@aws-sdk/client-mediapackagev2 3.597.0 → 3.598.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/dist-types/commands/CreateChannelCommand.d.ts +44 -0
  2. package/dist-types/commands/CreateChannelGroupCommand.d.ts +31 -0
  3. package/dist-types/commands/CreateOriginEndpointCommand.d.ts +472 -0
  4. package/dist-types/commands/DeleteChannelCommand.d.ts +12 -0
  5. package/dist-types/commands/DeleteChannelGroupCommand.d.ts +11 -0
  6. package/dist-types/commands/DeleteChannelPolicyCommand.d.ts +12 -0
  7. package/dist-types/commands/DeleteOriginEndpointCommand.d.ts +13 -0
  8. package/dist-types/commands/DeleteOriginEndpointPolicyCommand.d.ts +13 -0
  9. package/dist-types/commands/GetChannelCommand.d.ts +38 -0
  10. package/dist-types/commands/GetChannelGroupCommand.d.ts +26 -0
  11. package/dist-types/commands/GetChannelPolicyCommand.d.ts +19 -0
  12. package/dist-types/commands/GetOriginEndpointCommand.d.ts +115 -0
  13. package/dist-types/commands/GetOriginEndpointPolicyCommand.d.ts +21 -0
  14. package/dist-types/commands/ListChannelGroupsCommand.d.ts +28 -0
  15. package/dist-types/commands/ListChannelsCommand.d.ts +32 -0
  16. package/dist-types/commands/ListOriginEndpointsCommand.d.ts +111 -0
  17. package/dist-types/commands/ListTagsForResourceCommand.d.ts +19 -0
  18. package/dist-types/commands/PutChannelPolicyCommand.d.ts +13 -0
  19. package/dist-types/commands/PutOriginEndpointPolicyCommand.d.ts +14 -0
  20. package/dist-types/commands/TagResourceCommand.d.ts +15 -0
  21. package/dist-types/commands/UntagResourceCommand.d.ts +15 -0
  22. package/dist-types/commands/UpdateChannelCommand.d.ts +39 -0
  23. package/dist-types/commands/UpdateChannelGroupCommand.d.ts +27 -0
  24. package/dist-types/commands/UpdateOriginEndpointCommand.d.ts +196 -0
  25. package/package.json +37 -37
