[ aws . workmail ]

list-mailbox-export-jobs

Description

Lists the mailbox export jobs started for the specified organization within the last seven days.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-mailbox-export-jobs
--organization-id <value>
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--organization-id (string)

The organization ID.

--next-token (string)

The token to use to retrieve the next page of results.

--max-results (integer)

The maximum number of results to return in a single call.

--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.

Output

Jobs -> (list)

The mailbox export job details.

(structure)

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.

JobId -> (string)

The identifier of the mailbox export job.

EntityId -> (string)

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

Description -> (string)

The mailbox export job description.

S3BucketName -> (string)

The name of the S3 bucket.

S3Path -> (string)

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

EstimatedProgress -> (integer)

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

State -> (string)

The state of the mailbox export job.

StartTime -> (timestamp)

The mailbox export job start timestamp.

EndTime -> (timestamp)

The mailbox export job end timestamp.

NextToken -> (string)

The token to use to retrieve the next page of results.