export_table_to_point_in_time¶
Operation¶
async
¶
export_table_to_point_in_time(input: ExportTableToPointInTimeInput, plugins: list[Plugin] | None = None) -> ExportTableToPointInTimeOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ExportTableToPointInTimeInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
ExportTableToPointInTimeOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for ExportTableToPointInTimeInput structure.
Attributes¶
class-attribute
instance-attribute
¶
client_token: str | None = None
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
ExportConflictException.
class-attribute
instance-attribute
¶
export_format: ExportFormat | None = None
The format for the exported data. Valid values for ExportFormat are
DYNAMODB_JSON or ION.
class-attribute
instance-attribute
¶
export_time: datetime | None = None
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.
class-attribute
instance-attribute
¶
export_type: ExportType | None = None
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.
class-attribute
instance-attribute
¶
incremental_export_specification: IncrementalExportSpecification | None = None
Optional object containing the parameters specific to an incremental export.
class-attribute
instance-attribute
¶
s3_bucket: str | None = None
The name of the Amazon S3 bucket to export the snapshot to.
class-attribute
instance-attribute
¶
s3_bucket_owner: str | None = None
The ID of the Amazon Web Services account that owns the bucket the export will be stored in.
Note
S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.
class-attribute
instance-attribute
¶
s3_prefix: str | None = None
The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
class-attribute
instance-attribute
¶
s3_sse_algorithm: S3SseAlgorithm | None = None
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
Output¶
dataclass
¶
Dataclass for ExportTableToPointInTimeOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
export_description: ExportDescription | None = None
Contains a description of the table export.