feat(client-mediaconnect): AWS Elemental MediaConnect introduces the …

…ability to disable outputs. Disabling an output allows you to keep the output attached to the flow, but stop streaming to the output destination. A disabled output does not incur data transfer costs.
aws · Jul 10, 2024 · 427a732 · 427a732
1 parent c9d85d8
commit 427a732
Show file tree

Hide file tree

Showing 8 changed files with 82 additions and 0 deletions.
diff --git a/clients/client-mediaconnect/src/commands/AddFlowOutputsCommand.ts b/clients/client-mediaconnect/src/commands/AddFlowOutputsCommand.ts
@@ -86,6 +86,7 @@ export interface AddFlowOutputsCommandOutput extends AddFlowOutputsResponse, __M
  *       VpcInterfaceAttachment: { // VpcInterfaceAttachment
  *         VpcInterfaceName: "STRING_VALUE",
  *       },
+ *       OutputStatus: "ENABLED" || "DISABLED",
  *     },
  *   ],
  * };
@@ -159,6 +160,7 @@ export interface AddFlowOutputsCommandOutput extends AddFlowOutputsResponse, __M
  * //       BridgePorts: [ // __listOf__integer
  * //         Number("int"),
  * //       ],
+ * //       OutputStatus: "ENABLED" || "DISABLED",
  * //     },
  * //   ],
  * // };

diff --git a/clients/client-mediaconnect/src/commands/CreateFlowCommand.ts b/clients/client-mediaconnect/src/commands/CreateFlowCommand.ts
@@ -131,6 +131,7 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
  *       VpcInterfaceAttachment: { // VpcInterfaceAttachment
  *         VpcInterfaceName: "STRING_VALUE",
  *       },
+ *       OutputStatus: "ENABLED" || "DISABLED",
  *     },
  *   ],
  *   Source: { // SetSourceRequest
@@ -378,6 +379,7 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
  * //         BridgePorts: [ // __listOf__integer
  * //           Number("int"),
  * //         ],
+ * //         OutputStatus: "ENABLED" || "DISABLED",
  * //       },
  * //     ],
  * //     Source: { // Source

diff --git a/clients/client-mediaconnect/src/commands/DescribeFlowCommand.ts b/clients/client-mediaconnect/src/commands/DescribeFlowCommand.ts
@@ -159,6 +159,7 @@ export interface DescribeFlowCommandOutput extends DescribeFlowResponse, __Metad
  * //         BridgePorts: [ // __listOf__integer
  * //           Number("int"),
  * //         ],
+ * //         OutputStatus: "ENABLED" || "DISABLED",
  * //       },
  * //     ],
  * //     Source: { // Source

diff --git a/clients/client-mediaconnect/src/commands/UpdateFlowCommand.ts b/clients/client-mediaconnect/src/commands/UpdateFlowCommand.ts
@@ -172,6 +172,7 @@ export interface UpdateFlowCommandOutput extends UpdateFlowResponse, __MetadataB
  * //         BridgePorts: [ // __listOf__integer
  * //           Number("int"),
  * //         ],
+ * //         OutputStatus: "ENABLED" || "DISABLED",
  * //       },
  * //     ],
  * //     Source: { // Source

diff --git a/clients/client-mediaconnect/src/commands/UpdateFlowOutputCommand.ts b/clients/client-mediaconnect/src/commands/UpdateFlowOutputCommand.ts
@@ -85,6 +85,7 @@ export interface UpdateFlowOutputCommandOutput extends UpdateFlowOutputResponse,
  *   VpcInterfaceAttachment: { // VpcInterfaceAttachment
  *     VpcInterfaceName: "STRING_VALUE",
  *   },
+ *   OutputStatus: "ENABLED" || "DISABLED",
  * };
  * const command = new UpdateFlowOutputCommand(input);
  * const response = await client.send(command);
@@ -155,6 +156,7 @@ export interface UpdateFlowOutputCommandOutput extends UpdateFlowOutputResponse,
  * //     BridgePorts: [ // __listOf__integer
  * //       Number("int"),
  * //     ],
+ * //     OutputStatus: "ENABLED" || "DISABLED",
  * //   },
  * // };
  *

diff --git a/clients/client-mediaconnect/src/models/models_0.ts b/clients/client-mediaconnect/src/models/models_0.ts
@@ -573,6 +573,20 @@ export interface MediaStreamOutputConfigurationRequest {
   MediaStreamName: string | undefined;
 }
 
+/**
+ * @public
+ * @enum
+ */
+export const OutputStatus = {
+  DISABLED: "DISABLED",
+  ENABLED: "ENABLED",
+} as const;
+
+/**
+ * @public
+ */
+export type OutputStatus = (typeof OutputStatus)[keyof typeof OutputStatus];
+
 /**
  * The output that you want to add to this flow.
  * @public
@@ -667,6 +681,12 @@ export interface AddOutputRequest {
    * @public
    */
   VpcInterfaceAttachment?: VpcInterfaceAttachment;
