search_job_backups

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

Overview

Name	search_job_backups
Type	Resource
Id	aws.backupsearch.search_job_backups

Fields

The following fields are returned by SELECT queries:

list_search_job_backups

Name	Datatype	Description
backup_creation_time	string (date-time)	This is the creation time of the backup (recovery point).
backup_resource_arn	string	The Amazon Resource Name (ARN) that uniquely identifies the backup resources.
index_creation_time	string (date-time)	This is the creation time of the backup index.
resource_type	string	This is the resource type of the search. (S3, EBS)
source_resource_arn	string	The Amazon Resource Name (ARN) that uniquely identifies the source resources.
status	string	This is the status of the search job backup result. (RUNNING, COMPLETED, STOPPING, STOPPED, FAILED)
status_message	string	This is the status message included with the results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_search_job_backups	select	search_job_identifier, region	nextToken, maxResults	This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job. If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a FAILED status from a permissions issue will be displayed, along with a status message. Only recovery points with a backup index that has a status of ACTIVE will be included in search results. If the index has any other status, its status will be displayed along with a status message.

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)
search_job_identifier	string	The unique string that specifies the search job.
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.

SELECT examples

list_search_job_backups

This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job. If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a FAILED status from a permissions issue will be displayed, along with a status message. Only recovery points with a backup index that has a status of ACTIVE will be included in search results. If the index has any other status, its status will be displayed along with a status message.

SELECT
backup_creation_time,
backup_resource_arn,
index_creation_time,
resource_type,
source_resource_arn,
status,
status_message
FROM aws.backupsearch.search_job_backups
WHERE search_job_identifier = '{{ search_job_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;