snapshots

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

Overview

Name	snapshots
Type	Resource
Id	aws.kendra.snapshots

Fields

The following fields are returned by SELECT queries:

get_snapshots

Name	Datatype	Description
next_token	string	If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of search metrics data.
snap_shot_time_filter	object	The Unix timestamp for the beginning and end of the time window for the search metrics data.
snapshots_data	array	The search metrics data. The data returned depends on the metric type you requested.
snapshots_data_header	array	The column headers for the search metrics data.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_snapshots	select	region		Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.

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_snapshots

Retrieves search metrics data. The data provides a snapshot of how your users interact with your search application and how effective the application is.

SELECT
next_token,
snap_shot_time_filter,
snapshots_data,
snapshots_data_header
FROM aws.kendra.snapshots
WHERE region = '{{ region }}' -- required
;