SimpleDBv2 / Paginator / ListExports

ListExports

class SimpleDBv2.Paginator.ListExports

paginator = client.get_paginator('list_exports')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SimpleDBv2.Client.list_exports().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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 token to resume pagination.