MailManager / Paginator / ListArchives

ListArchives

class MailManager.Paginator.ListArchives

paginator = client.get_paginator('list_archives')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'Archives': [
        {
            'ArchiveId': 'string',
            'ArchiveName': 'string',
            'ArchiveState': 'ACTIVE'|'PENDING_DELETION',
            'LastUpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  The response containing a list of your email archives.

  • Archives (list) –

    The list of archive details.

    • (dict) –

      An archive resource for storing and retaining emails.

      • ArchiveId (string) –

        The unique identifier of the archive.

      • ArchiveName (string) –

        The unique name assigned to the archive.

      • ArchiveState (string) –

        The current state of the archive:

        • ACTIVE – The archive is ready and available for use.

        • PENDING_DELETION – The archive has been marked for deletion and will be permanently deleted in 30 days. No further modifications can be made in this state.

      • LastUpdatedTimestamp (datetime) –

        The timestamp of when the archive was last updated.