Skip to content
AWS for Query.Farm

aws.kinesis_video_archived_media.get_images

Example SQL Queries

SELECT * FROM
aws.kinesis_video_archived_media.get_images
WHERE
"image_selector_type" = 'VALUE'
AND "start_timestamp" = 'VALUE'
AND "end_timestamp" = 'VALUE'
AND "format" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
end_timestamp Required Input Column

The end timestamp for the range of images to be generated. If the time range between StartTimestamp and EndTimestamp is more than 300 seconds above StartTimestamp, you will receive an IllegalArgumentException.

TIMESTAMP_S
format Required Input Column

The format that will be used to encode the image.

VARCHAR
image_selector_type Required Input Column

The origin of the Server or Producer timestamps to use to generate the images.

VARCHAR
start_timestamp Required Input Column

The starting point from which the images should be generated. This StartTimestamp must be within an inclusive range of timestamps for an image to be returned.

TIMESTAMP_S
format_config Input Column

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.

MAP(VARCHAR, VARCHAR)
height_pixels Input Column

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.

BIGINT
sampling_interval Input Column

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 (5 images per second). If the timestamp range is less than the sampling interval, the image from the startTimestamp will be returned if available. 

BIGINT
stream_arn Input Column

The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

VARCHAR
stream_name Input Column

The name of the stream from which to retrieve the images. You must specify either the StreamName or the StreamARN.

VARCHAR
width_pixels Input Column

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 or if only the HeightPixels is provided, a ValidationException will be thrown. If neither parameter is provided, the original image size from the stream will be returned.

BIGINT
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

error

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.

VARCHAR
image_content

An attribute of the Image object that is Base64 encoded.

VARCHAR
time_stamp

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.

TIMESTAMP_S