docs(client-kinesis-video): Docs only build to bring up-to-date with …

…public docs.
aws · Nov 17, 2023 · 3ec9ad0 · 3ec9ad0
1 parent 90a90eb
commit 3ec9ad0
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 27 deletions.
diff --git a/clients/client-kinesis-video/src/commands/DescribeMediaStorageConfigurationCommand.ts b/clients/client-kinesis-video/src/commands/DescribeMediaStorageConfigurationCommand.ts
@@ -42,10 +42,7 @@ export interface DescribeMediaStorageConfigurationCommandOutput
 
 /**
  * @public
- * <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>
+ * <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/UpdateDataRetentionCommand.ts b/clients/client-kinesis-video/src/commands/UpdateDataRetentionCommand.ts
@@ -37,13 +37,10 @@ export interface UpdateDataRetentionCommandOutput extends UpdateDataRetentionOut
 
 /**
  * @public
- * <p> Increases or decreases the stream's data retention period by the value that you
+ * <p>Increases or decreases the stream's data retention period by the value that you
  *             specify. To indicate whether you want to increase or decrease the data retention period,
  *             specify the <code>Operation</code> parameter in the request body. In the request, you
  *             must specify either the <code>StreamName</code> or the <code>StreamARN</code>. </p>
- *          <note>
- *             <p>The retention period that you specify replaces the current value.</p>
- *          </note>
  *          <p>This operation requires permission for the
  *                 <code>KinesisVideo:UpdateDataRetention</code> action.</p>
  *          <p>Changing the data retention period affects the data in the stream as

diff --git a/clients/client-kinesis-video/src/commands/UpdateMediaStorageConfigurationCommand.ts b/clients/client-kinesis-video/src/commands/UpdateMediaStorageConfigurationCommand.ts
@@ -42,19 +42,17 @@ export interface UpdateMediaStorageConfigurationCommandOutput
 
 /**
  * @public
- * <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>
+ * <p>Associates a <code>SignalingChannel</code> to a stream to store the media. There are
+ *             two signaling modes that you can specify :</p>
  *          <ul>
  *             <li>
- *                <p>If the <code>StorageStatus</code> is disabled, no data will be stored,
- *                 and the <code>StreamARN</code> parameter will not be needed. </p>
+ *                <p>If <code>StorageStatus</code> is enabled, the data will be stored in the
+ *                         <code>StreamARN</code> provided. In order for WebRTC Ingestion to work, the stream must have data retention
+ *                     enabled.</p>
  *             </li>
  *             <li>
- *                <p>If the <code>StorageStatus</code> is enabled, the data will be stored in the
- *                 <code>StreamARN</code> provided. </p>
+ *                <p>If <code>StorageStatus</code> is disabled, no data will be stored, and the
+ *                         <code>StreamARN</code> parameter will not be needed. </p>
  *             </li>
  *          </ul>
  *          <important>

diff --git a/clients/client-kinesis-video/src/models/models_0.ts b/clients/client-kinesis-video/src/models/models_0.ts
@@ -1375,12 +1375,24 @@ export type MediaStorageConfigurationStatus =
 
 /**
  * @public
- * <p>A structure that encapsulates, or contains, the media storage configuration properties.</p>
+ * <p>A structure that encapsulates, or contains, the media storage configuration
+ *             properties.</p>
+ *          <ul>
+ *             <li>
+ *                <p>If <code>StorageStatus</code> is enabled, the data will be stored in the
+ *                         <code>StreamARN</code> provided. In order for WebRTC Ingestion to work, the stream must have data retention
+ *                     enabled.</p>
+ *             </li>
+ *             <li>
+ *                <p>If <code>StorageStatus</code> is disabled, no data will be stored, and the
+ *                         <code>StreamARN</code> parameter will not be needed. </p>
+ *             </li>
+ *          </ul>
  */
 export interface MediaStorageConfiguration {
   /**
    * @public
-   * <p>The Amazon Resource Name (ARN) of the stream </p>
+   * <p>The Amazon Resource Name (ARN) of the stream. </p>
    */
   StreamARN?: string;
 
@@ -2254,8 +2266,8 @@ export interface UpdateDataRetentionInput {
 
   /**
    * @public
-   * <p>The retention period, in hours. The value you specify replaces the current value.
-   *             The maximum value for this parameter is 87600 (ten years).</p>
+   * <p>The number of hours to adjust the current retention by. The value you specify is added to or subtracted from the current value, depending on the <code>operation</code>.</p>
+   *          <p>The minimum value for data retention is 0 and the maximum value is 87600 (ten years).</p>
    */
   DataRetentionChangeInHours: 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": "<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#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#http": {
           "method": "POST",
           "uri": "/describeMediaStorageConfiguration",
@@ -3310,7 +3310,7 @@
         "StreamARN": {
           "target": "com.amazonaws.kinesisvideo#ResourceARN",
           "traits": {
-            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the stream </p>"
+            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the stream. </p>"
           }
         },
         "Status": {
@@ -3322,7 +3322,7 @@
         }
       },
       "traits": {
-        "smithy.api#documentation": "<p>A structure that encapsulates, or contains, the media storage configuration properties.</p>"
+        "smithy.api#documentation": "<p>A structure that encapsulates, or contains, the media storage configuration\n            properties.</p>\n         <ul>\n            <li>\n               <p>If <code>StorageStatus</code> is enabled, the data will be stored in the\n                        <code>StreamARN</code> provided. In order for WebRTC Ingestion to work, the stream must have data retention\n                    enabled.</p>\n            </li>\n            <li>\n               <p>If <code>StorageStatus</code> is disabled, no data will be stored, and the\n                        <code>StreamARN</code> parameter will not be needed. </p>\n            </li>\n         </ul>"
       }
     },
     "com.amazonaws.kinesisvideo#MediaStorageConfigurationStatus": {
@@ -4361,7 +4361,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p> Increases or decreases the stream's data retention period by the value that you\n            specify. To indicate whether you want to increase or decrease the data retention period,\n            specify the <code>Operation</code> parameter in the request body. In the request, you\n            must specify either the <code>StreamName</code> or the <code>StreamARN</code>. </p>\n         <note>\n            <p>The retention period that you specify replaces the current value.</p>\n         </note>\n         <p>This operation requires permission for the\n                <code>KinesisVideo:UpdateDataRetention</code> action.</p>\n         <p>Changing the data retention period affects the data in the stream as\n            follows:</p>\n         <ul>\n            <li>\n               <p>If the data retention period is increased, existing data is retained for\n                    the new retention period. For example, if the data retention period is increased\n                    from one hour to seven hours, all existing data is retained for seven\n                    hours.</p>\n            </li>\n            <li>\n               <p>If the data retention period is decreased, existing data is retained for\n                    the new retention period. For example, if the data retention period is decreased\n                    from seven hours to one hour, all existing data is retained for one hour, and\n                    any data older than one hour is deleted immediately.</p>\n            </li>\n         </ul>",
+        "smithy.api#documentation": "<p>Increases or decreases the stream's data retention period by the value that you\n            specify. To indicate whether you want to increase or decrease the data retention period,\n            specify the <code>Operation</code> parameter in the request body. In the request, you\n            must specify either the <code>StreamName</code> or the <code>StreamARN</code>. </p>\n         <p>This operation requires permission for the\n                <code>KinesisVideo:UpdateDataRetention</code> action.</p>\n         <p>Changing the data retention period affects the data in the stream as\n            follows:</p>\n         <ul>\n            <li>\n               <p>If the data retention period is increased, existing data is retained for\n                    the new retention period. For example, if the data retention period is increased\n                    from one hour to seven hours, all existing data is retained for seven\n                    hours.</p>\n            </li>\n            <li>\n               <p>If the data retention period is decreased, existing data is retained for\n                    the new retention period. For example, if the data retention period is decreased\n                    from seven hours to one hour, all existing data is retained for one hour, and\n                    any data older than one hour is deleted immediately.</p>\n            </li>\n         </ul>",
         "smithy.api#http": {
           "method": "POST",
           "uri": "/updateDataRetention",
@@ -4401,7 +4401,7 @@
         "DataRetentionChangeInHours": {
           "target": "com.amazonaws.kinesisvideo#DataRetentionChangeInHours",
           "traits": {
-            "smithy.api#documentation": "<p>The retention period, in hours. The value you specify replaces the current value.\n            The maximum value for this parameter is 87600 (ten years).</p>",
+            "smithy.api#documentation": "<p>The number of hours to adjust the current retention by. The value you specify is added to or subtracted from the current value, depending on the <code>operation</code>.</p>\n         <p>The minimum value for data retention is 0 and the maximum value is 87600 (ten years).</p>",
             "smithy.api#required": {}
           }
         }
@@ -4533,7 +4533,7 @@
         }
       ],
       "traits": {
-        "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#documentation": "<p>Associates a <code>SignalingChannel</code> to a stream to store the media. There are\n            two signaling modes that you can specify :</p>\n         <ul>\n            <li>\n               <p>If <code>StorageStatus</code> is enabled, the data will be stored in the\n                        <code>StreamARN</code> provided. In order for WebRTC Ingestion to work, the stream must have data retention\n                    enabled.</p>\n            </li>\n            <li>\n               <p>If <code>StorageStatus</code> is disabled, no data will be stored, and the\n                        <code>StreamARN</code> parameter will not be needed. </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",