@@ -87,6 +87,44 @@ declare const GetChannelCommand_base: {
87
87
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
88
88
  *
89
89
  * @public
90
+ * @example Getting a Channel
91
+ * ```javascript
92
+ * //
93
+ * const input = {
94
+ * "ChannelGroupName": "exampleChannelGroup",
95
+ * "ChannelName": "exampleChannel"
96
+ * };
97
+ * const command = new GetChannelCommand(input);
98
+ * const response = await client.send(command);
99
+ * /* response ==
100
+ * {
101
+ * "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel",
102
+ * "ChannelGroupName": "exampleChannelGroup",
103
+ * "ChannelName": "exampleChannel",
104
+ * "CreatedAt": "2022-10-18T09:36:00.00Z",
105
+ * "Description": "Description for exampleChannel",
106
+ * "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=",
107
+ * "IngestEndpoints": [
108
+ * {
109
+ * "Id": "1",
110
+ * "Url": "https://abcde-1.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index"
111
+ * },
112
+ * {
113
+ * "Id": "2",
114
+ * "Url": "https://abcde-2.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index"
115
+ * }
116
+ * ],
117
+ * "InputType": "HLS",
118
+ * "ModifiedAt": "2022-10-18T09:36:00.00Z",
119
+ * "Tags": {
120
+ * "key1": "value1",
121
+ * "key2": "value2"
122
+ * }
123
+ * }
124
+ * *\/
125
+ * // example id: example-1
126
+ * ```
127
+ *
90
128
  */
91
129
  export declare class GetChannelCommand extends GetChannelCommand_base {
92
130
  }
@@ -79,6 +79,32 @@ declare const GetChannelGroupCommand_base: {
79
79
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
80
80
  *
81
81
  * @public
82
+ * @example Getting a Channel Group
83
+ * ```javascript
84
+ * //
85
+ * const input = {
86
+ * "ChannelGroupName": "exampleChannelGroup"
87
+ * };
88
+ * const command = new GetChannelGroupCommand(input);
89
+ * const response = await client.send(command);
90
+ * /* response ==
91
+ * {
92
+ * "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup",
93
+ * "ChannelGroupName": "exampleChannelGroup",
94
+ * "CreatedAt": "2022-10-18T09:36:00.00Z",
95
+ * "Description": "Description for exampleChannelGroup",
96
+ * "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=",
97
+ * "EgressDomain": "abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com",
98
+ * "ModifiedAt": "2022-10-18T09:36:00.00Z",
99
+ * "Tags": {
100
+ * "key1": "value1",
101
+ * "key2": "value2"
102
+ * }
103
+ * }
104
+ * *\/
105
+ * // example id: example-1
106
+ * ```
107
+ *
82
108
  */
83
109
  export declare class GetChannelGroupCommand extends GetChannelGroupCommand_base {
84
110
  }
@@ -73,6 +73,25 @@ declare const GetChannelPolicyCommand_base: {
73
73
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
74
74
  *
75
75
  * @public
76
+ * @example Getting a Channel Policy
77
+ * ```javascript
78
+ * //
79
+ * const input = {
80
+ * "ChannelGroupName": "exampleChannelGroup",
81
+ * "ChannelName": "exampleChannel"
82
+ * };
83
+ * const command = new GetChannelPolicyCommand(input);
84
+ * const response = await client.send(command);
85
+ * /* response ==
86
+ * {
87
+ * "ChannelGroupName": "exampleChannelGroup",
88
+ * "ChannelName": "exampleChannel",
89
+ * "Policy": "{...}"
90
+ * }
91
+ * *\/
92
+ * // example id: example-1
93
+ * ```
94
+ *
76
95
  */
77
96
  export declare class GetChannelPolicyCommand extends GetChannelPolicyCommand_base {
78
97
  }
@@ -185,6 +185,121 @@ declare const GetOriginEndpointCommand_base: {
185
185
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
186
186
  *
187
187
  * @public
188
+ * @example Getting an OriginEndpoint
189
+ * ```javascript
190
+ * //
191
+ * const input = {
192
+ * "ChannelGroupName": "exampleChannelGroup",
193
+ * "ChannelName": "exampleChannel",
194
+ * "OriginEndpointName": "exampleOriginEndpointTS"
195
+ * };
196
+ * const command = new GetOriginEndpointCommand(input);
197
+ * const response = await client.send(command);
198
+ * /* response ==
199
+ * {
200
+ * "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel/originEndpoint/exampleOriginEndpointTS",
201
+ * "ChannelGroupName": "exampleChannelGroup",
202
+ * "ChannelName": "exampleChannel",
203
+ * "ContainerType": "TS",
204
+ * "CreatedAt": "2022-10-18T09:36:00.00Z",
205
+ * "Description": "Description for exampleOriginEndpointTS",
206
+ * "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=",
207
+ * "ForceEndpointErrorConfiguration": {
208
+ * "EndpointErrorConditions": [
209
+ * "STALE_MANIFEST",
210
+ * "INCOMPLETE_MANIFEST",
211
+ * "MISSING_DRM_KEY",
212
+ * "SLATE_INPUT"
213
+ * ]
214
+ * },
215
+ * "HlsManifests": [
216
+ * {
217
+ * "ChildManifestName": "exampleChildManifest1",
218
+ * "ManifestName": "exampleManifest1",
219
+ * "ManifestWindowSeconds": 30,
220
+ * "ProgramDateTimeIntervalSeconds": 60,
221
+ * "ScteHls": {
222
+ * "AdMarkerHls": "DATERANGE"
223
+ * },
224
+ * "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleManifest1.m3u8"
225
+ * },
226
+ * {
227
+ * "ChildManifestName": "exampleManifest2",
228
+ * "ManifestName": "exampleManifest2",
229
+ * "ManifestWindowSeconds": 30,
230
+ * "ProgramDateTimeIntervalSeconds": 60,
231
+ * "ScteHls": {
232
+ * "AdMarkerHls": "DATERANGE"
233
+ * },
234
+ * "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleManifest2.m3u8"
235
+ * }
236
+ * ],
237
+ * "LowLatencyHlsManifests": [
238
+ * {
239
+ * "ChildManifestName": "exampleLLChildManifest1",
240
+ * "ManifestName": "exampleLLManifest1",
241
+ * "ManifestWindowSeconds": 30,
242
+ * "ProgramDateTimeIntervalSeconds": 60,
243
+ * "ScteHls": {
244
+ * "AdMarkerHls": "DATERANGE"
245
+ * },
246
+ * "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest1.m3u8"
247
+ * },
248
+ * {
249
+ * "ChildManifestName": "exampleLLManifest2",
250
+ * "ManifestName": "exampleLLManifest2",
251
+ * "ManifestWindowSeconds": 30,
252
+ * "ProgramDateTimeIntervalSeconds": 60,
253
+ * "ScteHls": {
254
+ * "AdMarkerHls": "DATERANGE"
255
+ * },
256
+ * "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest2.m3u8"
257
+ * }
258
+ * ],
259
+ * "ModifiedAt": "2022-10-18T09:36:00.00Z",
260
+ * "OriginEndpointName": "exampleOriginEndpointTS",
261
+ * "Segment": {
262
+ * "Encryption": {
263
+ * "ConstantInitializationVector": "A382A901F3C1F7718512266CFFBB0B7E",
264
+ * "EncryptionMethod": {
265
+ * "TsEncryptionMethod": "AES_128"
266
+ * },
267
+ * "KeyRotationIntervalSeconds": 300,
268
+ * "SpekeKeyProvider": {
269
+ * "DrmSystems": [
270
+ * "CLEAR_KEY_AES_128"
271
+ * ],
272
+ * "EncryptionContractConfiguration": {
273
+ * "PresetSpeke20Audio": "SHARED",
274
+ * "PresetSpeke20Video": "SHARED"
275
+ * },
276
+ * "ResourceId": "ResourceId",
277
+ * "RoleArn": "arn:aws:iam::123456789012:role/empRole",
278
+ * "Url": "https://foo.com"
279
+ * }
280
+ * },
281
+ * "IncludeIframeOnlyStreams": true,
282
+ * "Scte": {
283
+ * "ScteFilter": [
284
+ * "SPLICE_INSERT",
285
+ * "BREAK"
286
+ * ]
287
+ * },
288
+ * "SegmentDurationSeconds": 6,
289
+ * "SegmentName": "segmentName",
290
+ * "TsIncludeDvbSubtitles": true,
291
+ * "TsUseAudioRenditionGroup": true
292
+ * },
293
+ * "StartoverWindowSeconds": 300,
294
+ * "Tags": {
295
+ * "key1": "value1",
296
+ * "key2": "value2"
297
+ * }
298
+ * }
299
+ * *\/
300
+ * // example id: example-1
301
+ * ```
302
+ *
188
303
  */
189
304
  export declare class GetOriginEndpointCommand extends GetOriginEndpointCommand_base {
190
305
  }
@@ -75,6 +75,27 @@ declare const GetOriginEndpointPolicyCommand_base: {
75
75
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
76
76
  *
77
77
  * @public
78
+ * @example Getting an Origin Endpoint Policy
79
+ * ```javascript
80
+ * //
81
+ * const input = {
82
+ * "ChannelGroupName": "exampleChannelGroup",
83
+ * "ChannelName": "exampleChannel",
84
+ * "OriginEndpointName": "exampleOriginEndpoint"
85
+ * };
86
+ * const command = new GetOriginEndpointPolicyCommand(input);
87
+ * const response = await client.send(command);
88
+ * /* response ==
89
+ * {
90
+ * "ChannelGroupName": "exampleChannelGroup",
91
+ * "ChannelName": "exampleChannel",
92
+ * "OriginEndpointName": "exampleOriginEndpoint",
93
+ * "Policy": "{...}"
94
+ * }
95
+ * *\/
96
+ * // example id: example-1
97
+ * ```
98
+ *
78
99
  */
79
100
  export declare class GetOriginEndpointPolicyCommand extends GetOriginEndpointPolicyCommand_base {
80
101
  }
@@ -77,6 +77,34 @@ declare const ListChannelGroupsCommand_base: {
77
77
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
78
78
  *
79
79
  * @public
80
+ * @example Listing all Channel Groups
81
+ * ```javascript
82
+ * //
83
+ * const input = {};
84
+ * const command = new ListChannelGroupsCommand(input);
85
+ * const response = await client.send(command);
86
+ * /* response ==
87
+ * {
88
+ * "Items": [
89
+ * {
90
+ * "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup",
91
+ * "ChannelGroupName": "exampleChannelGroup",
92
+ * "CreatedAt": "2022-10-18T09:36:00.00Z",
93
+ * "Description": "Description for exampleChannelGroup",
94
+ * "ModifiedAt": "2022-10-18T09:36:00.00Z"
95
+ * },
96
+ * {
97
+ * "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/anotherExampleChannelGroup",
98
+ * "ChannelGroupName": "anotherExampleChannelGroup",
99
+ * "CreatedAt": "2022-10-18T10:36:00.00Z",
100
+ * "ModifiedAt": "2022-10-18T10:36:00.00Z"
101
+ * }
102
+ * ]
103
+ * }
104
+ * *\/
105
+ * // example id: example-1
106
+ * ```
107
+ *
80
108
  */
81
109
  export declare class ListChannelGroupsCommand extends ListChannelGroupsCommand_base {
82
110
  }
@@ -83,6 +83,38 @@ declare const ListChannelsCommand_base: {
83
83
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
84
84
  *
85
85
  * @public
86
+ * @example Listing all Channels
87
+ * ```javascript
88
+ * //
89
+ * const input = {
90
+ * "ChannelGroupName": "exampleChannelGroup"
91
+ * };
92
+ * const command = new ListChannelsCommand(input);
93
+ * const response = await client.send(command);
94
+ * /* response ==
95
+ * {
96
+ * "Items": [
97
+ * {
98
+ * "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel",
99
+ * "ChannelGroupName": "exampleChannelGroup",
100
+ * "ChannelName": "exampleChannel",
101
+ * "CreatedAt": "2022-10-18T09:36:00.00Z",
102
+ * "Description": "Description for exampleChannel",
103
+ * "ModifiedAt": "2022-10-18T09:36:00.00Z"
104
+ * },
105
+ * {
106
+ * "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/anotherExampleChannel",
107
+ * "ChannelGroupName": "exampleChannelGroup",
108
+ * "ChannelName": "anotherExampleChannel",
109
+ * "CreatedAt": "2022-10-18T10:36:00.00Z",
110
+ * "ModifiedAt": "2022-10-18T10:36:00.00Z"
111
+ * }
112
+ * ]
113
+ * }
114
+ * *\/
115
+ * // example id: example-1
116
+ * ```
117
+ *
86
118
  */
87
119
  export declare class ListChannelsCommand extends ListChannelsCommand_base {
88
120
  }
@@ -110,6 +110,117 @@ declare const ListOriginEndpointsCommand_base: {
110
110
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
111
111
  *
112
112
  * @public
113
+ * @example Listing all OriginEndpoints
114
+ * ```javascript
115
+ * //
116
+ * const input = {
117
+ * "ChannelGroupName": "exampleChannelGroup",
118
+ * "ChannelName": "exampleChannel"
119
+ * };
120
+ * const command = new ListOriginEndpointsCommand(input);
121
+ * const response = await client.send(command);
122
+ * /* response ==
123
+ * {
124
+ * "Items": [
125
+ * {
126
+ * "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel/originEndpoint/exampleOriginEndpointTS",
127
+ * "ChannelGroupName": "exampleChannelGroup",
128
+ * "ChannelName": "exampleChannel",
129
+ * "ContainerType": "TS",
130
+ * "CreatedAt": "2022-10-18T09:36:00.00Z",
131
+ * "Description": "Description for exampleOriginEndpointTS",
132
+ * "ForceEndpointErrorConfiguration": {
133
+ * "EndpointErrorConditions": [
134
+ * "STALE_MANIFEST",
135
+ * "INCOMPLETE_MANIFEST",
136
+ * "MISSING_DRM_KEY",
137
+ * "SLATE_INPUT"
138
+ * ]
139
+ * },
140
+ * "HlsManifests": [
141
+ * {
142
+ * "ChildManifestName": "exampleChildManifest1",
143
+ * "ManifestName": "exampleManifest1",
144
+ * "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleManifest1.m3u8"
145
+ * },
146
+ * {
147
+ * "ChildManifestName": "exampleManifest2",
148
+ * "ManifestName": "exampleManifest2",
149
+ * "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleManifest2.m3u8"
150
+ * }
151
+ * ],
152
+ * "LowLatencyHlsManifests": [
153
+ * {
154
+ * "ChildManifestName": "exampleLLChildManifest1",
155
+ * "ManifestName": "exampleLLManifest1",
156
+ * "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest1.m3u8"
157
+ * },
158
+ * {
159
+ * "ChildManifestName": "exampleLLManifest2",
160
+ * "ManifestName": "exampleLLManifest2",
161
+ * "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointTS/exampleLLManifest2.m3u8"
162
+ * }
163
+ * ],
164
+ * "ModifiedAt": "2022-10-18T09:36:00.00Z",
165
+ * "OriginEndpointName": "exampleOriginEndpointTS"
166
+ * },
167
+ * {
168
+ * "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel/originEndpoint/exampleOriginEndpointCMAF",
169
+ * "ChannelGroupName": "exampleChannelGroup",
170
+ * "ChannelName": "exampleChannel",
171
+ * "ContainerType": "CMAF",
172
+ * "CreatedAt": "2022-10-18T09:36:00.00Z",
173
+ * "DashManifests": [
174
+ * {
175
+ * "ManifestName": "exampleDashManifest1",
176
+ * "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest1.mpd"
177
+ * },
178
+ * {
179
+ * "ManifestName": "exampleDashManifest2",
180
+ * "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleDashManifest2.mpd"
181
+ * }
182
+ * ],
183
+ * "ForceEndpointErrorConfiguration": {
184
+ * "EndpointErrorConditions": [
185
+ * "STALE_MANIFEST",
186
+ * "INCOMPLETE_MANIFEST",
187
+ * "MISSING_DRM_KEY",
188
+ * "SLATE_INPUT"
189
+ * ]
190
+ * },
191
+ * "HlsManifests": [
192
+ * {
193
+ * "ChildManifestName": "exampleChildManifest1",
194
+ * "ManifestName": "exampleManifest1",
195
+ * "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleManifest1.m3u8"
196
+ * },
197
+ * {
198
+ * "ChildManifestName": "exampleManifest2",
199
+ * "ManifestName": "exampleManifest2",
200
+ * "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleManifest2.m3u8"
201
+ * }
202
+ * ],
203
+ * "LowLatencyHlsManifests": [
204
+ * {
205
+ * "ChildManifestName": "exampleLLChildManifest1",
206
+ * "ManifestName": "exampleLLManifest1",
207
+ * "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleLLManifest1.m3u8"
208
+ * },
209
+ * {
210
+ * "ChildManifestName": "exampleLLManifest2",
211
+ * "ManifestName": "exampleLLManifest2",
212
+ * "Url": "https://abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com/out/v1/exampleChannelGroup/exampleChannel/exampleOriginEndpointCMAF/exampleLLManifest2.m3u8"
213
+ * }
214
+ * ],
215
+ * "ModifiedAt": "2022-10-18T09:36:00.00Z",
216
+ * "OriginEndpointName": "exampleOriginEndpointCMAF"
217
+ * }
218
+ * ]
219
+ * }
220
+ * *\/
221
+ * // example id: example-1
222
+ * ```
223
+ *
113
224
  */
114
225
  export declare class ListOriginEndpointsCommand extends ListOriginEndpointsCommand_base {
115
226
  }
@@ -60,6 +60,25 @@ declare const ListTagsForResourceCommand_base: {
60
60
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
61
61
  *
62
62
  * @public
63
+ * @example List all tags for a resource
64
+ * ```javascript
65
+ * //
66
+ * const input = {
67
+ * "ResourceArn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel"
68
+ * };
69
+ * const command = new ListTagsForResourceCommand(input);
70
+ * const response = await client.send(command);
71
+ * /* response ==
72
+ * {
73
+ * "Tags": {
74
+ * "key1": "value1",
75
+ * "key2": "value2"
76
+ * }
77
+ * }
78
+ * *\/
79
+ * // example id: example-1
80
+ * ```
81
+ *
63
82
  */
64
83
  export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
65
84
  }
@@ -73,6 +73,19 @@ declare const PutChannelPolicyCommand_base: {
73
73
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
74
74
  *
75
75
  * @public
76
+ * @example Creating a Channel Policy
77
+ * ```javascript
78
+ * //
79
+ * const input = {
80
+ * "ChannelGroupName": "exampleChannelGroup",
81
+ * "ChannelName": "exampleChannel",
82
+ * "Policy": "{...}"
83
+ * };
84
+ * const command = new PutChannelPolicyCommand(input);
85
+ * await client.send(command);
86
+ * // example id: example-1
87
+ * ```
88
+ *
76
89
  */
77
90
  export declare class PutChannelPolicyCommand extends PutChannelPolicyCommand_base {
78
91
  }
@@ -74,6 +74,20 @@ declare const PutOriginEndpointPolicyCommand_base: {
74
74
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
75
75
  *
76
76
  * @public
77
+ * @example Creating an Origin Endpoint Policy
78
+ * ```javascript
79
+ * //
80
+ * const input = {
81
+ * "ChannelGroupName": "exampleChannelGroup",
82
+ * "ChannelName": "exampleChannel",
83
+ * "OriginEndpointName": "exampleOriginEndpoint",
84
+ * "Policy": "{...}"
85
+ * };
86
+ * const command = new PutOriginEndpointPolicyCommand(input);
87
+ * await client.send(command);
88
+ * // example id: example-1
89
+ * ```
90
+ *
77
91
  */
78
92
  export declare class PutOriginEndpointPolicyCommand extends PutOriginEndpointPolicyCommand_base {
79
93
  }
@@ -64,6 +64,21 @@ declare const TagResourceCommand_base: {
64
64
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
65
65
  *
66
66
  * @public
67
+ * @example Add tags to a resource
68
+ * ```javascript
69
+ * //
70
+ * const input = {
71
+ * "ResourceArn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel",
72
+ * "Tags": {
73
+ * "key3": "value3",
74
+ * "key4": "value4"
75
+ * }
76
+ * };
77
+ * const command = new TagResourceCommand(input);
78
+ * await client.send(command);
79
+ * // example id: example-1
80
+ * ```
81
+ *
67
82
  */
68
83
  export declare class TagResourceCommand extends TagResourceCommand_base {
69
84
  }
@@ -59,6 +59,21 @@ declare const UntagResourceCommand_base: {
59
59
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
60
60
  *
61
61
  * @public
62
+ * @example Remove tags from a resource
63
+ * ```javascript
64
+ * //
65
+ * const input = {
66
+ * "ResourceArn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel",
67
+ * "TagKeys": [
68
+ * "key3",
69
+ * "key4"
70
+ * ]
71
+ * };
72
+ * const command = new UntagResourceCommand(input);
73
+ * await client.send(command);
74
+ * // example id: example-1
75
+ * ```
76
+ *
62
77
  */
63
78
  export declare class UntagResourceCommand extends UntagResourceCommand_base {
64
79
  }
@@ -93,6 +93,45 @@ declare const UpdateChannelCommand_base: {
93
93
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
94
94
  *
95
95
  * @public
96
+ * @example Updating a Channel
97
+ * ```javascript
98
+ * //
99
+ * const input = {
100
+ * "ChannelGroupName": "exampleChannelGroup",
101
+ * "ChannelName": "exampleChannel",
102
+ * "Description": "Updated description for exampleChannel"
103
+ * };
104
+ * const command = new UpdateChannelCommand(input);
105
+ * const response = await client.send(command);
106
+ * /* response ==
107
+ * {
108
+ * "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel",
109
+ * "ChannelGroupName": "exampleChannelGroup",
110
+ * "ChannelName": "exampleChannel",
111
+ * "CreatedAt": "2022-10-18T09:36:00.00Z",
112
+ * "Description": "Updated description for exampleChannel",
113
+ * "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=",
114
+ * "IngestEndpoints": [
115
+ * {
116
+ * "Id": "1",
117
+ * "Url": "https://abcde-1.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index"
118
+ * },
119
+ * {
120
+ * "Id": "2",
121
+ * "Url": "https://abcde-2.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index"
122
+ * }
123
+ * ],
124
+ * "InputType": "HLS",
125
+ * "ModifiedAt": "2022-10-18T10:36:00.00Z",
126
+ * "Tags": {
127
+ * "key1": "value1",
128
+ * "key2": "value2"
129
+ * }
130
+ * }
131
+ * *\/
132
+ * // example id: example-1
133
+ * ```
134
+ *
96
135
  */
97
136
  export declare class UpdateChannelCommand extends UpdateChannelCommand_base {
98
137
  }
@@ -85,6 +85,33 @@ declare const UpdateChannelGroupCommand_base: {
85
85
  * <p>Base exception class for all service exceptions from MediaPackageV2 service.</p>
86
86
  *
87
87
  * @public
88
+ * @example Updating a Channel Group
89
+ * ```javascript
90
+ * //
91
+ * const input = {
92
+ * "ChannelGroupName": "exampleChannelGroup",
93
+ * "Description": "Updated description for exampleChannelGroup"
94
+ * };
95
+ * const command = new UpdateChannelGroupCommand(input);
96
+ * const response = await client.send(command);
97
+ * /* response ==
98
+ * {
99
+ * "Arn": "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup",
100
+ * "ChannelGroupName": "exampleChannelGroup",
101
+ * "CreatedAt": "2022-10-18T09:36:00.00Z",
102
+ * "Description": "Updated description for exampleChannelGroup",
103
+ * "ETag": "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=",
104
+ * "EgressDomain": "abcde.egress.vwxyz.mediapackagev2.us-west-2.amazonaws.com",
105
+ * "ModifiedAt": "2022-10-18T10:36:00.00Z",
106
+ * "Tags": {
107
+ * "key1": "value1",
108
+ * "key2": "value2"
109
+ * }
110
+ * }
111
+ * *\/
112
+ * // example id: example-1
113
+ * ```
114
+ *
88
115
  */
89
116
  export declare class UpdateChannelGroupCommand extends UpdateChannelGroupCommand_base {
90
117
  }