Skip to content

Commit

Permalink
docs(client-kinesis-video): Updated DescribeMediaStorageConfiguration…
Browse files Browse the repository at this point in the history
…, StartEdgeConfigurationUpdate, ImageGenerationConfiguration$SamplingInterval, and UpdateMediaStorageConfiguration to match AWS Docs.
  • Loading branch information
awstools committed Sep 20, 2023
1 parent f2d4554 commit 76370a8
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ export interface DescribeMediaStorageConfigurationCommandOutput

/**
* @public
* <p>Returns the most current information about the channel. Specify the <code>ChannelName</code>
* <important>
* <p>This API is related to <a href="https://docs.aws.amazon.com/kinesisvideostreams-webrtc-dg/latest/devguide/webrtc-ingestion.html">WebRTC Ingestion</a> and is only available in the <code>us-west-2</code> region.</p>
* </important>
* <p>Returns the most current information about the channel. Specify the <code>ChannelName</code>
* or <code>ChannelARN</code> in the input.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ export interface StartEdgeConfigurationUpdateCommandOutput
* If you invoke this API during the syncing process, a <code>ResourceInUseException</code> will be thrown.
* The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes,
* the status will transition into the <code>SYNC_FAILED</code> state.</p>
* <p>To move an edge configuration from one device to another, use <a>DeleteEdgeConfiguration</a> to delete
* the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,10 @@ export interface UpdateMediaStorageConfigurationCommandOutput

/**
* @public
* <p>Associates a <code>SignalingChannel</code> to a stream to store the media. There are two signaling modes that
* <important>
* <p>This API is related to <a href="https://docs.aws.amazon.com/kinesisvideostreams-webrtc-dg/latest/devguide/webrtc-ingestion.html">WebRTC Ingestion</a> and is only available in the <code>us-west-2</code> region.</p>
* </important>
* <p>Associates a <code>SignalingChannel</code> to a stream to store the media. There are two signaling modes that
* can specified :</p>
* <ul>
* <li>
Expand Down
3 changes: 1 addition & 2 deletions clients/client-kinesis-video/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1227,8 +1227,7 @@ export interface ImageGenerationConfiguration {

/**
* @public
* <p>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
* <p>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 <code>StartTimestamp</code> will be returned if available. </p>
*/
SamplingInterval: number | undefined;
Expand Down
10 changes: 5 additions & 5 deletions codegen/sdk-codegen/aws-models/kinesis-video.json
Original file line number Diff line number Diff line change
Expand Up @@ -1014,7 +1014,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the most current information about the channel. Specify the <code>ChannelName</code>\n or <code>ChannelARN</code> in the input.</p>",
"smithy.api#documentation": "<important>\n <p>This API is related to <a href=\"https://docs.aws.amazon.com/kinesisvideostreams-webrtc-dg/latest/devguide/webrtc-ingestion.html\">WebRTC Ingestion</a> and is only available in the <code>us-west-2</code> region.</p>\n </important>\n <p>Returns the most current information about the channel. Specify the <code>ChannelName</code>\n or <code>ChannelARN</code> in the input.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/describeMediaStorageConfiguration",
Expand Down Expand Up @@ -1612,7 +1612,7 @@
"SamplingInterval": {
"target": "com.amazonaws.kinesisvideo#SamplingInterval",
"traits": {
"smithy.api#documentation": "<p>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, \n 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 \n Image from the <code>StartTimestamp</code> will be returned if available. </p>",
"smithy.api#documentation": "<p>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 \n Image from the <code>StartTimestamp</code> will be returned if available. </p>",
"smithy.api#required": {}
}
},
Expand Down Expand Up @@ -3684,7 +3684,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>An asynchronous API that updates a stream’s existing edge configuration. \n The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass \n component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary\n and depends on the connectivity of the Hub Device. \n The <code>SyncStatus</code> will be updated as the edge configuration is acknowledged, \n and synced with the Edge Agent. </p>\n <p>If this API is invoked for the first time, a new edge configuration will be created for the stream,\n and the sync status will be set to <code>SYNCING</code>. You will have to wait for the sync status\n to reach a terminal state such as: <code>IN_SYNC</code>, or <code>SYNC_FAILED</code>, before using this API again. \n If you invoke this API during the syncing process, a <code>ResourceInUseException</code> will be thrown. \n The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes,\n the status will transition into the <code>SYNC_FAILED</code> state.</p>",
"smithy.api#documentation": "<p>An asynchronous API that updates a stream’s existing edge configuration. \n The Kinesis Video Stream will sync the stream’s edge configuration with the Edge Agent IoT Greengrass \n component that runs on an IoT Hub Device, setup at your premise. The time to sync can vary\n and depends on the connectivity of the Hub Device. \n The <code>SyncStatus</code> will be updated as the edge configuration is acknowledged, \n and synced with the Edge Agent. </p>\n <p>If this API is invoked for the first time, a new edge configuration will be created for the stream,\n and the sync status will be set to <code>SYNCING</code>. You will have to wait for the sync status\n to reach a terminal state such as: <code>IN_SYNC</code>, or <code>SYNC_FAILED</code>, before using this API again. \n If you invoke this API during the syncing process, a <code>ResourceInUseException</code> will be thrown. \n The connectivity of the stream’s edge configuration and the Edge Agent will be retried for 15 minutes. After 15 minutes,\n the status will transition into the <code>SYNC_FAILED</code> state.</p>\n <p>To move an edge configuration from one device to another, use <a>DeleteEdgeConfiguration</a> to delete\n the current edge configuration. You can then invoke StartEdgeConfigurationUpdate with an updated Hub Device ARN.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/startEdgeConfigurationUpdate",
Expand Down Expand Up @@ -4533,7 +4533,7 @@
}
],
"traits": {
"smithy.api#documentation": "<p>Associates a <code>SignalingChannel</code> to a stream to store the media. There are two signaling modes that \n can specified :</p>\n <ul>\n <li>\n <p>If the <code>StorageStatus</code> is disabled, no data will be stored,\n and the <code>StreamARN</code> parameter will not be needed. </p>\n </li>\n <li>\n <p>If the <code>StorageStatus</code> is enabled, the data will be stored in the \n <code>StreamARN</code> provided. </p>\n </li>\n </ul>\n <important>\n <p>If <code>StorageStatus</code> is enabled, direct peer-to-peer (master-viewer) connections no\n longer occur. Peers connect directly to the storage session. You must call the\n <code>JoinStorageSession</code> API to trigger an SDP offer send and establish a\n connection between a peer and the storage session. </p>\n </important>",
"smithy.api#documentation": "<important>\n <p>This API is related to <a href=\"https://docs.aws.amazon.com/kinesisvideostreams-webrtc-dg/latest/devguide/webrtc-ingestion.html\">WebRTC Ingestion</a> and is only available in the <code>us-west-2</code> region.</p>\n </important>\n <p>Associates a <code>SignalingChannel</code> to a stream to store the media. There are two signaling modes that \n can specified :</p>\n <ul>\n <li>\n <p>If the <code>StorageStatus</code> is disabled, no data will be stored,\n and the <code>StreamARN</code> parameter will not be needed. </p>\n </li>\n <li>\n <p>If the <code>StorageStatus</code> is enabled, the data will be stored in the \n <code>StreamARN</code> provided. </p>\n </li>\n </ul>\n <important>\n <p>If <code>StorageStatus</code> is enabled, direct peer-to-peer (master-viewer) connections no\n longer occur. Peers connect directly to the storage session. You must call the\n <code>JoinStorageSession</code> API to trigger an SDP offer send and establish a\n connection between a peer and the storage session. </p>\n </important>",
"smithy.api#http": {
"method": "POST",
"uri": "/updateMediaStorageConfiguration",
Expand Down Expand Up @@ -4866,4 +4866,4 @@
}
}
}
}
}

0 comments on commit 76370a8

Please sign in to comment.