Skip to content

Export Table to Point in Time

dynamodb_export_table_to_point_in_time R Documentation

Exports table data to an S3 bucket

Description

Exports table data to an S3 bucket. The table must have point in time recovery enabled, and you can export data from any time within the point in time recovery window.

Usage

dynamodb_export_table_to_point_in_time(TableArn, ExportTime,
  ClientToken, S3Bucket, S3BucketOwner, S3Prefix, S3SseAlgorithm,
  S3SseKmsKeyId, ExportFormat, ExportType, IncrementalExportSpecification)

Arguments

TableArn

[required] The Amazon Resource Name (ARN) associated with the table to export.

ExportTime

Time in the past from which to export table data, counted in seconds from the start of the Unix epoch. The table export will be a snapshot of the table's state at this point in time.

ClientToken

Providing a ClientToken makes the call to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.

A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an ImportConflictException.

S3Bucket

[required] The name of the Amazon S3 bucket to export the snapshot to.

S3BucketOwner

The ID of the Amazon Web Services account that owns the bucket the export will be stored in.

S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.

S3Prefix

The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

S3SseAlgorithm

Type of encryption used on the bucket where export data will be stored. Valid values for S3SseAlgorithm are:

  • AES256 - server-side encryption with Amazon S3 managed keys

  • KMS - server-side encryption with KMS managed keys

S3SseKmsKeyId

The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

ExportFormat

The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.

ExportType

Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.

IncrementalExportSpecification

Optional object containing the parameters specific to an incremental export.

Value

A list with the following syntax: 

list(
  ExportDescription = list(
    ExportArn = "string",
    ExportStatus = "IN_PROGRESS"|"COMPLETED"|"FAILED",
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    ),
    ExportManifest = "string",
    TableArn = "string",
    TableId = "string",
    ExportTime = as.POSIXct(
      "2015-01-01"
    ),
    ClientToken = "string",
    S3Bucket = "string",
    S3BucketOwner = "string",
    S3Prefix = "string",
    S3SseAlgorithm = "AES256"|"KMS",
    S3SseKmsKeyId = "string",
    FailureCode = "string",
    FailureMessage = "string",
    ExportFormat = "DYNAMODB_JSON"|"ION",
    BilledSizeBytes = 123,
    ItemCount = 123,
    ExportType = "FULL_EXPORT"|"INCREMENTAL_EXPORT",
    IncrementalExportSpecification = list(
      ExportFromTime = as.POSIXct(
        "2015-01-01"
      ),
      ExportToTime = as.POSIXct(
        "2015-01-01"
      ),
      ExportViewType = "NEW_IMAGE"|"NEW_AND_OLD_IMAGES"
    )
  )
)

Request syntax

svc$export_table_to_point_in_time(
  TableArn = "string",
  ExportTime = as.POSIXct(
    "2015-01-01"
  ),
  ClientToken = "string",
  S3Bucket = "string",
  S3BucketOwner = "string",
  S3Prefix = "string",
  S3SseAlgorithm = "AES256"|"KMS",
  S3SseKmsKeyId = "string",
  ExportFormat = "DYNAMODB_JSON"|"ION",
  ExportType = "FULL_EXPORT"|"INCREMENTAL_EXPORT",
  IncrementalExportSpecification = list(
    ExportFromTime = as.POSIXct(
      "2015-01-01"
    ),
    ExportToTime = as.POSIXct(
      "2015-01-01"
    ),
    ExportViewType = "NEW_IMAGE"|"NEW_AND_OLD_IMAGES"
  )
)