Skip to content

ExportDescription

Source code in docs_src/capo_dynamodb/types/export_description.py
class ExportDescription(TypedDict, closed=True):
    export_arn: NotRequired["capo_dynamodb.types.export_arn.ExportArn"]
    """<p>The Amazon Resource Name (ARN) of the table export.</p>"""
    export_status: NotRequired["capo_dynamodb.types.export_status.ExportStatus"]
    """<p>Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.</p>"""
    start_time: NotRequired["capo_dynamodb.types.export_start_time.ExportStartTime"]
    """<p>The time at which the export task began.</p>"""
    end_time: NotRequired["capo_dynamodb.types.export_end_time.ExportEndTime"]
    """<p>The time at which the export task completed.</p>"""
    export_manifest: NotRequired["capo_dynamodb.types.export_manifest.ExportManifest"]
    """<p>The name of the manifest file for the export task.</p>"""
    table_arn: NotRequired["capo_dynamodb.types.table_arn.TableArn"]
    """<p>The Amazon Resource Name (ARN) of the table that was exported.</p>"""
    table_id: NotRequired["capo_dynamodb.types.table_id.TableId"]
    """<p>Unique ID of the table that was exported.</p>"""
    export_time: NotRequired["capo_dynamodb.types.export_time.ExportTime"]
    """<p>Point in time from which table data was exported.</p>"""
    client_token: NotRequired["capo_dynamodb.types.client_token.ClientToken"]
    """<p>The client token that was provided for the export task. A client token makes calls to <code>ExportTableToPointInTimeInput</code> idempotent, meaning that multiple identical calls have the same effect as one single call.</p>"""
    s3_bucket: NotRequired["capo_dynamodb.types.s3_bucket.S3Bucket"]
    """<p>The name of the Amazon S3 bucket containing the export.</p>"""
    s3_bucket_owner: NotRequired["capo_dynamodb.types.s3_bucket_owner.S3BucketOwner"]
    """<p>The ID of the Amazon Web Services account that owns the bucket containing the export.</p>"""
    s3_prefix: NotRequired["capo_dynamodb.types.s3_prefix.S3Prefix"]
    """<p>The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.</p>"""
    s3_sse_algorithm: NotRequired["capo_dynamodb.types.s3_sse_algorithm.S3SseAlgorithm"]
    """<p>Type of encryption used on the bucket where export data is stored. Valid values for <code>S3SseAlgorithm</code> are:</p> <ul> <li> <p> <code>AES256</code> - server-side encryption with Amazon S3 managed keys</p> </li> <li> <p> <code>KMS</code> - server-side encryption with KMS managed keys</p> </li> </ul>"""
    s3_sse_kms_key_id: NotRequired[
        "capo_dynamodb.types.s3_sse_kms_key_id.S3SseKmsKeyId"
    ]
    """<p>The ID of the KMS managed key used to encrypt the S3 bucket where export data is stored (if applicable).</p>"""
    failure_code: NotRequired["capo_dynamodb.types.failure_code.FailureCode"]
    """<p>Status code for the result of the failed export.</p>"""
    failure_message: NotRequired["capo_dynamodb.types.failure_message.FailureMessage"]
    """<p>Export failure reason description.</p>"""
    export_format: NotRequired["capo_dynamodb.types.export_format.ExportFormat"]
    """<p>The format of the exported data. Valid values for <code>ExportFormat</code> are <code>DYNAMODB_JSON</code> or <code>ION</code>.</p>"""
    billed_size_bytes: NotRequired[
        "capo_dynamodb.types.billed_size_bytes.BilledSizeBytes"
    ]
    """<p>The billable size of the table export.</p>"""
    item_count: NotRequired["capo_dynamodb.types.item_count.ItemCount"]
    """<p>The number of items exported.</p>"""
    export_type: NotRequired["capo_dynamodb.types.export_type.ExportType"]
    """<p>The type of export that was performed. Valid values are <code>FULL_EXPORT</code> or <code>INCREMENTAL_EXPORT</code>.</p>"""
    incremental_export_specification: NotRequired[
        "capo_dynamodb.types.incremental_export_specification.IncrementalExportSpecification"
    ]
    """<p>Optional object containing the parameters specific to an incremental export.</p>"""
    filter_specification: NotRequired[
        "capo_dynamodb.types.filter_specification.FilterSpecification"
    ]
    """<p>The filter criteria applied to the export. When present, only items that match the specified key conditions and filter expressions are included in the export output.</p>"""

billed_size_bytes instance-attribute

billed_size_bytes: NotRequired[BilledSizeBytes]

The billable size of the table export.

client_token instance-attribute

client_token: NotRequired[ClientToken]

The client token that was provided for the export task. A client token makes calls to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.

end_time instance-attribute

end_time: NotRequired[ExportEndTime]

The time at which the export task completed.

export_arn instance-attribute

export_arn: NotRequired[ExportArn]

The Amazon Resource Name (ARN) of the table export.

export_format instance-attribute

export_format: NotRequired[ExportFormat]

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

export_manifest instance-attribute

export_manifest: NotRequired[ExportManifest]

The name of the manifest file for the export task.

export_status instance-attribute

export_status: NotRequired[ExportStatus]

Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.

export_time instance-attribute

export_time: NotRequired[ExportTime]

Point in time from which table data was exported.

export_type instance-attribute

export_type: NotRequired[ExportType]

The type of export that was performed. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT.

failure_code instance-attribute

failure_code: NotRequired[FailureCode]

Status code for the result of the failed export.

failure_message instance-attribute

failure_message: NotRequired[FailureMessage]

Export failure reason description.

filter_specification instance-attribute

filter_specification: NotRequired[FilterSpecification]

The filter criteria applied to the export. When present, only items that match the specified key conditions and filter expressions are included in the export output.

incremental_export_specification instance-attribute

incremental_export_specification: NotRequired[IncrementalExportSpecification]

Optional object containing the parameters specific to an incremental export.

item_count instance-attribute

item_count: NotRequired[ItemCount]

The number of items exported.

s3_bucket instance-attribute

s3_bucket: NotRequired[S3Bucket]

The name of the Amazon S3 bucket containing the export.

s3_bucket_owner instance-attribute

s3_bucket_owner: NotRequired[S3BucketOwner]

The ID of the Amazon Web Services account that owns the bucket containing the export.

s3_prefix instance-attribute

s3_prefix: NotRequired[S3Prefix]

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

s3_sse_algorithm instance-attribute

s3_sse_algorithm: NotRequired[S3SseAlgorithm]

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

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

  • KMS - server-side encryption with KMS managed keys

s3_sse_kms_key_id instance-attribute

s3_sse_kms_key_id: NotRequired[S3SseKmsKeyId]

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

start_time instance-attribute

start_time: NotRequired[ExportStartTime]

The time at which the export task began.

table_arn instance-attribute

table_arn: NotRequired[TableArn]

The Amazon Resource Name (ARN) of the table that was exported.

table_id instance-attribute

table_id: NotRequired[TableId]

Unique ID of the table that was exported.