DynamoDB / Client / describe_export

describe_export#

DynamoDB.Client.describe_export(**kwargs)#

Describes an existing table export.

See also: AWS API Documentation

Request Syntax

response = client.describe_export(
    ExportArn='string'
)
Parameters:

ExportArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) associated with the export.

Return type:

dict

Returns:

Response Syntax

{
    'ExportDescription': {
        'ExportArn': 'string',
        'ExportStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED',
        'StartTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'ExportManifest': 'string',
        'TableArn': 'string',
        'TableId': 'string',
        'ExportTime': datetime(2015, 1, 1),
        '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
    }
}

Response Structure

  • (dict) –

    • ExportDescription (dict) –

      Represents the properties of the export.

      • ExportArn (string) –

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

      • ExportStatus (string) –

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

      • StartTime (datetime) –

        The time at which the export task began.

      • EndTime (datetime) –

        The time at which the export task completed.

      • ExportManifest (string) –

        The name of the manifest file for the export task.

      • TableArn (string) –

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

      • TableId (string) –

        Unique ID of the table that was exported.

      • ExportTime (datetime) –

        Point in time from which table data was exported.

      • ClientToken (string) –

        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.

      • S3Bucket (string) –

        The name of the Amazon S3 bucket containing the export.

      • S3BucketOwner (string) –

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

      • S3Prefix (string) –

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

      • S3SseAlgorithm (string) –

        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

      • S3SseKmsKeyId (string) –

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

      • FailureCode (string) –

        Status code for the result of the failed export.

      • FailureMessage (string) –

        Export failure reason description.

      • ExportFormat (string) –

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

      • BilledSizeBytes (integer) –

        The billable size of the table export.

      • ItemCount (integer) –

        The number of items exported.

Exceptions

  • DynamoDB.Client.exceptions.ExportNotFoundException

  • DynamoDB.Client.exceptions.LimitExceededException

  • DynamoDB.Client.exceptions.InternalServerError