- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateImageGenerationConfigurationCommand
Updates the StreamInfo
and ImageProcessingConfiguration
fields.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { KinesisVideoClient, UpdateImageGenerationConfigurationCommand } from "@aws-sdk/client-kinesis-video"; // ES Modules import
// const { KinesisVideoClient, UpdateImageGenerationConfigurationCommand } = require("@aws-sdk/client-kinesis-video"); // CommonJS import
const client = new KinesisVideoClient(config);
const input = { // UpdateImageGenerationConfigurationInput
StreamName: "STRING_VALUE",
StreamARN: "STRING_VALUE",
ImageGenerationConfiguration: { // ImageGenerationConfiguration
Status: "ENABLED" || "DISABLED", // required
ImageSelectorType: "SERVER_TIMESTAMP" || "PRODUCER_TIMESTAMP", // required
DestinationConfig: { // ImageGenerationDestinationConfig
Uri: "STRING_VALUE", // required
DestinationRegion: "STRING_VALUE", // required
},
SamplingInterval: Number("int"), // required
Format: "JPEG" || "PNG", // required
FormatConfig: { // FormatConfig
"<keys>": "STRING_VALUE",
},
WidthPixels: Number("int"),
HeightPixels: Number("int"),
},
};
const command = new UpdateImageGenerationConfigurationCommand(input);
const response = await client.send(command);
// {};
UpdateImageGenerationConfigurationCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ImageGenerationConfiguration | ImageGenerationConfiguration | undefined | 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. |
StreamARN | string | undefined | 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 | string | undefined | The name of the stream from which to update the image generation configuration. You must specify either the |
UpdateImageGenerationConfigurationCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have required permissions to perform this operation. |
ClientLimitExceededException | client | Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later. |
InvalidArgumentException | client | The value for this input parameter is invalid. |
NoDataRetentionException | client | The Stream data retention in hours is equal to zero. |
ResourceInUseException | client | When the input
|
ResourceNotFoundException | client | Amazon Kinesis Video Streams can't find the stream that you specified. |
KinesisVideoServiceException | Base exception class for all service exceptions from KinesisVideo service. |