DynamoDB / Client / list_imports

list_imports#

DynamoDB.Client.list_imports(**kwargs)#

Lists completed imports within the past 90 days.

See also: AWS API Documentation

Request Syntax

response = client.list_imports(
    TableArn='string',
    PageSize=123,
    NextToken='string'
)
Parameters:

  • TableArn (string) – The Amazon Resource Name (ARN) associated with the table that was imported to.

  • PageSize (integer) – The number of ``ImportSummary ``objects returned in a single page.

  • NextToken (string) – An optional string that, if supplied, must be copied from the output of a previous call to ListImports. When provided in this manner, the API fetches the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'ImportSummaryList': [
        {
            'ImportArn': 'string',
            'ImportStatus': 'IN_PROGRESS'|'COMPLETED'|'CANCELLING'|'CANCELLED'|'FAILED',
            'TableArn': 'string',
            'S3BucketSource': {
                'S3BucketOwner': 'string',
                'S3Bucket': 'string',
                'S3KeyPrefix': 'string'
            },
            'CloudWatchLogGroupArn': 'string',
            'InputFormat': 'DYNAMODB_JSON'|'ION'|'CSV',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ImportSummaryList (list) –

      A list of ImportSummary objects.

      • (dict) –

        Summary information about the source file for the import.

        • ImportArn (string) –

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

        • ImportStatus (string) –

          The status of the import operation.

        • TableArn (string) –

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

        • S3BucketSource (dict) –

          The path and S3 bucket of the source file that is being imported. This includes the S3Bucket (required), S3KeyPrefix (optional) and S3BucketOwner (optional if the bucket is owned by the requester).

          • S3BucketOwner (string) –

            The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional.

          • S3Bucket (string) –

            The S3 bucket that is being imported from.

          • S3KeyPrefix (string) –

            The key prefix shared by all S3 Objects that are being imported.

        • CloudWatchLogGroupArn (string) –

          The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with this import task.

        • InputFormat (string) –

          The format of the source data. Valid values are CSV, DYNAMODB_JSON or ION.

        • StartTime (datetime) –

          The time at which this import task began.

        • EndTime (datetime) –

          The time at which this import task ended. (Does this include the successful complete creation of the table it was imported to?)

    • NextToken (string) –

      If this value is returned, there are additional results to be displayed. To retrieve them, call ListImports again, with NextToken set to this value.

Exceptions