images

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

Overview

Name	images
Type	Resource
Id	aws.kinesis_video_archived_media.images

Fields

The following fields are returned by SELECT queries:

get_images

Name	Datatype	Description
error	string	The error message shown when the image for the provided timestamp was not extracted due to a non-tryable error. An error will be returned if: There is no media that exists for the specified Timestamp. The media for the specified time does not allow an image to be extracted. In this case the media is audio only, or the incorrect media has been ingested. (NO_MEDIA, MEDIA_ERROR)
image_content	string	An attribute of the Image object that is Base64 encoded.
time_stamp	string (date-time)	An attribute of the Image object that is used to extract an image from the video stream. This field is used to manage gaps on images or to better understand the pagination window.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_images	select	region		Retrieves a list of images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.

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_images

Retrieves a list of images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.

SELECT
error,
image_content,
time_stamp
FROM aws.kinesis_video_archived_media.images
WHERE region = '{{ region }}' -- required
;