+
+  /**
+   * An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.
+   * @public
+   */
+  OutputStatus?: OutputStatus;
 }
 
 /**
@@ -1865,6 +1885,12 @@ export interface Output {
    * @public
    */
   BridgePorts?: number[];
+
+  /**
+   * An indication of whether the output is transmitting data or not.
+   * @public
+   */
+  OutputStatus?: OutputStatus;
 }
 
 /**
@@ -5123,6 +5149,12 @@ export interface UpdateFlowOutputRequest {
    * @public
    */
   VpcInterfaceAttachment?: VpcInterfaceAttachment;
+
+  /**
+   * An indication of whether the output should transmit data or not. If you don't specify the outputStatus field in your request, MediaConnect leaves the value unchanged.
+   * @public
+   */
+  OutputStatus?: OutputStatus;
 }
 
 /**

diff --git a/clients/client-mediaconnect/src/protocols/Aws_restJson1.ts b/clients/client-mediaconnect/src/protocols/Aws_restJson1.ts
@@ -1213,6 +1213,7 @@ export const se_UpdateFlowOutputCommand = async (
         `MediaStreamOutputConfigurations`,
       ],
       minLatency: [, , `MinLatency`],
+      outputStatus: [, , `OutputStatus`],
       port: [, , `Port`],
       protocol: [, , `Protocol`],
       remoteId: [, , `RemoteId`],
@@ -2944,6 +2945,7 @@ const se_AddOutputRequest = (input: AddOutputRequest, context: __SerdeContext):
     ],
     minLatency: [, , `MinLatency`],
     name: [, , `Name`],
+    outputStatus: [, , `OutputStatus`],
     port: [, , `Port`],
     protocol: [, , `Protocol`],
     remoteId: [, , `RemoteId`],
@@ -4036,6 +4038,7 @@ const de_Output = (output: any, context: __SerdeContext): Output => {
     ],
     Name: [, __expectString, `name`],
     OutputArn: [, __expectString, `outputArn`],
+    OutputStatus: [, __expectString, `outputStatus`],
     Port: [, __expectInt32, `port`],
     Transport: [, (_: any) => de_Transport(_, context), `transport`],
     VpcInterfaceAttachment: [, (_: any) => de_VpcInterfaceAttachment(_, context), `vpcInterfaceAttachment`],

diff --git a/codegen/sdk-codegen/aws-models/mediaconnect.json b/codegen/sdk-codegen/aws-models/mediaconnect.json
@@ -991,6 +991,13 @@
             "smithy.api#documentation": "The name of the VPC interface attachment to use for this output.",
             "smithy.api#jsonName": "vpcInterfaceAttachment"
           }
+        },
+        "OutputStatus": {
+          "target": "com.amazonaws.mediaconnect#OutputStatus",
+          "traits": {
+            "smithy.api#documentation": "An indication of whether the new output should be enabled or disabled as soon as it is created. If you don't specify the outputStatus field in your request, MediaConnect sets it to ENABLED.",
+            "smithy.api#jsonName": "outputStatus"
+          }
         }
       },
       "traits": {
@@ -5326,6 +5333,7 @@
           "name": "mediaconnect"
         },
         "aws.protocols#restJson1": {},
+        "smithy.api#auth": ["aws.auth#sigv4"],
         "smithy.api#documentation": "API for AWS Elemental MediaConnect",
         "smithy.api#title": "AWS MediaConnect",
         "smithy.rules#endpointRuleSet": {
@@ -6714,12 +6722,36 @@
             "smithy.api#documentation": "The bridge output ports currently in use.",
             "smithy.api#jsonName": "bridgePorts"
           }
+        },
+        "OutputStatus": {
+          "target": "com.amazonaws.mediaconnect#OutputStatus",
+          "traits": {
+            "smithy.api#documentation": "An indication of whether the output is transmitting data or not.",
+            "smithy.api#jsonName": "outputStatus"
+          }
         }
       },
       "traits": {
         "smithy.api#documentation": "The settings for an output."
       }
     },
+    "com.amazonaws.mediaconnect#OutputStatus": {
+      "type": "enum",
+      "members": {
+        "ENABLED": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "ENABLED"
+          }
+        },
+        "DISABLED": {
+          "target": "smithy.api#Unit",
+          "traits": {
+            "smithy.api#enumValue": "DISABLED"
+          }
+        }
+      }
+    },
     "com.amazonaws.mediaconnect#PriceUnits": {
       "type": "enum",
       "members": {
@@ -9719,6 +9751,13 @@
             "smithy.api#documentation": "The name of the VPC interface attachment to use for this output.",
             "smithy.api#jsonName": "vpcInterfaceAttachment"
           }
+        },
+        "OutputStatus": {
+          "target": "com.amazonaws.mediaconnect#OutputStatus",
+          "traits": {
+            "smithy.api#documentation": "An indication of whether the output should transmit data or not. If you don't specify the outputStatus field in your request, MediaConnect leaves the value unchanged.",
+            "smithy.api#jsonName": "outputStatus"
+          }
         }
       },
       "traits": {