export_table_to_point_in_time¶
Operation¶
export_table_to_point_in_time
¶
export_table_to_point_in_time(request: ExportTableToPointInTimeInput | ExportTableToPointInTimeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ExportTableToPointInTimeInputDict]) -> 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 |
|---|---|---|---|
request
|
ExportTableToPointInTimeInput | ExportTableToPointInTimeInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ExportTableToPointInTimeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ExportTableToPointInTimeOutput
|
An instance of |
export_table_to_point_in_time
async
¶
export_table_to_point_in_time(request: ExportTableToPointInTimeInput | ExportTableToPointInTimeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ExportTableToPointInTimeInputDict]) -> 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 |
|---|---|---|---|
request
|
ExportTableToPointInTimeInput | ExportTableToPointInTimeInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ExportTableToPointInTimeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ExportTableToPointInTimeOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ExportTableToPointInTimeInputDict
¶
Bases: TypedDict
Dictionary form of ExportTableToPointInTimeInput.
Attributes¶
client_token
instance-attribute
¶
client_token: str | 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.
This field is autopopulated if not provided.
export_format
instance-attribute
¶
export_format: str | None
The format for the exported data. Valid values for ExportFormat are
DYNAMODB_JSON or ION.
export_time
instance-attribute
¶
export_time: datetime | 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.
export_type
instance-attribute
¶
export_type: str | 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.
filter_specification
instance-attribute
¶
filter_specification: FilterSpecification | FilterSpecificationDict | None
The criteria used to filter which items are included in the point-in-time export. When you specify this parameter, only items that match the key conditions and filter expressions are exported.
incremental_export_specification
instance-attribute
¶
incremental_export_specification: IncrementalExportSpecification | IncrementalExportSpecificationDict | None
Optional object containing the parameters specific to an incremental export.
s3_bucket
instance-attribute
¶
The name of the Amazon S3 bucket to export the snapshot to.
s3_bucket_owner
instance-attribute
¶
s3_bucket_owner: str | 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.
s3_prefix
instance-attribute
¶
s3_prefix: str | None
The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
s3_sse_algorithm
instance-attribute
¶
s3_sse_algorithm: str | 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
ExportTableToPointInTimeInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ExportTableToPointInTimeInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | 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.
This field is autopopulated if not provided.
export_format
class-attribute
instance-attribute
¶
export_format: str | None = ...
The format for the exported data. Valid values for ExportFormat are
DYNAMODB_JSON or ION.
export_time
class-attribute
instance-attribute
¶
export_time: datetime | 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.
export_type
class-attribute
instance-attribute
¶
export_type: str | 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.
filter_specification
class-attribute
instance-attribute
¶
filter_specification: FilterSpecification | None = ...
The criteria used to filter which items are included in the point-in-time export. When you specify this parameter, only items that match the key conditions and filter expressions are exported.
incremental_export_specification
class-attribute
instance-attribute
¶
incremental_export_specification: IncrementalExportSpecification | None = ...
Optional object containing the parameters specific to an incremental export.
s3_bucket
class-attribute
instance-attribute
¶
s3_bucket: str | None = ...
The name of the Amazon S3 bucket to export the snapshot to.
s3_bucket_owner
class-attribute
instance-attribute
¶
s3_bucket_owner: str | 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.
s3_prefix
class-attribute
instance-attribute
¶
s3_prefix: str | None = ...
The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
s3_sse_algorithm
class-attribute
instance-attribute
¶
s3_sse_algorithm: str | 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¶
ExportTableToPointInTimeOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ExportTableToPointInTimeOutput structure.
Attributes¶
export_description
class-attribute
instance-attribute
¶
export_description: ExportDescription | None = ...
Contains a description of the table export.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.