MailManager / Client / list_archive_exports

list_archive_exports

MailManager.Client.list_archive_exports(**kwargs)

Returns a list of email archive export jobs.

See also: AWS API Documentation

Request Syntax

response = client.list_archive_exports(
    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 export jobs that are returned per call. You can use NextToken to obtain further pages of archives.

Return type:

dict

Returns:

Response Syntax

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

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.

          • SubmissionTimestamp (datetime) –

            The timestamp of when the export job was submitted.

          • CompletionTimestamp (datetime) –

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

          • State (string) –

            The current state of the export job.

          • ErrorMessage (string) –

            An error message if the export job 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