/AWS1/CL_WML=>STARTMAILBOXEXPORTJOB()¶
About StartMailboxExportJob¶
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_CLIENTTOKEN TYPE /AWS1/WMLIDEMPOTENCYCLITOKEN /AWS1/WMLIDEMPOTENCYCLITOKEN¶
The idempotency token for the client request.
IV_ORGANIZATIONID TYPE /AWS1/WMLORGANIZATIONID /AWS1/WMLORGANIZATIONID¶
The identifier associated with the organization.
IV_ENTITYID TYPE /AWS1/WMLENTITYIDENTIFIER /AWS1/WMLENTITYIDENTIFIER¶
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
IV_ROLEARN TYPE /AWS1/WMLROLEARN /AWS1/WMLROLEARN¶
The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
IV_KMSKEYARN TYPE /AWS1/WMLKMSKEYARN /AWS1/WMLKMSKEYARN¶
The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
IV_S3BUCKETNAME TYPE /AWS1/WMLS3BUCKETNAME /AWS1/WMLS3BUCKETNAME¶
The name of the S3 bucket.
IV_S3PREFIX TYPE /AWS1/WMLS3OBJECTKEY /AWS1/WMLS3OBJECTKEY¶
The S3 bucket prefix.
Optional arguments:¶
IV_DESCRIPTION TYPE /AWS1/WMLDESCRIPTION /AWS1/WMLDESCRIPTION¶
The mailbox export job description.