MailboxExportJob - Amazon WorkMail

MailboxExportJob

The details of a mailbox export job, including the user or resource ID associated with the mailbox and the S3 bucket that the mailbox contents are exported to.

Contents

Description

The mailbox export job description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1023.

Pattern: [\S\s]*

Required: No

EndTime

The mailbox export job end timestamp.

Type: Timestamp

Required: No

EntityId

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

Type: String

Length Constraints: Minimum length of 12. Maximum length of 256.

Required: No

EstimatedProgress

The estimated progress of the mailbox export job, in percentage points.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

JobId

The identifier of the mailbox export job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [A-Za-z0-9-]+

Required: No

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: No

S3Path

The path to the S3 bucket and file that the mailbox export job exports to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1023.

Pattern: [A-Za-z0-9!_.*'()/-]+

Required: No

StartTime

The mailbox export job start timestamp.

Type: Timestamp

Required: No

State

The state of the mailbox export job.

Type: String

Valid Values: RUNNING | COMPLETED | FAILED | CANCELLED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: