[ aws . kinesis-video-archived-media ]
Retrieves a list of Images corresponding to each timestamp for a given time range, sampling interval, and image format configuration.
See also: AWS API Documentation
get-images
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: Images
get-images
[--stream-name <value>]
[--stream-arn <value>]
--image-selector-type <value>
--start-timestamp <value>
--end-timestamp <value>
--sampling-interval <value>
--format <value>
[--format-config <value>]
[--width-pixels <value>]
[--height-pixels <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--stream-name
(string)
The name of the stream from which to retrieve the images. You must specify either the
StreamName
or theStreamARN
.
--stream-arn
(string)
The Amazon Resource Name (ARN) of the stream from which to retrieve the images. You must specify either the
StreamName
or theStreamARN
.
--image-selector-type
(string)
The origin of the Server or Producer timestamps to use to generate the images.
Possible values:
PRODUCER_TIMESTAMP
SERVER_TIMESTAMP
--start-timestamp
(timestamp)
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.
--end-timestamp
(timestamp)
The end timestamp for the range of images to be generated.
--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 3000 ms. If the timestamp range is less than the sampling interval, the Image from the
startTimestamp
will be returned if available.Note
The minimum value of 3000 ms is a soft limit. If needed, a lower sampling frequency can be requested.
--format
(string)The format that will be used to encode the image.
Possible values:
JPEG
PNG
--format-config
(map)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 theJPEGQuality
, which indicates the JPEG quality key to be used to generate the image. TheFormatConfig
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 theJPEGQuality
key will be set to 80.key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string Where valid key names are: JPEGQualityJSON Syntax:
{"JPEGQuality": "string" ...}
--width-pixels
(integer)The width of the output image that is used in conjunction with the
HeightPixels
parameter. When bothWidthPixels
andHeightPixels
parameters are provided, the image will be stretched to fit the specified aspect ratio. If only theWidthPixels
parameter is provided or if only theHeightPixels
is provided, aValidationException
will be thrown. If neither parameter is provided, the original image size from the stream will be returned.
--height-pixels
(integer)The height of the output image that is used in conjunction with the
WidthPixels
parameter. When bothHeightPixels
andWidthPixels
parameters are provided, the image will be stretched to fit the specified aspect ratio. If only theHeightPixels
parameter is provided, its original aspect ratio will be used to calculate theWidthPixels
ratio. If neither parameter is provided, the original image size will be returned.
--cli-input-json
|--cli-input-yaml
(string) Reads arguments from the JSON string provided. The JSON string follows the format provided by--generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with--cli-input-yaml
.
--starting-token
(string)A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(long)The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(long)The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the valueinput
, prints a sample input JSON that can be used as an argument for--cli-input-json
. Similarly, if providedyaml-input
it will print a sample input YAML that can be used with--cli-input-yaml
. If provided with the valueoutput
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.Global Options¶
--debug
(boolean)Turn on debug logging.
--endpoint-url
(string)Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)Disable automatic pagination.
--output
(string)The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)A JMESPath query to use in filtering the response data.
--profile
(string)Use a specific profile from your credential file.
--region
(string)The region to use. Overrides config/env settings.
--version
(string)Display the version of this tool.
--color
(string)Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb://
will always be treated as binary and use the file contents directly regardless of thecli-binary-format
setting. When usingfile://
the file contents will need to properly formatted for the configuredcli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)Disable cli pager for output.
--cli-auto-prompt
(boolean)Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)Disable automatically prompt for CLI input parameters.
Output¶
Images -> (list)
The list of images generated from the video stream. If there is no media available for the given timestamp, the
NO_MEDIA
error will be listed in the output. If an error occurs while the image is being generated, theMEDIA_ERROR
will be listed in the output as the cause of the missing image.(structure)
A structure that contains the
Timestamp
,Error
, andImageContent
.TimeStamp -> (timestamp)
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.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.
ImageContent -> (string)
An attribute of the
Image
object that is Base64 encoded.NextToken -> (string)
The encrypted token that was used in the request to get more images.