WorkMail / Client / list_mailbox_export_jobs

list_mailbox_export_jobs#

WorkMail.Client.list_mailbox_export_jobs(**kwargs)#

Lists the mailbox export jobs started for the specified organization within the last seven days.

See also: AWS API Documentation

Request Syntax

response = client.list_mailbox_export_jobs(
    OrganizationId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

    The organization ID.

  • NextToken (string) – The token to use to retrieve the next page of results.

  • MaxResults (integer) – The maximum number of results to return in a single call.

Return type:

dict

Returns:

Response Syntax

{
    'Jobs': [
        {
            'JobId': 'string',
            'EntityId': 'string',
            'Description': 'string',
            'S3BucketName': 'string',
            'S3Path': 'string',
            'EstimatedProgress': 123,
            'State': 'RUNNING'|'COMPLETED'|'FAILED'|'CANCELLED',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Jobs (list) –

      The mailbox export job details.

      • (dict) –

        The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.

        • JobId (string) –

          The identifier of the mailbox export job.

        • EntityId (string) –

          The identifier of the user or resource associated with the mailbox.

        • Description (string) –

          The mailbox export job description.

        • S3BucketName (string) –

          The name of the S3 bucket.

        • S3Path (string) –

          The path to the S3 bucket and file that the mailbox export job exports to.

        • EstimatedProgress (integer) –

          The estimated progress of the mailbox export job, in percentage points.

        • State (string) –

          The state of the mailbox export job.

        • StartTime (datetime) –

          The mailbox export job start timestamp.

        • EndTime (datetime) –

          The mailbox export job end timestamp.

    • NextToken (string) –

      The token to use to retrieve the next page of results.

Exceptions