ImageGenerationConfiguration for a given Kinesis video stream.
See also: AWS API Documentation
describe-image-generation-configuration [--stream-name <value>] [--stream-arn <value>] [--cli-input-json | --cli-input-yaml] [--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]
The name of the stream from which to retrieve the image generation configuration. You must specify either the
The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the
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
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value
input, prints a sample input JSON that can be used as an argument for
--cli-input-json. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, 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.
Turn on debug logging.
Override command’s default URL with the given URL.
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.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
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.
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.
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 the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
ImageGenerationConfiguration -> (structure)
The structure that contains the information required for the Kinesis video stream (KVS) images delivery. If this structure is null, the configuration will be deleted from the stream.
Status -> (string)
Indicates whether the
ContinuousImageGenerationConfigurationsAPI is enabled or disabled.
ImageSelectorType -> (string)
The origin of the Server or Producer timestamps to use to generate the images.
DestinationConfig -> (structure)
The structure that contains the information required to deliver images to a customer.
Uri -> (string)
The Uniform Resource Idenifier (URI) that identifies where the images will be delivered.
DestinationRegion -> (string)
The AWS Region of the S3 bucket where images will be delivered. This
DestinationRegionmust match the Region where the stream is located.
SamplingInterval -> (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 33 ms, because a camera that generates content at 30 FPS would create a frame every 33.3 ms. If the timestamp range is less than the sampling interval, the Image from the
StartTimestampwill be returned if available.
Format -> (string)
The accepted image format.
FormatConfig -> (map)
The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The
FormatConfigkey is the
JPEGQuality, which indicates the JPEG quality key to be used to generate the image. The
FormatConfigvalue 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
JPEGQualitykey will be set to 80.
key -> (string)
value -> (string)
WidthPixels -> (integer)
The width of the output image that is used in conjunction with the
HeightPixelsparameter. When both
HeightPixelsparameters are provided, the image will be stretched to fit the specified aspect ratio. If only the
WidthPixelsparameter is provided, its original aspect ratio will be used to calculate the
HeightPixelsratio. If neither parameter is provided, the original image size will be returned.
HeightPixels -> (integer)
The height of the output image that is used in conjunction with the
WidthPixelsparameter. When both
WidthPixelsparameters are provided, the image will be stretched to fit the specified aspect ratio. If only the
HeightPixelsparameter is provided, its original aspect ratio will be used to calculate the
WidthPixelsratio. If neither parameter is provided, the original image size will be returned.