mailbox_export_jobs

Creates, updates, deletes, gets or lists a mailbox_export_jobs resource.

Overview

Name	mailbox_export_jobs
Type	Resource
Id	aws.workmail.mailbox_export_jobs

Fields

The following fields are returned by SELECT queries:

describe_mailbox_export_job

Name	Datatype	Description
description	string	The mailbox export job description. (pattern: <code>[\S\s]*</code>)
end_time	string (date-time)	The mailbox export job end timestamp.
entity_id	string	The identifier of the user or resource associated with the mailbox.
error_info	string	Error information for failed mailbox export jobs. (pattern: <code>[\S\s]*</code>)
estimated_progress	integer	The estimated progress of the mailbox export job, in percentage points.
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. (pattern: <code>arn:aws:kms:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}</code>)
role_arn	string	The ARN of the AWS Identity and Access Management (IAM) role that grants write permission to the Amazon Simple Storage Service (Amazon S3) bucket. (pattern: <code>arn:aws:iam:[a-z0-9-]*:[a-z0-9-]+:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}</code>)
s3_bucket_name	string	The name of the S3 bucket. (pattern: <code>[A-Za-z0-9.-]+</code>)
s3_path	string	The path to the S3 bucket and file that the mailbox export job is exporting to. (pattern: <code>[A-Za-z0-9!_.*'()/-]+</code>)
s3_prefix	string	The S3 bucket prefix. (pattern: <code>[A-Za-z0-9!_.*'()/-]+</code>)
start_time	string (date-time)	The mailbox export job start timestamp.
state	string	The state of the mailbox export job. (RUNNING, COMPLETED, FAILED, CANCELLED)

list_mailbox_export_jobs

Name	Datatype	Description
jobs	array	The mailbox export job details.
next_token	string	The token to use to retrieve the next page of results. (pattern: <code>[\S\s]*|[a-zA-Z0-9/+=]{1,1024}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_mailbox_export_job	select	region		Describes the current status of a mailbox export job.
list_mailbox_export_jobs	select	region		Lists the mailbox export jobs started for the specified organization within the last seven days.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_mailbox_export_job

Describes the current status of a mailbox export job.

SELECT
description,
end_time,
entity_id,
error_info,
estimated_progress,
kms_key_arn,
role_arn,
s3_bucket_name,
s3_path,
s3_prefix,
start_time,
state
FROM aws.workmail.mailbox_export_jobs
WHERE region = '{{ region }}' -- required
;

list_mailbox_export_jobs

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

SELECT
jobs,
next_token
FROM aws.workmail.mailbox_export_jobs
WHERE region = '{{ region }}' -- required
;