archive_searches

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

Overview

Name	archive_searches
Type	Resource
Id	aws.mailmanager.archive_searches

Fields

The following fields are returned by SELECT queries:

get_archive_search

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

list_archive_searches

Name	Datatype	Description
search_id	string	The unique identifier of the search job.
status	object	The current status of the search job.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_archive_search	select	region		Retrieves the details and current status of a specific email archive search job.
list_archive_searches	select	region		Returns a list of email archive search 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_search

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

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

list_archive_searches

Returns a list of email archive search jobs.

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