image_generation_configurations

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

Overview

Name	image_generation_configurations
Type	Resource
Id	aws.kinesisvideo.image_generation_configurations

Fields

The following fields are returned by SELECT queries:

describe_image_generation_configuration

Name	Datatype	Description
destination_config	object	The structure that contains the information required to deliver images to a customer.
format	string	The accepted image format. (JPEG, PNG)
format_config	object	The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The FormatConfig key is the JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The FormatConfig value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the JPEGQuality key will be set to 80.
height_pixels	integer	The height of the output image that is used in conjunction with the WidthPixels parameter. When both HeightPixels and WidthPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the HeightPixels parameter is provided, its original aspect ratio will be used to calculate the WidthPixels ratio. If neither parameter is provided, the original image size will be returned.
image_selector_type	string	The origin of the Server or Producer timestamps to use to generate the images. (SERVER_TIMESTAMP, PRODUCER_TIMESTAMP)
sampling_interval	integer	The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 200 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.
status	string	Indicates whether the ContinuousImageGenerationConfigurations API is enabled or disabled. (ENABLED, DISABLED)
width_pixels	integer	The width of the output image that is used in conjunction with the HeightPixels parameter. When both WidthPixels and HeightPixels parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the WidthPixels parameter is provided, its original aspect ratio will be used to calculate the HeightPixels ratio. If neither parameter is provided, the original image size will be returned.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_image_generation_configuration	select	region		Gets the ImageGenerationConfiguration for a given Kinesis video stream.
update_image_generation_configuration	update	region		Updates the StreamInfo and ImageProcessingConfiguration fields.

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

describe_image_generation_configuration

Gets the ImageGenerationConfiguration for a given Kinesis video stream.

SELECT
destination_config,
format,
format_config,
height_pixels,
image_selector_type,
sampling_interval,
status,
width_pixels
FROM aws.kinesisvideo.image_generation_configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_image_generation_configuration

Updates the StreamInfo and ImageProcessingConfiguration fields.

UPDATE aws.kinesisvideo.image_generation_configurations
SET 
StreamName = '{{ StreamName }}',
StreamARN = '{{ StreamARN }}',
ImageGenerationConfiguration = '{{ ImageGenerationConfiguration }}'
WHERE 
region = '{{ region }}' --required;