:doc:`MailManager <../../mailmanager>` / Paginator / ListArchiveSearches

*******************
ListArchiveSearches
*******************



.. py:class:: MailManager.Paginator.ListArchiveSearches

  ::

    
    paginator = client.get_paginator('list_archive_searches')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`MailManager.Client.list_archive_searches`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mailmanager-2023-10-17/ListArchiveSearches>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ArchiveId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ArchiveId: string
    :param ArchiveId: **[REQUIRED]** 

      The identifier of the archive.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Searches': [
                {
                    'SearchId': 'string',
                    'Status': {
                        'SubmissionTimestamp': datetime(2015, 1, 1),
                        'CompletionTimestamp': datetime(2015, 1, 1),
                        'State': 'QUEUED'|'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLED',
                        'ErrorMessage': 'string'
                    }
                },
            ],
            
        }
        
      **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.

              
              

              - **SubmissionTimestamp** *(datetime) --* 

                The timestamp of when the search was submitted.

                
              

              - **CompletionTimestamp** *(datetime) --* 

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

                
              

              - **State** *(string) --* 

                The current state of the search job.

                
              

              - **ErrorMessage** *(string) --* 

                An error message if the search failed.

                
          
        
      
    