DescribeMailboxExportJob
Describes the current status of a mailbox export job.
Request Syntax
{
"JobId": "string",
"OrganizationId": "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.
- JobId
-
The mailbox export job ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[A-Za-z0-9-]+Required: Yes
- OrganizationId
-
The organization ID.
Type: String
Length Constraints: Fixed length of 34.
Pattern:
^m-[0-9a-f]{32}$Required: Yes
Response Syntax
{
"Description": "string",
"EndTime": number,
"EntityId": "string",
"ErrorInfo": "string",
"EstimatedProgress": number,
"KmsKeyArn": "string",
"RoleArn": "string",
"S3BucketName": "string",
"S3Path": "string",
"S3Prefix": "string",
"StartTime": number,
"State": "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.
- Description
-
The mailbox export job description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1023.
Pattern:
[\S\s]* - EndTime
-
The mailbox export job end timestamp.
Type: Timestamp
- EntityId
-
The identifier of the user or resource associated with the mailbox.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 256.
- ErrorInfo
-
Error information for failed mailbox export jobs.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
[\S\s]* - EstimatedProgress
-
The estimated progress of the mailbox export job, in percentage points.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
- 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} - RoleArn
-
The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon 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} - S3BucketName
-
The name of the S3 bucket.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
[A-Za-z0-9.-]+ - S3Path
-
The path to the S3 bucket and file that the mailbox export job is exporting to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1023.
Pattern:
[A-Za-z0-9!_.*'()/-]+ - S3Prefix
-
The S3 bucket prefix.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1023.
Pattern:
[A-Za-z0-9!_.*'()/-]+ - StartTime
-
The mailbox export job start timestamp.
Type: Timestamp
- State
-
The state of the mailbox export job.
Type: String
Valid Values:
RUNNING | COMPLETED | FAILED | CANCELLED
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
- 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:
