@aws-sdk/client-mediapackagev2 3.596.0 → 3.598.0

package/dist-types/commands/CreateOriginEndpointCommand.d.ts

@@ -135,6 +135,11 @@ declare const CreateOriginEndpointCommand_base: {
  *       },
  *     },
  *   ],
+ *   ForceEndpointErrorConfiguration: { // ForceEndpointErrorConfiguration
+ *     EndpointErrorConditions: [ // EndpointErrorConditions
+ *       "STALE_MANIFEST" || "INCOMPLETE_MANIFEST" || "MISSING_DRM_KEY" || "SLATE_INPUT",
+ *     ],
+ *   },
  *   Tags: { // TagMap
  *     "<keys>": "STRING_VALUE",
  *   },
@@ -247,6 +252,11 @@ declare const CreateOriginEndpointCommand_base: {
  * //       },
  * //     },
  * //   ],
+ * //   ForceEndpointErrorConfiguration: { // ForceEndpointErrorConfiguration
+ * //     EndpointErrorConditions: [ // EndpointErrorConditions
+ * //       "STALE_MANIFEST" || "INCOMPLETE_MANIFEST" || "MISSING_DRM_KEY" || "SLATE_INPUT",
+ * //     ],
+ * //   },
  * //   ETag: "STRING_VALUE",
  * //   Tags: { // TagMap
  * //     "<keys>": "STRING_VALUE",
@@ -286,6 +296,478 @@ declare const CreateOriginEndpointCommand_base: {
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
  *
  * @public
+ * @example Creating an OriginEndpoint with container type TS, and encryption enabled
+ * ```javascript
+ * //
+ * const input = {
+ *   "ChannelGroupName": "exampleChannelGroup",
+ *   "ChannelName": "exampleChannel",
+ *   "ContainerType": "TS",
+ *   "Description": "Description for exampleOriginEndpointTS",
+ *   "ForceEndpointErrorConfiguration": {
+ *     "EndpointErrorConditions": [
+ *       "STALE_MANIFEST",
+ *       "INCOMPLETE_MANIFEST",
+ *       "MISSING_DRM_KEY",
+ *       "SLATE_INPUT"
+ *     ]
+ *   },
+ *   "HlsManifests": [
+ *     {
+ *       "ChildManifestName": "exampleChildManifest1",
+ *       "ManifestName": "exampleManifest1",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       }
+ *     },
+ *     {
+ *       "ChildManifestName": "exampleManifest2",
+ *       "ManifestName": "exampleManifest2",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       }
+ *     }
+ *   ],
+ *   "LowLatencyHlsManifests": [
+ *     {
+ *       "ChildManifestName": "exampleLLChildManifest1",
+ *       "ManifestName": "exampleLLManifest1",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       }
+ *     },
+ *     {
+ *       "ChildManifestName": "exampleLLManifest2",
+ *       "ManifestName": "exampleLLManifest2",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       }
+ *     }
+ *   ],
+ *   "OriginEndpointName": "exampleOriginEndpointTS",
+ *   "Segment": {
+ *     "Encryption": {
+ *       "ConstantInitializationVector": "A382A901F3C1F7718512266CFFBB0B7E",
+ *       "EncryptionMethod": {
+ *         "TsEncryptionMethod": "AES_128"
+ *       },
+ *       "KeyRotationIntervalSeconds": 300,
+ *       "SpekeKeyProvider": {
+ *         "DrmSystems": [
+ *           "CLEAR_KEY_AES_128"
+ *         ],
+ *         "EncryptionContractConfiguration": {
+ *           "PresetSpeke20Audio": "SHARED",
+ *           "PresetSpeke20Video": "SHARED"
+ *         },
+ *         "ResourceId": "ResourceId",
+ *         "RoleArn": "arn:aws:iam::123456789012:role/empRole",
+ *         "Url": "https://foo.com"
+ *       }
+ *     },
+ *     "IncludeIframeOnlyStreams": true,
+ *     "Scte": {
+ *       "ScteFilter": [
+ *         "SPLICE_INSERT",
+ *         "BREAK"
+ *       ]
+ *     },
+ *     "SegmentDurationSeconds": 6,
+ *     "SegmentName": "segmentName",
+ *     "TsIncludeDvbSubtitles": true,
+ *     "TsUseAudioRenditionGroup": true
+ *   },
+ *   "StartoverWindowSeconds": 300,
+ *   "Tags": {
+ *     "key1": "value1",
+ *     "key2": "value2"
+ *   }
+ * };
+ * const command = new CreateOriginEndpointCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel/originEndpoint/exampleOriginEndpointTS",
+ *   "ChannelGroupName": "exampleChannelGroup",
+ *   "ChannelName": "exampleChannel",
+ *   "ContainerType": "TS",
+ *   "CreatedAt": "2022-10-18T09:36:00.00Z",
+ *   "Description": "Description for exampleOriginEndpointTS",
+ *   "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=",
+ *   "ForceEndpointErrorConfiguration": {
+ *     "EndpointErrorConditions": [
+ *       "STALE_MANIFEST",
+ *       "INCOMPLETE_MANIFEST",
+ *       "MISSING_DRM_KEY",
+ *       "SLATE_INPUT"
+ *     ]
+ *   },
+ *   "HlsManifests": [
+ *     {
+ *       "ChildManifestName": "exampleChildManifest1",
+ *       "ManifestName": "exampleManifest1",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       },
+ *       "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleManifest1.m3u8"
+ *     },
+ *     {
+ *       "ChildManifestName": "exampleManifest2",
+ *       "ManifestName": "exampleManifest2",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       },
+ *       "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleManifest2.m3u8"
+ *     }
+ *   ],
+ *   "LowLatencyHlsManifests": [
+ *     {
+ *       "ChildManifestName": "exampleLLChildManifest1",
+ *       "ManifestName": "exampleLLManifest1",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       },
+ *       "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest1.m3u8"
+ *     },
+ *     {
+ *       "ChildManifestName": "exampleLLManifest2",
+ *       "ManifestName": "exampleLLManifest2",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       },
+ *       "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest2.m3u8"
+ *     }
+ *   ],
+ *   "ModifiedAt": "2022-10-18T09:36:00.00Z",
+ *   "OriginEndpointName": "exampleOriginEndpointTS",
+ *   "Segment": {
+ *     "Encryption": {
+ *       "ConstantInitializationVector": "A382A901F3C1F7718512266CFFBB0B7E",
+ *       "EncryptionMethod": {
+ *         "TsEncryptionMethod": "AES_128"
+ *       },
+ *       "KeyRotationIntervalSeconds": 300,
+ *       "SpekeKeyProvider": {
+ *         "DrmSystems": [
+ *           "CLEAR_KEY_AES_128"
+ *         ],
+ *         "EncryptionContractConfiguration": {
+ *           "PresetSpeke20Audio": "SHARED",
+ *           "PresetSpeke20Video": "SHARED"
+ *         },
+ *         "ResourceId": "ResourceId",
+ *         "RoleArn": "arn:aws:iam::123456789012:role/empRole",
+ *         "Url": "https://foo.com"
+ *       }
+ *     },
+ *     "IncludeIframeOnlyStreams": true,
+ *     "Scte": {
+ *       "ScteFilter": [
+ *         "SPLICE_INSERT",
+ *         "BREAK"
+ *       ]
+ *     },
+ *     "SegmentDurationSeconds": 6,
+ *     "SegmentName": "segmentName",
+ *     "TsIncludeDvbSubtitles": true,
+ *     "TsUseAudioRenditionGroup": true
+ *   },
+ *   "StartoverWindowSeconds": 300,
+ *   "Tags": {
+ *     "key1": "value1",
+ *     "key2": "value2"
+ *   }
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
+ * @example Creating an OriginEndpoint with container type CMAF, and encryption enabled
+ * ```javascript
+ * //
+ * const input = {
+ *   "ChannelGroupName": "exampleChannelGroup",
+ *   "ChannelName": "exampleChannel",
+ *   "ContainerType": "CMAF",
+ *   "DashManifests": [
+ *     {
+ *       "DrmSignaling": "INDIVIDUAL",
+ *       "ManifestName": "exampleDashManifest1",
+ *       "ManifestWindowSeconds": 300,
+ *       "MinBufferTimeSeconds": 30,
+ *       "MinUpdatePeriodSeconds": 5,
+ *       "PeriodTriggers": [
+ *         "AVAILS"
+ *       ],
+ *       "ScteDash": {
+ *         "AdMarkerDash": "XML"
+ *       },
+ *       "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE",
+ *       "SuggestedPresentationDelaySeconds": 2
+ *     },
+ *     {
+ *       "DrmSignaling": "INDIVIDUAL",
+ *       "ManifestName": "exampleDashManifest2",
+ *       "ManifestWindowSeconds": 60,
+ *       "MinBufferTimeSeconds": 9,
+ *       "MinUpdatePeriodSeconds": 3,
+ *       "PeriodTriggers": [
+ *         "AVAILS",
+ *         "DRM_KEY_ROTATION",
+ *         "SOURCE_CHANGES",
+ *         "SOURCE_DISRUPTIONS"
+ *       ],
+ *       "ScteDash": {
+ *         "AdMarkerDash": "XML"
+ *       },
+ *       "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE",
+ *       "SuggestedPresentationDelaySeconds": 12
+ *     }
+ *   ],
+ *   "ForceEndpointErrorConfiguration": {
+ *     "EndpointErrorConditions": [
+ *       "STALE_MANIFEST",
+ *       "INCOMPLETE_MANIFEST",
+ *       "MISSING_DRM_KEY",
+ *       "SLATE_INPUT"
+ *     ]
+ *   },
+ *   "HlsManifests": [
+ *     {
+ *       "ChildManifestName": "exampleChildManifest1",
+ *       "ManifestName": "exampleManifest1",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       }
+ *     },
+ *     {
+ *       "ChildManifestName": "exampleManifest2",
+ *       "ManifestName": "exampleManifest2",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       }
+ *     }
+ *   ],
+ *   "LowLatencyHlsManifests": [
+ *     {
+ *       "ChildManifestName": "exampleLLChildManifest1",
+ *       "ManifestName": "exampleLLManifest1",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       }
+ *     },
+ *     {
+ *       "ChildManifestName": "exampleLLManifest2",
+ *       "ManifestName": "exampleLLManifest2",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       }
+ *     }
+ *   ],
+ *   "OriginEndpointName": "exampleOriginEndpointCMAF",
+ *   "Segment": {
+ *     "Encryption": {
+ *       "ConstantInitializationVector": "A382A901F3C1F7718512266CFFBB0B9F",
+ *       "EncryptionMethod": {
+ *         "CmafEncryptionMethod": "CBCS"
+ *       },
+ *       "KeyRotationIntervalSeconds": 300,
+ *       "SpekeKeyProvider": {
+ *         "DrmSystems": [
+ *           "PLAYREADY",
+ *           "WIDEVINE"
+ *         ],
+ *         "EncryptionContractConfiguration": {
+ *           "PresetSpeke20Audio": "PRESET_AUDIO_1",
+ *           "PresetSpeke20Video": "PRESET_VIDEO_1"
+ *         },
+ *         "ResourceId": "ResourceId",
+ *         "RoleArn": "arn:aws:iam::123456789012:role/empRole",
+ *         "Url": "https://foo.com"
+ *       }
+ *     },
+ *     "IncludeIframeOnlyStreams": true,
+ *     "Scte": {
+ *       "ScteFilter": [
+ *         "SPLICE_INSERT",
+ *         "BREAK"
+ *       ]
+ *     },
+ *     "SegmentDurationSeconds": 6,
+ *     "SegmentName": "segmentName"
+ *   },
+ *   "StartoverWindowSeconds": 300,
+ *   "Tags": {
+ *     "key1": "value1",
+ *     "key2": "value2"
+ *   }
+ * };
+ * const command = new CreateOriginEndpointCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel/originEndpoint/exampleOriginEndpointCMAF",
+ *   "ChannelGroupName": "exampleChannelGroup",
+ *   "ChannelName": "exampleChannel",
+ *   "ContainerType": "CMAF",
+ *   "CreatedAt": "2022-10-18T09:36:00.00Z",
+ *   "DashManifests": [
+ *     {
+ *       "DrmSignaling": "INDIVIDUAL",
+ *       "ManifestName": "exampleDashManifest1",
+ *       "ManifestWindowSeconds": 300,
+ *       "MinBufferTimeSeconds": 30,
+ *       "MinUpdatePeriodSeconds": 5,
+ *       "PeriodTriggers": [
+ *         "AVAILS"
+ *       ],
+ *       "ScteDash": {
+ *         "AdMarkerDash": "XML"
+ *       },
+ *       "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE",
+ *       "SuggestedPresentationDelaySeconds": 2,
+ *       "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest1.mpd"
+ *     },
+ *     {
+ *       "DrmSignaling": "INDIVIDUAL",
+ *       "ManifestName": "exampleDashManifest2",
+ *       "ManifestWindowSeconds": 60,
+ *       "MinBufferTimeSeconds": 9,
+ *       "MinUpdatePeriodSeconds": 3,
+ *       "PeriodTriggers": [
+ *         "AVAILS",
+ *         "DRM_KEY_ROTATION",
+ *         "SOURCE_CHANGES",
+ *         "SOURCE_DISRUPTIONS"
+ *       ],
+ *       "ScteDash": {
+ *         "AdMarkerDash": "XML"
+ *       },
+ *       "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE",
+ *       "SuggestedPresentationDelaySeconds": 12,
+ *       "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest2.mpd"
+ *     }
+ *   ],
+ *   "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=",
+ *   "ForceEndpointErrorConfiguration": {
+ *     "EndpointErrorConditions": [
+ *       "STALE_MANIFEST",
+ *       "INCOMPLETE_MANIFEST",
+ *       "MISSING_DRM_KEY",
+ *       "SLATE_INPUT"
+ *     ]
+ *   },
+ *   "HlsManifests": [
+ *     {
+ *       "ChildManifestName": "exampleChildManifest1",
+ *       "ManifestName": "exampleManifest1",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       },
+ *       "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleManifest1.m3u8"
+ *     },
+ *     {
+ *       "ChildManifestName": "exampleManifest2",
+ *       "ManifestName": "exampleManifest2",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       },
+ *       "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleManifest2.m3u8"
+ *     }
+ *   ],
+ *   "LowLatencyHlsManifests": [
+ *     {
+ *       "ChildManifestName": "exampleLLChildManifest1",
+ *       "ManifestName": "exampleLLManifest1",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       },
+ *       "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleLLManifest1.m3u8"
+ *     },
+ *     {
+ *       "ChildManifestName": "exampleLLManifest2",
+ *       "ManifestName": "exampleLLManifest2",
+ *       "ManifestWindowSeconds": 30,
+ *       "ProgramDateTimeIntervalSeconds": 60,
+ *       "ScteHls": {
+ *         "AdMarkerHls": "DATERANGE"
+ *       },
+ *       "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleLLManifest2.m3u8"
+ *     }
+ *   ],
+ *   "ModifiedAt": "2022-10-18T09:36:00.00Z",
+ *   "OriginEndpointName": "exampleOriginEndpointCMAF",
+ *   "Segment": {
+ *     "Encryption": {
+ *       "ConstantInitializationVector": "A382A901F3C1F7718512266CFFBB0B9F",
+ *       "EncryptionMethod": {
+ *         "CmafEncryptionMethod": "CBCS"
+ *       },
+ *       "KeyRotationIntervalSeconds": 300,
+ *       "SpekeKeyProvider": {
+ *         "DrmSystems": [
+ *           "PLAYREADY",
+ *           "WIDEVINE"
+ *         ],
+ *         "EncryptionContractConfiguration": {
+ *           "PresetSpeke20Audio": "PRESET_AUDIO_1",
+ *           "PresetSpeke20Video": "PRESET_VIDEO_1"
+ *         },
+ *         "ResourceId": "ResourceId",
+ *         "RoleArn": "arn:aws:iam::123456789012:role/empRole",
+ *         "Url": "https://foo.com"
+ *       }
+ *     },
+ *     "IncludeIframeOnlyStreams": true,
+ *     "Scte": {
+ *       "ScteFilter": [
+ *         "SPLICE_INSERT",
+ *         "BREAK"
+ *       ]
+ *     },
+ *     "SegmentDurationSeconds": 6,
+ *     "SegmentName": "segmentName"
+ *   },
+ *   "StartoverWindowSeconds": 300,
+ *   "Tags": {
+ *     "key1": "value1",
+ *     "key2": "value2"
+ *   }
+ * }
+ * *\/
+ * // example id: example-2
+ * ```
+ *
  */
 export declare class CreateOriginEndpointCommand extends CreateOriginEndpointCommand_base {
 }

package/dist-types/commands/DeleteChannelCommand.d.ts

@@ -69,6 +69,18 @@ declare const DeleteChannelCommand_base: {
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
  *
  * @public
+ * @example Deleting a Channel
+ * ```javascript
+ * //
+ * const input = {
+ *   "ChannelGroupName": "exampleChannelGroup",
+ *   "ChannelName": "exampleChannel"
+ * };
+ * const command = new DeleteChannelCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class DeleteChannelCommand extends DeleteChannelCommand_base {
 }

