feat(client-ivs): API update to include an SRT ingest endpoint and pa…

…ssphrase for all channels.
aws · Apr 4, 2024 · 9d14837 · 9d14837
1 parent 30e75ea
commit 9d14837
Show file tree

Hide file tree

Showing 12 changed files with 228 additions and 130 deletions.
diff --git a/clients/client-ivs/README.md b/clients/client-ivs/README.md
@@ -47,49 +47,34 @@ History</a>.</p>
 </li>
 </ul>
 <p>
-<b>Resources</b>
+<b>Key Concepts</b>
 </p>
-<p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html"> Getting Started with
-Amazon IVS</a>):</p>
 <ul>
 <li>
 <p>
-<b>Channel</b> — Stores configuration data related to your
-live stream. You first create a channel and then use the channel’s stream key to start
-your live stream. See the Channel endpoints for more information. </p>
+<b>Channel</b> — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream.</p>
 </li>
 <li>
 <p>
-<b>Stream key</b> — An identifier assigned by Amazon IVS
-when you create a channel, which is then used to authorize streaming. See the StreamKey
-endpoints for more information. <i>
-<b>Treat the stream key like
-a secret, since it allows anyone to stream to the
-channel.</b>
+<b>Stream key</b> — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. <i>
+<b>Treat the stream key like a secret, since it allows anyone to stream to the channel.</b>
 </i>
 </p>
 </li>
 <li>
 <p>
-<b>Playback key pair</b> — Video playback may be restricted
-using playback-authorization tokens, which use public-key encryption. A playback key pair
-is the public-private pair of keys used to sign and validate the playback-authorization
-token. See the PlaybackKeyPair endpoints for more information.</p>
+<b>Playback key pair</b> — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token.</p>
 </li>
 <li>
 <p>
-<b>Recording configuration</b> — Stores configuration
-related to recording a live stream and where to store the recorded content. Multiple
-channels can reference the same recording configuration. See the Recording Configuration
-endpoints for more information.</p>
+<b>Recording configuration</b> — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration.</p>
 </li>
 <li>
 <p>
-<b>Playback restriction policy</b> — Restricts playback by
-countries and/or origin sites. See the Playback Restriction Policy endpoints for more
-information.</p>
+<b>Playback restriction policy</b> — Restricts playback by countries and/or origin sites.</p>
 </li>
 </ul>
+<p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started.html">Getting Started with IVS Low-Latency Streaming</a>.</p>
 <p>
 <b>Tagging</b>
 </p>
@@ -268,7 +253,7 @@ simultaneously.</p>
 </li>
 </ul>
 <p>
-<b>RecordingConfiguration Endpoints</b>
+<b>Recording Configuration Endpoints</b>
 </p>
 <ul>
 <li>
@@ -333,7 +318,7 @@ allowed.</p>
 </li>
 </ul>
 <p>
-<b>StreamKey Endpoints</b>
+<b>Stream Key Endpoints</b>
 </p>
 <ul>
 <li>

diff --git a/clients/client-ivs/src/Ivs.ts b/clients/client-ivs/src/Ivs.ts
@@ -755,49 +755,34 @@ export interface Ivs {
  *             </li>
  *          </ul>
  *          <p>
- *             <b>Resources</b>
+ *             <b>Key Concepts</b>
  *          </p>
- *          <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html"> Getting Started with
- *         Amazon IVS</a>):</p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <b>Channel</b> — Stores configuration data related to your
- *           live stream. You first create a channel and then use the channel’s stream key to start
- *           your live stream. See the Channel endpoints for more information. </p>
+ *                   <b>Channel</b> — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream.</p>
  *             </li>
  *             <li>
  *                <p>
- *                   <b>Stream key</b> — An identifier assigned by Amazon IVS
- *           when you create a channel, which is then used to authorize streaming. See the StreamKey
- *           endpoints for more information. <i>
- *                      <b>Treat the stream key like
- *               a secret, since it allows anyone to stream to the
- *           channel.</b>
+ *                   <b>Stream key</b> — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. <i>
+ *                      <b>Treat the stream key like a secret, since it allows anyone to stream to the channel.</b>
  *                   </i>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <b>Playback key pair</b> — Video playback may be restricted
- *           using playback-authorization tokens, which use public-key encryption. A playback key pair
- *           is the public-private pair of keys used to sign and validate the playback-authorization
- *           token. See the PlaybackKeyPair endpoints for more information.</p>
+ *                   <b>Playback key pair</b> — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token.</p>
  *             </li>
  *             <li>
  *                <p>
- *                   <b>Recording configuration</b> — Stores configuration
- *           related to recording a live stream and where to store the recorded content. Multiple
- *           channels can reference the same recording configuration. See the Recording Configuration
- *           endpoints for more information.</p>
+ *                   <b>Recording configuration</b> — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration.</p>
  *             </li>
  *             <li>
  *                <p>
- *                   <b>Playback restriction policy</b> — Restricts playback by
- *           countries and/or origin sites. See the Playback Restriction Policy endpoints for more
- *           information.</p>
+ *                   <b>Playback restriction policy</b> — Restricts playback by countries and/or origin sites.</p>
  *             </li>
  *          </ul>
