MailManager / Client / list_archive_searches

list_archive_searches¶

MailManager.Client.list_archive_searches(**kwargs)¶

Returns a list of email archive search jobs.

Request Syntax

response = client.list_archive_searches(
    ArchiveId='string',
    NextToken='string',
    PageSize=123
)

Parameters:

ArchiveId (string) –
[REQUIRED]

The identifier of the archive.
NextToken (string) – If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
PageSize (integer) – The maximum number of archive search jobs that are returned per call. You can use NextToken to obtain further pages of archives.

Return type:

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'
            }
        },
    ],
    'NextToken': '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.
- NextToken (string) –
  
  If present, use to retrieve the next page of results.

Exceptions

MailManager.Client.exceptions.ValidationException
MailManager.Client.exceptions.AccessDeniedException
MailManager.Client.exceptions.ResourceNotFoundException
MailManager.Client.exceptions.ThrottlingException