MailManager / Paginator / ListArchiveExports

ListArchiveExports

class MailManager.Paginator.ListArchiveExports

paginator = client.get_paginator('list_archive_exports')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MailManager.Client.list_archive_exports().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ArchiveId (string) –

  [REQUIRED]

  The identifier of the archive.

• 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

{
    'Exports': [
        {
            'ExportId': 'string',
            'Status': {
                'CompletionTimestamp': datetime(2015, 1, 1),
                'ErrorMessage': 'string',
                'State': 'QUEUED'|'PREPROCESSING'|'PROCESSING'|'COMPLETED'|'FAILED'|'CANCELLED',
                'SubmissionTimestamp': datetime(2015, 1, 1)
            }
        },
    ],

}

Response Structure

• (dict) –

  The response containing a list of archive export jobs and their statuses.

  • Exports (list) –

    The list of export job identifiers and statuses.

    • (dict) –

      Summary statuses of an archive export job.

      • ExportId (string) –

        The unique identifier of the export job.

      • Status (dict) –

        The current status of the export job.

        • CompletionTimestamp (datetime) –

          The timestamp of when the export job completed (if finished).

        • ErrorMessage (string) –

          An error message if the export job failed.

        • State (string) –

          The current state of the export job.

        • SubmissionTimestamp (datetime) –

          The timestamp of when the export job was submitted.