MailManager / Paginator / ListArchiveSearches


class MailManager.Paginator.ListArchiveSearches#
paginator = client.get_paginator('list_archive_searches')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • ArchiveId (string) –


    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:



Response Syntax

    'Searches': [
            'SearchId': 'string',
            'Status': {
                'CompletionTimestamp': datetime(2015, 1, 1),
                'ErrorMessage': 'string',
                'State': 'QUEUED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLED',
                'SubmissionTimestamp': datetime(2015, 1, 1)

Response Structure

  • (dict) –

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

    • Searches (list) –

      The list of search job identifiers and statuses.

      • (dict) –

        Summary details of an archive search job.

        • SearchId (string) –

          The unique identifier of the search job.

        • Status (dict) –

          The current status of the search job.

          • CompletionTimestamp (datetime) –

            The timestamp of when the search completed (if finished).

          • ErrorMessage (string) –

            An error message if the search failed.

          • State (string) –

            The current state of the search job.

          • SubmissionTimestamp (datetime) –

            The timestamp of when the search was submitted.