Skip to content

ImportTableDescription

Source code in docs_src/capo_dynamodb/types/import_table_description.py
class ImportTableDescription(TypedDict, closed=True):
    import_arn: NotRequired["capo_dynamodb.types.import_arn.ImportArn"]
    """<p> The Amazon Resource Number (ARN) corresponding to the import request. </p>"""
    import_status: NotRequired["capo_dynamodb.types.import_status.ImportStatus"]
    """<p> The status of the import. </p>"""
    table_arn: NotRequired["capo_dynamodb.types.table_arn.TableArn"]
    """<p> The Amazon Resource Number (ARN) of the table being imported into. </p>"""
    table_id: NotRequired["capo_dynamodb.types.table_id.TableId"]
    """<p> The table id corresponding to the table created by import table process. </p>"""
    client_token: NotRequired["capo_dynamodb.types.client_token.ClientToken"]
    """<p> The client token that was provided for the import task. Reusing the client token on retry makes a call to <code>ImportTable</code> idempotent. </p>"""
    s3_bucket_source: NotRequired["capo_dynamodb.types.s3_bucket_source.S3BucketSource"]
    """<p> Values for the S3 bucket the source file is imported from. Includes bucket name (required), key prefix (optional) and bucket account owner ID (optional). </p>"""
    error_count: "capo_dynamodb.types.error_count.ErrorCount"
    """<p> The number of errors occurred on importing the source file into the target table. </p>"""
    cloud_watch_log_group_arn: NotRequired[
        "capo_dynamodb.types.cloud_watch_log_group_arn.CloudWatchLogGroupArn"
    ]
    """<p> The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table. </p>"""
    input_format: NotRequired["capo_dynamodb.types.input_format.InputFormat"]
    """<p> The format of the source data going into the target table. </p>"""
    input_format_options: NotRequired[
        "capo_dynamodb.types.input_format_options.InputFormatOptions"
    ]
    """<p> The format options for the data that was imported into the target table. There is one value, CsvOption. </p>"""
    input_compression_type: NotRequired[
        "capo_dynamodb.types.input_compression_type.InputCompressionType"
    ]
    """<p> The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD. </p>"""
    table_creation_parameters: NotRequired[
        "capo_dynamodb.types.table_creation_parameters.TableCreationParameters"
    ]
    """<p> The parameters for the new table that is being imported into. </p>"""
    start_time: NotRequired["capo_dynamodb.types.import_start_time.ImportStartTime"]
    """<p> The time when this import task started. </p>"""
    end_time: NotRequired["capo_dynamodb.types.import_end_time.ImportEndTime"]
    """<p> The time at which the creation of the table associated with this import task completed. </p>"""
    processed_size_bytes: NotRequired["capo_dynamodb.types.long_object.LongObject"]
    """<p> The total size of data processed from the source file, in Bytes. </p>"""
    processed_item_count: "capo_dynamodb.types.processed_item_count.ProcessedItemCount"
    """<p> The total number of items processed from the source file. </p>"""
    imported_item_count: "capo_dynamodb.types.imported_item_count.ImportedItemCount"
    """<p> The number of items successfully imported into the new table. </p>"""
    failure_code: NotRequired["capo_dynamodb.types.failure_code.FailureCode"]
    """<p> The error code corresponding to the failure that the import job ran into during execution. </p>"""
    failure_message: NotRequired["capo_dynamodb.types.failure_message.FailureMessage"]
    """<p> The error message corresponding to the failure that the import job ran into during execution. </p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

The client token that was provided for the import task. Reusing the client token on retry makes a call to ImportTable idempotent.

cloud_watch_log_group_arn instance-attribute

cloud_watch_log_group_arn: NotRequired[CloudWatchLogGroupArn]

The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the target table.

end_time instance-attribute

end_time: NotRequired[ImportEndTime]

The time at which the creation of the table associated with this import task completed.

error_count instance-attribute

error_count: ErrorCount

The number of errors occurred on importing the source file into the target table.

failure_code instance-attribute

failure_code: NotRequired[FailureCode]

The error code corresponding to the failure that the import job ran into during execution.

failure_message instance-attribute

failure_message: NotRequired[FailureMessage]

The error message corresponding to the failure that the import job ran into during execution.

import_arn instance-attribute

import_arn: NotRequired[ImportArn]

The Amazon Resource Number (ARN) corresponding to the import request.

import_status instance-attribute

import_status: NotRequired[ImportStatus]

The status of the import.

imported_item_count instance-attribute

imported_item_count: ImportedItemCount

The number of items successfully imported into the new table.

input_compression_type instance-attribute

input_compression_type: NotRequired[InputCompressionType]

The compression options for the data that has been imported into the target table. The values are NONE, GZIP, or ZSTD.

input_format instance-attribute

input_format: NotRequired[InputFormat]

The format of the source data going into the target table.

input_format_options instance-attribute

input_format_options: NotRequired[InputFormatOptions]

The format options for the data that was imported into the target table. There is one value, CsvOption.

processed_item_count instance-attribute

processed_item_count: ProcessedItemCount

The total number of items processed from the source file.

processed_size_bytes instance-attribute

processed_size_bytes: NotRequired[LongObject]

The total size of data processed from the source file, in Bytes.

s3_bucket_source instance-attribute

s3_bucket_source: NotRequired[S3BucketSource]

Values for the S3 bucket the source file is imported from. Includes bucket name (required), key prefix (optional) and bucket account owner ID (optional).

start_time instance-attribute

start_time: NotRequired[ImportStartTime]

The time when this import task started.

table_arn instance-attribute

table_arn: NotRequired[TableArn]

The Amazon Resource Number (ARN) of the table being imported into.

table_creation_parameters instance-attribute

table_creation_parameters: NotRequired[TableCreationParameters]

The parameters for the new table that is being imported into.

table_id instance-attribute

table_id: NotRequired[TableId]

The table id corresponding to the table created by import table process.