archive_exports

Creates, updates, deletes, gets or lists an archive_exports resource.

Overview

Name	archive_exports
Type	Resource
Id	aws.mailmanager.archive_exports

Fields

The following fields are returned by SELECT queries:

get_archive_export

Name	Datatype	Description
archive_id	string	The identifier of the archive the email export was performed from. (pattern: <code>a-[\w]{1,64}</code>)
export_destination_configuration	object	Where the exported emails are being delivered.
filters	object	The criteria used to filter emails included in the export.
from_timestamp	string (date-time)	The start of the timestamp range the exported emails cover.
max_results	integer	The maximum number of email items included in the export.
status	object	The current status of the export job.
to_timestamp	string (date-time)	The end of the date range the exported emails cover.

list_archive_exports

Name	Datatype	Description
export_id	string	The unique identifier of the export job.
status	object	The current status of the export job.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_archive_export	select	region		Retrieves the details and current status of a specific email archive export job.
list_archive_exports	select	region		Returns a list of email archive export jobs.

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

get_archive_export

Retrieves the details and current status of a specific email archive export job.

SELECT
archive_id,
export_destination_configuration,
filters,
from_timestamp,
max_results,
status,
to_timestamp
FROM aws.mailmanager.archive_exports
WHERE region = '{{ region }}' -- required
;

list_archive_exports

Returns a list of email archive export jobs.

SELECT
export_id,
status
FROM aws.mailmanager.archive_exports
WHERE region = '{{ region }}' -- required
;