feat(client-ivs): On a channel that you own, you can now replace an o…

…ngoing stream with a new stream by streaming up with the priority parameter appended to the stream key.
aws · Oct 15, 2024 · 0141b42 · 0141b42
1 parent 8f3697f
commit 0141b42
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 0 deletions.
diff --git a/clients/client-ivs/src/commands/GetStreamSessionCommand.ts b/clients/client-ivs/src/commands/GetStreamSessionCommand.ts
@@ -121,6 +121,7 @@ export interface GetStreamSessionCommandOutput extends GetStreamSessionResponse,
  * //         name: "STRING_VALUE",
  * //         type: "STRING_VALUE",
  * //         eventTime: new Date("TIMESTAMP"),
+ * //         code: "STRING_VALUE",
  * //       },
  * //     ],
  * //   },

diff --git a/clients/client-ivs/src/models/models_0.ts b/clients/client-ivs/src/models/models_0.ts
@@ -1579,6 +1579,33 @@ export interface StreamEvent {
    * @public
    */
   eventTime?: Date;
+
+  /**
+   * <p>Provides additional details about the stream event. There are several values; note that
+   * 			the long descriptions are provided in the IVS console but not delivered through
+   * 	  	    the IVS API or EventBridge:</p>
+   *          <ul>
+   *             <li>
+   *                <p>
+   *                   <code>StreamTakeoverMediaMismatch</code> — The broadcast client attempted to take over
+   * 			with different media properties (e.g., codec, resolution, or video track type) from the
+   * 			original stream.</p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>StreamTakeoverInvalidPriority</code> — The broadcast client attempted a takeover
+   * 			with either a priority integer value equal to or lower than the original stream's value or a value outside
+   * 			the allowed range of 1 to 2,147,483,647.</p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>StreamTakeoverLimitBreached</code> — The broadcast client reached the maximum allowed
+   * 			takeover attempts for this stream.</p>
+   *             </li>
+   *          </ul>
+   * @public
+   */
+  code?: string;
 }
 
 /**

diff --git a/clients/client-ivs/src/protocols/Aws_restJson1.ts b/clients/client-ivs/src/protocols/Aws_restJson1.ts
@@ -1983,6 +1983,7 @@ const de__Stream = (output: any, context: __SerdeContext): _Stream => {
  */
 const de_StreamEvent = (output: any, context: __SerdeContext): StreamEvent => {
   return take(output, {
+    code: __expectString,
     eventTime: (_: any) => __expectNonNull(__parseRfc3339DateTimeWithOffset(_)),
     name: __expectString,
     type: __expectString,

diff --git a/codegen/sdk-codegen/aws-models/ivs.json b/codegen/sdk-codegen/aws-models/ivs.json
@@ -4037,6 +4037,12 @@
           "traits": {
             "smithy.api#documentation": "<p>Time when the event occurred. This is an ISO 8601 timestamp; <i>note that this is\n        returned as a string</i>.</p>"
           }
+        },
+        "code": {
+          "target": "com.amazonaws.ivs#String",
+          "traits": {
+            "smithy.api#documentation": "<p>Provides additional details about the stream event. There are several values; note that \n\t\t\tthe long descriptions are provided in the IVS console but not delivered through \n\t  \t    the IVS API or EventBridge:</p>\n         <ul>\n            <li>\n               <p>\n                  <code>StreamTakeoverMediaMismatch</code> — The broadcast client attempted to take over \n\t\t\twith different media properties (e.g., codec, resolution, or video track type) from the \n\t\t\toriginal stream.</p>\n            </li>\n            <li>\n               <p>\n                  <code>StreamTakeoverInvalidPriority</code> — The broadcast client attempted a takeover \n\t\t\twith either a priority integer value equal to or lower than the original stream's value or a value outside \n\t\t\tthe allowed range of 1 to 2,147,483,647.</p>\n            </li>\n            <li>\n               <p>\n                  <code>StreamTakeoverLimitBreached</code> — The broadcast client reached the maximum allowed \n\t\t\ttakeover attempts for this stream.</p>\n            </li>\n         </ul>"
+          }
         }
       },
       "traits": {