Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1480317256.9 KB

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 <a href="https://docs.aws.amazon.com/workmail/latest/adminguide/mail-export.html">Exporting mailbox content</a> in the <i>WorkMail Administrator Guide</i>.

post/#X-Amz-Target=WorkMailService.StartMailboxExportJob

Headers

X-Amz-Target'WorkMailService.StartMailboxExportJob' required

Request body

ClientTokenstring required

The idempotency token for the client request.

OrganizationIdstring required

The identifier associated with the organization.

EntityIdstring required

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

Descriptionstring

The mailbox export job description.

RoleArnstring required

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

KmsKeyArnstring required

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

S3BucketNamestring required

The name of the S3 bucket.

S3Prefixstring required

The S3 bucket prefix.

Response

Success

JobIdstring

The job ID.