KinesisVideo / Client / describe_image_generation_configuration

describe_image_generation_configuration#

KinesisVideo.Client.describe_image_generation_configuration(**kwargs)#

Gets the ImageGenerationConfiguration for a given Kinesis video stream.

See also: AWS API Documentation

Request Syntax

response = client.describe_image_generation_configuration(
    StreamName='string',
    StreamARN='string'
)
Parameters:

  • StreamName (string) – The name of the stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.

  • StreamARN (string) – The Amazon Resource Name (ARN) of the Kinesis video stream from which to retrieve the image generation configuration. You must specify either the StreamName or the StreamARN.

Return type:

dict

Returns:

Response Syntax

{
    'ImageGenerationConfiguration': {
        'Status': 'ENABLED'|'DISABLED',
        'ImageSelectorType': 'SERVER_TIMESTAMP'|'PRODUCER_TIMESTAMP',
        'DestinationConfig': {
            'Uri': 'string',
            'DestinationRegion': 'string'
        },
        'SamplingInterval': 123,
        'Format': 'JPEG'|'PNG',
        'FormatConfig': {
            'string': 'string'
        },
        'WidthPixels': 123,
        'HeightPixels': 123
    }
}

Response Structure

  • (dict) –

    • ImageGenerationConfiguration (dict) –

      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 ContinuousImageGenerationConfigurations API is enabled or disabled.

      • ImageSelectorType (string) –

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

      • DestinationConfig (dict) –

        The structure that contains the information required to deliver images to a customer.

        • Uri (string) –

          The Uniform Resource Identifier (URI) that identifies where the images will be delivered.

        • DestinationRegion (string) –

          The Amazon Web Services Region of the S3 bucket where images will be delivered. This DestinationRegion must 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 200 ms. If the timestamp range is less than the sampling interval, the Image from the StartTimestamp will be returned if available.

      • Format (string) –

        The accepted image format.

      • FormatConfig (dict) –

        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.

        • (string) –

          • (string) –

      • WidthPixels (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.

      • HeightPixels (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.

Exceptions