search_job_results

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

Overview

Name	search_job_results
Type	Resource
Id	aws.backupsearch.search_job_results

Fields

The following fields are returned by SELECT queries:

list_search_job_results

Name	Datatype	Description
ebs_result_item	object	These are items returned in the search results of an Amazon EBS search.
s3_result_item	object	These are items returned in the search results of an Amazon S3 search.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_search_job_results	select	search_job_identifier, region	nextToken, maxResults	This operation returns a list of a specified search job.

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 search job results. For example, if a request is made to return MaxResults number of search job results, 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_results

This operation returns a list of a specified search job.

SELECT
ebs_result_item,
s3_result_item
FROM aws.backupsearch.search_job_results
WHERE search_job_identifier = '{{ search_job_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;