WorkMail / Client / start_mailbox_export_job

start_mailbox_export_job#

WorkMail.Client.start_mailbox_export_job(**kwargs)#

Starts a mailbox export job to export MIME-format email messages and calendar items from the specified mailbox to the specified Amazon Simple Storage Service (Amazon S3) bucket. For more information, see Exporting mailbox content in the WorkMail Administrator Guide.

See also: AWS API Documentation

Request Syntax

response = client.start_mailbox_export_job(
    ClientToken='string',
    OrganizationId='string',
    EntityId='string',
    Description='string',
    RoleArn='string',
    KmsKeyArn='string',
    S3BucketName='string',
    S3Prefix='string'
)
Parameters:

  • ClientToken (string) –

    [REQUIRED]

    The idempotency token for the client request.

    This field is autopopulated if not provided.

  • OrganizationId (string) –

    [REQUIRED]

    The identifier associated with the organization.

  • EntityId (string) –

    [REQUIRED]

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

    The identifier can accept UserId or ResourceId, Username or Resourcename, or email. The following identity formats are available:

    • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789 , or S-1-1-12-1234567890-123456789-123456789-1234

    • Email address: entity@domain.tld

    • Entity name: entity

  • Description (string) – The mailbox export job description.

  • RoleArn (string) –

    [REQUIRED]

    The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.

  • KmsKeyArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.

  • S3BucketName (string) –

    [REQUIRED]

    The name of the S3 bucket.

  • S3Prefix (string) –

    [REQUIRED]

    The S3 bucket prefix.

Return type:

dict

Returns:

Response Syntax

{
    'JobId': 'string'
}

Response Structure

  • (dict) –

    • JobId (string) –

      The job ID.

Exceptions

  • WorkMail.Client.exceptions.InvalidParameterException

  • WorkMail.Client.exceptions.OrganizationNotFoundException

  • WorkMail.Client.exceptions.OrganizationStateException

  • WorkMail.Client.exceptions.EntityNotFoundException

  • WorkMail.Client.exceptions.LimitExceededException