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.
Request Syntax
{
"ClientToken": "string",
"Description": "string",
"EntityId": "string",
"KmsKeyArn": "string",
"OrganizationId": "string",
"RoleArn": "string",
"S3BucketName": "string",
"S3Prefix": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientToken
-
The idempotency token for the client request.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\x21-\x7e]+Required: Yes
- Description
-
The mailbox export job description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1023.
Pattern:
[\S\s]*Required: No
- EntityId
-
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
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9._%+@-]+Required: Yes
-
- KmsKeyArn
-
The Amazon Resource Name (ARN) of the symmetric AWS Key Management Service (AWS KMS) key that encrypts the exported mailbox content.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws:kms:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}Required: Yes
- OrganizationId
-
The identifier associated with the organization.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
- RoleArn
-
The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the S3 bucket.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws:iam:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}Required: Yes
- S3BucketName
-
The name of the S3 bucket.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[A-Za-z0-9.-]+Required: Yes
- S3Prefix
-
The S3 bucket prefix.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1023.
Pattern:
[A-Za-z0-9!_.*'()/-]+Required: Yes
Response Syntax
{
"JobId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- JobId
-
The job ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[A-Za-z0-9-]+
Errors
For information about the errors that are common to all actions, see Common Errors.
- EntityNotFoundException
-
The identifier supplied for the user, group, or resource does not exist in your organization.
HTTP Status Code: 400
- InvalidParameterException
-
One or more of the input parameters don't match the service's restrictions.
HTTP Status Code: 400
- LimitExceededException
-
The request exceeds the limit of the resource.
HTTP Status Code: 400
- OrganizationNotFoundException
-
An operation received a valid organization identifier that either doesn't belong or exist in the system.
HTTP Status Code: 400
- OrganizationStateException
-
The organization must have a valid state to perform certain operations on the organization or its members.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
