docs(client-kinesis-video): Updated DescribeMediaStorageConfiguration, StartEdgeConfigurationUpdate, ImageGenerationConfiguration$SamplingInterval, and UpdateMediaStorageConfiguration to match AWS Docs.

awstools · awstools · commit 76370a8b5f10 · 2023-09-20T19:23:45.000Z
diff --git a/clients/client-kinesis-video/src/commands/DescribeMediaStorageConfigurationCommand.ts b/clients/client-kinesis-video/src/commands/DescribeMediaStorageConfigurationCommand.ts
@@ -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.
diff --git a/clients/client-kinesis-video/src/commands/StartEdgeConfigurationUpdateCommand.ts b/clients/client-kinesis-video/src/commands/StartEdgeConfigurationUpdateCommand.ts
@@ -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
diff --git a/clients/client-kinesis-video/src/commands/UpdateMediaStorageConfigurationCommand.ts b/clients/client-kinesis-video/src/commands/UpdateMediaStorageConfigurationCommand.ts
@@ -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>
diff --git a/clients/client-kinesis-video/src/models/models_0.ts b/clients/client-kinesis-video/src/models/models_0.ts
@@ -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;
diff --git a/codegen/sdk-codegen/aws-models/kinesis-video.json b/codegen/sdk-codegen/aws-models/kinesis-video.json
@@ -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",
@@ -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": {}
           }
         },
@@ -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",
@@ -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",
@@ -4866,4 +4866,4 @@
       }
     }
   }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -1014,7 +1014,7 @@`
`1014`	`1014`	`}`
`1015`	`1015`	`],`
`1016`	`1016`	`"traits": {`
`1017`		`- "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>",`
	`1017`	`+ "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>",`
`1018`	`1018`	`"smithy.api#http": {`
`1019`	`1019`	`"method": "POST",`
`1020`	`1020`	`"uri": "/describeMediaStorageConfiguration",`
`@@ -1612,7 +1612,7 @@`
`1612`	`1612`	`"SamplingInterval": {`
`1613`	`1613`	`"target": "com.amazonaws.kinesisvideo#SamplingInterval",`
`1614`	`1614`	`"traits": {`
`1615`		`- "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>",`
	`1615`	`+ "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>",`
`1616`	`1616`	`"smithy.api#required": {}`
`1617`	`1617`	`}`
`1618`	`1618`	`},`
`@@ -3684,7 +3684,7 @@`
`3684`	`3684`	`}`
`3685`	`3685`	`],`
`3686`	`3686`	`"traits": {`
`3687`		- "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>",
	`3687`	+ "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>",
`3688`	`3688`	`"smithy.api#http": {`
`3689`	`3689`	`"method": "POST",`
`3690`	`3690`	`"uri": "/startEdgeConfigurationUpdate",`
`@@ -4533,7 +4533,7 @@`
`4533`	`4533`	`}`
`4534`	`4534`	`],`
`4535`	`4535`	`"traits": {`
`4536`		- "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>",
	`4536`	+ "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>",
`4537`	`4537`	`"smithy.api#http": {`
`4538`	`4538`	`"method": "POST",`
`4539`	`4539`	`"uri": "/updateMediaStorageConfiguration",`
`@@ -4866,4 +4866,4 @@`
`4866`	`4866`	`}`
`4867`	`4867`	`}`
`4868`	`4868`	`}`
`4869`		`-}`
	`4869`	`+}`