+ *          <p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started.html">Getting Started with IVS Low-Latency Streaming</a>.</p>
  *          <p>
  *             <b>Tagging</b>
  *          </p>
@@ -976,7 +961,7 @@ export interface Ivs {
  *             </li>
  *          </ul>
  *          <p>
- *             <b>RecordingConfiguration Endpoints</b>
+ *             <b>Recording Configuration Endpoints</b>
  *          </p>
  *          <ul>
  *             <li>
@@ -1041,7 +1026,7 @@ export interface Ivs {
  *             </li>
  *          </ul>
  *          <p>
- *             <b>StreamKey Endpoints</b>
+ *             <b>Stream Key Endpoints</b>
  *          </p>
  *          <ul>
  *             <li>

diff --git a/clients/client-ivs/src/IvsClient.ts b/clients/client-ivs/src/IvsClient.ts
@@ -437,49 +437,34 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {}
  *             </li>
  *          </ul>
  *          <p>
- *             <b>Resources</b>
+ *             <b>Key Concepts</b>
  *          </p>
- *          <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html"> Getting Started with
- *         Amazon IVS</a>):</p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <b>Channel</b> — Stores configuration data related to your
- *           live stream. You first create a channel and then use the channel’s stream key to start
- *           your live stream. See the Channel endpoints for more information. </p>
+ *                   <b>Channel</b> — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream.</p>
  *             </li>
  *             <li>
  *                <p>
- *                   <b>Stream key</b> — An identifier assigned by Amazon IVS
- *           when you create a channel, which is then used to authorize streaming. See the StreamKey
- *           endpoints for more information. <i>
- *                      <b>Treat the stream key like
- *               a secret, since it allows anyone to stream to the
- *           channel.</b>
+ *                   <b>Stream key</b> — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. <i>
+ *                      <b>Treat the stream key like a secret, since it allows anyone to stream to the channel.</b>
  *                   </i>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <b>Playback key pair</b> — Video playback may be restricted
- *           using playback-authorization tokens, which use public-key encryption. A playback key pair
- *           is the public-private pair of keys used to sign and validate the playback-authorization
- *           token. See the PlaybackKeyPair endpoints for more information.</p>
+ *                   <b>Playback key pair</b> — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token.</p>
  *             </li>
  *             <li>
  *                <p>
- *                   <b>Recording configuration</b> — Stores configuration
- *           related to recording a live stream and where to store the recorded content. Multiple
- *           channels can reference the same recording configuration. See the Recording Configuration
- *           endpoints for more information.</p>
+ *                   <b>Recording configuration</b> — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration.</p>
  *             </li>
  *             <li>
  *                <p>
- *                   <b>Playback restriction policy</b> — Restricts playback by
- *           countries and/or origin sites. See the Playback Restriction Policy endpoints for more
- *           information.</p>
+ *                   <b>Playback restriction policy</b> — Restricts playback by countries and/or origin sites.</p>
  *             </li>
  *          </ul>
+ *          <p>For more information about your IVS live stream, also see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started.html">Getting Started with IVS Low-Latency Streaming</a>.</p>
  *          <p>
  *             <b>Tagging</b>
  *          </p>
@@ -658,7 +643,7 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {}
  *             </li>
  *          </ul>
  *          <p>
- *             <b>RecordingConfiguration Endpoints</b>
+ *             <b>Recording Configuration Endpoints</b>
  *          </p>
  *          <ul>
  *             <li>
@@ -723,7 +708,7 @@ export interface IvsClientResolvedConfig extends IvsClientResolvedConfigType {}
  *             </li>
  *          </ul>
  *          <p>
- *             <b>StreamKey Endpoints</b>
+ *             <b>Stream Key Endpoints</b>
  *          </p>
  *          <ul>
  *             <li>

diff --git a/clients/client-ivs/src/commands/BatchGetChannelCommand.ts b/clients/client-ivs/src/commands/BatchGetChannelCommand.ts
@@ -6,7 +6,11 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
 import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
-import { BatchGetChannelRequest, BatchGetChannelResponse } from "../models/models_0";
+import {
+  BatchGetChannelRequest,
+  BatchGetChannelResponse,
+  BatchGetChannelResponseFilterSensitiveLog,
+} from "../models/models_0";
 import { de_BatchGetChannelCommand, se_BatchGetChannelCommand } from "../protocols/Aws_restJson1";
 
 /**
@@ -57,6 +61,10 @@ export interface BatchGetChannelCommandOutput extends BatchGetChannelResponse, _
  * //       },
  * //       insecureIngest: true || false,
  * //       preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
+ * //       srt: { // Srt
+ * //         endpoint: "STRING_VALUE",
+ * //         passphrase: "STRING_VALUE",
+ * //       },
  * //       playbackRestrictionPolicyArn: "STRING_VALUE",
  * //     },
  * //   ],
@@ -101,7 +109,7 @@ export class BatchGetChannelCommand extends $Command
   })
   .s("AmazonInteractiveVideoService", "BatchGetChannel", {})
   .n("IvsClient", "BatchGetChannelCommand")
-  .f(void 0, void 0)
+  .f(void 0, BatchGetChannelResponseFilterSensitiveLog)
   .ser(se_BatchGetChannelCommand)
   .de(de_BatchGetChannelCommand)
   .build() {}
diff --git a/clients/client-ivs/src/commands/CreateChannelCommand.ts b/clients/client-ivs/src/commands/CreateChannelCommand.ts
@@ -68,6 +68,10 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
  * //     },
  * //     insecureIngest: true || false,
  * //     preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
+ * //     srt: { // Srt
+ * //       endpoint: "STRING_VALUE",
+ * //       passphrase: "STRING_VALUE",
+ * //     },
  * //     playbackRestrictionPolicyArn: "STRING_VALUE",
  * //   },
  * //   streamKey: { // StreamKey

diff --git a/clients/client-ivs/src/commands/GetChannelCommand.ts b/clients/client-ivs/src/commands/GetChannelCommand.ts
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
 import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
-import { GetChannelRequest, GetChannelResponse } from "../models/models_0";
+import { GetChannelRequest, GetChannelResponse, GetChannelResponseFilterSensitiveLog } from "../models/models_0";
 import { de_GetChannelCommand, se_GetChannelCommand } from "../protocols/Aws_restJson1";
 
 /**
@@ -54,6 +54,10 @@ export interface GetChannelCommandOutput extends GetChannelResponse, __MetadataB
  * //     },
  * //     insecureIngest: true || false,
  * //     preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
+ * //     srt: { // Srt
+ * //       endpoint: "STRING_VALUE",
+ * //       passphrase: "STRING_VALUE",
+ * //     },
  * //     playbackRestrictionPolicyArn: "STRING_VALUE",
  * //   },
  * // };
@@ -99,7 +103,7 @@ export class GetChannelCommand extends $Command
   })
   .s("AmazonInteractiveVideoService", "GetChannel", {})
   .n("IvsClient", "GetChannelCommand")
-  .f(void 0, void 0)
+  .f(void 0, GetChannelResponseFilterSensitiveLog)
   .ser(se_GetChannelCommand)
   .de(de_GetChannelCommand)
   .build() {}
diff --git a/clients/client-ivs/src/commands/GetStreamSessionCommand.ts b/clients/client-ivs/src/commands/GetStreamSessionCommand.ts
@@ -6,7 +6,11 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
 import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
-import { GetStreamSessionRequest, GetStreamSessionResponse } from "../models/models_0";
+import {
+  GetStreamSessionRequest,
+  GetStreamSessionResponse,
+  GetStreamSessionResponseFilterSensitiveLog,
+} from "../models/models_0";
 import { de_GetStreamSessionCommand, se_GetStreamSessionCommand } from "../protocols/Aws_restJson1";
 
 /**
@@ -59,6 +63,10 @@ export interface GetStreamSessionCommandOutput extends GetStreamSessionResponse,
  * //       },
  * //       insecureIngest: true || false,
  * //       preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
+ * //       srt: { // Srt
+ * //         endpoint: "STRING_VALUE",
+ * //         passphrase: "STRING_VALUE",
+ * //       },
  * //       playbackRestrictionPolicyArn: "STRING_VALUE",
  * //     },
  * //     ingestConfiguration: { // IngestConfiguration
@@ -158,7 +166,7 @@ export class GetStreamSessionCommand extends $Command
   })
   .s("AmazonInteractiveVideoService", "GetStreamSession", {})
   .n("IvsClient", "GetStreamSessionCommand")
-  .f(void 0, void 0)
+  .f(void 0, GetStreamSessionResponseFilterSensitiveLog)
   .ser(se_GetStreamSessionCommand)
   .de(de_GetStreamSessionCommand)
   .build() {}
diff --git a/clients/client-ivs/src/commands/UpdateChannelCommand.ts b/clients/client-ivs/src/commands/UpdateChannelCommand.ts
@@ -6,7 +6,11 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
 import { IvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IvsClient";
-import { UpdateChannelRequest, UpdateChannelResponse } from "../models/models_0";
+import {
+  UpdateChannelRequest,
+  UpdateChannelResponse,
+  UpdateChannelResponseFilterSensitiveLog,
+} from "../models/models_0";
 import { de_UpdateChannelCommand, se_UpdateChannelCommand } from "../protocols/Aws_restJson1";
 
 /**
@@ -64,6 +68,10 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met
  * //     },
  * //     insecureIngest: true || false,
  * //     preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
+ * //     srt: { // Srt
+ * //       endpoint: "STRING_VALUE",
+ * //       passphrase: "STRING_VALUE",
+ * //     },
  * //     playbackRestrictionPolicyArn: "STRING_VALUE",
  * //   },
  * // };
@@ -115,7 +123,7 @@ export class UpdateChannelCommand extends $Command
   })
   .s("AmazonInteractiveVideoService", "UpdateChannel", {})
   .n("IvsClient", "UpdateChannelCommand")
-  .f(void 0, void 0)
+  .f(void 0, UpdateChannelResponseFilterSensitiveLog)
   .ser(se_UpdateChannelCommand)
   .de(de_UpdateChannelCommand)
   .build() {}