[ aws . workmail ]



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 Amazon WorkMail Administrator Guide .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


[--client-token <value>]
--organization-id <value>
--entity-id <value>
[--description <value>]
--role-arn <value>
--kms-key-arn <value>
--s3-bucket-name <value>
--s3-prefix <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--client-token (string)

The idempotency token for the client request.

--organization-id (string)

The identifier associated with the organization.

--entity-id (string)

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

--description (string)

The mailbox export job description.

--role-arn (string)

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

--kms-key-arn (string)

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

--s3-bucket-name (string)

The name of the S3 bucket.

--s3-prefix (string)

The S3 bucket prefix.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.


JobId -> (string)

The job ID.