search_result_export_jobs

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

Overview

Name	search_result_export_jobs
Type	Resource
Id	aws.backupsearch.search_result_export_jobs

Fields

The following fields are returned by SELECT queries:

get_search_result_export_job

Name	Datatype	Description
completion_time	string (date-time)	The date and time that an export job completed, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
creation_time	string (date-time)	The date and time that an export job was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
export_job_arn	string	The unique Amazon Resource Name (ARN) that uniquely identifies the export job.
export_job_identifier	string	This is the unique string that identifies the specified export job.
export_specification	object	The export specification consists of the destination S3 bucket to which the search results were exported, along with the destination prefix.
search_job_arn	string	The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
status	string	This is the current status of the export job. (RUNNING, FAILED, COMPLETED)
status_message	string	A status message is a string that is returned for search job with a status of FAILED, along with steps to remedy and retry the operation.

list_search_result_export_jobs

Name	Datatype	Description
completion_time	string (date-time)	This is a timestamp of the time the export job compeleted.
creation_time	string (date-time)	This is a timestamp of the time the export job was created.
export_job_arn	string	This is the unique ARN (Amazon Resource Name) that belongs to the new export job.
export_job_identifier	string	This is the unique string that identifies a specific export job.
search_job_arn	string	The unique string that identifies the Amazon Resource Name (ARN) of the specified search job.
status	string	The status of the export job is one of the following: CREATED; RUNNING; FAILED; or COMPLETED. (RUNNING, FAILED, COMPLETED)
status_message	string	A status message is a string that is returned for an export job. A status message is included for any status other than COMPLETED without issues.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_search_result_export_job	select	export_job_identifier, region		This operation retrieves the metadata of an export job. An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file. An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.
list_search_result_export_jobs	select	region	Status, SearchJobIdentifier, NextToken, MaxResults	This operation exports search results of a search job to a specified destination S3 bucket.

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
export_job_identifier	string	This is the unique string that identifies a specific export job. Required for this operation.
region	string	AWS region (default: us-east-1)
MaxResults	integer	The maximum number of resource list items to be returned.
NextToken	string	The next item following a partial list of returned backups included in a search job. For example, if a request is made to return MaxResults number of backups, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
SearchJobIdentifier	string	The unique string that specifies the search job.
Status	string	The search jobs to be included in the export job can be filtered by including this parameter.

SELECT examples

get_search_result_export_job

This operation retrieves the metadata of an export job. An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file. An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.

SELECT
completion_time,
creation_time,
export_job_arn,
export_job_identifier,
export_specification,
search_job_arn,
status,
status_message
FROM aws.backupsearch.search_result_export_jobs
WHERE export_job_identifier = '{{ export_job_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_search_result_export_jobs

This operation exports search results of a search job to a specified destination S3 bucket.

SELECT
completion_time,
creation_time,
export_job_arn,
export_job_identifier,
search_job_arn,
status,
status_message
FROM aws.backupsearch.search_result_export_jobs
WHERE region = '{{ region }}' -- required
AND Status = '{{ Status }}'
AND SearchJobIdentifier = '{{ SearchJobIdentifier }}'
AND NextToken = '{{ NextToken }}'
AND MaxResults = '{{ MaxResults }}'
;