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,
        'ExportType': 'FULL_EXPORT'|'INCREMENTAL_EXPORT',
        'IncrementalExportSpecification': {
            'ExportFromTime': datetime(2015, 1, 1),
            'ExportToTime': datetime(2015, 1, 1),
            'ExportViewType': 'NEW_IMAGE'|'NEW_AND_OLD_IMAGES'
        },
        'FilterSpecification': {
            'FilterExpression': 'string',
            'ProjectionExpression': 'string',
            'KeyConditionExpression': 'string',
            'ExpressionAttributeNames': {
                'string': 'string'
            },
            'ExpressionAttributeValues': {
                'string': {
                    'S': 'string',
                    'N': 'string',
                    'B': b'bytes',
                    'SS': [
                        'string',
                    ],
                    'NS': [
                        'string',
                    ],
                    'BS': [
                        b'bytes',
                    ],
                    'M': {
                        'string': {'... recursive ...'}
                    },
                    'L': [
                        {'... recursive ...'},
                    ],
                    'NULL': True|False,
                    'BOOL': True|False
                }
            }
        }
    }
}

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.

      • ExportType (string) –

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

      • IncrementalExportSpecification (dict) –

        Optional object containing the parameters specific to an incremental export.

        • ExportFromTime (datetime) –

          Time in the past which provides the inclusive start range for the export table’s data, counted in seconds from the start of the Unix epoch. The incremental export will reflect the table’s state including and after this point in time.

        • ExportToTime (datetime) –

          Time in the past which provides the exclusive end range for the export table’s data, counted in seconds from the start of the Unix epoch. The incremental export will reflect the table’s state just prior to this point in time. If this is not provided, the latest time with data available will be used.

        • ExportViewType (string) –

          The view type that was chosen for the export. Valid values are NEW_AND_OLD_IMAGES and NEW_IMAGES. The default value is NEW_AND_OLD_IMAGES.

          NEW_AND_OLD_IMAGES exports both the new and old images of each changed item, while NEW_IMAGES exports only the new (latest) image. The view type you choose determines the structure of each item in the output for insert, update, and delete operations. For details and examples of how each view type shapes the export output, see DynamoDB table export output format in the Amazon DynamoDB Developer Guide.

      • FilterSpecification (dict) –

        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.

        • FilterExpression (string) –

          A condition that filters which items are included in the export. This parameter uses the same syntax as FilterExpression in Query and Scan. If you don’t provide KeyConditionExpression, this expression can also reference key attributes. If you don’t specify this parameter, all items are included in the export.

        • ProjectionExpression (string) –

          The attributes you want to retrieve for items included in the export. Separate attribute names in the expression with commas. If you don’t specify this parameter, all attributes are returned.

        • KeyConditionExpression (string) –

          A condition expression that filters items by key values. The expression must test equality on a single partition key value and can optionally compare a sort key value. This parameter uses the same syntax as KeyConditionExpression in Query. When you provide this parameter, FilterExpression can only reference non-key attributes. If you don’t specify this parameter, all items are eligible for export.

        • ExpressionAttributeNames (dict) –

          One or more substitution tokens for attribute names in an expression. For more information, see Expression Attribute Names in the Amazon DynamoDB Developer Guide.

          • (string) –

            • (string) –

        • ExpressionAttributeValues (dict) –

          One or more values that can be substituted in an expression. For more information, see Expression Attribute Values in the Amazon DynamoDB Developer Guide.

          • (string) –

            • (dict) –

              Represents the data for an attribute.

              Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

              For more information, see Data Types in the Amazon DynamoDB Developer Guide.

              • S (string) –

                An attribute of type String. For example:

                "S": "Hello"

              • N (string) –

                An attribute of type Number. For example:

                "N": "123.45"

                Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

              • B (bytes) –

                An attribute of type Binary. For example:

                "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

              • SS (list) –

                An attribute of type String Set. For example:

                "SS": ["Giraffe", "Hippo" ,"Zebra"]

                • (string) –

              • NS (list) –

                An attribute of type Number Set. For example:

                "NS": ["42.2", "-19", "7.5", "3.14"]

                Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

                • (string) –

              • BS (list) –

                An attribute of type Binary Set. For example:

                "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]

                • (bytes) –

              • M (dict) –

                An attribute of type Map. For example:

                "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}

                • (string) –

                  • (dict) –

                    Represents the data for an attribute.

                    Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

                    For more information, see Data Types in the Amazon DynamoDB Developer Guide.

              • L (list) –

                An attribute of type List. For example:

                "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N": "3.14159"}]

                • (dict) –

                  Represents the data for an attribute.

                  Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

                  For more information, see Data Types in the Amazon DynamoDB Developer Guide.

              • NULL (boolean) –

                An attribute of type Null. For example:

                "NULL": true

              • BOOL (boolean) –

                An attribute of type Boolean. For example:

                "BOOL": true

Exceptions