package/dist-types/commands/DeleteChannelGroupCommand.d.ts

@@ -68,6 +68,17 @@ declare const DeleteChannelGroupCommand_base: {
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
  *
  * @public
+ * @example Deleting a Channel Group
+ * ```javascript
+ * //
+ * const input = {
+ *   "ChannelGroupName": "exampleChannelGroup"
+ * };
+ * const command = new DeleteChannelGroupCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class DeleteChannelGroupCommand extends DeleteChannelGroupCommand_base {
 }

package/dist-types/commands/DeleteChannelPolicyCommand.d.ts

@@ -69,6 +69,18 @@ declare const DeleteChannelPolicyCommand_base: {
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
  *
  * @public
+ * @example Deleting a Channel Policy
+ * ```javascript
+ * //
+ * const input = {
+ *   "ChannelGroupName": "exampleChannelGroup",
+ *   "ChannelName": "exampleChannel"
+ * };
+ * const command = new DeleteChannelPolicyCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class DeleteChannelPolicyCommand extends DeleteChannelPolicyCommand_base {
 }

package/dist-types/commands/DeleteOriginEndpointCommand.d.ts

@@ -67,6 +67,19 @@ declare const DeleteOriginEndpointCommand_base: {
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
  *
  * @public
+ * @example Deleting an OriginEndpoint
+ * ```javascript
+ * //
+ * const input = {
+ *   "ChannelGroupName": "exampleChannelGroup",
+ *   "ChannelName": "exampleChannel",
+ *   "OriginEndpointName": "exampleOriginEndpointTS"
+ * };
+ * const command = new DeleteOriginEndpointCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class DeleteOriginEndpointCommand extends DeleteOriginEndpointCommand_base {
 }

package/dist-types/commands/DeleteOriginEndpointPolicyCommand.d.ts

@@ -70,6 +70,19 @@ declare const DeleteOriginEndpointPolicyCommand_base: {
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
  *
  * @public
+ * @example Deleting an Origin Endpoint Policy
+ * ```javascript
+ * //
+ * const input = {
+ *   "ChannelGroupName": "exampleChannelGroup",
+ *   "ChannelName": "exampleChannel",
+ *   "OriginEndpointName": "exampleOriginEndpoint"
+ * };
+ * const command = new DeleteOriginEndpointPolicyCommand(input);
+ * await client.send(command);
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class DeleteOriginEndpointPolicyCommand extends DeleteOriginEndpointPolicyCommand_base {
 }

package/dist-types/commands/GetChannelCommand.d.ts

@@ -53,6 +53,7 @@ declare const GetChannelCommand_base: {
  * //       Url: "STRING_VALUE",
  * //     },
  * //   ],
+ * //   InputType: "HLS" || "CMAF",
  * //   ETag: "STRING_VALUE",
  * //   Tags: { // TagMap
  * //     "<keys>": "STRING_VALUE",
@@ -86,6 +87,44 @@ declare const GetChannelCommand_base: {
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
  *
  * @public
+ * @example Getting a Channel
+ * ```javascript
+ * //
+ * const input = {
+ *   "ChannelGroupName": "exampleChannelGroup",
+ *   "ChannelName": "exampleChannel"
+ * };
+ * const command = new GetChannelCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel",
+ *   "ChannelGroupName": "exampleChannelGroup",
+ *   "ChannelName": "exampleChannel",
+ *   "CreatedAt": "2022-10-18T09:36:00.00Z",
+ *   "Description": "Description for exampleChannel",
+ *   "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=",
+ *   "IngestEndpoints": [
+ *     {
+ *       "Id": "1",
+ *       "Url": "https://abcde-1.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index"
+ *     },
+ *     {
+ *       "Id": "2",
+ *       "Url": "https://abcde-2.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index"
+ *     }
+ *   ],
+ *   "InputType": "HLS",
+ *   "ModifiedAt": "2022-10-18T09:36:00.00Z",
+ *   "Tags": {
+ *     "key1": "value1",
+ *     "key2": "value2"
+ *   }
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class GetChannelCommand extends GetChannelCommand_base {
 }

package/dist-types/commands/GetChannelGroupCommand.d.ts

@@ -79,6 +79,32 @@ declare const GetChannelGroupCommand_base: {
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
  *
  * @public
+ * @example Getting a Channel Group
+ * ```javascript
+ * //
+ * const input = {
+ *   "ChannelGroupName": "exampleChannelGroup"
+ * };
+ * const command = new GetChannelGroupCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup",
+ *   "ChannelGroupName": "exampleChannelGroup",
+ *   "CreatedAt": "2022-10-18T09:36:00.00Z",
+ *   "Description": "Description for exampleChannelGroup",
+ *   "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=",
+ *   "EgressDomain": "abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com",
+ *   "ModifiedAt": "2022-10-18T09:36:00.00Z",
+ *   "Tags": {
+ *     "key1": "value1",
+ *     "key2": "value2"
+ *   }
+ * }
+ * *\/
+ * // example id: example-1
+ * ```
+ *
  */
 export declare class GetChannelGroupCommand extends GetChannelGroupCommand_base {
 }