aws-sdk-mediapackagev2 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-mediapackagev2/client.rb +1846 -0
- data/lib/aws-sdk-mediapackagev2/client_api.rb +913 -0
- data/lib/aws-sdk-mediapackagev2/customizations.rb +0 -0
- data/lib/aws-sdk-mediapackagev2/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-mediapackagev2/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-mediapackagev2/endpoints.rb +351 -0
- data/lib/aws-sdk-mediapackagev2/errors.rb +165 -0
- data/lib/aws-sdk-mediapackagev2/plugins/endpoints.rb +116 -0
- data/lib/aws-sdk-mediapackagev2/resource.rb +26 -0
- data/lib/aws-sdk-mediapackagev2/types.rb +2291 -0
- data/lib/aws-sdk-mediapackagev2/waiters.rb +15 -0
- data/lib/aws-sdk-mediapackagev2.rb +58 -0
- metadata +95 -0
@@ -0,0 +1,2291 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::MediaPackageV2
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You don't have permissions to perform the requested operation. The
|
14
|
+
# user or role that is making the request must have at least one IAM
|
15
|
+
# permissions policy attached that grants the required permissions. For
|
16
|
+
# more information, see Access Management in the IAM User Guide.
|
17
|
+
#
|
18
|
+
# @!attribute [rw] message
|
19
|
+
# @return [String]
|
20
|
+
#
|
21
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/AccessDeniedException AWS API Documentation
|
22
|
+
#
|
23
|
+
class AccessDeniedException < Struct.new(
|
24
|
+
:message)
|
25
|
+
SENSITIVE = []
|
26
|
+
include Aws::Structure
|
27
|
+
end
|
28
|
+
|
29
|
+
# The configuration of the channel group.
|
30
|
+
#
|
31
|
+
# @!attribute [rw] channel_group_name
|
32
|
+
# The name that describes the channel group. The name is the primary
|
33
|
+
# identifier for the channel group, and must be unique for your
|
34
|
+
# account in the AWS Region.
|
35
|
+
# @return [String]
|
36
|
+
#
|
37
|
+
# @!attribute [rw] arn
|
38
|
+
# The Amazon Resource Name (ARN) associated with the resource.
|
39
|
+
# @return [String]
|
40
|
+
#
|
41
|
+
# @!attribute [rw] created_at
|
42
|
+
# The date and time the channel group was created.
|
43
|
+
# @return [Time]
|
44
|
+
#
|
45
|
+
# @!attribute [rw] modified_at
|
46
|
+
# The date and time the channel group was modified.
|
47
|
+
# @return [Time]
|
48
|
+
#
|
49
|
+
# @!attribute [rw] description
|
50
|
+
# Any descriptive information that you want to add to the channel
|
51
|
+
# group for future identification purposes.
|
52
|
+
# @return [String]
|
53
|
+
#
|
54
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ChannelGroupListConfiguration AWS API Documentation
|
55
|
+
#
|
56
|
+
class ChannelGroupListConfiguration < Struct.new(
|
57
|
+
:channel_group_name,
|
58
|
+
:arn,
|
59
|
+
:created_at,
|
60
|
+
:modified_at,
|
61
|
+
:description)
|
62
|
+
SENSITIVE = []
|
63
|
+
include Aws::Structure
|
64
|
+
end
|
65
|
+
|
66
|
+
# The configuration of the channel.
|
67
|
+
#
|
68
|
+
# @!attribute [rw] arn
|
69
|
+
# The Amazon Resource Name (ARN) associated with the resource.
|
70
|
+
# @return [String]
|
71
|
+
#
|
72
|
+
# @!attribute [rw] channel_name
|
73
|
+
# The name that describes the channel. The name is the primary
|
74
|
+
# identifier for the channel, and must be unique for your account in
|
75
|
+
# the AWS Region and channel group.
|
76
|
+
# @return [String]
|
77
|
+
#
|
78
|
+
# @!attribute [rw] channel_group_name
|
79
|
+
# The name that describes the channel group. The name is the primary
|
80
|
+
# identifier for the channel group, and must be unique for your
|
81
|
+
# account in the AWS Region.
|
82
|
+
# @return [String]
|
83
|
+
#
|
84
|
+
# @!attribute [rw] created_at
|
85
|
+
# The date and time the channel was created.
|
86
|
+
# @return [Time]
|
87
|
+
#
|
88
|
+
# @!attribute [rw] modified_at
|
89
|
+
# The date and time the channel was modified.
|
90
|
+
# @return [Time]
|
91
|
+
#
|
92
|
+
# @!attribute [rw] description
|
93
|
+
# Any descriptive information that you want to add to the channel for
|
94
|
+
# future identification purposes.
|
95
|
+
# @return [String]
|
96
|
+
#
|
97
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ChannelListConfiguration AWS API Documentation
|
98
|
+
#
|
99
|
+
class ChannelListConfiguration < Struct.new(
|
100
|
+
:arn,
|
101
|
+
:channel_name,
|
102
|
+
:channel_group_name,
|
103
|
+
:created_at,
|
104
|
+
:modified_at,
|
105
|
+
:description)
|
106
|
+
SENSITIVE = []
|
107
|
+
include Aws::Structure
|
108
|
+
end
|
109
|
+
|
110
|
+
# Updating or deleting this resource can cause an inconsistent state.
|
111
|
+
#
|
112
|
+
# @!attribute [rw] message
|
113
|
+
# @return [String]
|
114
|
+
#
|
115
|
+
# @!attribute [rw] conflict_exception_type
|
116
|
+
# The type of ConflictException.
|
117
|
+
# @return [String]
|
118
|
+
#
|
119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ConflictException AWS API Documentation
|
120
|
+
#
|
121
|
+
class ConflictException < Struct.new(
|
122
|
+
:message,
|
123
|
+
:conflict_exception_type)
|
124
|
+
SENSITIVE = []
|
125
|
+
include Aws::Structure
|
126
|
+
end
|
127
|
+
|
128
|
+
# @!attribute [rw] channel_group_name
|
129
|
+
# The name that describes the channel group. The name is the primary
|
130
|
+
# identifier for the channel group, and must be unique for your
|
131
|
+
# account in the AWS Region. You can't use spaces in the name. You
|
132
|
+
# can't change the name after you create the channel group.
|
133
|
+
# @return [String]
|
134
|
+
#
|
135
|
+
# @!attribute [rw] client_token
|
136
|
+
# A unique, case-sensitive token that you provide to ensure the
|
137
|
+
# idempotency of the request.
|
138
|
+
#
|
139
|
+
# **A suitable default value is auto-generated.** You should normally
|
140
|
+
# not need to pass this option.
|
141
|
+
# @return [String]
|
142
|
+
#
|
143
|
+
# @!attribute [rw] description
|
144
|
+
# Enter any descriptive text that helps you to identify the channel
|
145
|
+
# group.
|
146
|
+
# @return [String]
|
147
|
+
#
|
148
|
+
# @!attribute [rw] tags
|
149
|
+
# A comma-separated list of tag key:value pairs that you define. For
|
150
|
+
# example:
|
151
|
+
#
|
152
|
+
# `"Key1": "Value1",`
|
153
|
+
#
|
154
|
+
# `"Key2": "Value2"`
|
155
|
+
# @return [Hash<String,String>]
|
156
|
+
#
|
157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/CreateChannelGroupRequest AWS API Documentation
|
158
|
+
#
|
159
|
+
class CreateChannelGroupRequest < Struct.new(
|
160
|
+
:channel_group_name,
|
161
|
+
:client_token,
|
162
|
+
:description,
|
163
|
+
:tags)
|
164
|
+
SENSITIVE = []
|
165
|
+
include Aws::Structure
|
166
|
+
end
|
167
|
+
|
168
|
+
# @!attribute [rw] channel_group_name
|
169
|
+
# The name that describes the channel group. The name is the primary
|
170
|
+
# identifier for the channel group, and must be unique for your
|
171
|
+
# account in the AWS Region.
|
172
|
+
# @return [String]
|
173
|
+
#
|
174
|
+
# @!attribute [rw] arn
|
175
|
+
# The Amazon Resource Name (ARN) associated with the resource.
|
176
|
+
# @return [String]
|
177
|
+
#
|
178
|
+
# @!attribute [rw] egress_domain
|
179
|
+
# The output domain where the source stream should be sent. Integrate
|
180
|
+
# the egress domain with a downstream CDN (such as Amazon CloudFront)
|
181
|
+
# or playback device.
|
182
|
+
# @return [String]
|
183
|
+
#
|
184
|
+
# @!attribute [rw] created_at
|
185
|
+
# The date and time the channel group was created.
|
186
|
+
# @return [Time]
|
187
|
+
#
|
188
|
+
# @!attribute [rw] modified_at
|
189
|
+
# The date and time the channel group was modified.
|
190
|
+
# @return [Time]
|
191
|
+
#
|
192
|
+
# @!attribute [rw] description
|
193
|
+
# The description for your channel group.
|
194
|
+
# @return [String]
|
195
|
+
#
|
196
|
+
# @!attribute [rw] tags
|
197
|
+
# The comma-separated list of tag key:value pairs assigned to the
|
198
|
+
# channel group.
|
199
|
+
# @return [Hash<String,String>]
|
200
|
+
#
|
201
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/CreateChannelGroupResponse AWS API Documentation
|
202
|
+
#
|
203
|
+
class CreateChannelGroupResponse < Struct.new(
|
204
|
+
:channel_group_name,
|
205
|
+
:arn,
|
206
|
+
:egress_domain,
|
207
|
+
:created_at,
|
208
|
+
:modified_at,
|
209
|
+
:description,
|
210
|
+
:tags)
|
211
|
+
SENSITIVE = []
|
212
|
+
include Aws::Structure
|
213
|
+
end
|
214
|
+
|
215
|
+
# @!attribute [rw] channel_group_name
|
216
|
+
# The name that describes the channel group. The name is the primary
|
217
|
+
# identifier for the channel group, and must be unique for your
|
218
|
+
# account in the AWS Region.
|
219
|
+
# @return [String]
|
220
|
+
#
|
221
|
+
# @!attribute [rw] channel_name
|
222
|
+
# The name that describes the channel. The name is the primary
|
223
|
+
# identifier for the channel, and must be unique for your account in
|
224
|
+
# the AWS Region and channel group. You can't change the name after
|
225
|
+
# you create the channel.
|
226
|
+
# @return [String]
|
227
|
+
#
|
228
|
+
# @!attribute [rw] client_token
|
229
|
+
# A unique, case-sensitive token that you provide to ensure the
|
230
|
+
# idempotency of the request.
|
231
|
+
#
|
232
|
+
# **A suitable default value is auto-generated.** You should normally
|
233
|
+
# not need to pass this option.
|
234
|
+
# @return [String]
|
235
|
+
#
|
236
|
+
# @!attribute [rw] description
|
237
|
+
# Enter any descriptive text that helps you to identify the channel.
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @!attribute [rw] tags
|
241
|
+
# A comma-separated list of tag key:value pairs that you define. For
|
242
|
+
# example:
|
243
|
+
#
|
244
|
+
# `"Key1": "Value1",`
|
245
|
+
#
|
246
|
+
# `"Key2": "Value2"`
|
247
|
+
# @return [Hash<String,String>]
|
248
|
+
#
|
249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/CreateChannelRequest AWS API Documentation
|
250
|
+
#
|
251
|
+
class CreateChannelRequest < Struct.new(
|
252
|
+
:channel_group_name,
|
253
|
+
:channel_name,
|
254
|
+
:client_token,
|
255
|
+
:description,
|
256
|
+
:tags)
|
257
|
+
SENSITIVE = []
|
258
|
+
include Aws::Structure
|
259
|
+
end
|
260
|
+
|
261
|
+
# @!attribute [rw] arn
|
262
|
+
# The Amazon Resource Name (ARN) associated with the resource.
|
263
|
+
# @return [String]
|
264
|
+
#
|
265
|
+
# @!attribute [rw] channel_name
|
266
|
+
# The name that describes the channel. The name is the primary
|
267
|
+
# identifier for the channel, and must be unique for your account in
|
268
|
+
# the AWS Region and channel group.
|
269
|
+
# @return [String]
|
270
|
+
#
|
271
|
+
# @!attribute [rw] channel_group_name
|
272
|
+
# The name that describes the channel group. The name is the primary
|
273
|
+
# identifier for the channel group, and must be unique for your
|
274
|
+
# account in the AWS Region.
|
275
|
+
# @return [String]
|
276
|
+
#
|
277
|
+
# @!attribute [rw] created_at
|
278
|
+
# The date and time the channel was created.
|
279
|
+
# @return [Time]
|
280
|
+
#
|
281
|
+
# @!attribute [rw] modified_at
|
282
|
+
# The date and time the channel was modified.
|
283
|
+
# @return [Time]
|
284
|
+
#
|
285
|
+
# @!attribute [rw] description
|
286
|
+
# The description for your channel.
|
287
|
+
# @return [String]
|
288
|
+
#
|
289
|
+
# @!attribute [rw] ingest_endpoints
|
290
|
+
# The list of ingest endpoints.
|
291
|
+
# @return [Array<Types::IngestEndpoint>]
|
292
|
+
#
|
293
|
+
# @!attribute [rw] tags
|
294
|
+
# The comma-separated list of tag key:value pairs assigned to the
|
295
|
+
# channel.
|
296
|
+
# @return [Hash<String,String>]
|
297
|
+
#
|
298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/CreateChannelResponse AWS API Documentation
|
299
|
+
#
|
300
|
+
class CreateChannelResponse < Struct.new(
|
301
|
+
:arn,
|
302
|
+
:channel_name,
|
303
|
+
:channel_group_name,
|
304
|
+
:created_at,
|
305
|
+
:modified_at,
|
306
|
+
:description,
|
307
|
+
:ingest_endpoints,
|
308
|
+
:tags)
|
309
|
+
SENSITIVE = []
|
310
|
+
include Aws::Structure
|
311
|
+
end
|
312
|
+
|
313
|
+
# Create an HTTP live streaming (HLS) manifest configuration.
|
314
|
+
#
|
315
|
+
# @!attribute [rw] manifest_name
|
316
|
+
# A short short string that's appended to the endpoint URL. The
|
317
|
+
# manifest name creates a unique path to this endpoint. If you don't
|
318
|
+
# enter a value, MediaPackage uses the default manifest name, index.
|
319
|
+
# MediaPackage automatically inserts the format extension, such as
|
320
|
+
# .m3u8. You can't use the same manifest name if you use HLS manifest
|
321
|
+
# and low-latency HLS manifest. The manifestName on the HLSManifest
|
322
|
+
# object overrides the manifestName you provided on the originEndpoint
|
323
|
+
# object.
|
324
|
+
# @return [String]
|
325
|
+
#
|
326
|
+
# @!attribute [rw] child_manifest_name
|
327
|
+
# A short string that's appended to the endpoint URL. The child
|
328
|
+
# manifest name creates a unique path to this endpoint. If you don't
|
329
|
+
# enter a value, MediaPackage uses the default manifest name, index,
|
330
|
+
# with an added suffix to distinguish it from the manifest name. The
|
331
|
+
# manifestName on the HLSManifest object overrides the manifestName
|
332
|
+
# you provided on the originEndpoint object.
|
333
|
+
# @return [String]
|
334
|
+
#
|
335
|
+
# @!attribute [rw] scte_hls
|
336
|
+
# The SCTE configuration.
|
337
|
+
# @return [Types::ScteHls]
|
338
|
+
#
|
339
|
+
# @!attribute [rw] manifest_window_seconds
|
340
|
+
# The total duration (in seconds) of the manifest's content.
|
341
|
+
# @return [Integer]
|
342
|
+
#
|
343
|
+
# @!attribute [rw] program_date_time_interval_seconds
|
344
|
+
# Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the
|
345
|
+
# interval that you specify. If you don't enter an interval,
|
346
|
+
# EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The
|
347
|
+
# tags sync the stream to the wall clock so that viewers can seek to a
|
348
|
+
# specific time in the playback timeline on the player. ID3Timed
|
349
|
+
# metadata messages generate every 5 seconds whenever the content is
|
350
|
+
# ingested.
|
351
|
+
#
|
352
|
+
# Irrespective of this parameter, if any ID3Timed metadata is in the
|
353
|
+
# HLS input, it is passed through to the HLS output.
|
354
|
+
# @return [Integer]
|
355
|
+
#
|
356
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/CreateHlsManifestConfiguration AWS API Documentation
|
357
|
+
#
|
358
|
+
class CreateHlsManifestConfiguration < Struct.new(
|
359
|
+
:manifest_name,
|
360
|
+
:child_manifest_name,
|
361
|
+
:scte_hls,
|
362
|
+
:manifest_window_seconds,
|
363
|
+
:program_date_time_interval_seconds)
|
364
|
+
SENSITIVE = []
|
365
|
+
include Aws::Structure
|
366
|
+
end
|
367
|
+
|
368
|
+
# Create a low-latency HTTP live streaming (HLS) manifest configuration.
|
369
|
+
#
|
370
|
+
# @!attribute [rw] manifest_name
|
371
|
+
# A short short string that's appended to the endpoint URL. The
|
372
|
+
# manifest name creates a unique path to this endpoint. If you don't
|
373
|
+
# enter a value, MediaPackage uses the default manifest name, index.
|
374
|
+
# MediaPackage automatically inserts the format extension, such as
|
375
|
+
# .m3u8. You can't use the same manifest name if you use HLS manifest
|
376
|
+
# and low-latency HLS manifest. The manifestName on the HLSManifest
|
377
|
+
# object overrides the manifestName you provided on the originEndpoint
|
378
|
+
# object.
|
379
|
+
# @return [String]
|
380
|
+
#
|
381
|
+
# @!attribute [rw] child_manifest_name
|
382
|
+
# A short string that's appended to the endpoint URL. The child
|
383
|
+
# manifest name creates a unique path to this endpoint. If you don't
|
384
|
+
# enter a value, MediaPackage uses the default manifest name, index,
|
385
|
+
# with an added suffix to distinguish it from the manifest name. The
|
386
|
+
# manifestName on the HLSManifest object overrides the manifestName
|
387
|
+
# you provided on the originEndpoint object.
|
388
|
+
# @return [String]
|
389
|
+
#
|
390
|
+
# @!attribute [rw] scte_hls
|
391
|
+
# The SCTE configuration.
|
392
|
+
# @return [Types::ScteHls]
|
393
|
+
#
|
394
|
+
# @!attribute [rw] manifest_window_seconds
|
395
|
+
# The total duration (in seconds) of the manifest's content.
|
396
|
+
# @return [Integer]
|
397
|
+
#
|
398
|
+
# @!attribute [rw] program_date_time_interval_seconds
|
399
|
+
# Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the
|
400
|
+
# interval that you specify. If you don't enter an interval,
|
401
|
+
# EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The
|
402
|
+
# tags sync the stream to the wall clock so that viewers can seek to a
|
403
|
+
# specific time in the playback timeline on the player. ID3Timed
|
404
|
+
# metadata messages generate every 5 seconds whenever the content is
|
405
|
+
# ingested.
|
406
|
+
#
|
407
|
+
# Irrespective of this parameter, if any ID3Timed metadata is in the
|
408
|
+
# HLS input, it is passed through to the HLS output.
|
409
|
+
# @return [Integer]
|
410
|
+
#
|
411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/CreateLowLatencyHlsManifestConfiguration AWS API Documentation
|
412
|
+
#
|
413
|
+
class CreateLowLatencyHlsManifestConfiguration < Struct.new(
|
414
|
+
:manifest_name,
|
415
|
+
:child_manifest_name,
|
416
|
+
:scte_hls,
|
417
|
+
:manifest_window_seconds,
|
418
|
+
:program_date_time_interval_seconds)
|
419
|
+
SENSITIVE = []
|
420
|
+
include Aws::Structure
|
421
|
+
end
|
422
|
+
|
423
|
+
# @!attribute [rw] channel_group_name
|
424
|
+
# The name that describes the channel group. The name is the primary
|
425
|
+
# identifier for the channel group, and must be unique for your
|
426
|
+
# account in the AWS Region.
|
427
|
+
# @return [String]
|
428
|
+
#
|
429
|
+
# @!attribute [rw] channel_name
|
430
|
+
# The name that describes the channel. The name is the primary
|
431
|
+
# identifier for the channel, and must be unique for your account in
|
432
|
+
# the AWS Region and channel group.
|
433
|
+
# @return [String]
|
434
|
+
#
|
435
|
+
# @!attribute [rw] origin_endpoint_name
|
436
|
+
# The name that describes the origin endpoint. The name is the primary
|
437
|
+
# identifier for the origin endpoint, and must be unique for your
|
438
|
+
# account in the AWS Region and channel. You can't use spaces in the
|
439
|
+
# name. You can't change the name after you create the endpoint.
|
440
|
+
# @return [String]
|
441
|
+
#
|
442
|
+
# @!attribute [rw] container_type
|
443
|
+
# The type of container to attach to this origin endpoint. A container
|
444
|
+
# type is a file format that encapsulates one or more media streams,
|
445
|
+
# such as audio and video, into a single file. You can't change the
|
446
|
+
# container type after you create the endpoint.
|
447
|
+
# @return [String]
|
448
|
+
#
|
449
|
+
# @!attribute [rw] segment
|
450
|
+
# The segment configuration, including the segment name, duration, and
|
451
|
+
# other configuration values.
|
452
|
+
# @return [Types::Segment]
|
453
|
+
#
|
454
|
+
# @!attribute [rw] client_token
|
455
|
+
# A unique, case-sensitive token that you provide to ensure the
|
456
|
+
# idempotency of the request.
|
457
|
+
#
|
458
|
+
# **A suitable default value is auto-generated.** You should normally
|
459
|
+
# not need to pass this option.
|
460
|
+
# @return [String]
|
461
|
+
#
|
462
|
+
# @!attribute [rw] description
|
463
|
+
# Enter any descriptive text that helps you to identify the origin
|
464
|
+
# endpoint.
|
465
|
+
# @return [String]
|
466
|
+
#
|
467
|
+
# @!attribute [rw] startover_window_seconds
|
468
|
+
# The size of the window (in seconds) to create a window of the live
|
469
|
+
# stream that's available for on-demand viewing. Viewers can
|
470
|
+
# start-over or catch-up on content that falls within the window. The
|
471
|
+
# maximum startover window is 1,209,600 seconds (14 days).
|
472
|
+
# @return [Integer]
|
473
|
+
#
|
474
|
+
# @!attribute [rw] hls_manifests
|
475
|
+
# An HTTP live streaming (HLS) manifest configuration.
|
476
|
+
# @return [Array<Types::CreateHlsManifestConfiguration>]
|
477
|
+
#
|
478
|
+
# @!attribute [rw] low_latency_hls_manifests
|
479
|
+
# A low-latency HLS manifest configuration.
|
480
|
+
# @return [Array<Types::CreateLowLatencyHlsManifestConfiguration>]
|
481
|
+
#
|
482
|
+
# @!attribute [rw] tags
|
483
|
+
# A comma-separated list of tag key:value pairs that you define. For
|
484
|
+
# example:
|
485
|
+
#
|
486
|
+
# `"Key1": "Value1",`
|
487
|
+
#
|
488
|
+
# `"Key2": "Value2"`
|
489
|
+
# @return [Hash<String,String>]
|
490
|
+
#
|
491
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/CreateOriginEndpointRequest AWS API Documentation
|
492
|
+
#
|
493
|
+
class CreateOriginEndpointRequest < Struct.new(
|
494
|
+
:channel_group_name,
|
495
|
+
:channel_name,
|
496
|
+
:origin_endpoint_name,
|
497
|
+
:container_type,
|
498
|
+
:segment,
|
499
|
+
:client_token,
|
500
|
+
:description,
|
501
|
+
:startover_window_seconds,
|
502
|
+
:hls_manifests,
|
503
|
+
:low_latency_hls_manifests,
|
504
|
+
:tags)
|
505
|
+
SENSITIVE = []
|
506
|
+
include Aws::Structure
|
507
|
+
end
|
508
|
+
|
509
|
+
# @!attribute [rw] arn
|
510
|
+
# The Amazon Resource Name (ARN) associated with the resource.
|
511
|
+
# @return [String]
|
512
|
+
#
|
513
|
+
# @!attribute [rw] channel_group_name
|
514
|
+
# The name that describes the channel group. The name is the primary
|
515
|
+
# identifier for the channel group, and must be unique for your
|
516
|
+
# account in the AWS Region.
|
517
|
+
# @return [String]
|
518
|
+
#
|
519
|
+
# @!attribute [rw] channel_name
|
520
|
+
# The name that describes the channel. The name is the primary
|
521
|
+
# identifier for the channel, and must be unique for your account in
|
522
|
+
# the AWS Region and channel group.
|
523
|
+
# @return [String]
|
524
|
+
#
|
525
|
+
# @!attribute [rw] origin_endpoint_name
|
526
|
+
# The name that describes the origin endpoint. The name is the primary
|
527
|
+
# identifier for the origin endpoint, and and must be unique for your
|
528
|
+
# account in the AWS Region and channel.
|
529
|
+
# @return [String]
|
530
|
+
#
|
531
|
+
# @!attribute [rw] container_type
|
532
|
+
# The type of container attached to this origin endpoint.
|
533
|
+
# @return [String]
|
534
|
+
#
|
535
|
+
# @!attribute [rw] segment
|
536
|
+
# The segment configuration, including the segment name, duration, and
|
537
|
+
# other configuration values.
|
538
|
+
# @return [Types::Segment]
|
539
|
+
#
|
540
|
+
# @!attribute [rw] created_at
|
541
|
+
# The date and time the origin endpoint was created.
|
542
|
+
# @return [Time]
|
543
|
+
#
|
544
|
+
# @!attribute [rw] modified_at
|
545
|
+
# The date and time the origin endpoint was modified.
|
546
|
+
# @return [Time]
|
547
|
+
#
|
548
|
+
# @!attribute [rw] description
|
549
|
+
# The description for your origin endpoint.
|
550
|
+
# @return [String]
|
551
|
+
#
|
552
|
+
# @!attribute [rw] startover_window_seconds
|
553
|
+
# The size of the window (in seconds) to create a window of the live
|
554
|
+
# stream that's available for on-demand viewing. Viewers can
|
555
|
+
# start-over or catch-up on content that falls within the window.
|
556
|
+
# @return [Integer]
|
557
|
+
#
|
558
|
+
# @!attribute [rw] hls_manifests
|
559
|
+
# An HTTP live streaming (HLS) manifest configuration.
|
560
|
+
# @return [Array<Types::GetHlsManifestConfiguration>]
|
561
|
+
#
|
562
|
+
# @!attribute [rw] low_latency_hls_manifests
|
563
|
+
# A low-latency HLS manifest configuration.
|
564
|
+
# @return [Array<Types::GetLowLatencyHlsManifestConfiguration>]
|
565
|
+
#
|
566
|
+
# @!attribute [rw] tags
|
567
|
+
# The comma-separated list of tag key:value pairs assigned to the
|
568
|
+
# origin endpoint.
|
569
|
+
# @return [Hash<String,String>]
|
570
|
+
#
|
571
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/CreateOriginEndpointResponse AWS API Documentation
|
572
|
+
#
|
573
|
+
class CreateOriginEndpointResponse < Struct.new(
|
574
|
+
:arn,
|
575
|
+
:channel_group_name,
|
576
|
+
:channel_name,
|
577
|
+
:origin_endpoint_name,
|
578
|
+
:container_type,
|
579
|
+
:segment,
|
580
|
+
:created_at,
|
581
|
+
:modified_at,
|
582
|
+
:description,
|
583
|
+
:startover_window_seconds,
|
584
|
+
:hls_manifests,
|
585
|
+
:low_latency_hls_manifests,
|
586
|
+
:tags)
|
587
|
+
SENSITIVE = []
|
588
|
+
include Aws::Structure
|
589
|
+
end
|
590
|
+
|
591
|
+
# @!attribute [rw] channel_group_name
|
592
|
+
# The name that describes the channel group. The name is the primary
|
593
|
+
# identifier for the channel group, and must be unique for your
|
594
|
+
# account in the AWS Region.
|
595
|
+
# @return [String]
|
596
|
+
#
|
597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/DeleteChannelGroupRequest AWS API Documentation
|
598
|
+
#
|
599
|
+
class DeleteChannelGroupRequest < Struct.new(
|
600
|
+
:channel_group_name)
|
601
|
+
SENSITIVE = []
|
602
|
+
include Aws::Structure
|
603
|
+
end
|
604
|
+
|
605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/DeleteChannelGroupResponse AWS API Documentation
|
606
|
+
#
|
607
|
+
class DeleteChannelGroupResponse < Aws::EmptyStructure; end
|
608
|
+
|
609
|
+
# @!attribute [rw] channel_group_name
|
610
|
+
# The name that describes the channel group. The name is the primary
|
611
|
+
# identifier for the channel group, and must be unique for your
|
612
|
+
# account in the AWS Region.
|
613
|
+
# @return [String]
|
614
|
+
#
|
615
|
+
# @!attribute [rw] channel_name
|
616
|
+
# The name that describes the channel. The name is the primary
|
617
|
+
# identifier for the channel, and must be unique for your account in
|
618
|
+
# the AWS Region and channel group.
|
619
|
+
# @return [String]
|
620
|
+
#
|
621
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/DeleteChannelPolicyRequest AWS API Documentation
|
622
|
+
#
|
623
|
+
class DeleteChannelPolicyRequest < Struct.new(
|
624
|
+
:channel_group_name,
|
625
|
+
:channel_name)
|
626
|
+
SENSITIVE = []
|
627
|
+
include Aws::Structure
|
628
|
+
end
|
629
|
+
|
630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/DeleteChannelPolicyResponse AWS API Documentation
|
631
|
+
#
|
632
|
+
class DeleteChannelPolicyResponse < Aws::EmptyStructure; end
|
633
|
+
|
634
|
+
# @!attribute [rw] channel_group_name
|
635
|
+
# The name that describes the channel group. The name is the primary
|
636
|
+
# identifier for the channel group, and must be unique for your
|
637
|
+
# account in the AWS Region.
|
638
|
+
# @return [String]
|
639
|
+
#
|
640
|
+
# @!attribute [rw] channel_name
|
641
|
+
# The name that describes the channel. The name is the primary
|
642
|
+
# identifier for the channel, and must be unique for your account in
|
643
|
+
# the AWS Region and channel group.
|
644
|
+
# @return [String]
|
645
|
+
#
|
646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/DeleteChannelRequest AWS API Documentation
|
647
|
+
#
|
648
|
+
class DeleteChannelRequest < Struct.new(
|
649
|
+
:channel_group_name,
|
650
|
+
:channel_name)
|
651
|
+
SENSITIVE = []
|
652
|
+
include Aws::Structure
|
653
|
+
end
|
654
|
+
|
655
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/DeleteChannelResponse AWS API Documentation
|
656
|
+
#
|
657
|
+
class DeleteChannelResponse < Aws::EmptyStructure; end
|
658
|
+
|
659
|
+
# @!attribute [rw] channel_group_name
|
660
|
+
# The name that describes the channel group. The name is the primary
|
661
|
+
# identifier for the channel group, and must be unique for your
|
662
|
+
# account in the AWS Region.
|
663
|
+
# @return [String]
|
664
|
+
#
|
665
|
+
# @!attribute [rw] channel_name
|
666
|
+
# The name that describes the channel. The name is the primary
|
667
|
+
# identifier for the channel, and must be unique for your account in
|
668
|
+
# the AWS Region and channel group.
|
669
|
+
# @return [String]
|
670
|
+
#
|
671
|
+
# @!attribute [rw] origin_endpoint_name
|
672
|
+
# The name that describes the origin endpoint. The name is the primary
|
673
|
+
# identifier for the origin endpoint, and and must be unique for your
|
674
|
+
# account in the AWS Region and channel.
|
675
|
+
# @return [String]
|
676
|
+
#
|
677
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/DeleteOriginEndpointPolicyRequest AWS API Documentation
|
678
|
+
#
|
679
|
+
class DeleteOriginEndpointPolicyRequest < Struct.new(
|
680
|
+
:channel_group_name,
|
681
|
+
:channel_name,
|
682
|
+
:origin_endpoint_name)
|
683
|
+
SENSITIVE = []
|
684
|
+
include Aws::Structure
|
685
|
+
end
|
686
|
+
|
687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/DeleteOriginEndpointPolicyResponse AWS API Documentation
|
688
|
+
#
|
689
|
+
class DeleteOriginEndpointPolicyResponse < Aws::EmptyStructure; end
|
690
|
+
|
691
|
+
# @!attribute [rw] channel_group_name
|
692
|
+
# The name that describes the channel group. The name is the primary
|
693
|
+
# identifier for the channel group, and must be unique for your
|
694
|
+
# account in the AWS Region.
|
695
|
+
# @return [String]
|
696
|
+
#
|
697
|
+
# @!attribute [rw] channel_name
|
698
|
+
# The name that describes the channel. The name is the primary
|
699
|
+
# identifier for the channel, and must be unique for your account in
|
700
|
+
# the AWS Region and channel group.
|
701
|
+
# @return [String]
|
702
|
+
#
|
703
|
+
# @!attribute [rw] origin_endpoint_name
|
704
|
+
# The name that describes the origin endpoint. The name is the primary
|
705
|
+
# identifier for the origin endpoint, and and must be unique for your
|
706
|
+
# account in the AWS Region and channel.
|
707
|
+
# @return [String]
|
708
|
+
#
|
709
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/DeleteOriginEndpointRequest AWS API Documentation
|
710
|
+
#
|
711
|
+
class DeleteOriginEndpointRequest < Struct.new(
|
712
|
+
:channel_group_name,
|
713
|
+
:channel_name,
|
714
|
+
:origin_endpoint_name)
|
715
|
+
SENSITIVE = []
|
716
|
+
include Aws::Structure
|
717
|
+
end
|
718
|
+
|
719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/DeleteOriginEndpointResponse AWS API Documentation
|
720
|
+
#
|
721
|
+
class DeleteOriginEndpointResponse < Aws::EmptyStructure; end
|
722
|
+
|
723
|
+
# The parameters for encrypting content.
|
724
|
+
#
|
725
|
+
# @!attribute [rw] constant_initialization_vector
|
726
|
+
# A 128-bit, 16-byte hex value represented by a 32-character string,
|
727
|
+
# used in conjunction with the key for encrypting content. If you
|
728
|
+
# don't specify a value, then MediaPackage creates the constant
|
729
|
+
# initialization vector (IV).
|
730
|
+
# @return [String]
|
731
|
+
#
|
732
|
+
# @!attribute [rw] encryption_method
|
733
|
+
# The encryption method to use.
|
734
|
+
# @return [Types::EncryptionMethod]
|
735
|
+
#
|
736
|
+
# @!attribute [rw] key_rotation_interval_seconds
|
737
|
+
# The frequency (in seconds) of key changes for live workflows, in
|
738
|
+
# which content is streamed real time. The service retrieves content
|
739
|
+
# keys before the live content begins streaming, and then retrieves
|
740
|
+
# them as needed over the lifetime of the workflow. By default, key
|
741
|
+
# rotation is set to 300 seconds (5 minutes), the minimum rotation
|
742
|
+
# interval, which is equivalent to setting it to 300. If you don't
|
743
|
+
# enter an interval, content keys aren't rotated.
|
744
|
+
#
|
745
|
+
# The following example setting causes the service to rotate keys
|
746
|
+
# every thirty minutes: `1800`
|
747
|
+
# @return [Integer]
|
748
|
+
#
|
749
|
+
# @!attribute [rw] speke_key_provider
|
750
|
+
# The parameters for the SPEKE key provider.
|
751
|
+
# @return [Types::SpekeKeyProvider]
|
752
|
+
#
|
753
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/Encryption AWS API Documentation
|
754
|
+
#
|
755
|
+
class Encryption < Struct.new(
|
756
|
+
:constant_initialization_vector,
|
757
|
+
:encryption_method,
|
758
|
+
:key_rotation_interval_seconds,
|
759
|
+
:speke_key_provider)
|
760
|
+
SENSITIVE = []
|
761
|
+
include Aws::Structure
|
762
|
+
end
|
763
|
+
|
764
|
+
# Configure one or more content encryption keys for your endpoints that
|
765
|
+
# use SPEKE Version 2.0. The encryption contract defines which content
|
766
|
+
# keys are used to encrypt the audio and video tracks in your stream. To
|
767
|
+
# configure the encryption contract, specify which audio and video
|
768
|
+
# encryption presets to use.
|
769
|
+
#
|
770
|
+
# @!attribute [rw] preset_speke_20_audio
|
771
|
+
# A collection of audio encryption presets.
|
772
|
+
#
|
773
|
+
# Value description:
|
774
|
+
#
|
775
|
+
# * PRESET-AUDIO-1 - Use one content key to encrypt all of the audio
|
776
|
+
# tracks in your stream.
|
777
|
+
#
|
778
|
+
# * PRESET-AUDIO-2 - Use one content key to encrypt all of the stereo
|
779
|
+
# audio tracks and one content key to encrypt all of the
|
780
|
+
# multichannel audio tracks.
|
781
|
+
#
|
782
|
+
# * PRESET-AUDIO-3 - Use one content key to encrypt all of the stereo
|
783
|
+
# audio tracks, one content key to encrypt all of the multichannel
|
784
|
+
# audio tracks with 3 to 6 channels, and one content key to encrypt
|
785
|
+
# all of the multichannel audio tracks with more than 6 channels.
|
786
|
+
#
|
787
|
+
# * SHARED - Use the same content key for all of the audio and video
|
788
|
+
# tracks in your stream.
|
789
|
+
#
|
790
|
+
# * UNENCRYPTED - Don't encrypt any of the audio tracks in your
|
791
|
+
# stream.
|
792
|
+
# @return [String]
|
793
|
+
#
|
794
|
+
# @!attribute [rw] preset_speke_20_video
|
795
|
+
# A collection of video encryption presets.
|
796
|
+
#
|
797
|
+
# Value description:
|
798
|
+
#
|
799
|
+
# * PRESET-VIDEO-1 - Use one content key to encrypt all of the video
|
800
|
+
# tracks in your stream.
|
801
|
+
#
|
802
|
+
# * PRESET-VIDEO-2 - Use one content key to encrypt all of the SD
|
803
|
+
# video tracks and one content key for all HD and higher resolutions
|
804
|
+
# video tracks.
|
805
|
+
#
|
806
|
+
# * PRESET-VIDEO-3 - Use one content key to encrypt all of the SD
|
807
|
+
# video tracks, one content key for HD video tracks and one content
|
808
|
+
# key for all UHD video tracks.
|
809
|
+
#
|
810
|
+
# * PRESET-VIDEO-4 - Use one content key to encrypt all of the SD
|
811
|
+
# video tracks, one content key for HD video tracks, one content key
|
812
|
+
# for all UHD1 video tracks and one content key for all UHD2 video
|
813
|
+
# tracks.
|
814
|
+
#
|
815
|
+
# * PRESET-VIDEO-5 - Use one content key to encrypt all of the SD
|
816
|
+
# video tracks, one content key for HD1 video tracks, one content
|
817
|
+
# key for HD2 video tracks, one content key for all UHD1 video
|
818
|
+
# tracks and one content key for all UHD2 video tracks.
|
819
|
+
#
|
820
|
+
# * PRESET-VIDEO-6 - Use one content key to encrypt all of the SD
|
821
|
+
# video tracks, one content key for HD1 video tracks, one content
|
822
|
+
# key for HD2 video tracks and one content key for all UHD video
|
823
|
+
# tracks.
|
824
|
+
#
|
825
|
+
# * PRESET-VIDEO-7 - Use one content key to encrypt all of the SD+HD1
|
826
|
+
# video tracks, one content key for HD2 video tracks and one content
|
827
|
+
# key for all UHD video tracks.
|
828
|
+
#
|
829
|
+
# * PRESET-VIDEO-8 - Use one content key to encrypt all of the SD+HD1
|
830
|
+
# video tracks, one content key for HD2 video tracks, one content
|
831
|
+
# key for all UHD1 video tracks and one content key for all UHD2
|
832
|
+
# video tracks.
|
833
|
+
#
|
834
|
+
# * SHARED - Use the same content key for all of the video and audio
|
835
|
+
# tracks in your stream.
|
836
|
+
#
|
837
|
+
# * UNENCRYPTED - Don't encrypt any of the video tracks in your
|
838
|
+
# stream.
|
839
|
+
# @return [String]
|
840
|
+
#
|
841
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/EncryptionContractConfiguration AWS API Documentation
|
842
|
+
#
|
843
|
+
class EncryptionContractConfiguration < Struct.new(
|
844
|
+
:preset_speke_20_audio,
|
845
|
+
:preset_speke_20_video)
|
846
|
+
SENSITIVE = []
|
847
|
+
include Aws::Structure
|
848
|
+
end
|
849
|
+
|
850
|
+
# The encryption type.
|
851
|
+
#
|
852
|
+
# @!attribute [rw] ts_encryption_method
|
853
|
+
# The encryption method to use.
|
854
|
+
# @return [String]
|
855
|
+
#
|
856
|
+
# @!attribute [rw] cmaf_encryption_method
|
857
|
+
# The encryption method to use.
|
858
|
+
# @return [String]
|
859
|
+
#
|
860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/EncryptionMethod AWS API Documentation
|
861
|
+
#
|
862
|
+
class EncryptionMethod < Struct.new(
|
863
|
+
:ts_encryption_method,
|
864
|
+
:cmaf_encryption_method)
|
865
|
+
SENSITIVE = []
|
866
|
+
include Aws::Structure
|
867
|
+
end
|
868
|
+
|
869
|
+
# @!attribute [rw] channel_group_name
|
870
|
+
# The name that describes the channel group. The name is the primary
|
871
|
+
# identifier for the channel group, and must be unique for your
|
872
|
+
# account in the AWS Region.
|
873
|
+
# @return [String]
|
874
|
+
#
|
875
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/GetChannelGroupRequest AWS API Documentation
|
876
|
+
#
|
877
|
+
class GetChannelGroupRequest < Struct.new(
|
878
|
+
:channel_group_name)
|
879
|
+
SENSITIVE = []
|
880
|
+
include Aws::Structure
|
881
|
+
end
|
882
|
+
|
883
|
+
# @!attribute [rw] channel_group_name
|
884
|
+
# The name that describes the channel group. The name is the primary
|
885
|
+
# identifier for the channel group, and must be unique for your
|
886
|
+
# account in the AWS Region.
|
887
|
+
# @return [String]
|
888
|
+
#
|
889
|
+
# @!attribute [rw] arn
|
890
|
+
# The Amazon Resource Name (ARN) associated with the resource.
|
891
|
+
# @return [String]
|
892
|
+
#
|
893
|
+
# @!attribute [rw] egress_domain
|
894
|
+
# The output domain where the source stream should be sent. Integrate
|
895
|
+
# the domain with a downstream CDN (such as Amazon CloudFront) or
|
896
|
+
# playback device.
|
897
|
+
# @return [String]
|
898
|
+
#
|
899
|
+
# @!attribute [rw] created_at
|
900
|
+
# The date and time the channel group was created.
|
901
|
+
# @return [Time]
|
902
|
+
#
|
903
|
+
# @!attribute [rw] modified_at
|
904
|
+
# The date and time the channel group was modified.
|
905
|
+
# @return [Time]
|
906
|
+
#
|
907
|
+
# @!attribute [rw] description
|
908
|
+
# The description for your channel group.
|
909
|
+
# @return [String]
|
910
|
+
#
|
911
|
+
# @!attribute [rw] tags
|
912
|
+
# The comma-separated list of tag key:value pairs assigned to the
|
913
|
+
# channel group.
|
914
|
+
# @return [Hash<String,String>]
|
915
|
+
#
|
916
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/GetChannelGroupResponse AWS API Documentation
|
917
|
+
#
|
918
|
+
class GetChannelGroupResponse < Struct.new(
|
919
|
+
:channel_group_name,
|
920
|
+
:arn,
|
921
|
+
:egress_domain,
|
922
|
+
:created_at,
|
923
|
+
:modified_at,
|
924
|
+
:description,
|
925
|
+
:tags)
|
926
|
+
SENSITIVE = []
|
927
|
+
include Aws::Structure
|
928
|
+
end
|
929
|
+
|
930
|
+
# @!attribute [rw] channel_group_name
|
931
|
+
# The name that describes the channel group. The name is the primary
|
932
|
+
# identifier for the channel group, and must be unique for your
|
933
|
+
# account in the AWS Region.
|
934
|
+
# @return [String]
|
935
|
+
#
|
936
|
+
# @!attribute [rw] channel_name
|
937
|
+
# The name that describes the channel. The name is the primary
|
938
|
+
# identifier for the channel, and must be unique for your account in
|
939
|
+
# the AWS Region and channel group.
|
940
|
+
# @return [String]
|
941
|
+
#
|
942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/GetChannelPolicyRequest AWS API Documentation
|
943
|
+
#
|
944
|
+
class GetChannelPolicyRequest < Struct.new(
|
945
|
+
:channel_group_name,
|
946
|
+
:channel_name)
|
947
|
+
SENSITIVE = []
|
948
|
+
include Aws::Structure
|
949
|
+
end
|
950
|
+
|
951
|
+
# @!attribute [rw] channel_group_name
|
952
|
+
# The name that describes the channel group. The name is the primary
|
953
|
+
# identifier for the channel group, and must be unique for your
|
954
|
+
# account in the AWS Region.
|
955
|
+
# @return [String]
|
956
|
+
#
|
957
|
+
# @!attribute [rw] channel_name
|
958
|
+
# The name that describes the channel. The name is the primary
|
959
|
+
# identifier for the channel, and must be unique for your account in
|
960
|
+
# the AWS Region and channel group.
|
961
|
+
# @return [String]
|
962
|
+
#
|
963
|
+
# @!attribute [rw] policy
|
964
|
+
# The policy assigned to the channel.
|
965
|
+
# @return [String]
|
966
|
+
#
|
967
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/GetChannelPolicyResponse AWS API Documentation
|
968
|
+
#
|
969
|
+
class GetChannelPolicyResponse < Struct.new(
|
970
|
+
:channel_group_name,
|
971
|
+
:channel_name,
|
972
|
+
:policy)
|
973
|
+
SENSITIVE = []
|
974
|
+
include Aws::Structure
|
975
|
+
end
|
976
|
+
|
977
|
+
# @!attribute [rw] channel_group_name
|
978
|
+
# The name that describes the channel group. The name is the primary
|
979
|
+
# identifier for the channel group, and must be unique for your
|
980
|
+
# account in the AWS Region.
|
981
|
+
# @return [String]
|
982
|
+
#
|
983
|
+
# @!attribute [rw] channel_name
|
984
|
+
# The name that describes the channel. The name is the primary
|
985
|
+
# identifier for the channel, and must be unique for your account in
|
986
|
+
# the AWS Region and channel group.
|
987
|
+
# @return [String]
|
988
|
+
#
|
989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/GetChannelRequest AWS API Documentation
|
990
|
+
#
|
991
|
+
class GetChannelRequest < Struct.new(
|
992
|
+
:channel_group_name,
|
993
|
+
:channel_name)
|
994
|
+
SENSITIVE = []
|
995
|
+
include Aws::Structure
|
996
|
+
end
|
997
|
+
|
998
|
+
# @!attribute [rw] arn
|
999
|
+
# The Amazon Resource Name (ARN) associated with the resource.
|
1000
|
+
# @return [String]
|
1001
|
+
#
|
1002
|
+
# @!attribute [rw] channel_name
|
1003
|
+
# The name that describes the channel. The name is the primary
|
1004
|
+
# identifier for the channel, and must be unique for your account in
|
1005
|
+
# the AWS Region and channel group.
|
1006
|
+
# @return [String]
|
1007
|
+
#
|
1008
|
+
# @!attribute [rw] channel_group_name
|
1009
|
+
# The name that describes the channel group. The name is the primary
|
1010
|
+
# identifier for the channel group, and must be unique for your
|
1011
|
+
# account in the AWS Region.
|
1012
|
+
# @return [String]
|
1013
|
+
#
|
1014
|
+
# @!attribute [rw] created_at
|
1015
|
+
# The date and time the channel was created.
|
1016
|
+
# @return [Time]
|
1017
|
+
#
|
1018
|
+
# @!attribute [rw] modified_at
|
1019
|
+
# The date and time the channel was modified.
|
1020
|
+
# @return [Time]
|
1021
|
+
#
|
1022
|
+
# @!attribute [rw] description
|
1023
|
+
# The description for your channel.
|
1024
|
+
# @return [String]
|
1025
|
+
#
|
1026
|
+
# @!attribute [rw] ingest_endpoints
|
1027
|
+
# The list of ingest endpoints.
|
1028
|
+
# @return [Array<Types::IngestEndpoint>]
|
1029
|
+
#
|
1030
|
+
# @!attribute [rw] tags
|
1031
|
+
# The comma-separated list of tag key:value pairs assigned to the
|
1032
|
+
# channel.
|
1033
|
+
# @return [Hash<String,String>]
|
1034
|
+
#
|
1035
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/GetChannelResponse AWS API Documentation
|
1036
|
+
#
|
1037
|
+
class GetChannelResponse < Struct.new(
|
1038
|
+
:arn,
|
1039
|
+
:channel_name,
|
1040
|
+
:channel_group_name,
|
1041
|
+
:created_at,
|
1042
|
+
:modified_at,
|
1043
|
+
:description,
|
1044
|
+
:ingest_endpoints,
|
1045
|
+
:tags)
|
1046
|
+
SENSITIVE = []
|
1047
|
+
include Aws::Structure
|
1048
|
+
end
|
1049
|
+
|
1050
|
+
# Retrieve the HTTP live streaming (HLS) manifest configuration.
|
1051
|
+
#
|
1052
|
+
# @!attribute [rw] manifest_name
|
1053
|
+
# A short short string that's appended to the endpoint URL. The
|
1054
|
+
# manifest name creates a unique path to this endpoint. If you don't
|
1055
|
+
# enter a value, MediaPackage uses the default manifest name, index.
|
1056
|
+
# MediaPackage automatically inserts the format extension, such as
|
1057
|
+
# .m3u8. You can't use the same manifest name if you use HLS manifest
|
1058
|
+
# and low-latency HLS manifest. The manifestName on the HLSManifest
|
1059
|
+
# object overrides the manifestName you provided on the originEndpoint
|
1060
|
+
# object.
|
1061
|
+
# @return [String]
|
1062
|
+
#
|
1063
|
+
# @!attribute [rw] url
|
1064
|
+
# The egress domain URL for stream delivery from MediaPackage.
|
1065
|
+
# @return [String]
|
1066
|
+
#
|
1067
|
+
# @!attribute [rw] child_manifest_name
|
1068
|
+
# A short string that's appended to the endpoint URL. The child
|
1069
|
+
# manifest name creates a unique path to this endpoint. If you don't
|
1070
|
+
# enter a value, MediaPackage uses the default child manifest name,
|
1071
|
+
# index\_1. The manifestName on the HLSManifest object overrides the
|
1072
|
+
# manifestName you provided on the originEndpoint object.
|
1073
|
+
# @return [String]
|
1074
|
+
#
|
1075
|
+
# @!attribute [rw] manifest_window_seconds
|
1076
|
+
# The total duration (in seconds) of the manifest's content.
|
1077
|
+
# @return [Integer]
|
1078
|
+
#
|
1079
|
+
# @!attribute [rw] program_date_time_interval_seconds
|
1080
|
+
# Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the
|
1081
|
+
# interval that you specify. If you don't enter an interval,
|
1082
|
+
# EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The
|
1083
|
+
# tags sync the stream to the wall clock so that viewers can seek to a
|
1084
|
+
# specific time in the playback timeline on the player. ID3Timed
|
1085
|
+
# metadata messages generate every 5 seconds whenever the content is
|
1086
|
+
# ingested.
|
1087
|
+
#
|
1088
|
+
# Irrespective of this parameter, if any ID3Timed metadata is in the
|
1089
|
+
# HLS input, it is passed through to the HLS output.
|
1090
|
+
# @return [Integer]
|
1091
|
+
#
|
1092
|
+
# @!attribute [rw] scte_hls
|
1093
|
+
# The SCTE configuration.
|
1094
|
+
# @return [Types::ScteHls]
|
1095
|
+
#
|
1096
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/GetHlsManifestConfiguration AWS API Documentation
|
1097
|
+
#
|
1098
|
+
class GetHlsManifestConfiguration < Struct.new(
|
1099
|
+
:manifest_name,
|
1100
|
+
:url,
|
1101
|
+
:child_manifest_name,
|
1102
|
+
:manifest_window_seconds,
|
1103
|
+
:program_date_time_interval_seconds,
|
1104
|
+
:scte_hls)
|
1105
|
+
SENSITIVE = []
|
1106
|
+
include Aws::Structure
|
1107
|
+
end
|
1108
|
+
|
1109
|
+
# Retrieve the low-latency HTTP live streaming (HLS) manifest
|
1110
|
+
# configuration.
|
1111
|
+
#
|
1112
|
+
# @!attribute [rw] manifest_name
|
1113
|
+
# A short short string that's appended to the endpoint URL. The
|
1114
|
+
# manifest name creates a unique path to this endpoint. If you don't
|
1115
|
+
# enter a value, MediaPackage uses the default manifest name, index.
|
1116
|
+
# MediaPackage automatically inserts the format extension, such as
|
1117
|
+
# .m3u8. You can't use the same manifest name if you use HLS manifest
|
1118
|
+
# and low-latency HLS manifest. The manifestName on the HLSManifest
|
1119
|
+
# object overrides the manifestName you provided on the originEndpoint
|
1120
|
+
# object.
|
1121
|
+
# @return [String]
|
1122
|
+
#
|
1123
|
+
# @!attribute [rw] url
|
1124
|
+
# The egress domain URL for stream delivery from MediaPackage.
|
1125
|
+
# @return [String]
|
1126
|
+
#
|
1127
|
+
# @!attribute [rw] child_manifest_name
|
1128
|
+
# A short string that's appended to the endpoint URL. The child
|
1129
|
+
# manifest name creates a unique path to this endpoint. If you don't
|
1130
|
+
# enter a value, MediaPackage uses the default child manifest name,
|
1131
|
+
# index\_1. The manifestName on the HLSManifest object overrides the
|
1132
|
+
# manifestName you provided on the originEndpoint object.
|
1133
|
+
# @return [String]
|
1134
|
+
#
|
1135
|
+
# @!attribute [rw] manifest_window_seconds
|
1136
|
+
# The total duration (in seconds) of the manifest's content.
|
1137
|
+
# @return [Integer]
|
1138
|
+
#
|
1139
|
+
# @!attribute [rw] program_date_time_interval_seconds
|
1140
|
+
# Inserts EXT-X-PROGRAM-DATE-TIME tags in the output manifest at the
|
1141
|
+
# interval that you specify. If you don't enter an interval,
|
1142
|
+
# EXT-X-PROGRAM-DATE-TIME tags aren't included in the manifest. The
|
1143
|
+
# tags sync the stream to the wall clock so that viewers can seek to a
|
1144
|
+
# specific time in the playback timeline on the player. ID3Timed
|
1145
|
+
# metadata messages generate every 5 seconds whenever the content is
|
1146
|
+
# ingested.
|
1147
|
+
#
|
1148
|
+
# Irrespective of this parameter, if any ID3Timed metadata is in the
|
1149
|
+
# HLS input, it is passed through to the HLS output.
|
1150
|
+
# @return [Integer]
|
1151
|
+
#
|
1152
|
+
# @!attribute [rw] scte_hls
|
1153
|
+
# The SCTE configuration.
|
1154
|
+
# @return [Types::ScteHls]
|
1155
|
+
#
|
1156
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/GetLowLatencyHlsManifestConfiguration AWS API Documentation
|
1157
|
+
#
|
1158
|
+
class GetLowLatencyHlsManifestConfiguration < Struct.new(
|
1159
|
+
:manifest_name,
|
1160
|
+
:url,
|
1161
|
+
:child_manifest_name,
|
1162
|
+
:manifest_window_seconds,
|
1163
|
+
:program_date_time_interval_seconds,
|
1164
|
+
:scte_hls)
|
1165
|
+
SENSITIVE = []
|
1166
|
+
include Aws::Structure
|
1167
|
+
end
|
1168
|
+
|
1169
|
+
# @!attribute [rw] channel_group_name
|
1170
|
+
# The name that describes the channel group. The name is the primary
|
1171
|
+
# identifier for the channel group, and must be unique for your
|
1172
|
+
# account in the AWS Region.
|
1173
|
+
# @return [String]
|
1174
|
+
#
|
1175
|
+
# @!attribute [rw] channel_name
|
1176
|
+
# The name that describes the channel. The name is the primary
|
1177
|
+
# identifier for the channel, and must be unique for your account in
|
1178
|
+
# the AWS Region and channel group.
|
1179
|
+
# @return [String]
|
1180
|
+
#
|
1181
|
+
# @!attribute [rw] origin_endpoint_name
|
1182
|
+
# The name that describes the origin endpoint. The name is the primary
|
1183
|
+
# identifier for the origin endpoint, and and must be unique for your
|
1184
|
+
# account in the AWS Region and channel.
|
1185
|
+
# @return [String]
|
1186
|
+
#
|
1187
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/GetOriginEndpointPolicyRequest AWS API Documentation
|
1188
|
+
#
|
1189
|
+
class GetOriginEndpointPolicyRequest < Struct.new(
|
1190
|
+
:channel_group_name,
|
1191
|
+
:channel_name,
|
1192
|
+
:origin_endpoint_name)
|
1193
|
+
SENSITIVE = []
|
1194
|
+
include Aws::Structure
|
1195
|
+
end
|
1196
|
+
|
1197
|
+
# @!attribute [rw] channel_group_name
|
1198
|
+
# The name that describes the channel group. The name is the primary
|
1199
|
+
# identifier for the channel group, and must be unique for your
|
1200
|
+
# account in the AWS Region.
|
1201
|
+
# @return [String]
|
1202
|
+
#
|
1203
|
+
# @!attribute [rw] channel_name
|
1204
|
+
# The name that describes the channel. The name is the primary
|
1205
|
+
# identifier for the channel, and must be unique for your account in
|
1206
|
+
# the AWS Region and channel group.
|
1207
|
+
# @return [String]
|
1208
|
+
#
|
1209
|
+
# @!attribute [rw] origin_endpoint_name
|
1210
|
+
# The name that describes the origin endpoint. The name is the primary
|
1211
|
+
# identifier for the origin endpoint, and and must be unique for your
|
1212
|
+
# account in the AWS Region and channel.
|
1213
|
+
# @return [String]
|
1214
|
+
#
|
1215
|
+
# @!attribute [rw] policy
|
1216
|
+
# The policy assigned to the origin endpoint.
|
1217
|
+
# @return [String]
|
1218
|
+
#
|
1219
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/GetOriginEndpointPolicyResponse AWS API Documentation
|
1220
|
+
#
|
1221
|
+
class GetOriginEndpointPolicyResponse < Struct.new(
|
1222
|
+
:channel_group_name,
|
1223
|
+
:channel_name,
|
1224
|
+
:origin_endpoint_name,
|
1225
|
+
:policy)
|
1226
|
+
SENSITIVE = []
|
1227
|
+
include Aws::Structure
|
1228
|
+
end
|
1229
|
+
|
1230
|
+
# @!attribute [rw] channel_group_name
|
1231
|
+
# The name that describes the channel group. The name is the primary
|
1232
|
+
# identifier for the channel group, and must be unique for your
|
1233
|
+
# account in the AWS Region.
|
1234
|
+
# @return [String]
|
1235
|
+
#
|
1236
|
+
# @!attribute [rw] channel_name
|
1237
|
+
# The name that describes the channel. The name is the primary
|
1238
|
+
# identifier for the channel, and must be unique for your account in
|
1239
|
+
# the AWS Region and channel group.
|
1240
|
+
# @return [String]
|
1241
|
+
#
|
1242
|
+
# @!attribute [rw] origin_endpoint_name
|
1243
|
+
# The name that describes the origin endpoint. The name is the primary
|
1244
|
+
# identifier for the origin endpoint, and and must be unique for your
|
1245
|
+
# account in the AWS Region and channel.
|
1246
|
+
# @return [String]
|
1247
|
+
#
|
1248
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/GetOriginEndpointRequest AWS API Documentation
|
1249
|
+
#
|
1250
|
+
class GetOriginEndpointRequest < Struct.new(
|
1251
|
+
:channel_group_name,
|
1252
|
+
:channel_name,
|
1253
|
+
:origin_endpoint_name)
|
1254
|
+
SENSITIVE = []
|
1255
|
+
include Aws::Structure
|
1256
|
+
end
|
1257
|
+
|
1258
|
+
# @!attribute [rw] arn
|
1259
|
+
# The Amazon Resource Name (ARN) associated with the resource.
|
1260
|
+
# @return [String]
|
1261
|
+
#
|
1262
|
+
# @!attribute [rw] channel_group_name
|
1263
|
+
# The name that describes the channel group. The name is the primary
|
1264
|
+
# identifier for the channel group, and must be unique for your
|
1265
|
+
# account in the AWS Region.
|
1266
|
+
# @return [String]
|
1267
|
+
#
|
1268
|
+
# @!attribute [rw] channel_name
|
1269
|
+
# The name that describes the channel. The name is the primary
|
1270
|
+
# identifier for the channel, and must be unique for your account in
|
1271
|
+
# the AWS Region and channel group.
|
1272
|
+
# @return [String]
|
1273
|
+
#
|
1274
|
+
# @!attribute [rw] origin_endpoint_name
|
1275
|
+
# The name that describes the origin endpoint. The name is the primary
|
1276
|
+
# identifier for the origin endpoint, and and must be unique for your
|
1277
|
+
# account in the AWS Region and channel.
|
1278
|
+
# @return [String]
|
1279
|
+
#
|
1280
|
+
# @!attribute [rw] container_type
|
1281
|
+
# The type of container attached to this origin endpoint.
|
1282
|
+
# @return [String]
|
1283
|
+
#
|
1284
|
+
# @!attribute [rw] segment
|
1285
|
+
# The segment configuration, including the segment name, duration, and
|
1286
|
+
# other configuration values.
|
1287
|
+
# @return [Types::Segment]
|
1288
|
+
#
|
1289
|
+
# @!attribute [rw] created_at
|
1290
|
+
# The date and time the origin endpoint was created.
|
1291
|
+
# @return [Time]
|
1292
|
+
#
|
1293
|
+
# @!attribute [rw] modified_at
|
1294
|
+
# The date and time the origin endpoint was modified.
|
1295
|
+
# @return [Time]
|
1296
|
+
#
|
1297
|
+
# @!attribute [rw] description
|
1298
|
+
# The description for your origin endpoint.
|
1299
|
+
# @return [String]
|
1300
|
+
#
|
1301
|
+
# @!attribute [rw] startover_window_seconds
|
1302
|
+
# The size of the window (in seconds) to create a window of the live
|
1303
|
+
# stream that's available for on-demand viewing. Viewers can
|
1304
|
+
# start-over or catch-up on content that falls within the window.
|
1305
|
+
# @return [Integer]
|
1306
|
+
#
|
1307
|
+
# @!attribute [rw] hls_manifests
|
1308
|
+
# An HTTP live streaming (HLS) manifest configuration.
|
1309
|
+
# @return [Array<Types::GetHlsManifestConfiguration>]
|
1310
|
+
#
|
1311
|
+
# @!attribute [rw] low_latency_hls_manifests
|
1312
|
+
# A low-latency HLS manifest configuration.
|
1313
|
+
# @return [Array<Types::GetLowLatencyHlsManifestConfiguration>]
|
1314
|
+
#
|
1315
|
+
# @!attribute [rw] tags
|
1316
|
+
# The comma-separated list of tag key:value pairs assigned to the
|
1317
|
+
# origin endpoint.
|
1318
|
+
# @return [Hash<String,String>]
|
1319
|
+
#
|
1320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/GetOriginEndpointResponse AWS API Documentation
|
1321
|
+
#
|
1322
|
+
class GetOriginEndpointResponse < Struct.new(
|
1323
|
+
:arn,
|
1324
|
+
:channel_group_name,
|
1325
|
+
:channel_name,
|
1326
|
+
:origin_endpoint_name,
|
1327
|
+
:container_type,
|
1328
|
+
:segment,
|
1329
|
+
:created_at,
|
1330
|
+
:modified_at,
|
1331
|
+
:description,
|
1332
|
+
:startover_window_seconds,
|
1333
|
+
:hls_manifests,
|
1334
|
+
:low_latency_hls_manifests,
|
1335
|
+
:tags)
|
1336
|
+
SENSITIVE = []
|
1337
|
+
include Aws::Structure
|
1338
|
+
end
|
1339
|
+
|
1340
|
+
# The ingest domain URL where the source stream should be sent.
|
1341
|
+
#
|
1342
|
+
# @!attribute [rw] id
|
1343
|
+
# The system-generated unique identifier for the IngestEndpoint.
|
1344
|
+
# @return [String]
|
1345
|
+
#
|
1346
|
+
# @!attribute [rw] url
|
1347
|
+
# The ingest domain URL where the source stream should be sent.
|
1348
|
+
# @return [String]
|
1349
|
+
#
|
1350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/IngestEndpoint AWS API Documentation
|
1351
|
+
#
|
1352
|
+
class IngestEndpoint < Struct.new(
|
1353
|
+
:id,
|
1354
|
+
:url)
|
1355
|
+
SENSITIVE = []
|
1356
|
+
include Aws::Structure
|
1357
|
+
end
|
1358
|
+
|
1359
|
+
# Indicates that an error from the service occurred while trying to
|
1360
|
+
# process a request.
|
1361
|
+
#
|
1362
|
+
# @!attribute [rw] message
|
1363
|
+
# @return [String]
|
1364
|
+
#
|
1365
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/InternalServerException AWS API Documentation
|
1366
|
+
#
|
1367
|
+
class InternalServerException < Struct.new(
|
1368
|
+
:message)
|
1369
|
+
SENSITIVE = []
|
1370
|
+
include Aws::Structure
|
1371
|
+
end
|
1372
|
+
|
1373
|
+
# @!attribute [rw] max_results
|
1374
|
+
# The maximum number of results to return in the response.
|
1375
|
+
# @return [Integer]
|
1376
|
+
#
|
1377
|
+
# @!attribute [rw] next_token
|
1378
|
+
# The pagination token from the GET list request. Use the token to
|
1379
|
+
# fetch the next page of results.
|
1380
|
+
# @return [String]
|
1381
|
+
#
|
1382
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ListChannelGroupsRequest AWS API Documentation
|
1383
|
+
#
|
1384
|
+
class ListChannelGroupsRequest < Struct.new(
|
1385
|
+
:max_results,
|
1386
|
+
:next_token)
|
1387
|
+
SENSITIVE = []
|
1388
|
+
include Aws::Structure
|
1389
|
+
end
|
1390
|
+
|
1391
|
+
# @!attribute [rw] items
|
1392
|
+
# The objects being returned.
|
1393
|
+
# @return [Array<Types::ChannelGroupListConfiguration>]
|
1394
|
+
#
|
1395
|
+
# @!attribute [rw] next_token
|
1396
|
+
# The pagination token from the GET list request. Use the token to
|
1397
|
+
# fetch the next page of results.
|
1398
|
+
# @return [String]
|
1399
|
+
#
|
1400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ListChannelGroupsResponse AWS API Documentation
|
1401
|
+
#
|
1402
|
+
class ListChannelGroupsResponse < Struct.new(
|
1403
|
+
:items,
|
1404
|
+
:next_token)
|
1405
|
+
SENSITIVE = []
|
1406
|
+
include Aws::Structure
|
1407
|
+
end
|
1408
|
+
|
1409
|
+
# @!attribute [rw] channel_group_name
|
1410
|
+
# The name that describes the channel group. The name is the primary
|
1411
|
+
# identifier for the channel group, and must be unique for your
|
1412
|
+
# account in the AWS Region.
|
1413
|
+
# @return [String]
|
1414
|
+
#
|
1415
|
+
# @!attribute [rw] max_results
|
1416
|
+
# The maximum number of results to return in the response.
|
1417
|
+
# @return [Integer]
|
1418
|
+
#
|
1419
|
+
# @!attribute [rw] next_token
|
1420
|
+
# The pagination token from the GET list request. Use the token to
|
1421
|
+
# fetch the next page of results.
|
1422
|
+
# @return [String]
|
1423
|
+
#
|
1424
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ListChannelsRequest AWS API Documentation
|
1425
|
+
#
|
1426
|
+
class ListChannelsRequest < Struct.new(
|
1427
|
+
:channel_group_name,
|
1428
|
+
:max_results,
|
1429
|
+
:next_token)
|
1430
|
+
SENSITIVE = []
|
1431
|
+
include Aws::Structure
|
1432
|
+
end
|
1433
|
+
|
1434
|
+
# @!attribute [rw] items
|
1435
|
+
# The objects being returned.
|
1436
|
+
# @return [Array<Types::ChannelListConfiguration>]
|
1437
|
+
#
|
1438
|
+
# @!attribute [rw] next_token
|
1439
|
+
# The pagination token from the GET list request.
|
1440
|
+
# @return [String]
|
1441
|
+
#
|
1442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ListChannelsResponse AWS API Documentation
|
1443
|
+
#
|
1444
|
+
class ListChannelsResponse < Struct.new(
|
1445
|
+
:items,
|
1446
|
+
:next_token)
|
1447
|
+
SENSITIVE = []
|
1448
|
+
include Aws::Structure
|
1449
|
+
end
|
1450
|
+
|
1451
|
+
# List the HTTP live streaming (HLS) manifest configuration.
|
1452
|
+
#
|
1453
|
+
# @!attribute [rw] manifest_name
|
1454
|
+
# A short short string that's appended to the endpoint URL. The
|
1455
|
+
# manifest name creates a unique path to this endpoint. If you don't
|
1456
|
+
# enter a value, MediaPackage uses the default manifest name, index.
|
1457
|
+
# MediaPackage automatically inserts the format extension, such as
|
1458
|
+
# .m3u8. You can't use the same manifest name if you use HLS manifest
|
1459
|
+
# and low-latency HLS manifest. The manifestName on the HLSManifest
|
1460
|
+
# object overrides the manifestName you provided on the originEndpoint
|
1461
|
+
# object.
|
1462
|
+
# @return [String]
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] child_manifest_name
|
1465
|
+
# A short string that's appended to the endpoint URL. The child
|
1466
|
+
# manifest name creates a unique path to this endpoint. If you don't
|
1467
|
+
# enter a value, MediaPackage uses the default child manifest name,
|
1468
|
+
# index\_1. The manifestName on the HLSManifest object overrides the
|
1469
|
+
# manifestName you provided on the originEndpoint object.
|
1470
|
+
# @return [String]
|
1471
|
+
#
|
1472
|
+
# @!attribute [rw] url
|
1473
|
+
# The egress domain URL for stream delivery from MediaPackage.
|
1474
|
+
# @return [String]
|
1475
|
+
#
|
1476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ListHlsManifestConfiguration AWS API Documentation
|
1477
|
+
#
|
1478
|
+
class ListHlsManifestConfiguration < Struct.new(
|
1479
|
+
:manifest_name,
|
1480
|
+
:child_manifest_name,
|
1481
|
+
:url)
|
1482
|
+
SENSITIVE = []
|
1483
|
+
include Aws::Structure
|
1484
|
+
end
|
1485
|
+
|
1486
|
+
# List the low-latency HTTP live streaming (HLS) manifest configuration.
|
1487
|
+
#
|
1488
|
+
# @!attribute [rw] manifest_name
|
1489
|
+
# A short short string that's appended to the endpoint URL. The
|
1490
|
+
# manifest name creates a unique path to this endpoint. If you don't
|
1491
|
+
# enter a value, MediaPackage uses the default manifest name, index.
|
1492
|
+
# MediaPackage automatically inserts the format extension, such as
|
1493
|
+
# .m3u8. You can't use the same manifest name if you use HLS manifest
|
1494
|
+
# and low-latency HLS manifest. The manifestName on the HLSManifest
|
1495
|
+
# object overrides the manifestName you provided on the originEndpoint
|
1496
|
+
# object.
|
1497
|
+
# @return [String]
|
1498
|
+
#
|
1499
|
+
# @!attribute [rw] child_manifest_name
|
1500
|
+
# A short string that's appended to the endpoint URL. The child
|
1501
|
+
# manifest name creates a unique path to this endpoint. If you don't
|
1502
|
+
# enter a value, MediaPackage uses the default child manifest name,
|
1503
|
+
# index\_1. The manifestName on the HLSManifest object overrides the
|
1504
|
+
# manifestName you provided on the originEndpoint object.
|
1505
|
+
# @return [String]
|
1506
|
+
#
|
1507
|
+
# @!attribute [rw] url
|
1508
|
+
# The egress domain URL for stream delivery from MediaPackage.
|
1509
|
+
# @return [String]
|
1510
|
+
#
|
1511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ListLowLatencyHlsManifestConfiguration AWS API Documentation
|
1512
|
+
#
|
1513
|
+
class ListLowLatencyHlsManifestConfiguration < Struct.new(
|
1514
|
+
:manifest_name,
|
1515
|
+
:child_manifest_name,
|
1516
|
+
:url)
|
1517
|
+
SENSITIVE = []
|
1518
|
+
include Aws::Structure
|
1519
|
+
end
|
1520
|
+
|
1521
|
+
# @!attribute [rw] channel_group_name
|
1522
|
+
# The name that describes the channel group. The name is the primary
|
1523
|
+
# identifier for the channel group, and must be unique for your
|
1524
|
+
# account in the AWS Region.
|
1525
|
+
# @return [String]
|
1526
|
+
#
|
1527
|
+
# @!attribute [rw] channel_name
|
1528
|
+
# The name that describes the channel. The name is the primary
|
1529
|
+
# identifier for the channel, and must be unique for your account in
|
1530
|
+
# the AWS Region and channel group.
|
1531
|
+
# @return [String]
|
1532
|
+
#
|
1533
|
+
# @!attribute [rw] max_results
|
1534
|
+
# The maximum number of results to return in the response.
|
1535
|
+
# @return [Integer]
|
1536
|
+
#
|
1537
|
+
# @!attribute [rw] next_token
|
1538
|
+
# The pagination token from the GET list request. Use the token to
|
1539
|
+
# fetch the next page of results.
|
1540
|
+
# @return [String]
|
1541
|
+
#
|
1542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ListOriginEndpointsRequest AWS API Documentation
|
1543
|
+
#
|
1544
|
+
class ListOriginEndpointsRequest < Struct.new(
|
1545
|
+
:channel_group_name,
|
1546
|
+
:channel_name,
|
1547
|
+
:max_results,
|
1548
|
+
:next_token)
|
1549
|
+
SENSITIVE = []
|
1550
|
+
include Aws::Structure
|
1551
|
+
end
|
1552
|
+
|
1553
|
+
# @!attribute [rw] items
|
1554
|
+
# The objects being returned.
|
1555
|
+
# @return [Array<Types::OriginEndpointListConfiguration>]
|
1556
|
+
#
|
1557
|
+
# @!attribute [rw] next_token
|
1558
|
+
# The pagination token from the GET list request. Use the token to
|
1559
|
+
# fetch the next page of results.
|
1560
|
+
# @return [String]
|
1561
|
+
#
|
1562
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ListOriginEndpointsResponse AWS API Documentation
|
1563
|
+
#
|
1564
|
+
class ListOriginEndpointsResponse < Struct.new(
|
1565
|
+
:items,
|
1566
|
+
:next_token)
|
1567
|
+
SENSITIVE = []
|
1568
|
+
include Aws::Structure
|
1569
|
+
end
|
1570
|
+
|
1571
|
+
# @!attribute [rw] resource_arn
|
1572
|
+
# The ARN of the CloudWatch resource that you want to view tags for.
|
1573
|
+
# @return [String]
|
1574
|
+
#
|
1575
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ListTagsForResourceRequest AWS API Documentation
|
1576
|
+
#
|
1577
|
+
class ListTagsForResourceRequest < Struct.new(
|
1578
|
+
:resource_arn)
|
1579
|
+
SENSITIVE = []
|
1580
|
+
include Aws::Structure
|
1581
|
+
end
|
1582
|
+
|
1583
|
+
# @!attribute [rw] tags
|
1584
|
+
# Contains a map of the key-value pairs for the resource tag or tags
|
1585
|
+
# assigned to the resource.
|
1586
|
+
# @return [Hash<String,String>]
|
1587
|
+
#
|
1588
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ListTagsForResourceResponse AWS API Documentation
|
1589
|
+
#
|
1590
|
+
class ListTagsForResourceResponse < Struct.new(
|
1591
|
+
:tags)
|
1592
|
+
SENSITIVE = []
|
1593
|
+
include Aws::Structure
|
1594
|
+
end
|
1595
|
+
|
1596
|
+
# The configuration of the origin endpoint.
|
1597
|
+
#
|
1598
|
+
# @!attribute [rw] arn
|
1599
|
+
# The Amazon Resource Name (ARN) associated with the resource.
|
1600
|
+
# @return [String]
|
1601
|
+
#
|
1602
|
+
# @!attribute [rw] channel_group_name
|
1603
|
+
# The name that describes the channel group. The name is the primary
|
1604
|
+
# identifier for the channel group, and must be unique for your
|
1605
|
+
# account in the AWS Region.
|
1606
|
+
# @return [String]
|
1607
|
+
#
|
1608
|
+
# @!attribute [rw] channel_name
|
1609
|
+
# The name that describes the channel. The name is the primary
|
1610
|
+
# identifier for the channel, and must be unique for your account in
|
1611
|
+
# the AWS Region and channel group.
|
1612
|
+
# @return [String]
|
1613
|
+
#
|
1614
|
+
# @!attribute [rw] origin_endpoint_name
|
1615
|
+
# The name that describes the origin endpoint. The name is the primary
|
1616
|
+
# identifier for the origin endpoint, and and must be unique for your
|
1617
|
+
# account in the AWS Region and channel.
|
1618
|
+
# @return [String]
|
1619
|
+
#
|
1620
|
+
# @!attribute [rw] container_type
|
1621
|
+
# The type of container attached to this origin endpoint. A container
|
1622
|
+
# type is a file format that encapsulates one or more media streams,
|
1623
|
+
# such as audio and video, into a single file.
|
1624
|
+
# @return [String]
|
1625
|
+
#
|
1626
|
+
# @!attribute [rw] description
|
1627
|
+
# Any descriptive information that you want to add to the origin
|
1628
|
+
# endpoint for future identification purposes.
|
1629
|
+
# @return [String]
|
1630
|
+
#
|
1631
|
+
# @!attribute [rw] created_at
|
1632
|
+
# The date and time the origin endpoint was created.
|
1633
|
+
# @return [Time]
|
1634
|
+
#
|
1635
|
+
# @!attribute [rw] modified_at
|
1636
|
+
# The date and time the origin endpoint was modified.
|
1637
|
+
# @return [Time]
|
1638
|
+
#
|
1639
|
+
# @!attribute [rw] hls_manifests
|
1640
|
+
# An HTTP live streaming (HLS) manifest configuration.
|
1641
|
+
# @return [Array<Types::ListHlsManifestConfiguration>]
|
1642
|
+
#
|
1643
|
+
# @!attribute [rw] low_latency_hls_manifests
|
1644
|
+
# A low-latency HLS manifest configuration.
|
1645
|
+
# @return [Array<Types::ListLowLatencyHlsManifestConfiguration>]
|
1646
|
+
#
|
1647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/OriginEndpointListConfiguration AWS API Documentation
|
1648
|
+
#
|
1649
|
+
class OriginEndpointListConfiguration < Struct.new(
|
1650
|
+
:arn,
|
1651
|
+
:channel_group_name,
|
1652
|
+
:channel_name,
|
1653
|
+
:origin_endpoint_name,
|
1654
|
+
:container_type,
|
1655
|
+
:description,
|
1656
|
+
:created_at,
|
1657
|
+
:modified_at,
|
1658
|
+
:hls_manifests,
|
1659
|
+
:low_latency_hls_manifests)
|
1660
|
+
SENSITIVE = []
|
1661
|
+
include Aws::Structure
|
1662
|
+
end
|
1663
|
+
|
1664
|
+
# @!attribute [rw] channel_group_name
|
1665
|
+
# The name that describes the channel group. The name is the primary
|
1666
|
+
# identifier for the channel group, and must be unique for your
|
1667
|
+
# account in the AWS Region.
|
1668
|
+
# @return [String]
|
1669
|
+
#
|
1670
|
+
# @!attribute [rw] channel_name
|
1671
|
+
# The name that describes the channel. The name is the primary
|
1672
|
+
# identifier for the channel, and must be unique for your account in
|
1673
|
+
# the AWS Region and channel group.
|
1674
|
+
# @return [String]
|
1675
|
+
#
|
1676
|
+
# @!attribute [rw] policy
|
1677
|
+
# The policy to attach to the specified channel.
|
1678
|
+
# @return [String]
|
1679
|
+
#
|
1680
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/PutChannelPolicyRequest AWS API Documentation
|
1681
|
+
#
|
1682
|
+
class PutChannelPolicyRequest < Struct.new(
|
1683
|
+
:channel_group_name,
|
1684
|
+
:channel_name,
|
1685
|
+
:policy)
|
1686
|
+
SENSITIVE = []
|
1687
|
+
include Aws::Structure
|
1688
|
+
end
|
1689
|
+
|
1690
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/PutChannelPolicyResponse AWS API Documentation
|
1691
|
+
#
|
1692
|
+
class PutChannelPolicyResponse < Aws::EmptyStructure; end
|
1693
|
+
|
1694
|
+
# @!attribute [rw] channel_group_name
|
1695
|
+
# The name that describes the channel group. The name is the primary
|
1696
|
+
# identifier for the channel group, and must be unique for your
|
1697
|
+
# account in the AWS Region.
|
1698
|
+
# @return [String]
|
1699
|
+
#
|
1700
|
+
# @!attribute [rw] channel_name
|
1701
|
+
# The name that describes the channel. The name is the primary
|
1702
|
+
# identifier for the channel, and must be unique for your account in
|
1703
|
+
# the AWS Region and channel group.
|
1704
|
+
# @return [String]
|
1705
|
+
#
|
1706
|
+
# @!attribute [rw] origin_endpoint_name
|
1707
|
+
# The name that describes the origin endpoint. The name is the primary
|
1708
|
+
# identifier for the origin endpoint, and and must be unique for your
|
1709
|
+
# account in the AWS Region and channel.
|
1710
|
+
# @return [String]
|
1711
|
+
#
|
1712
|
+
# @!attribute [rw] policy
|
1713
|
+
# The policy to attach to the specified origin endpoint.
|
1714
|
+
# @return [String]
|
1715
|
+
#
|
1716
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/PutOriginEndpointPolicyRequest AWS API Documentation
|
1717
|
+
#
|
1718
|
+
class PutOriginEndpointPolicyRequest < Struct.new(
|
1719
|
+
:channel_group_name,
|
1720
|
+
:channel_name,
|
1721
|
+
:origin_endpoint_name,
|
1722
|
+
:policy)
|
1723
|
+
SENSITIVE = []
|
1724
|
+
include Aws::Structure
|
1725
|
+
end
|
1726
|
+
|
1727
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/PutOriginEndpointPolicyResponse AWS API Documentation
|
1728
|
+
#
|
1729
|
+
class PutOriginEndpointPolicyResponse < Aws::EmptyStructure; end
|
1730
|
+
|
1731
|
+
# The specified resource doesn't exist.
|
1732
|
+
#
|
1733
|
+
# @!attribute [rw] message
|
1734
|
+
# @return [String]
|
1735
|
+
#
|
1736
|
+
# @!attribute [rw] resource_type_not_found
|
1737
|
+
# The specified resource type wasn't found.
|
1738
|
+
# @return [String]
|
1739
|
+
#
|
1740
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ResourceNotFoundException AWS API Documentation
|
1741
|
+
#
|
1742
|
+
class ResourceNotFoundException < Struct.new(
|
1743
|
+
:message,
|
1744
|
+
:resource_type_not_found)
|
1745
|
+
SENSITIVE = []
|
1746
|
+
include Aws::Structure
|
1747
|
+
end
|
1748
|
+
|
1749
|
+
# The SCTE configuration.
|
1750
|
+
#
|
1751
|
+
# @!attribute [rw] scte_filter
|
1752
|
+
# The SCTE-35 message types that you want to be treated as ad markers
|
1753
|
+
# in the output.
|
1754
|
+
# @return [Array<String>]
|
1755
|
+
#
|
1756
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/Scte AWS API Documentation
|
1757
|
+
#
|
1758
|
+
class Scte < Struct.new(
|
1759
|
+
:scte_filter)
|
1760
|
+
SENSITIVE = []
|
1761
|
+
include Aws::Structure
|
1762
|
+
end
|
1763
|
+
|
1764
|
+
# The SCTE configuration.
|
1765
|
+
#
|
1766
|
+
# @!attribute [rw] ad_marker_hls
|
1767
|
+
# Ad markers indicate when ads should be inserted during playback. If
|
1768
|
+
# you include ad markers in the content stream in your upstream
|
1769
|
+
# encoders, then you need to inform MediaPackage what to do with the
|
1770
|
+
# ad markers in the output. Choose what you want MediaPackage to do
|
1771
|
+
# with the ad markers.
|
1772
|
+
#
|
1773
|
+
# Value description:
|
1774
|
+
#
|
1775
|
+
# * DATERANGE - Insert EXT-X-DATERANGE tags to signal ad and program
|
1776
|
+
# transition events in TS and CMAF manifests. If you use DATERANGE,
|
1777
|
+
# you must set a programDateTimeIntervalSeconds value of 1 or
|
1778
|
+
# higher. To learn more about DATERANGE, see [SCTE-35 Ad Marker
|
1779
|
+
# EXT-X-DATERANGE][1].
|
1780
|
+
#
|
1781
|
+
# ^
|
1782
|
+
#
|
1783
|
+
#
|
1784
|
+
#
|
1785
|
+
# [1]: http://docs.aws.amazon.com/mediapackage/latest/ug/scte-35-ad-marker-ext-x-daterange.html
|
1786
|
+
# @return [String]
|
1787
|
+
#
|
1788
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ScteHls AWS API Documentation
|
1789
|
+
#
|
1790
|
+
class ScteHls < Struct.new(
|
1791
|
+
:ad_marker_hls)
|
1792
|
+
SENSITIVE = []
|
1793
|
+
include Aws::Structure
|
1794
|
+
end
|
1795
|
+
|
1796
|
+
# The segment configuration, including the segment name, duration, and
|
1797
|
+
# other configuration values.
|
1798
|
+
#
|
1799
|
+
# @!attribute [rw] segment_duration_seconds
|
1800
|
+
# The duration (in seconds) of each segment. Enter a value equal to,
|
1801
|
+
# or a multiple of, the input segment duration. If the value that you
|
1802
|
+
# enter is different from the input segment duration, MediaPackage
|
1803
|
+
# rounds segments to the nearest multiple of the input segment
|
1804
|
+
# duration.
|
1805
|
+
# @return [Integer]
|
1806
|
+
#
|
1807
|
+
# @!attribute [rw] segment_name
|
1808
|
+
# The name that describes the segment. The name is the base name of
|
1809
|
+
# the segment used in all content manifests inside of the endpoint.
|
1810
|
+
# You can't use spaces in the name.
|
1811
|
+
# @return [String]
|
1812
|
+
#
|
1813
|
+
# @!attribute [rw] ts_use_audio_rendition_group
|
1814
|
+
# When selected, MediaPackage bundles all audio tracks in a rendition
|
1815
|
+
# group. All other tracks in the stream can be used with any audio
|
1816
|
+
# rendition from the group.
|
1817
|
+
# @return [Boolean]
|
1818
|
+
#
|
1819
|
+
# @!attribute [rw] include_iframe_only_streams
|
1820
|
+
# When selected, the stream set includes an additional I-frame only
|
1821
|
+
# stream, along with the other tracks. If false, this extra stream is
|
1822
|
+
# not included. MediaPackage generates an I-frame only stream from the
|
1823
|
+
# first rendition in the manifest. The service inserts
|
1824
|
+
# EXT-I-FRAMES-ONLY tags in the output manifest, and then generates
|
1825
|
+
# and includes an I-frames only playlist in the stream. This playlist
|
1826
|
+
# permits player functionality like fast forward and rewind.
|
1827
|
+
# @return [Boolean]
|
1828
|
+
#
|
1829
|
+
# @!attribute [rw] ts_include_dvb_subtitles
|
1830
|
+
# By default, MediaPackage excludes all digital video broadcasting
|
1831
|
+
# (DVB) subtitles from the output. When selected, MediaPackage passes
|
1832
|
+
# through DVB subtitles into the output.
|
1833
|
+
# @return [Boolean]
|
1834
|
+
#
|
1835
|
+
# @!attribute [rw] scte
|
1836
|
+
# The SCTE configuration options in the segment settings.
|
1837
|
+
# @return [Types::Scte]
|
1838
|
+
#
|
1839
|
+
# @!attribute [rw] encryption
|
1840
|
+
# The parameters for encrypting content.
|
1841
|
+
# @return [Types::Encryption]
|
1842
|
+
#
|
1843
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/Segment AWS API Documentation
|
1844
|
+
#
|
1845
|
+
class Segment < Struct.new(
|
1846
|
+
:segment_duration_seconds,
|
1847
|
+
:segment_name,
|
1848
|
+
:ts_use_audio_rendition_group,
|
1849
|
+
:include_iframe_only_streams,
|
1850
|
+
:ts_include_dvb_subtitles,
|
1851
|
+
:scte,
|
1852
|
+
:encryption)
|
1853
|
+
SENSITIVE = []
|
1854
|
+
include Aws::Structure
|
1855
|
+
end
|
1856
|
+
|
1857
|
+
# The request would cause a service quota to be exceeded.
|
1858
|
+
#
|
1859
|
+
# @!attribute [rw] message
|
1860
|
+
# @return [String]
|
1861
|
+
#
|
1862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ServiceQuotaExceededException AWS API Documentation
|
1863
|
+
#
|
1864
|
+
class ServiceQuotaExceededException < Struct.new(
|
1865
|
+
:message)
|
1866
|
+
SENSITIVE = []
|
1867
|
+
include Aws::Structure
|
1868
|
+
end
|
1869
|
+
|
1870
|
+
# The parameters for the SPEKE key provider.
|
1871
|
+
#
|
1872
|
+
# @!attribute [rw] encryption_contract_configuration
|
1873
|
+
# Configure one or more content encryption keys for your endpoints
|
1874
|
+
# that use SPEKE Version 2.0. The encryption contract defines which
|
1875
|
+
# content keys are used to encrypt the audio and video tracks in your
|
1876
|
+
# stream. To configure the encryption contract, specify which audio
|
1877
|
+
# and video encryption presets to use.
|
1878
|
+
# @return [Types::EncryptionContractConfiguration]
|
1879
|
+
#
|
1880
|
+
# @!attribute [rw] resource_id
|
1881
|
+
# The unique identifier for the content. The service sends this to the
|
1882
|
+
# key server to identify the current endpoint. How unique you make
|
1883
|
+
# this depends on how fine-grained you want access controls to be. The
|
1884
|
+
# service does not permit you to use the same ID for two simultaneous
|
1885
|
+
# encryption processes. The resource ID is also known as the content
|
1886
|
+
# ID.
|
1887
|
+
#
|
1888
|
+
# The following example shows a resource ID:
|
1889
|
+
# `MovieNight20171126093045`
|
1890
|
+
# @return [String]
|
1891
|
+
#
|
1892
|
+
# @!attribute [rw] drm_systems
|
1893
|
+
# The DRM solution provider you're using to protect your content
|
1894
|
+
# during distribution.
|
1895
|
+
# @return [Array<String>]
|
1896
|
+
#
|
1897
|
+
# @!attribute [rw] role_arn
|
1898
|
+
# The ARN for the IAM role granted by the key provider that provides
|
1899
|
+
# access to the key provider API. This role must have a trust policy
|
1900
|
+
# that allows MediaPackage to assume the role, and it must have a
|
1901
|
+
# sufficient permissions policy to allow access to the specific key
|
1902
|
+
# retrieval URL. Get this from your DRM solution provider.
|
1903
|
+
#
|
1904
|
+
# Valid format: `arn:aws:iam::\{accountID\}:role/\{name\}`. The
|
1905
|
+
# following example shows a role ARN:
|
1906
|
+
# `arn:aws:iam::444455556666:role/SpekeAccess`
|
1907
|
+
# @return [String]
|
1908
|
+
#
|
1909
|
+
# @!attribute [rw] url
|
1910
|
+
# The URL of the API Gateway proxy that you set up to talk to your key
|
1911
|
+
# server. The API Gateway proxy must reside in the same AWS Region as
|
1912
|
+
# MediaPackage and must start with https://.
|
1913
|
+
#
|
1914
|
+
# The following example shows a URL:
|
1915
|
+
# `https://1wm2dx1f33.execute-api.us-west-2.amazonaws.com/SpekeSample/copyProtection`
|
1916
|
+
# @return [String]
|
1917
|
+
#
|
1918
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/SpekeKeyProvider AWS API Documentation
|
1919
|
+
#
|
1920
|
+
class SpekeKeyProvider < Struct.new(
|
1921
|
+
:encryption_contract_configuration,
|
1922
|
+
:resource_id,
|
1923
|
+
:drm_systems,
|
1924
|
+
:role_arn,
|
1925
|
+
:url)
|
1926
|
+
SENSITIVE = []
|
1927
|
+
include Aws::Structure
|
1928
|
+
end
|
1929
|
+
|
1930
|
+
# @!attribute [rw] resource_arn
|
1931
|
+
# The ARN of the MediaPackage resource that you're adding tags to.
|
1932
|
+
# @return [String]
|
1933
|
+
#
|
1934
|
+
# @!attribute [rw] tags
|
1935
|
+
# Contains a map of the key-value pairs for the resource tag or tags
|
1936
|
+
# assigned to the resource.
|
1937
|
+
# @return [Hash<String,String>]
|
1938
|
+
#
|
1939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/TagResourceRequest AWS API Documentation
|
1940
|
+
#
|
1941
|
+
class TagResourceRequest < Struct.new(
|
1942
|
+
:resource_arn,
|
1943
|
+
:tags)
|
1944
|
+
SENSITIVE = []
|
1945
|
+
include Aws::Structure
|
1946
|
+
end
|
1947
|
+
|
1948
|
+
# The request throughput limit was exceeded.
|
1949
|
+
#
|
1950
|
+
# @!attribute [rw] message
|
1951
|
+
# @return [String]
|
1952
|
+
#
|
1953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ThrottlingException AWS API Documentation
|
1954
|
+
#
|
1955
|
+
class ThrottlingException < Struct.new(
|
1956
|
+
:message)
|
1957
|
+
SENSITIVE = []
|
1958
|
+
include Aws::Structure
|
1959
|
+
end
|
1960
|
+
|
1961
|
+
# @!attribute [rw] resource_arn
|
1962
|
+
# The ARN of the MediaPackage resource that you're removing tags
|
1963
|
+
# from.
|
1964
|
+
# @return [String]
|
1965
|
+
#
|
1966
|
+
# @!attribute [rw] tag_keys
|
1967
|
+
# The list of tag keys to remove from the resource.
|
1968
|
+
# @return [Array<String>]
|
1969
|
+
#
|
1970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/UntagResourceRequest AWS API Documentation
|
1971
|
+
#
|
1972
|
+
class UntagResourceRequest < Struct.new(
|
1973
|
+
:resource_arn,
|
1974
|
+
:tag_keys)
|
1975
|
+
SENSITIVE = []
|
1976
|
+
include Aws::Structure
|
1977
|
+
end
|
1978
|
+
|
1979
|
+
# @!attribute [rw] channel_group_name
|
1980
|
+
# The name that describes the channel group. The name is the primary
|
1981
|
+
# identifier for the channel group, and must be unique for your
|
1982
|
+
# account in the AWS Region.
|
1983
|
+
# @return [String]
|
1984
|
+
#
|
1985
|
+
# @!attribute [rw] description
|
1986
|
+
# Any descriptive information that you want to add to the channel
|
1987
|
+
# group for future identification purposes.
|
1988
|
+
# @return [String]
|
1989
|
+
#
|
1990
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/UpdateChannelGroupRequest AWS API Documentation
|
1991
|
+
#
|
1992
|
+
class UpdateChannelGroupRequest < Struct.new(
|
1993
|
+
:channel_group_name,
|
1994
|
+
:description)
|
1995
|
+
SENSITIVE = []
|
1996
|
+
include Aws::Structure
|
1997
|
+
end
|
1998
|
+
|
1999
|
+
# @!attribute [rw] channel_group_name
|
2000
|
+
# The name that describes the channel group. The name is the primary
|
2001
|
+
# identifier for the channel group, and must be unique for your
|
2002
|
+
# account in the AWS Region.
|
2003
|
+
# @return [String]
|
2004
|
+
#
|
2005
|
+
# @!attribute [rw] arn
|
2006
|
+
# The Amazon Resource Name (ARN) associated with the resource.
|
2007
|
+
# @return [String]
|
2008
|
+
#
|
2009
|
+
# @!attribute [rw] egress_domain
|
2010
|
+
# The output domain where the source stream is sent. Integrate the
|
2011
|
+
# domain with a downstream CDN (such as Amazon CloudFront) or playback
|
2012
|
+
# device.
|
2013
|
+
# @return [String]
|
2014
|
+
#
|
2015
|
+
# @!attribute [rw] created_at
|
2016
|
+
# The date and time the channel group was created.
|
2017
|
+
# @return [Time]
|
2018
|
+
#
|
2019
|
+
# @!attribute [rw] modified_at
|
2020
|
+
# The date and time the channel group was modified.
|
2021
|
+
# @return [Time]
|
2022
|
+
#
|
2023
|
+
# @!attribute [rw] description
|
2024
|
+
# The description for your channel group.
|
2025
|
+
# @return [String]
|
2026
|
+
#
|
2027
|
+
# @!attribute [rw] tags
|
2028
|
+
# The comma-separated list of tag key:value pairs assigned to the
|
2029
|
+
# channel group.
|
2030
|
+
# @return [Hash<String,String>]
|
2031
|
+
#
|
2032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/UpdateChannelGroupResponse AWS API Documentation
|
2033
|
+
#
|
2034
|
+
class UpdateChannelGroupResponse < Struct.new(
|
2035
|
+
:channel_group_name,
|
2036
|
+
:arn,
|
2037
|
+
:egress_domain,
|
2038
|
+
:created_at,
|
2039
|
+
:modified_at,
|
2040
|
+
:description,
|
2041
|
+
:tags)
|
2042
|
+
SENSITIVE = []
|
2043
|
+
include Aws::Structure
|
2044
|
+
end
|
2045
|
+
|
2046
|
+
# @!attribute [rw] channel_group_name
|
2047
|
+
# The name that describes the channel group. The name is the primary
|
2048
|
+
# identifier for the channel group, and must be unique for your
|
2049
|
+
# account in the AWS Region.
|
2050
|
+
# @return [String]
|
2051
|
+
#
|
2052
|
+
# @!attribute [rw] channel_name
|
2053
|
+
# The name that describes the channel. The name is the primary
|
2054
|
+
# identifier for the channel, and must be unique for your account in
|
2055
|
+
# the AWS Region and channel group.
|
2056
|
+
# @return [String]
|
2057
|
+
#
|
2058
|
+
# @!attribute [rw] description
|
2059
|
+
# Any descriptive information that you want to add to the channel for
|
2060
|
+
# future identification purposes.
|
2061
|
+
# @return [String]
|
2062
|
+
#
|
2063
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/UpdateChannelRequest AWS API Documentation
|
2064
|
+
#
|
2065
|
+
class UpdateChannelRequest < Struct.new(
|
2066
|
+
:channel_group_name,
|
2067
|
+
:channel_name,
|
2068
|
+
:description)
|
2069
|
+
SENSITIVE = []
|
2070
|
+
include Aws::Structure
|
2071
|
+
end
|
2072
|
+
|
2073
|
+
# @!attribute [rw] arn
|
2074
|
+
# The Amazon Resource Name (ARN) associated with the resource.
|
2075
|
+
# @return [String]
|
2076
|
+
#
|
2077
|
+
# @!attribute [rw] channel_name
|
2078
|
+
# The name that describes the channel. The name is the primary
|
2079
|
+
# identifier for the channel, and must be unique for your account in
|
2080
|
+
# the AWS Region and channel group.
|
2081
|
+
# @return [String]
|
2082
|
+
#
|
2083
|
+
# @!attribute [rw] channel_group_name
|
2084
|
+
# The name that describes the channel group. The name is the primary
|
2085
|
+
# identifier for the channel group, and must be unique for your
|
2086
|
+
# account in the AWS Region.
|
2087
|
+
# @return [String]
|
2088
|
+
#
|
2089
|
+
# @!attribute [rw] created_at
|
2090
|
+
# The date and time the channel was created.
|
2091
|
+
# @return [Time]
|
2092
|
+
#
|
2093
|
+
# @!attribute [rw] modified_at
|
2094
|
+
# The date and time the channel was modified.
|
2095
|
+
# @return [Time]
|
2096
|
+
#
|
2097
|
+
# @!attribute [rw] description
|
2098
|
+
# The description for your channel.
|
2099
|
+
# @return [String]
|
2100
|
+
#
|
2101
|
+
# @!attribute [rw] ingest_endpoints
|
2102
|
+
# The list of ingest endpoints.
|
2103
|
+
# @return [Array<Types::IngestEndpoint>]
|
2104
|
+
#
|
2105
|
+
# @!attribute [rw] tags
|
2106
|
+
# The comma-separated list of tag key:value pairs assigned to the
|
2107
|
+
# channel.
|
2108
|
+
# @return [Hash<String,String>]
|
2109
|
+
#
|
2110
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/UpdateChannelResponse AWS API Documentation
|
2111
|
+
#
|
2112
|
+
class UpdateChannelResponse < Struct.new(
|
2113
|
+
:arn,
|
2114
|
+
:channel_name,
|
2115
|
+
:channel_group_name,
|
2116
|
+
:created_at,
|
2117
|
+
:modified_at,
|
2118
|
+
:description,
|
2119
|
+
:ingest_endpoints,
|
2120
|
+
:tags)
|
2121
|
+
SENSITIVE = []
|
2122
|
+
include Aws::Structure
|
2123
|
+
end
|
2124
|
+
|
2125
|
+
# @!attribute [rw] channel_group_name
|
2126
|
+
# The name that describes the channel group. The name is the primary
|
2127
|
+
# identifier for the channel group, and must be unique for your
|
2128
|
+
# account in the AWS Region.
|
2129
|
+
# @return [String]
|
2130
|
+
#
|
2131
|
+
# @!attribute [rw] channel_name
|
2132
|
+
# The name that describes the channel. The name is the primary
|
2133
|
+
# identifier for the channel, and must be unique for your account in
|
2134
|
+
# the AWS Region and channel group.
|
2135
|
+
# @return [String]
|
2136
|
+
#
|
2137
|
+
# @!attribute [rw] origin_endpoint_name
|
2138
|
+
# The name that describes the origin endpoint. The name is the primary
|
2139
|
+
# identifier for the origin endpoint, and and must be unique for your
|
2140
|
+
# account in the AWS Region and channel.
|
2141
|
+
# @return [String]
|
2142
|
+
#
|
2143
|
+
# @!attribute [rw] container_type
|
2144
|
+
# The type of container attached to this origin endpoint. A container
|
2145
|
+
# type is a file format that encapsulates one or more media streams,
|
2146
|
+
# such as audio and video, into a single file.
|
2147
|
+
# @return [String]
|
2148
|
+
#
|
2149
|
+
# @!attribute [rw] segment
|
2150
|
+
# The segment configuration, including the segment name, duration, and
|
2151
|
+
# other configuration values.
|
2152
|
+
# @return [Types::Segment]
|
2153
|
+
#
|
2154
|
+
# @!attribute [rw] description
|
2155
|
+
# Any descriptive information that you want to add to the origin
|
2156
|
+
# endpoint for future identification purposes.
|
2157
|
+
# @return [String]
|
2158
|
+
#
|
2159
|
+
# @!attribute [rw] startover_window_seconds
|
2160
|
+
# The size of the window (in seconds) to create a window of the live
|
2161
|
+
# stream that's available for on-demand viewing. Viewers can
|
2162
|
+
# start-over or catch-up on content that falls within the window. The
|
2163
|
+
# maximum startover window is 1,209,600 seconds (14 days).
|
2164
|
+
# @return [Integer]
|
2165
|
+
#
|
2166
|
+
# @!attribute [rw] hls_manifests
|
2167
|
+
# An HTTP live streaming (HLS) manifest configuration.
|
2168
|
+
# @return [Array<Types::CreateHlsManifestConfiguration>]
|
2169
|
+
#
|
2170
|
+
# @!attribute [rw] low_latency_hls_manifests
|
2171
|
+
# A low-latency HLS manifest configuration.
|
2172
|
+
# @return [Array<Types::CreateLowLatencyHlsManifestConfiguration>]
|
2173
|
+
#
|
2174
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/UpdateOriginEndpointRequest AWS API Documentation
|
2175
|
+
#
|
2176
|
+
class UpdateOriginEndpointRequest < Struct.new(
|
2177
|
+
:channel_group_name,
|
2178
|
+
:channel_name,
|
2179
|
+
:origin_endpoint_name,
|
2180
|
+
:container_type,
|
2181
|
+
:segment,
|
2182
|
+
:description,
|
2183
|
+
:startover_window_seconds,
|
2184
|
+
:hls_manifests,
|
2185
|
+
:low_latency_hls_manifests)
|
2186
|
+
SENSITIVE = []
|
2187
|
+
include Aws::Structure
|
2188
|
+
end
|
2189
|
+
|
2190
|
+
# @!attribute [rw] arn
|
2191
|
+
# The ARN associated with the resource.
|
2192
|
+
# @return [String]
|
2193
|
+
#
|
2194
|
+
# @!attribute [rw] channel_group_name
|
2195
|
+
# The name that describes the channel group. The name is the primary
|
2196
|
+
# identifier for the channel group, and must be unique for your
|
2197
|
+
# account in the AWS Region.
|
2198
|
+
# @return [String]
|
2199
|
+
#
|
2200
|
+
# @!attribute [rw] channel_name
|
2201
|
+
# The name that describes the channel. The name is the primary
|
2202
|
+
# identifier for the channel, and must be unique for your account in
|
2203
|
+
# the AWS Region and channel group.
|
2204
|
+
# @return [String]
|
2205
|
+
#
|
2206
|
+
# @!attribute [rw] origin_endpoint_name
|
2207
|
+
# The name that describes the origin endpoint. The name is the primary
|
2208
|
+
# identifier for the origin endpoint, and and must be unique for your
|
2209
|
+
# account in the AWS Region and channel.
|
2210
|
+
# @return [String]
|
2211
|
+
#
|
2212
|
+
# @!attribute [rw] container_type
|
2213
|
+
# The type of container attached to this origin endpoint.
|
2214
|
+
# @return [String]
|
2215
|
+
#
|
2216
|
+
# @!attribute [rw] segment
|
2217
|
+
# The segment configuration, including the segment name, duration, and
|
2218
|
+
# other configuration values.
|
2219
|
+
# @return [Types::Segment]
|
2220
|
+
#
|
2221
|
+
# @!attribute [rw] created_at
|
2222
|
+
# The date and time the origin endpoint was created.
|
2223
|
+
# @return [Time]
|
2224
|
+
#
|
2225
|
+
# @!attribute [rw] modified_at
|
2226
|
+
# The date and time the origin endpoint was modified.
|
2227
|
+
# @return [Time]
|
2228
|
+
#
|
2229
|
+
# @!attribute [rw] description
|
2230
|
+
# The description of the origin endpoint.
|
2231
|
+
# @return [String]
|
2232
|
+
#
|
2233
|
+
# @!attribute [rw] startover_window_seconds
|
2234
|
+
# The size of the window (in seconds) to create a window of the live
|
2235
|
+
# stream that's available for on-demand viewing. Viewers can
|
2236
|
+
# start-over or catch-up on content that falls within the window.
|
2237
|
+
# @return [Integer]
|
2238
|
+
#
|
2239
|
+
# @!attribute [rw] hls_manifests
|
2240
|
+
# An HTTP live streaming (HLS) manifest configuration.
|
2241
|
+
# @return [Array<Types::GetHlsManifestConfiguration>]
|
2242
|
+
#
|
2243
|
+
# @!attribute [rw] low_latency_hls_manifests
|
2244
|
+
# A low-latency HLS manifest configuration.
|
2245
|
+
# @return [Array<Types::GetLowLatencyHlsManifestConfiguration>]
|
2246
|
+
#
|
2247
|
+
# @!attribute [rw] tags
|
2248
|
+
# The comma-separated list of tag key:value pairs assigned to the
|
2249
|
+
# origin endpoint.
|
2250
|
+
# @return [Hash<String,String>]
|
2251
|
+
#
|
2252
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/UpdateOriginEndpointResponse AWS API Documentation
|
2253
|
+
#
|
2254
|
+
class UpdateOriginEndpointResponse < Struct.new(
|
2255
|
+
:arn,
|
2256
|
+
:channel_group_name,
|
2257
|
+
:channel_name,
|
2258
|
+
:origin_endpoint_name,
|
2259
|
+
:container_type,
|
2260
|
+
:segment,
|
2261
|
+
:created_at,
|
2262
|
+
:modified_at,
|
2263
|
+
:description,
|
2264
|
+
:startover_window_seconds,
|
2265
|
+
:hls_manifests,
|
2266
|
+
:low_latency_hls_manifests,
|
2267
|
+
:tags)
|
2268
|
+
SENSITIVE = []
|
2269
|
+
include Aws::Structure
|
2270
|
+
end
|
2271
|
+
|
2272
|
+
# The input failed to meet the constraints specified by the AWS service.
|
2273
|
+
#
|
2274
|
+
# @!attribute [rw] message
|
2275
|
+
# @return [String]
|
2276
|
+
#
|
2277
|
+
# @!attribute [rw] validation_exception_type
|
2278
|
+
# The type of ValidationException.
|
2279
|
+
# @return [String]
|
2280
|
+
#
|
2281
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediapackagev2-2022-12-25/ValidationException AWS API Documentation
|
2282
|
+
#
|
2283
|
+
class ValidationException < Struct.new(
|
2284
|
+
:message,
|
2285
|
+
:validation_exception_type)
|
2286
|
+
SENSITIVE = []
|
2287
|
+
include Aws::Structure
|
2288
|
+
end
|
2289
|
+
|
2290
|
+
end
|
2291
|
+
end
|