SimpleDBv2 / Client / list_exports

list_exports

SimpleDBv2.Client.list_exports(**kwargs)

Lists all exports that were created. The results are paginated and can be filtered by domain name.

See also: AWS API Documentation

Request Syntax

response = client.list_exports(
    domainName='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • domainName (string) – The name of the domain to filter exports. If not provided, exports for all the domains will be listed.

  • maxResults (integer) – The maximum number of exports to return in a single response.

  • nextToken (string) – A pagination token used to retrieve the next page of results. This token is obtained from the nextToken field in the previous ListExportsResponse. Leave empty for the first request.

Return type:

dict

Returns:

Response Syntax

{
    'exportSummaries': [
        {
            'exportArn': 'string',
            'exportStatus': 'PENDING'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
            'requestedAt': datetime(2015, 1, 1),
            'domainName': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • exportSummaries (list) –

      List of export summaries containing export ARN, status, request timestamp, and associated domain name.

      • (dict) –

        Summary information about an export, including its unique identifier, current status, creation time, and the domain being exported.

        • exportArn (string) –

          Unique ARN identifier of the export.

        • exportStatus (string) –

          The current state of the export. Current possible values include : PENDING - export request received, IN_PROGRESS - export is being processed, SUCCEEDED - export completed successfully, and FAILED - export encountered an error.

        • requestedAt (datetime) –

          Timestamp when the export request was received by the service

        • domainName (string) –

          The name of the domain for which the export was created.

    • nextToken (string) –

      A pagination token indicating that more results are available. To retrieve the next page of results, provide this token in a subsequent ListExports request. If null or empty, there are no more results to retrieve.

Exceptions