AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . kinesisvideo ]

update-image-generation-configuration

Description

Updates the StreamInfo and ImageProcessingConfiguration fields.

See also: AWS API Documentation

Synopsis

  update-image-generation-configuration
[--stream-name <value>]
[--stream-arn <value>]
[--image-generation-configuration <value>]
[--cli-input-json <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>]

Options

--stream-name (string)

The name of the stream from which to update the image generation configuration. You must specify either the StreamName or the StreamARN .

--stream-arn (string)

The Amazon Resource Name (ARN) of the Kinesis video stream from where you want to update the image generation configuration. You must specify either the StreamName or the StreamARN .

--image-generation-configuration (structure)

The structure that contains the information required for the KVS images delivery. If the 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 -> (structure)

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

key -> (string)

value -> (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.

Shorthand Syntax:

Status=string,ImageSelectorType=string,DestinationConfig={Uri=string,DestinationRegion=string},SamplingInterval=integer,Format=string,FormatConfig={KeyName1=string,KeyName2=string},WidthPixels=integer,HeightPixels=integer

JSON Syntax:

{
  "Status": "ENABLED"|"DISABLED",
  "ImageSelectorType": "SERVER_TIMESTAMP"|"PRODUCER_TIMESTAMP",
  "DestinationConfig": {
    "Uri": "string",
    "DestinationRegion": "string"
  },
  "SamplingInterval": integer,
  "Format": "JPEG"|"PNG",
  "FormatConfig": {"JPEGQuality": "string"
    ...},
  "WidthPixels": integer,
  "HeightPixels": integer
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--generate-cli-skeleton (string) 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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--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.

Output

None