aws-sdk-mediatailor 1.49.0 → 1.71.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +113 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-mediatailor/client.rb +966 -95
- data/lib/aws-sdk-mediatailor/client_api.rb +331 -55
- data/lib/aws-sdk-mediatailor/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-mediatailor/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-mediatailor/endpoints.rb +632 -0
- data/lib/aws-sdk-mediatailor/plugins/endpoints.rb +156 -0
- data/lib/aws-sdk-mediatailor/types.rb +1516 -933
- data/lib/aws-sdk-mediatailor.rb +6 -2
- metadata +8 -4
@@ -12,24 +12,11 @@ module Aws::MediaTailor
|
|
12
12
|
|
13
13
|
# Access configuration parameters.
|
14
14
|
#
|
15
|
-
# @note When making an API call, you may pass AccessConfiguration
|
16
|
-
# data as a hash:
|
17
|
-
#
|
18
|
-
# {
|
19
|
-
# access_type: "S3_SIGV4", # accepts S3_SIGV4, SECRETS_MANAGER_ACCESS_TOKEN
|
20
|
-
# secrets_manager_access_token_configuration: {
|
21
|
-
# header_name: "__string",
|
22
|
-
# secret_arn: "__string",
|
23
|
-
# secret_string_key: "__string",
|
24
|
-
# },
|
25
|
-
# }
|
26
|
-
#
|
27
15
|
# @!attribute [rw] access_type
|
28
16
|
# The type of authentication used to access content from
|
29
|
-
# HttpConfiguration::BaseUrl on your source location.
|
30
|
-
# S3\_SIGV4.
|
17
|
+
# `HttpConfiguration::BaseUrl` on your source location.
|
31
18
|
#
|
32
|
-
#
|
19
|
+
# `S3_SIGV4` - AWS Signature Version 4 authentication for Amazon S3
|
33
20
|
# hosted virtual-style access. If your source location base URL is an
|
34
21
|
# Amazon S3 bucket, MediaTailor can use AWS Signature Version 4
|
35
22
|
# (SigV4) authentication to access the bucket where your source
|
@@ -37,7 +24,7 @@ module Aws::MediaTailor
|
|
37
24
|
# follow the S3 virtual hosted-style request URL format. For example,
|
38
25
|
# https://bucket-name.s3.Region.amazonaws.com/key-name.
|
39
26
|
#
|
40
|
-
# Before you can use
|
27
|
+
# Before you can use `S3_SIGV4`, you must meet these requirements:
|
41
28
|
#
|
42
29
|
# • You must allow MediaTailor to access your S3 bucket by granting
|
43
30
|
# mediatailor.amazonaws.com principal access in IAM. For information
|
@@ -51,6 +38,47 @@ module Aws::MediaTailor
|
|
51
38
|
# • The caller of the API must have s3:GetObject IAM permissions to
|
52
39
|
# read all top level manifests referenced by your MediaTailor
|
53
40
|
# VodSource packaging configurations.
|
41
|
+
#
|
42
|
+
# `AUTODETECT_SIGV4` - AWS Signature Version 4 authentication for a
|
43
|
+
# set of supported services: MediaPackage Version 2 and Amazon S3
|
44
|
+
# hosted virtual-style access. If your source location base URL is a
|
45
|
+
# MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor
|
46
|
+
# can use AWS Signature Version 4 (SigV4) authentication to access the
|
47
|
+
# resource where your source content is stored.
|
48
|
+
#
|
49
|
+
# Before you can use `AUTODETECT_SIGV4` with a MediaPackage Version 2
|
50
|
+
# endpoint, you must meet these requirements:
|
51
|
+
#
|
52
|
+
# • You must grant MediaTailor access to your MediaPackage endpoint by
|
53
|
+
# granting `mediatailor.amazonaws.com` principal access in an Origin
|
54
|
+
# Access policy on the endpoint.
|
55
|
+
#
|
56
|
+
# • Your MediaTailor source location base URL must be a MediaPackage
|
57
|
+
# V2 endpoint.
|
58
|
+
#
|
59
|
+
# • The caller of the API must have `mediapackagev2:GetObject` IAM
|
60
|
+
# permissions to read all top level manifests referenced by the
|
61
|
+
# MediaTailor source packaging configurations.
|
62
|
+
#
|
63
|
+
# Before you can use `AUTODETECT_SIGV4` with an Amazon S3 bucket, you
|
64
|
+
# must meet these requirements:
|
65
|
+
#
|
66
|
+
# • You must grant MediaTailor access to your S3 bucket by granting
|
67
|
+
# `mediatailor.amazonaws.com` principal access in IAM. For more
|
68
|
+
# information about configuring access in IAM, see [Access
|
69
|
+
# management][1] in the *IAM User Guide.*.
|
70
|
+
#
|
71
|
+
# • The `mediatailor.amazonaws.com` service principal must have
|
72
|
+
# permissions to read all top-level manifests referenced by the
|
73
|
+
# `VodSource` packaging configurations.
|
74
|
+
#
|
75
|
+
# • The caller of the API must have `s3:GetObject` IAM permissions to
|
76
|
+
# read all top level manifests referenced by your MediaTailor
|
77
|
+
# `VodSource` packaging configurations.
|
78
|
+
#
|
79
|
+
#
|
80
|
+
#
|
81
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html
|
54
82
|
# @return [String]
|
55
83
|
#
|
56
84
|
# @!attribute [rw] secrets_manager_access_token_configuration
|
@@ -68,26 +96,14 @@ module Aws::MediaTailor
|
|
68
96
|
|
69
97
|
# Ad break configuration parameters.
|
70
98
|
#
|
71
|
-
#
|
72
|
-
#
|
73
|
-
#
|
74
|
-
#
|
75
|
-
# message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT
|
76
|
-
# offset_millis: 1,
|
77
|
-
# slate: {
|
78
|
-
# source_location_name: "__string",
|
79
|
-
# vod_source_name: "__string",
|
80
|
-
# },
|
81
|
-
# splice_insert_message: {
|
82
|
-
# avail_num: 1,
|
83
|
-
# avails_expected: 1,
|
84
|
-
# splice_event_id: 1,
|
85
|
-
# unique_program_id: 1,
|
86
|
-
# },
|
87
|
-
# }
|
99
|
+
# @!attribute [rw] ad_break_metadata
|
100
|
+
# Defines a list of key/value pairs that MediaTailor generates within
|
101
|
+
# the `EXT-X-ASSET`tag for `SCTE35_ENHANCED` output.
|
102
|
+
# @return [Array<Types::KeyValuePair>]
|
88
103
|
#
|
89
104
|
# @!attribute [rw] message_type
|
90
|
-
# The SCTE-35 ad insertion type. Accepted value:
|
105
|
+
# The SCTE-35 ad insertion type. Accepted value: `SPLICE_INSERT`,
|
106
|
+
# `TIME_SIGNAL`.
|
91
107
|
# @return [String]
|
92
108
|
#
|
93
109
|
# @!attribute [rw] offset_millis
|
@@ -101,36 +117,59 @@ module Aws::MediaTailor
|
|
101
117
|
# @return [Types::SlateSource]
|
102
118
|
#
|
103
119
|
# @!attribute [rw] splice_insert_message
|
104
|
-
# This defines the SCTE-35
|
105
|
-
# the ad. For information about using
|
120
|
+
# This defines the SCTE-35 `splice_insert()` message inserted around
|
121
|
+
# the ad. For information about using `splice_insert()`, see the
|
106
122
|
# SCTE-35 specficiaiton, section 9.7.3.1.
|
107
123
|
# @return [Types::SpliceInsertMessage]
|
108
124
|
#
|
125
|
+
# @!attribute [rw] time_signal_message
|
126
|
+
# Defines the SCTE-35 `time_signal` message inserted around the ad.
|
127
|
+
#
|
128
|
+
# Programs on a channel's schedule can be configured with one or more
|
129
|
+
# ad breaks. You can attach a `splice_insert` SCTE-35 message to the
|
130
|
+
# ad break. This message provides basic metadata about the ad break.
|
131
|
+
#
|
132
|
+
# See section 9.7.4 of the 2022 SCTE-35 specification for more
|
133
|
+
# information.
|
134
|
+
# @return [Types::TimeSignalMessage]
|
135
|
+
#
|
109
136
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/AdBreak AWS API Documentation
|
110
137
|
#
|
111
138
|
class AdBreak < Struct.new(
|
139
|
+
:ad_break_metadata,
|
112
140
|
:message_type,
|
113
141
|
:offset_millis,
|
114
142
|
:slate,
|
115
|
-
:splice_insert_message
|
143
|
+
:splice_insert_message,
|
144
|
+
:time_signal_message)
|
116
145
|
SENSITIVE = []
|
117
146
|
include Aws::Structure
|
118
147
|
end
|
119
148
|
|
120
|
-
#
|
121
|
-
#
|
122
|
-
#
|
149
|
+
# A location at which a zero-duration ad marker was detected in a VOD
|
150
|
+
# source manifest.
|
151
|
+
#
|
152
|
+
# @!attribute [rw] offset_millis
|
153
|
+
# The offset in milliseconds from the start of the VOD source at which
|
154
|
+
# an ad marker was detected.
|
155
|
+
# @return [Integer]
|
123
156
|
#
|
124
|
-
#
|
125
|
-
# has a value of 60, but no ads are filled for that ad break,
|
126
|
-
# MediaTailor will not set the value to 0.
|
157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/AdBreakOpportunity AWS API Documentation
|
127
158
|
#
|
128
|
-
|
129
|
-
|
159
|
+
class AdBreakOpportunity < Struct.new(
|
160
|
+
:offset_millis)
|
161
|
+
SENSITIVE = []
|
162
|
+
include Aws::Structure
|
163
|
+
end
|
164
|
+
|
165
|
+
# For HLS, when set to `true`, MediaTailor passes through
|
166
|
+
# `EXT-X-CUE-IN`, `EXT-X-CUE-OUT`, and `EXT-X-SPLICEPOINT-SCTE35` ad
|
167
|
+
# markers from the origin manifest to the MediaTailor personalized
|
168
|
+
# manifest.
|
130
169
|
#
|
131
|
-
#
|
132
|
-
#
|
133
|
-
#
|
170
|
+
# No logic is applied to these ad markers. For example, if
|
171
|
+
# `EXT-X-CUE-OUT` has a value of `60`, but no ads are filled for that ad
|
172
|
+
# break, MediaTailor will not set the value to `0`.
|
134
173
|
#
|
135
174
|
# @!attribute [rw] enabled
|
136
175
|
# Enables ad marker passthrough for your configuration.
|
@@ -147,7 +186,7 @@ module Aws::MediaTailor
|
|
147
186
|
# Alert configuration parameters.
|
148
187
|
#
|
149
188
|
# @!attribute [rw] alert_code
|
150
|
-
# The code for the alert. For example,
|
189
|
+
# The code for the alert. For example, `NOT_PROCESSED`.
|
151
190
|
# @return [String]
|
152
191
|
#
|
153
192
|
# @!attribute [rw] alert_message
|
@@ -155,6 +194,10 @@ module Aws::MediaTailor
|
|
155
194
|
# reason for the alert.
|
156
195
|
# @return [String]
|
157
196
|
#
|
197
|
+
# @!attribute [rw] category
|
198
|
+
# The category that MediaTailor assigns to the alert.
|
199
|
+
# @return [String]
|
200
|
+
#
|
158
201
|
# @!attribute [rw] last_modified_time
|
159
202
|
# The timestamp when the alert was last modified.
|
160
203
|
# @return [Time]
|
@@ -172,6 +215,7 @@ module Aws::MediaTailor
|
|
172
215
|
class Alert < Struct.new(
|
173
216
|
:alert_code,
|
174
217
|
:alert_message,
|
218
|
+
:category,
|
175
219
|
:last_modified_time,
|
176
220
|
:related_resource_arns,
|
177
221
|
:resource_arn)
|
@@ -183,28 +227,20 @@ module Aws::MediaTailor
|
|
183
227
|
# meets the criteria defined by the dynamic variables. This gives you
|
184
228
|
# granular control over which ad break to place the prefetched ads into.
|
185
229
|
#
|
186
|
-
# As an example, let's say that you set DynamicVariable to
|
187
|
-
# scte.
|
188
|
-
# has an ADS URL of
|
189
|
-
# https://my.ads.server.com/path?&
|
230
|
+
# As an example, let's say that you set `DynamicVariable` to
|
231
|
+
# `scte.event_id` and `Operator` to `EQUALS`, and your playback
|
232
|
+
# configuration has an ADS URL of
|
233
|
+
# `https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]`.
|
190
234
|
# And the prefetch request to the ADS contains these values
|
191
|
-
# https://my.ads.server.com/path?&
|
235
|
+
# `https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30`.
|
192
236
|
# MediaTailor will only insert the prefetched ads into the ad break if
|
193
|
-
# has a SCTE marker with an event id of my-awesome-event
|
194
|
-
# match the event id that MediaTailor uses to query the ADS.
|
195
|
-
#
|
196
|
-
# You can specify up to five AvailMatchingCriteria. If you specify
|
197
|
-
# multiple AvailMatchingCriteria, MediaTailor combines them to match
|
198
|
-
# using a logical AND. You can model logical OR combinations by creating
|
199
|
-
# multiple prefetch schedules.
|
237
|
+
# has a SCTE marker with an event id of `my-awesome-event`, since it
|
238
|
+
# must match the event id that MediaTailor uses to query the ADS.
|
200
239
|
#
|
201
|
-
#
|
202
|
-
#
|
203
|
-
#
|
204
|
-
#
|
205
|
-
# dynamic_variable: "__string", # required
|
206
|
-
# operator: "EQUALS", # required, accepts EQUALS
|
207
|
-
# }
|
240
|
+
# You can specify up to five `AvailMatchingCriteria`. If you specify
|
241
|
+
# multiple `AvailMatchingCriteria`, MediaTailor combines them to match
|
242
|
+
# using a logical `AND`. You can model logical `OR` combinations by
|
243
|
+
# creating multiple prefetch schedules.
|
208
244
|
#
|
209
245
|
# @!attribute [rw] dynamic_variable
|
210
246
|
# The dynamic variable(s) that MediaTailor should use as avail
|
@@ -221,7 +257,7 @@ module Aws::MediaTailor
|
|
221
257
|
# @return [String]
|
222
258
|
#
|
223
259
|
# @!attribute [rw] operator
|
224
|
-
# For the DynamicVariable specified in AvailMatchingCriteria
|
260
|
+
# For the `DynamicVariable` specified in `AvailMatchingCriteria`, the
|
225
261
|
# Operator that is used for the comparison.
|
226
262
|
# @return [String]
|
227
263
|
#
|
@@ -241,20 +277,21 @@ module Aws::MediaTailor
|
|
241
277
|
#
|
242
278
|
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
|
243
279
|
#
|
244
|
-
#
|
245
|
-
#
|
246
|
-
#
|
247
|
-
#
|
248
|
-
#
|
249
|
-
#
|
250
|
-
# }
|
280
|
+
# @!attribute [rw] fill_policy
|
281
|
+
# Defines the policy to apply to the avail suppression mode.
|
282
|
+
# `BEHIND_LIVE_EDGE` will always use the full avail suppression
|
283
|
+
# policy. `AFTER_LIVE_EDGE` mode can be used to invoke partial ad
|
284
|
+
# break fills when a session starts mid-break.
|
285
|
+
# @return [String]
|
251
286
|
#
|
252
287
|
# @!attribute [rw] mode
|
253
288
|
# Sets the ad suppression mode. By default, ad suppression is off and
|
254
289
|
# all ad breaks are filled with ads or slate. When Mode is set to
|
255
|
-
#
|
290
|
+
# `BEHIND_LIVE_EDGE`, ad suppression is active and MediaTailor won't
|
256
291
|
# fill ad breaks on or behind the ad suppression Value time in the
|
257
|
-
# manifest lookback window.
|
292
|
+
# manifest lookback window. When Mode is set to `AFTER_LIVE_EDGE`, ad
|
293
|
+
# suppression is active and MediaTailor won't fill ad breaks that are
|
294
|
+
# within the live edge plus the avail suppression value.
|
258
295
|
# @return [String]
|
259
296
|
#
|
260
297
|
# @!attribute [rw] value
|
@@ -272,6 +309,7 @@ module Aws::MediaTailor
|
|
272
309
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/AvailSuppression AWS API Documentation
|
273
310
|
#
|
274
311
|
class AvailSuppression < Struct.new(
|
312
|
+
:fill_policy,
|
275
313
|
:mode,
|
276
314
|
:value)
|
277
315
|
SENSITIVE = []
|
@@ -281,8 +319,6 @@ module Aws::MediaTailor
|
|
281
319
|
# A request contains unexpected data.
|
282
320
|
#
|
283
321
|
# @!attribute [rw] message
|
284
|
-
# Constructs a new BadRequestException with the specified error
|
285
|
-
# message.
|
286
322
|
# @return [String]
|
287
323
|
#
|
288
324
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/BadRequestException AWS API Documentation
|
@@ -301,14 +337,6 @@ module Aws::MediaTailor
|
|
301
337
|
#
|
302
338
|
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html
|
303
339
|
#
|
304
|
-
# @note When making an API call, you may pass Bumper
|
305
|
-
# data as a hash:
|
306
|
-
#
|
307
|
-
# {
|
308
|
-
# end_url: "__string",
|
309
|
-
# start_url: "__string",
|
310
|
-
# }
|
311
|
-
#
|
312
340
|
# @!attribute [rw] end_url
|
313
341
|
# The URL for the end bumper asset.
|
314
342
|
# @return [String]
|
@@ -329,21 +357,13 @@ module Aws::MediaTailor
|
|
329
357
|
# The configuration for using a content delivery network (CDN), like
|
330
358
|
# Amazon CloudFront, for content and ad segment management.
|
331
359
|
#
|
332
|
-
# @note When making an API call, you may pass CdnConfiguration
|
333
|
-
# data as a hash:
|
334
|
-
#
|
335
|
-
# {
|
336
|
-
# ad_segment_url_prefix: "__string",
|
337
|
-
# content_segment_url_prefix: "__string",
|
338
|
-
# }
|
339
|
-
#
|
340
360
|
# @!attribute [rw] ad_segment_url_prefix
|
341
361
|
# A non-default content delivery network (CDN) to serve ad segments.
|
342
362
|
# By default, AWS Elemental MediaTailor uses Amazon CloudFront with
|
343
363
|
# default cache settings as its CDN for ad segments. To set up an
|
344
364
|
# alternate CDN, create a rule in your CDN for the origin
|
345
|
-
# ads.mediatailor
|
346
|
-
# rule's name in this AdSegmentUrlPrefix
|
365
|
+
# ads.mediatailor.*<region>*.amazonaws.com. Then specify the
|
366
|
+
# rule's name in this `AdSegmentUrlPrefix`. When AWS Elemental
|
347
367
|
# MediaTailor serves a manifest, it reports your CDN as the source for
|
348
368
|
# ad segments.
|
349
369
|
# @return [String]
|
@@ -353,7 +373,7 @@ module Aws::MediaTailor
|
|
353
373
|
# content requests don’t always have to go to the origin server.
|
354
374
|
# First, create a rule in your CDN for the content segment origin
|
355
375
|
# server. Then specify the rule's name in this
|
356
|
-
# ContentSegmentUrlPrefix
|
376
|
+
# `ContentSegmentUrlPrefix`. When AWS Elemental MediaTailor serves a
|
357
377
|
# manifest, it reports your CDN as the source for content segments.
|
358
378
|
# @return [String]
|
359
379
|
#
|
@@ -366,7 +386,13 @@ module Aws::MediaTailor
|
|
366
386
|
include Aws::Structure
|
367
387
|
end
|
368
388
|
|
369
|
-
# The configuration parameters for a channel.
|
389
|
+
# The configuration parameters for a channel. For information about
|
390
|
+
# MediaTailor channels, see [Working with channels][1] in the
|
391
|
+
# *MediaTailor User Guide*.
|
392
|
+
#
|
393
|
+
#
|
394
|
+
#
|
395
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
|
370
396
|
#
|
371
397
|
# @!attribute [rw] arn
|
372
398
|
# The ARN of the channel.
|
@@ -385,15 +411,20 @@ module Aws::MediaTailor
|
|
385
411
|
# @return [Time]
|
386
412
|
#
|
387
413
|
# @!attribute [rw] filler_slate
|
388
|
-
#
|
389
|
-
#
|
390
|
-
#
|
414
|
+
# The slate used to fill gaps between programs in the schedule. You
|
415
|
+
# must configure filler slate if your channel uses the `LINEAR`
|
416
|
+
# `PlaybackMode`. MediaTailor doesn't support filler slate for
|
417
|
+
# channels using the `LOOP` `PlaybackMode`.
|
391
418
|
# @return [Types::SlateSource]
|
392
419
|
#
|
393
420
|
# @!attribute [rw] last_modified_time
|
394
421
|
# The timestamp of when the channel was last modified.
|
395
422
|
# @return [Time]
|
396
423
|
#
|
424
|
+
# @!attribute [rw] log_configuration
|
425
|
+
# The log configuration.
|
426
|
+
# @return [Types::LogConfigurationForChannel]
|
427
|
+
#
|
397
428
|
# @!attribute [rw] outputs
|
398
429
|
# The channel's output properties.
|
399
430
|
# @return [Array<Types::ResponseOutputItem>]
|
@@ -401,17 +432,29 @@ module Aws::MediaTailor
|
|
401
432
|
# @!attribute [rw] playback_mode
|
402
433
|
# The type of playback mode for this channel.
|
403
434
|
#
|
404
|
-
# LINEAR - Programs play back-to-back only once.
|
435
|
+
# `LINEAR` - Programs play back-to-back only once.
|
405
436
|
#
|
406
|
-
# LOOP - Programs play back-to-back in an endless loop. When the
|
407
|
-
# program in the schedule plays, playback loops back to the first
|
437
|
+
# `LOOP` - Programs play back-to-back in an endless loop. When the
|
438
|
+
# last program in the schedule plays, playback loops back to the first
|
408
439
|
# program in the schedule.
|
409
440
|
# @return [String]
|
410
441
|
#
|
411
442
|
# @!attribute [rw] tags
|
412
|
-
# The tags to assign to the channel.
|
443
|
+
# The tags to assign to the channel. Tags are key-value pairs that you
|
444
|
+
# can associate with Amazon resources to help with organization,
|
445
|
+
# access control, and cost tracking. For more information, see
|
446
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
447
|
+
#
|
448
|
+
#
|
449
|
+
#
|
450
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
413
451
|
# @return [Hash<String,String>]
|
414
452
|
#
|
453
|
+
# @!attribute [rw] tier
|
454
|
+
# The tier for this channel. STANDARD tier channels can contain live
|
455
|
+
# programs.
|
456
|
+
# @return [String]
|
457
|
+
#
|
415
458
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/Channel AWS API Documentation
|
416
459
|
#
|
417
460
|
class Channel < Struct.new(
|
@@ -421,34 +464,78 @@ module Aws::MediaTailor
|
|
421
464
|
:creation_time,
|
422
465
|
:filler_slate,
|
423
466
|
:last_modified_time,
|
467
|
+
:log_configuration,
|
424
468
|
:outputs,
|
425
469
|
:playback_mode,
|
426
|
-
:tags
|
470
|
+
:tags,
|
471
|
+
:tier)
|
472
|
+
SENSITIVE = []
|
473
|
+
include Aws::Structure
|
474
|
+
end
|
475
|
+
|
476
|
+
# Clip range configuration for the VOD source associated with the
|
477
|
+
# program.
|
478
|
+
#
|
479
|
+
# @!attribute [rw] end_offset_millis
|
480
|
+
# The end offset of the clip range, in milliseconds, starting from the
|
481
|
+
# beginning of the VOD source associated with the program.
|
482
|
+
# @return [Integer]
|
483
|
+
#
|
484
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ClipRange AWS API Documentation
|
485
|
+
#
|
486
|
+
class ClipRange < Struct.new(
|
487
|
+
:end_offset_millis)
|
488
|
+
SENSITIVE = []
|
489
|
+
include Aws::Structure
|
490
|
+
end
|
491
|
+
|
492
|
+
# @!attribute [rw] channel_name
|
493
|
+
# The name of the channel.
|
494
|
+
# @return [String]
|
495
|
+
#
|
496
|
+
# @!attribute [rw] log_types
|
497
|
+
# The types of logs to collect.
|
498
|
+
# @return [Array<String>]
|
499
|
+
#
|
500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ConfigureLogsForChannelRequest AWS API Documentation
|
501
|
+
#
|
502
|
+
class ConfigureLogsForChannelRequest < Struct.new(
|
503
|
+
:channel_name,
|
504
|
+
:log_types)
|
427
505
|
SENSITIVE = []
|
428
506
|
include Aws::Structure
|
429
507
|
end
|
430
508
|
|
431
|
-
#
|
432
|
-
#
|
509
|
+
# @!attribute [rw] channel_name
|
510
|
+
# The name of the channel.
|
511
|
+
# @return [String]
|
512
|
+
#
|
513
|
+
# @!attribute [rw] log_types
|
514
|
+
# The types of logs collected.
|
515
|
+
# @return [Array<String>]
|
433
516
|
#
|
434
|
-
# @
|
435
|
-
# data as a hash:
|
517
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ConfigureLogsForChannelResponse AWS API Documentation
|
436
518
|
#
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
519
|
+
class ConfigureLogsForChannelResponse < Struct.new(
|
520
|
+
:channel_name,
|
521
|
+
:log_types)
|
522
|
+
SENSITIVE = []
|
523
|
+
include Aws::Structure
|
524
|
+
end
|
525
|
+
|
526
|
+
# Configures Amazon CloudWatch log settings for a playback
|
527
|
+
# configuration.
|
441
528
|
#
|
442
529
|
# @!attribute [rw] percent_enabled
|
443
530
|
# The percentage of session logs that MediaTailor sends to your
|
444
531
|
# Cloudwatch Logs account. For example, if your playback configuration
|
445
|
-
# has 1000 sessions and percentEnabled is set to 60
|
446
|
-
# logs for 600 of the sessions to CloudWatch Logs. MediaTailor
|
447
|
-
# at random which of the playback configuration sessions to
|
448
|
-
# for. If you want to view logs for a specific session, you
|
449
|
-
# the [debug log mode][1].
|
532
|
+
# has 1000 sessions and percentEnabled is set to `60`, MediaTailor
|
533
|
+
# sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor
|
534
|
+
# decides at random which of the playback configuration sessions to
|
535
|
+
# send logs for. If you want to view logs for a specific session, you
|
536
|
+
# can use the [debug log mode][1].
|
450
537
|
#
|
451
|
-
# Valid values: 0 - 100
|
538
|
+
# Valid values: `0` - `100`
|
452
539
|
#
|
453
540
|
#
|
454
541
|
#
|
@@ -468,8 +555,6 @@ module Aws::MediaTailor
|
|
468
555
|
include Aws::Structure
|
469
556
|
end
|
470
557
|
|
471
|
-
# Amazon CloudWatch log settings for a playback configuration.
|
472
|
-
#
|
473
558
|
# @!attribute [rw] percent_enabled
|
474
559
|
# The percentage of session logs that MediaTailor sends to your
|
475
560
|
# Cloudwatch Logs account.
|
@@ -488,45 +573,15 @@ module Aws::MediaTailor
|
|
488
573
|
include Aws::Structure
|
489
574
|
end
|
490
575
|
|
491
|
-
# The configuration for this channel.
|
492
|
-
#
|
493
|
-
# @note When making an API call, you may pass CreateChannelRequest
|
494
|
-
# data as a hash:
|
495
|
-
#
|
496
|
-
# {
|
497
|
-
# channel_name: "__string", # required
|
498
|
-
# filler_slate: {
|
499
|
-
# source_location_name: "__string",
|
500
|
-
# vod_source_name: "__string",
|
501
|
-
# },
|
502
|
-
# outputs: [ # required
|
503
|
-
# {
|
504
|
-
# dash_playlist_settings: {
|
505
|
-
# manifest_window_seconds: 1,
|
506
|
-
# min_buffer_time_seconds: 1,
|
507
|
-
# min_update_period_seconds: 1,
|
508
|
-
# suggested_presentation_delay_seconds: 1,
|
509
|
-
# },
|
510
|
-
# hls_playlist_settings: {
|
511
|
-
# manifest_window_seconds: 1,
|
512
|
-
# },
|
513
|
-
# manifest_name: "__string", # required
|
514
|
-
# source_group: "__string", # required
|
515
|
-
# },
|
516
|
-
# ],
|
517
|
-
# playback_mode: "LOOP", # required, accepts LOOP, LINEAR
|
518
|
-
# tags: {
|
519
|
-
# "__string" => "__string",
|
520
|
-
# },
|
521
|
-
# }
|
522
|
-
#
|
523
576
|
# @!attribute [rw] channel_name
|
577
|
+
# The name of the channel.
|
524
578
|
# @return [String]
|
525
579
|
#
|
526
580
|
# @!attribute [rw] filler_slate
|
527
581
|
# The slate used to fill gaps between programs in the schedule. You
|
528
|
-
# must configure filler slate if your channel uses
|
529
|
-
# PlaybackMode
|
582
|
+
# must configure filler slate if your channel uses the `LINEAR`
|
583
|
+
# `PlaybackMode`. MediaTailor doesn't support filler slate for
|
584
|
+
# channels using the `LOOP` `PlaybackMode`.
|
530
585
|
# @return [Types::SlateSource]
|
531
586
|
#
|
532
587
|
# @!attribute [rw] outputs
|
@@ -536,18 +591,29 @@ module Aws::MediaTailor
|
|
536
591
|
# @!attribute [rw] playback_mode
|
537
592
|
# The type of playback mode to use for this channel.
|
538
593
|
#
|
539
|
-
# LINEAR - The programs in the schedule play once back-to-back in
|
540
|
-
# schedule.
|
594
|
+
# `LINEAR` - The programs in the schedule play once back-to-back in
|
595
|
+
# the schedule.
|
541
596
|
#
|
542
|
-
# LOOP - The programs in the schedule play back-to-back in an
|
543
|
-
# loop. When the last program in the schedule stops playing,
|
544
|
-
# loops back to the first program in the schedule.
|
597
|
+
# `LOOP` - The programs in the schedule play back-to-back in an
|
598
|
+
# endless loop. When the last program in the schedule stops playing,
|
599
|
+
# playback loops back to the first program in the schedule.
|
545
600
|
# @return [String]
|
546
601
|
#
|
547
602
|
# @!attribute [rw] tags
|
548
|
-
# The tags to assign to the channel.
|
603
|
+
# The tags to assign to the channel. Tags are key-value pairs that you
|
604
|
+
# can associate with Amazon resources to help with organization,
|
605
|
+
# access control, and cost tracking. For more information, see
|
606
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
607
|
+
#
|
608
|
+
#
|
609
|
+
#
|
610
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
549
611
|
# @return [Hash<String,String>]
|
550
612
|
#
|
613
|
+
# @!attribute [rw] tier
|
614
|
+
# The tier of the channel.
|
615
|
+
# @return [String]
|
616
|
+
#
|
551
617
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateChannelRequest AWS API Documentation
|
552
618
|
#
|
553
619
|
class CreateChannelRequest < Struct.new(
|
@@ -555,39 +621,60 @@ module Aws::MediaTailor
|
|
555
621
|
:filler_slate,
|
556
622
|
:outputs,
|
557
623
|
:playback_mode,
|
558
|
-
:tags
|
624
|
+
:tags,
|
625
|
+
:tier)
|
559
626
|
SENSITIVE = []
|
560
627
|
include Aws::Structure
|
561
628
|
end
|
562
629
|
|
563
630
|
# @!attribute [rw] arn
|
631
|
+
# The Amazon Resource Name (ARN) to assign to the channel.
|
564
632
|
# @return [String]
|
565
633
|
#
|
566
634
|
# @!attribute [rw] channel_name
|
635
|
+
# The name to assign to the channel.
|
567
636
|
# @return [String]
|
568
637
|
#
|
569
638
|
# @!attribute [rw] channel_state
|
639
|
+
# Indicates whether the channel is in a running state or not.
|
570
640
|
# @return [String]
|
571
641
|
#
|
572
642
|
# @!attribute [rw] creation_time
|
643
|
+
# The timestamp of when the channel was created.
|
573
644
|
# @return [Time]
|
574
645
|
#
|
575
646
|
# @!attribute [rw] filler_slate
|
576
|
-
#
|
647
|
+
# Contains information about the slate used to fill gaps between
|
648
|
+
# programs in the schedule.
|
577
649
|
# @return [Types::SlateSource]
|
578
650
|
#
|
579
651
|
# @!attribute [rw] last_modified_time
|
652
|
+
# The timestamp of when the channel was last modified.
|
580
653
|
# @return [Time]
|
581
654
|
#
|
582
655
|
# @!attribute [rw] outputs
|
656
|
+
# The output properties to assign to the channel.
|
583
657
|
# @return [Array<Types::ResponseOutputItem>]
|
584
658
|
#
|
585
659
|
# @!attribute [rw] playback_mode
|
660
|
+
# The playback mode to assign to the channel.
|
586
661
|
# @return [String]
|
587
662
|
#
|
588
663
|
# @!attribute [rw] tags
|
664
|
+
# The tags to assign to the channel. Tags are key-value pairs that you
|
665
|
+
# can associate with Amazon resources to help with organization,
|
666
|
+
# access control, and cost tracking. For more information, see
|
667
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
668
|
+
#
|
669
|
+
#
|
670
|
+
#
|
671
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
589
672
|
# @return [Hash<String,String>]
|
590
673
|
#
|
674
|
+
# @!attribute [rw] tier
|
675
|
+
# The tier of the channel.
|
676
|
+
# @return [String]
|
677
|
+
#
|
591
678
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateChannelResponse AWS API Documentation
|
592
679
|
#
|
593
680
|
class CreateChannelResponse < Struct.new(
|
@@ -599,40 +686,97 @@ module Aws::MediaTailor
|
|
599
686
|
:last_modified_time,
|
600
687
|
:outputs,
|
601
688
|
:playback_mode,
|
689
|
+
:tags,
|
690
|
+
:tier)
|
691
|
+
SENSITIVE = []
|
692
|
+
include Aws::Structure
|
693
|
+
end
|
694
|
+
|
695
|
+
# @!attribute [rw] http_package_configurations
|
696
|
+
# A list of HTTP package configuration parameters for this live
|
697
|
+
# source.
|
698
|
+
# @return [Array<Types::HttpPackageConfiguration>]
|
699
|
+
#
|
700
|
+
# @!attribute [rw] live_source_name
|
701
|
+
# The name of the live source.
|
702
|
+
# @return [String]
|
703
|
+
#
|
704
|
+
# @!attribute [rw] source_location_name
|
705
|
+
# The name of the source location.
|
706
|
+
# @return [String]
|
707
|
+
#
|
708
|
+
# @!attribute [rw] tags
|
709
|
+
# The tags to assign to the live source. Tags are key-value pairs that
|
710
|
+
# you can associate with Amazon resources to help with organization,
|
711
|
+
# access control, and cost tracking. For more information, see
|
712
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
713
|
+
#
|
714
|
+
#
|
715
|
+
#
|
716
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
717
|
+
# @return [Hash<String,String>]
|
718
|
+
#
|
719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateLiveSourceRequest AWS API Documentation
|
720
|
+
#
|
721
|
+
class CreateLiveSourceRequest < Struct.new(
|
722
|
+
:http_package_configurations,
|
723
|
+
:live_source_name,
|
724
|
+
:source_location_name,
|
602
725
|
:tags)
|
603
726
|
SENSITIVE = []
|
604
727
|
include Aws::Structure
|
605
728
|
end
|
606
729
|
|
607
|
-
#
|
608
|
-
#
|
609
|
-
#
|
610
|
-
#
|
611
|
-
#
|
612
|
-
#
|
613
|
-
#
|
614
|
-
#
|
615
|
-
#
|
616
|
-
#
|
617
|
-
#
|
618
|
-
#
|
619
|
-
#
|
620
|
-
#
|
621
|
-
#
|
622
|
-
#
|
623
|
-
#
|
624
|
-
#
|
625
|
-
#
|
626
|
-
#
|
627
|
-
#
|
628
|
-
#
|
629
|
-
#
|
630
|
-
#
|
631
|
-
#
|
632
|
-
#
|
633
|
-
#
|
634
|
-
#
|
730
|
+
# @!attribute [rw] arn
|
731
|
+
# The ARN to assign to the live source.
|
732
|
+
# @return [String]
|
733
|
+
#
|
734
|
+
# @!attribute [rw] creation_time
|
735
|
+
# The time the live source was created.
|
736
|
+
# @return [Time]
|
737
|
+
#
|
738
|
+
# @!attribute [rw] http_package_configurations
|
739
|
+
# A list of HTTP package configuration parameters for this live
|
740
|
+
# source.
|
741
|
+
# @return [Array<Types::HttpPackageConfiguration>]
|
742
|
+
#
|
743
|
+
# @!attribute [rw] last_modified_time
|
744
|
+
# The time the live source was last modified.
|
745
|
+
# @return [Time]
|
746
|
+
#
|
747
|
+
# @!attribute [rw] live_source_name
|
748
|
+
# The name to assign to the live source.
|
749
|
+
# @return [String]
|
750
|
+
#
|
751
|
+
# @!attribute [rw] source_location_name
|
752
|
+
# The name to assign to the source location of the live source.
|
753
|
+
# @return [String]
|
754
|
+
#
|
755
|
+
# @!attribute [rw] tags
|
756
|
+
# The tags to assign to the live source. Tags are key-value pairs that
|
757
|
+
# you can associate with Amazon resources to help with organization,
|
758
|
+
# access control, and cost tracking. For more information, see
|
759
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
635
760
|
#
|
761
|
+
#
|
762
|
+
#
|
763
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
764
|
+
# @return [Hash<String,String>]
|
765
|
+
#
|
766
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateLiveSourceResponse AWS API Documentation
|
767
|
+
#
|
768
|
+
class CreateLiveSourceResponse < Struct.new(
|
769
|
+
:arn,
|
770
|
+
:creation_time,
|
771
|
+
:http_package_configurations,
|
772
|
+
:last_modified_time,
|
773
|
+
:live_source_name,
|
774
|
+
:source_location_name,
|
775
|
+
:tags)
|
776
|
+
SENSITIVE = []
|
777
|
+
include Aws::Structure
|
778
|
+
end
|
779
|
+
|
636
780
|
# @!attribute [rw] consumption
|
637
781
|
# The configuration settings for MediaTailor's *consumption* of the
|
638
782
|
# prefetched ads from the ad decision server. Each consumption
|
@@ -642,9 +786,11 @@ module Aws::MediaTailor
|
|
642
786
|
# @return [Types::PrefetchConsumption]
|
643
787
|
#
|
644
788
|
# @!attribute [rw] name
|
789
|
+
# The name to assign to the schedule request.
|
645
790
|
# @return [String]
|
646
791
|
#
|
647
792
|
# @!attribute [rw] playback_configuration_name
|
793
|
+
# The name to assign to the playback configuration.
|
648
794
|
# @return [String]
|
649
795
|
#
|
650
796
|
# @!attribute [rw] retrieval
|
@@ -656,10 +802,10 @@ module Aws::MediaTailor
|
|
656
802
|
# @!attribute [rw] stream_id
|
657
803
|
# An optional stream identifier that MediaTailor uses to prefetch ads
|
658
804
|
# for multiple streams that use the same playback configuration. If
|
659
|
-
# StreamId is specified, MediaTailor returns all of the prefetch
|
660
|
-
# schedules with an exact match on StreamId
|
805
|
+
# `StreamId` is specified, MediaTailor returns all of the prefetch
|
806
|
+
# schedules with an exact match on `StreamId`. If not specified,
|
661
807
|
# MediaTailor returns all of the prefetch schedules for the playback
|
662
|
-
# configuration, regardless of StreamId
|
808
|
+
# configuration, regardless of `StreamId`.
|
663
809
|
# @return [String]
|
664
810
|
#
|
665
811
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreatePrefetchScheduleRequest AWS API Documentation
|
@@ -675,26 +821,38 @@ module Aws::MediaTailor
|
|
675
821
|
end
|
676
822
|
|
677
823
|
# @!attribute [rw] arn
|
824
|
+
# The ARN to assign to the prefetch schedule.
|
678
825
|
# @return [String]
|
679
826
|
#
|
680
827
|
# @!attribute [rw] consumption
|
681
|
-
#
|
682
|
-
#
|
828
|
+
# The configuration settings for MediaTailor's *consumption* of the
|
829
|
+
# prefetched ads from the ad decision server. Each consumption
|
830
|
+
# configuration contains an end time and an optional start time that
|
831
|
+
# define the *consumption window*. Prefetch schedules automatically
|
832
|
+
# expire no earlier than seven days after the end time.
|
683
833
|
# @return [Types::PrefetchConsumption]
|
684
834
|
#
|
685
835
|
# @!attribute [rw] name
|
836
|
+
# The name to assign to the prefetch schedule.
|
686
837
|
# @return [String]
|
687
838
|
#
|
688
839
|
# @!attribute [rw] playback_configuration_name
|
840
|
+
# The name to assign to the playback configuration.
|
689
841
|
# @return [String]
|
690
842
|
#
|
691
843
|
# @!attribute [rw] retrieval
|
692
|
-
#
|
693
|
-
#
|
694
|
-
#
|
844
|
+
# The configuration settings for retrieval of prefetched ads from the
|
845
|
+
# ad decision server. Only one set of prefetched ads will be retrieved
|
846
|
+
# and subsequently consumed for each ad break.
|
695
847
|
# @return [Types::PrefetchRetrieval]
|
696
848
|
#
|
697
849
|
# @!attribute [rw] stream_id
|
850
|
+
# An optional stream identifier that MediaTailor uses to prefetch ads
|
851
|
+
# for multiple streams that use the same playback configuration. If
|
852
|
+
# `StreamId` is specified, MediaTailor returns all of the prefetch
|
853
|
+
# schedules with an exact match on `StreamId`. If not specified,
|
854
|
+
# MediaTailor returns all of the prefetch schedules for the playback
|
855
|
+
# configuration, regardless of `StreamId`.
|
698
856
|
# @return [String]
|
699
857
|
#
|
700
858
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreatePrefetchScheduleResponse AWS API Documentation
|
@@ -710,50 +868,20 @@ module Aws::MediaTailor
|
|
710
868
|
include Aws::Structure
|
711
869
|
end
|
712
870
|
|
713
|
-
# Program configuration parameters.
|
714
|
-
#
|
715
|
-
# @note When making an API call, you may pass CreateProgramRequest
|
716
|
-
# data as a hash:
|
717
|
-
#
|
718
|
-
# {
|
719
|
-
# ad_breaks: [
|
720
|
-
# {
|
721
|
-
# message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT
|
722
|
-
# offset_millis: 1,
|
723
|
-
# slate: {
|
724
|
-
# source_location_name: "__string",
|
725
|
-
# vod_source_name: "__string",
|
726
|
-
# },
|
727
|
-
# splice_insert_message: {
|
728
|
-
# avail_num: 1,
|
729
|
-
# avails_expected: 1,
|
730
|
-
# splice_event_id: 1,
|
731
|
-
# unique_program_id: 1,
|
732
|
-
# },
|
733
|
-
# },
|
734
|
-
# ],
|
735
|
-
# channel_name: "__string", # required
|
736
|
-
# program_name: "__string", # required
|
737
|
-
# schedule_configuration: { # required
|
738
|
-
# transition: { # required
|
739
|
-
# relative_position: "BEFORE_PROGRAM", # required, accepts BEFORE_PROGRAM, AFTER_PROGRAM
|
740
|
-
# relative_program: "__string",
|
741
|
-
# scheduled_start_time_millis: 1,
|
742
|
-
# type: "__string", # required
|
743
|
-
# },
|
744
|
-
# },
|
745
|
-
# source_location_name: "__string", # required
|
746
|
-
# vod_source_name: "__string", # required
|
747
|
-
# }
|
748
|
-
#
|
749
871
|
# @!attribute [rw] ad_breaks
|
750
872
|
# The ad break configuration settings.
|
751
873
|
# @return [Array<Types::AdBreak>]
|
752
874
|
#
|
753
875
|
# @!attribute [rw] channel_name
|
876
|
+
# The name of the channel for this Program.
|
877
|
+
# @return [String]
|
878
|
+
#
|
879
|
+
# @!attribute [rw] live_source_name
|
880
|
+
# The name of the LiveSource for this Program.
|
754
881
|
# @return [String]
|
755
882
|
#
|
756
883
|
# @!attribute [rw] program_name
|
884
|
+
# The name of the Program.
|
757
885
|
# @return [String]
|
758
886
|
#
|
759
887
|
# @!attribute [rw] schedule_configuration
|
@@ -773,6 +901,7 @@ module Aws::MediaTailor
|
|
773
901
|
class CreateProgramRequest < Struct.new(
|
774
902
|
:ad_breaks,
|
775
903
|
:channel_name,
|
904
|
+
:live_source_name,
|
776
905
|
:program_name,
|
777
906
|
:schedule_configuration,
|
778
907
|
:source_location_name,
|
@@ -782,27 +911,47 @@ module Aws::MediaTailor
|
|
782
911
|
end
|
783
912
|
|
784
913
|
# @!attribute [rw] ad_breaks
|
914
|
+
# The ad break configuration settings.
|
785
915
|
# @return [Array<Types::AdBreak>]
|
786
916
|
#
|
787
917
|
# @!attribute [rw] arn
|
918
|
+
# The ARN to assign to the program.
|
788
919
|
# @return [String]
|
789
920
|
#
|
790
921
|
# @!attribute [rw] channel_name
|
922
|
+
# The name to assign to the channel for this program.
|
791
923
|
# @return [String]
|
792
924
|
#
|
925
|
+
# @!attribute [rw] clip_range
|
926
|
+
# The clip range configuration settings.
|
927
|
+
# @return [Types::ClipRange]
|
928
|
+
#
|
793
929
|
# @!attribute [rw] creation_time
|
930
|
+
# The time the program was created.
|
794
931
|
# @return [Time]
|
795
932
|
#
|
933
|
+
# @!attribute [rw] duration_millis
|
934
|
+
# The duration of the live program in milliseconds.
|
935
|
+
# @return [Integer]
|
936
|
+
#
|
937
|
+
# @!attribute [rw] live_source_name
|
938
|
+
# The name of the LiveSource for this Program.
|
939
|
+
# @return [String]
|
940
|
+
#
|
796
941
|
# @!attribute [rw] program_name
|
942
|
+
# The name to assign to this program.
|
797
943
|
# @return [String]
|
798
944
|
#
|
799
945
|
# @!attribute [rw] scheduled_start_time
|
946
|
+
# The scheduled start time for this Program.
|
800
947
|
# @return [Time]
|
801
948
|
#
|
802
949
|
# @!attribute [rw] source_location_name
|
950
|
+
# The name to assign to the source location for this program.
|
803
951
|
# @return [String]
|
804
952
|
#
|
805
953
|
# @!attribute [rw] vod_source_name
|
954
|
+
# The name that's used to refer to a VOD source.
|
806
955
|
# @return [String]
|
807
956
|
#
|
808
957
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateProgramResponse AWS API Documentation
|
@@ -811,7 +960,10 @@ module Aws::MediaTailor
|
|
811
960
|
:ad_breaks,
|
812
961
|
:arn,
|
813
962
|
:channel_name,
|
963
|
+
:clip_range,
|
814
964
|
:creation_time,
|
965
|
+
:duration_millis,
|
966
|
+
:live_source_name,
|
815
967
|
:program_name,
|
816
968
|
:scheduled_start_time,
|
817
969
|
:source_location_name,
|
@@ -820,32 +972,6 @@ module Aws::MediaTailor
|
|
820
972
|
include Aws::Structure
|
821
973
|
end
|
822
974
|
|
823
|
-
# Source location configuration parameters.
|
824
|
-
#
|
825
|
-
# @note When making an API call, you may pass CreateSourceLocationRequest
|
826
|
-
# data as a hash:
|
827
|
-
#
|
828
|
-
# {
|
829
|
-
# access_configuration: {
|
830
|
-
# access_type: "S3_SIGV4", # accepts S3_SIGV4, SECRETS_MANAGER_ACCESS_TOKEN
|
831
|
-
# secrets_manager_access_token_configuration: {
|
832
|
-
# header_name: "__string",
|
833
|
-
# secret_arn: "__string",
|
834
|
-
# secret_string_key: "__string",
|
835
|
-
# },
|
836
|
-
# },
|
837
|
-
# default_segment_delivery_configuration: {
|
838
|
-
# base_url: "__string",
|
839
|
-
# },
|
840
|
-
# http_configuration: { # required
|
841
|
-
# base_url: "__string", # required
|
842
|
-
# },
|
843
|
-
# source_location_name: "__string", # required
|
844
|
-
# tags: {
|
845
|
-
# "__string" => "__string",
|
846
|
-
# },
|
847
|
-
# }
|
848
|
-
#
|
849
975
|
# @!attribute [rw] access_configuration
|
850
976
|
# Access configuration parameters. Configures the type of
|
851
977
|
# authentication used to access content from your source location.
|
@@ -859,11 +985,24 @@ module Aws::MediaTailor
|
|
859
985
|
# The source's HTTP package configurations.
|
860
986
|
# @return [Types::HttpConfiguration]
|
861
987
|
#
|
988
|
+
# @!attribute [rw] segment_delivery_configurations
|
989
|
+
# A list of the segment delivery configurations associated with this
|
990
|
+
# resource.
|
991
|
+
# @return [Array<Types::SegmentDeliveryConfiguration>]
|
992
|
+
#
|
862
993
|
# @!attribute [rw] source_location_name
|
994
|
+
# The name associated with the source location.
|
863
995
|
# @return [String]
|
864
996
|
#
|
865
997
|
# @!attribute [rw] tags
|
866
|
-
# The tags to assign to the source location.
|
998
|
+
# The tags to assign to the source location. Tags are key-value pairs
|
999
|
+
# that you can associate with Amazon resources to help with
|
1000
|
+
# organization, access control, and cost tracking. For more
|
1001
|
+
# information, see [Tagging AWS Elemental MediaTailor Resources][1].
|
1002
|
+
#
|
1003
|
+
#
|
1004
|
+
#
|
1005
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
867
1006
|
# @return [Hash<String,String>]
|
868
1007
|
#
|
869
1008
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateSourceLocationRequest AWS API Documentation
|
@@ -872,6 +1011,7 @@ module Aws::MediaTailor
|
|
872
1011
|
:access_configuration,
|
873
1012
|
:default_segment_delivery_configuration,
|
874
1013
|
:http_configuration,
|
1014
|
+
:segment_delivery_configurations,
|
875
1015
|
:source_location_name,
|
876
1016
|
:tags)
|
877
1017
|
SENSITIVE = []
|
@@ -879,36 +1019,53 @@ module Aws::MediaTailor
|
|
879
1019
|
end
|
880
1020
|
|
881
1021
|
# @!attribute [rw] access_configuration
|
882
|
-
# Access configuration parameters.
|
1022
|
+
# Access configuration parameters. Configures the type of
|
1023
|
+
# authentication used to access content from your source location.
|
883
1024
|
# @return [Types::AccessConfiguration]
|
884
1025
|
#
|
885
1026
|
# @!attribute [rw] arn
|
1027
|
+
# The ARN to assign to the source location.
|
886
1028
|
# @return [String]
|
887
1029
|
#
|
888
1030
|
# @!attribute [rw] creation_time
|
1031
|
+
# The time the source location was created.
|
889
1032
|
# @return [Time]
|
890
1033
|
#
|
891
1034
|
# @!attribute [rw] default_segment_delivery_configuration
|
892
|
-
# The optional configuration for
|
893
|
-
# this if you want the segment delivery server to be different from
|
894
|
-
# the source location server. For example, you can configure your
|
895
|
-
# source location server to be an origination server, such as
|
896
|
-
# MediaPackage, and the segment delivery server to be a content
|
897
|
-
# delivery network (CDN), such as CloudFront. If you don't specify a
|
898
|
-
# segment delivery server, then the source location server is used.
|
1035
|
+
# The optional configuration for the server that serves segments.
|
899
1036
|
# @return [Types::DefaultSegmentDeliveryConfiguration]
|
900
1037
|
#
|
901
1038
|
# @!attribute [rw] http_configuration
|
902
|
-
# The HTTP
|
1039
|
+
# The source's HTTP package configurations.
|
903
1040
|
# @return [Types::HttpConfiguration]
|
904
1041
|
#
|
905
1042
|
# @!attribute [rw] last_modified_time
|
1043
|
+
# The time the source location was last modified.
|
906
1044
|
# @return [Time]
|
907
1045
|
#
|
1046
|
+
# @!attribute [rw] segment_delivery_configurations
|
1047
|
+
# The segment delivery configurations for the source location. For
|
1048
|
+
# information about MediaTailor configurations, see [Working with
|
1049
|
+
# configurations in AWS Elemental MediaTailor][1].
|
1050
|
+
#
|
1051
|
+
#
|
1052
|
+
#
|
1053
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
|
1054
|
+
# @return [Array<Types::SegmentDeliveryConfiguration>]
|
1055
|
+
#
|
908
1056
|
# @!attribute [rw] source_location_name
|
1057
|
+
# The name to assign to the source location.
|
909
1058
|
# @return [String]
|
910
1059
|
#
|
911
1060
|
# @!attribute [rw] tags
|
1061
|
+
# The tags to assign to the source location. Tags are key-value pairs
|
1062
|
+
# that you can associate with Amazon resources to help with
|
1063
|
+
# organization, access control, and cost tracking. For more
|
1064
|
+
# information, see [Tagging AWS Elemental MediaTailor Resources][1].
|
1065
|
+
#
|
1066
|
+
#
|
1067
|
+
#
|
1068
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
912
1069
|
# @return [Hash<String,String>]
|
913
1070
|
#
|
914
1071
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateSourceLocationResponse AWS API Documentation
|
@@ -920,45 +1077,34 @@ module Aws::MediaTailor
|
|
920
1077
|
:default_segment_delivery_configuration,
|
921
1078
|
:http_configuration,
|
922
1079
|
:last_modified_time,
|
1080
|
+
:segment_delivery_configurations,
|
923
1081
|
:source_location_name,
|
924
1082
|
:tags)
|
925
1083
|
SENSITIVE = []
|
926
1084
|
include Aws::Structure
|
927
1085
|
end
|
928
1086
|
|
929
|
-
# The VOD source configuration parameters.
|
930
|
-
#
|
931
|
-
# @note When making an API call, you may pass CreateVodSourceRequest
|
932
|
-
# data as a hash:
|
933
|
-
#
|
934
|
-
# {
|
935
|
-
# http_package_configurations: [ # required
|
936
|
-
# {
|
937
|
-
# path: "__string", # required
|
938
|
-
# source_group: "__string", # required
|
939
|
-
# type: "DASH", # required, accepts DASH, HLS
|
940
|
-
# },
|
941
|
-
# ],
|
942
|
-
# source_location_name: "__string", # required
|
943
|
-
# tags: {
|
944
|
-
# "__string" => "__string",
|
945
|
-
# },
|
946
|
-
# vod_source_name: "__string", # required
|
947
|
-
# }
|
948
|
-
#
|
949
1087
|
# @!attribute [rw] http_package_configurations
|
950
|
-
#
|
951
|
-
# source.
|
1088
|
+
# A list of HTTP package configuration parameters for this VOD source.
|
952
1089
|
# @return [Array<Types::HttpPackageConfiguration>]
|
953
1090
|
#
|
954
1091
|
# @!attribute [rw] source_location_name
|
1092
|
+
# The name of the source location for this VOD source.
|
955
1093
|
# @return [String]
|
956
1094
|
#
|
957
1095
|
# @!attribute [rw] tags
|
958
|
-
# The tags to assign to the VOD source.
|
1096
|
+
# The tags to assign to the VOD source. Tags are key-value pairs that
|
1097
|
+
# you can associate with Amazon resources to help with organization,
|
1098
|
+
# access control, and cost tracking. For more information, see
|
1099
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
1100
|
+
#
|
1101
|
+
#
|
1102
|
+
#
|
1103
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
959
1104
|
# @return [Hash<String,String>]
|
960
1105
|
#
|
961
1106
|
# @!attribute [rw] vod_source_name
|
1107
|
+
# The name associated with the VOD source.>
|
962
1108
|
# @return [String]
|
963
1109
|
#
|
964
1110
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateVodSourceRequest AWS API Documentation
|
@@ -973,25 +1119,38 @@ module Aws::MediaTailor
|
|
973
1119
|
end
|
974
1120
|
|
975
1121
|
# @!attribute [rw] arn
|
1122
|
+
# The ARN to assign to this VOD source.
|
976
1123
|
# @return [String]
|
977
1124
|
#
|
978
1125
|
# @!attribute [rw] creation_time
|
1126
|
+
# The time the VOD source was created.
|
979
1127
|
# @return [Time]
|
980
1128
|
#
|
981
1129
|
# @!attribute [rw] http_package_configurations
|
982
|
-
#
|
1130
|
+
# A list of HTTP package configuration parameters for this VOD source.
|
983
1131
|
# @return [Array<Types::HttpPackageConfiguration>]
|
984
1132
|
#
|
985
1133
|
# @!attribute [rw] last_modified_time
|
1134
|
+
# The time the VOD source was last modified.
|
986
1135
|
# @return [Time]
|
987
1136
|
#
|
988
1137
|
# @!attribute [rw] source_location_name
|
1138
|
+
# The name to assign to the source location for this VOD source.
|
989
1139
|
# @return [String]
|
990
1140
|
#
|
991
1141
|
# @!attribute [rw] tags
|
1142
|
+
# The tags to assign to the VOD source. Tags are key-value pairs that
|
1143
|
+
# you can associate with Amazon resources to help with organization,
|
1144
|
+
# access control, and cost tracking. For more information, see
|
1145
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
1146
|
+
#
|
1147
|
+
#
|
1148
|
+
#
|
1149
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
992
1150
|
# @return [Hash<String,String>]
|
993
1151
|
#
|
994
1152
|
# @!attribute [rw] vod_source_name
|
1153
|
+
# The name to assign to the VOD source.
|
995
1154
|
# @return [String]
|
996
1155
|
#
|
997
1156
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateVodSourceResponse AWS API Documentation
|
@@ -1023,18 +1182,18 @@ module Aws::MediaTailor
|
|
1023
1182
|
# don't support sticky redirects. Disable this if you have CDN
|
1024
1183
|
# routing rules set up for accessing MediaTailor manifests, and you
|
1025
1184
|
# are either using client-side reporting or your players support
|
1026
|
-
# sticky HTTP redirects. Valid values are DISABLED and
|
1027
|
-
# The
|
1028
|
-
# default value.
|
1185
|
+
# sticky HTTP redirects. Valid values are `DISABLED` and
|
1186
|
+
# `EMT_DEFAULT`. The `EMT_DEFAULT` setting enables the inclusion of
|
1187
|
+
# the tag and is the default value.
|
1029
1188
|
# @return [String]
|
1030
1189
|
#
|
1031
1190
|
# @!attribute [rw] origin_manifest_type
|
1032
1191
|
# The setting that controls whether MediaTailor handles manifests from
|
1033
1192
|
# the origin server as multi-period manifests or single-period
|
1034
1193
|
# manifests. If your origin server produces single-period manifests,
|
1035
|
-
# set this to
|
1194
|
+
# set this to `SINGLE_PERIOD`. The default setting is `MULTI_PERIOD`.
|
1036
1195
|
# For multi-period manifests, omit this setting or set it to
|
1037
|
-
#
|
1196
|
+
# `MULTI_PERIOD`.
|
1038
1197
|
# @return [String]
|
1039
1198
|
#
|
1040
1199
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DashConfiguration AWS API Documentation
|
@@ -1049,14 +1208,6 @@ module Aws::MediaTailor
|
|
1049
1208
|
|
1050
1209
|
# The configuration for DASH PUT operations.
|
1051
1210
|
#
|
1052
|
-
# @note When making an API call, you may pass DashConfigurationForPut
|
1053
|
-
# data as a hash:
|
1054
|
-
#
|
1055
|
-
# {
|
1056
|
-
# mpd_location: "__string",
|
1057
|
-
# origin_manifest_type: "SINGLE_PERIOD", # accepts SINGLE_PERIOD, MULTI_PERIOD
|
1058
|
-
# }
|
1059
|
-
#
|
1060
1211
|
# @!attribute [rw] mpd_location
|
1061
1212
|
# The setting that controls whether MediaTailor includes the Location
|
1062
1213
|
# tag in DASH manifests. MediaTailor populates the Location tag with
|
@@ -1064,18 +1215,18 @@ module Aws::MediaTailor
|
|
1064
1215
|
# don't support sticky redirects. Disable this if you have CDN
|
1065
1216
|
# routing rules set up for accessing MediaTailor manifests, and you
|
1066
1217
|
# are either using client-side reporting or your players support
|
1067
|
-
# sticky HTTP redirects. Valid values are DISABLED and
|
1068
|
-
# The
|
1069
|
-
# default value.
|
1218
|
+
# sticky HTTP redirects. Valid values are `DISABLED` and
|
1219
|
+
# `EMT_DEFAULT`. The `EMT_DEFAULT` setting enables the inclusion of
|
1220
|
+
# the tag and is the default value.
|
1070
1221
|
# @return [String]
|
1071
1222
|
#
|
1072
1223
|
# @!attribute [rw] origin_manifest_type
|
1073
1224
|
# The setting that controls whether MediaTailor handles manifests from
|
1074
1225
|
# the origin server as multi-period manifests or single-period
|
1075
1226
|
# manifests. If your origin server produces single-period manifests,
|
1076
|
-
# set this to
|
1227
|
+
# set this to `SINGLE_PERIOD`. The default setting is `MULTI_PERIOD`.
|
1077
1228
|
# For multi-period manifests, omit this setting or set it to
|
1078
|
-
#
|
1229
|
+
# `MULTI_PERIOD`.
|
1079
1230
|
# @return [String]
|
1080
1231
|
#
|
1081
1232
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DashConfigurationForPut AWS API Documentation
|
@@ -1089,37 +1240,27 @@ module Aws::MediaTailor
|
|
1089
1240
|
|
1090
1241
|
# Dash manifest configuration parameters.
|
1091
1242
|
#
|
1092
|
-
# @note When making an API call, you may pass DashPlaylistSettings
|
1093
|
-
# data as a hash:
|
1094
|
-
#
|
1095
|
-
# {
|
1096
|
-
# manifest_window_seconds: 1,
|
1097
|
-
# min_buffer_time_seconds: 1,
|
1098
|
-
# min_update_period_seconds: 1,
|
1099
|
-
# suggested_presentation_delay_seconds: 1,
|
1100
|
-
# }
|
1101
|
-
#
|
1102
1243
|
# @!attribute [rw] manifest_window_seconds
|
1103
|
-
# The total duration (in seconds) of each manifest. Minimum value:
|
1104
|
-
# seconds. Maximum value: 3600 seconds.
|
1244
|
+
# The total duration (in seconds) of each manifest. Minimum value:
|
1245
|
+
# `30` seconds. Maximum value: `3600` seconds.
|
1105
1246
|
# @return [Integer]
|
1106
1247
|
#
|
1107
1248
|
# @!attribute [rw] min_buffer_time_seconds
|
1108
1249
|
# Minimum amount of content (measured in seconds) that a player must
|
1109
|
-
# keep available in the buffer. Minimum value: 2 seconds. Maximum
|
1110
|
-
# value: 60 seconds.
|
1250
|
+
# keep available in the buffer. Minimum value: `2` seconds. Maximum
|
1251
|
+
# value: `60` seconds.
|
1111
1252
|
# @return [Integer]
|
1112
1253
|
#
|
1113
1254
|
# @!attribute [rw] min_update_period_seconds
|
1114
1255
|
# Minimum amount of time (in seconds) that the player should wait
|
1115
|
-
# before requesting updates to the manifest. Minimum value: 2
|
1116
|
-
# Maximum value: 60 seconds.
|
1256
|
+
# before requesting updates to the manifest. Minimum value: `2`
|
1257
|
+
# seconds. Maximum value: `60` seconds.
|
1117
1258
|
# @return [Integer]
|
1118
1259
|
#
|
1119
1260
|
# @!attribute [rw] suggested_presentation_delay_seconds
|
1120
1261
|
# Amount of time (in seconds) that the player should be from the live
|
1121
|
-
# point at the end of the manifest. Minimum value: 2 seconds.
|
1122
|
-
# value: 60 seconds.
|
1262
|
+
# point at the end of the manifest. Minimum value: `2` seconds.
|
1263
|
+
# Maximum value: `60` seconds.
|
1123
1264
|
# @return [Integer]
|
1124
1265
|
#
|
1125
1266
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DashPlaylistSettings AWS API Documentation
|
@@ -1141,13 +1282,6 @@ module Aws::MediaTailor
|
|
1141
1282
|
# such as CloudFront. If you don't specify a segment delivery server,
|
1142
1283
|
# then the source location server is used.
|
1143
1284
|
#
|
1144
|
-
# @note When making an API call, you may pass DefaultSegmentDeliveryConfiguration
|
1145
|
-
# data as a hash:
|
1146
|
-
#
|
1147
|
-
# {
|
1148
|
-
# base_url: "__string",
|
1149
|
-
# }
|
1150
|
-
#
|
1151
1285
|
# @!attribute [rw] base_url
|
1152
1286
|
# The hostname of the server that will be used to serve segments. This
|
1153
1287
|
# string must include the protocol, such as **https://**.
|
@@ -1161,16 +1295,8 @@ module Aws::MediaTailor
|
|
1161
1295
|
include Aws::Structure
|
1162
1296
|
end
|
1163
1297
|
|
1164
|
-
# This response includes only the "type" : "object" property.
|
1165
|
-
#
|
1166
|
-
# @note When making an API call, you may pass DeleteChannelPolicyRequest
|
1167
|
-
# data as a hash:
|
1168
|
-
#
|
1169
|
-
# {
|
1170
|
-
# channel_name: "__string", # required
|
1171
|
-
# }
|
1172
|
-
#
|
1173
1298
|
# @!attribute [rw] channel_name
|
1299
|
+
# The name of the channel associated with this channel policy.
|
1174
1300
|
# @return [String]
|
1175
1301
|
#
|
1176
1302
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelPolicyRequest AWS API Documentation
|
@@ -1181,20 +1307,12 @@ module Aws::MediaTailor
|
|
1181
1307
|
include Aws::Structure
|
1182
1308
|
end
|
1183
1309
|
|
1184
|
-
# This response includes only the "type" : "object" property.
|
1185
|
-
#
|
1186
1310
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelPolicyResponse AWS API Documentation
|
1187
1311
|
#
|
1188
1312
|
class DeleteChannelPolicyResponse < Aws::EmptyStructure; end
|
1189
1313
|
|
1190
|
-
# @note When making an API call, you may pass DeleteChannelRequest
|
1191
|
-
# data as a hash:
|
1192
|
-
#
|
1193
|
-
# {
|
1194
|
-
# channel_name: "__string", # required
|
1195
|
-
# }
|
1196
|
-
#
|
1197
1314
|
# @!attribute [rw] channel_name
|
1315
|
+
# The name of the channel.
|
1198
1316
|
# @return [String]
|
1199
1317
|
#
|
1200
1318
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelRequest AWS API Documentation
|
@@ -1205,20 +1323,33 @@ module Aws::MediaTailor
|
|
1205
1323
|
include Aws::Structure
|
1206
1324
|
end
|
1207
1325
|
|
1208
|
-
# This response includes only the "type" : "object" property.
|
1209
|
-
#
|
1210
1326
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelResponse AWS API Documentation
|
1211
1327
|
#
|
1212
1328
|
class DeleteChannelResponse < Aws::EmptyStructure; end
|
1213
1329
|
|
1214
|
-
#
|
1215
|
-
#
|
1330
|
+
# @!attribute [rw] live_source_name
|
1331
|
+
# The name of the live source.
|
1332
|
+
# @return [String]
|
1216
1333
|
#
|
1217
|
-
#
|
1218
|
-
#
|
1219
|
-
#
|
1334
|
+
# @!attribute [rw] source_location_name
|
1335
|
+
# The name of the source location associated with this Live Source.
|
1336
|
+
# @return [String]
|
1337
|
+
#
|
1338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteLiveSourceRequest AWS API Documentation
|
1339
|
+
#
|
1340
|
+
class DeleteLiveSourceRequest < Struct.new(
|
1341
|
+
:live_source_name,
|
1342
|
+
:source_location_name)
|
1343
|
+
SENSITIVE = []
|
1344
|
+
include Aws::Structure
|
1345
|
+
end
|
1346
|
+
|
1347
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteLiveSourceResponse AWS API Documentation
|
1220
1348
|
#
|
1349
|
+
class DeleteLiveSourceResponse < Aws::EmptyStructure; end
|
1350
|
+
|
1221
1351
|
# @!attribute [rw] name
|
1352
|
+
# The name of the playback configuration.
|
1222
1353
|
# @return [String]
|
1223
1354
|
#
|
1224
1355
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePlaybackConfigurationRequest AWS API Documentation
|
@@ -1233,18 +1364,13 @@ module Aws::MediaTailor
|
|
1233
1364
|
#
|
1234
1365
|
class DeletePlaybackConfigurationResponse < Aws::EmptyStructure; end
|
1235
1366
|
|
1236
|
-
# @note When making an API call, you may pass DeletePrefetchScheduleRequest
|
1237
|
-
# data as a hash:
|
1238
|
-
#
|
1239
|
-
# {
|
1240
|
-
# name: "__string", # required
|
1241
|
-
# playback_configuration_name: "__string", # required
|
1242
|
-
# }
|
1243
|
-
#
|
1244
1367
|
# @!attribute [rw] name
|
1368
|
+
# The name of the prefetch schedule. If the action is successful, the
|
1369
|
+
# service sends back an HTTP 204 response with an empty HTTP body.
|
1245
1370
|
# @return [String]
|
1246
1371
|
#
|
1247
1372
|
# @!attribute [rw] playback_configuration_name
|
1373
|
+
# The name of the playback configuration for this prefetch schedule.
|
1248
1374
|
# @return [String]
|
1249
1375
|
#
|
1250
1376
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePrefetchScheduleRequest AWS API Documentation
|
@@ -1256,25 +1382,16 @@ module Aws::MediaTailor
|
|
1256
1382
|
include Aws::Structure
|
1257
1383
|
end
|
1258
1384
|
|
1259
|
-
# If the action is successful, the service sends back an HTTP 204
|
1260
|
-
# response with an empty HTTP body.
|
1261
|
-
#
|
1262
1385
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePrefetchScheduleResponse AWS API Documentation
|
1263
1386
|
#
|
1264
1387
|
class DeletePrefetchScheduleResponse < Aws::EmptyStructure; end
|
1265
1388
|
|
1266
|
-
# @note When making an API call, you may pass DeleteProgramRequest
|
1267
|
-
# data as a hash:
|
1268
|
-
#
|
1269
|
-
# {
|
1270
|
-
# channel_name: "__string", # required
|
1271
|
-
# program_name: "__string", # required
|
1272
|
-
# }
|
1273
|
-
#
|
1274
1389
|
# @!attribute [rw] channel_name
|
1390
|
+
# The name of the channel.
|
1275
1391
|
# @return [String]
|
1276
1392
|
#
|
1277
1393
|
# @!attribute [rw] program_name
|
1394
|
+
# The name of the program.
|
1278
1395
|
# @return [String]
|
1279
1396
|
#
|
1280
1397
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteProgramRequest AWS API Documentation
|
@@ -1286,20 +1403,12 @@ module Aws::MediaTailor
|
|
1286
1403
|
include Aws::Structure
|
1287
1404
|
end
|
1288
1405
|
|
1289
|
-
# This response includes only the "type" : "object" property.
|
1290
|
-
#
|
1291
1406
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteProgramResponse AWS API Documentation
|
1292
1407
|
#
|
1293
1408
|
class DeleteProgramResponse < Aws::EmptyStructure; end
|
1294
1409
|
|
1295
|
-
# @note When making an API call, you may pass DeleteSourceLocationRequest
|
1296
|
-
# data as a hash:
|
1297
|
-
#
|
1298
|
-
# {
|
1299
|
-
# source_location_name: "__string", # required
|
1300
|
-
# }
|
1301
|
-
#
|
1302
1410
|
# @!attribute [rw] source_location_name
|
1411
|
+
# The name of the source location.
|
1303
1412
|
# @return [String]
|
1304
1413
|
#
|
1305
1414
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteSourceLocationRequest AWS API Documentation
|
@@ -1310,24 +1419,16 @@ module Aws::MediaTailor
|
|
1310
1419
|
include Aws::Structure
|
1311
1420
|
end
|
1312
1421
|
|
1313
|
-
# This response includes only the "type" : "object" property.
|
1314
|
-
#
|
1315
1422
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteSourceLocationResponse AWS API Documentation
|
1316
1423
|
#
|
1317
1424
|
class DeleteSourceLocationResponse < Aws::EmptyStructure; end
|
1318
1425
|
|
1319
|
-
# @note When making an API call, you may pass DeleteVodSourceRequest
|
1320
|
-
# data as a hash:
|
1321
|
-
#
|
1322
|
-
# {
|
1323
|
-
# source_location_name: "__string", # required
|
1324
|
-
# vod_source_name: "__string", # required
|
1325
|
-
# }
|
1326
|
-
#
|
1327
1426
|
# @!attribute [rw] source_location_name
|
1427
|
+
# The name of the source location associated with this VOD Source.
|
1328
1428
|
# @return [String]
|
1329
1429
|
#
|
1330
1430
|
# @!attribute [rw] vod_source_name
|
1431
|
+
# The name of the VOD source.
|
1331
1432
|
# @return [String]
|
1332
1433
|
#
|
1333
1434
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteVodSourceRequest AWS API Documentation
|
@@ -1339,20 +1440,12 @@ module Aws::MediaTailor
|
|
1339
1440
|
include Aws::Structure
|
1340
1441
|
end
|
1341
1442
|
|
1342
|
-
# This response includes only the "type" : "object" property.
|
1343
|
-
#
|
1344
1443
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteVodSourceResponse AWS API Documentation
|
1345
1444
|
#
|
1346
1445
|
class DeleteVodSourceResponse < Aws::EmptyStructure; end
|
1347
1446
|
|
1348
|
-
# @note When making an API call, you may pass DescribeChannelRequest
|
1349
|
-
# data as a hash:
|
1350
|
-
#
|
1351
|
-
# {
|
1352
|
-
# channel_name: "__string", # required
|
1353
|
-
# }
|
1354
|
-
#
|
1355
1447
|
# @!attribute [rw] channel_name
|
1448
|
+
# The name of the channel.
|
1356
1449
|
# @return [String]
|
1357
1450
|
#
|
1358
1451
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeChannelRequest AWS API Documentation
|
@@ -1363,8 +1456,6 @@ module Aws::MediaTailor
|
|
1363
1456
|
include Aws::Structure
|
1364
1457
|
end
|
1365
1458
|
|
1366
|
-
# Returns a channel's properties.
|
1367
|
-
#
|
1368
1459
|
# @!attribute [rw] arn
|
1369
1460
|
# The ARN of the channel.
|
1370
1461
|
# @return [String]
|
@@ -1390,7 +1481,11 @@ module Aws::MediaTailor
|
|
1390
1481
|
# The timestamp of when the channel was last modified.
|
1391
1482
|
# @return [Time]
|
1392
1483
|
#
|
1393
|
-
# @!attribute [rw]
|
1484
|
+
# @!attribute [rw] log_configuration
|
1485
|
+
# The log configuration for the channel.
|
1486
|
+
# @return [Types::LogConfigurationForChannel]
|
1487
|
+
#
|
1488
|
+
# @!attribute [rw] outputs
|
1394
1489
|
# The channel's output properties.
|
1395
1490
|
# @return [Array<Types::ResponseOutputItem>]
|
1396
1491
|
#
|
@@ -1399,9 +1494,20 @@ module Aws::MediaTailor
|
|
1399
1494
|
# @return [String]
|
1400
1495
|
#
|
1401
1496
|
# @!attribute [rw] tags
|
1402
|
-
# The tags assigned to the channel.
|
1497
|
+
# The tags assigned to the channel. Tags are key-value pairs that you
|
1498
|
+
# can associate with Amazon resources to help with organization,
|
1499
|
+
# access control, and cost tracking. For more information, see
|
1500
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
1501
|
+
#
|
1502
|
+
#
|
1503
|
+
#
|
1504
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
1403
1505
|
# @return [Hash<String,String>]
|
1404
1506
|
#
|
1507
|
+
# @!attribute [rw] tier
|
1508
|
+
# The channel's tier.
|
1509
|
+
# @return [String]
|
1510
|
+
#
|
1405
1511
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeChannelResponse AWS API Documentation
|
1406
1512
|
#
|
1407
1513
|
class DescribeChannelResponse < Struct.new(
|
@@ -1411,25 +1517,87 @@ module Aws::MediaTailor
|
|
1411
1517
|
:creation_time,
|
1412
1518
|
:filler_slate,
|
1413
1519
|
:last_modified_time,
|
1520
|
+
:log_configuration,
|
1414
1521
|
:outputs,
|
1415
1522
|
:playback_mode,
|
1416
|
-
:tags
|
1523
|
+
:tags,
|
1524
|
+
:tier)
|
1525
|
+
SENSITIVE = []
|
1526
|
+
include Aws::Structure
|
1527
|
+
end
|
1528
|
+
|
1529
|
+
# @!attribute [rw] live_source_name
|
1530
|
+
# The name of the live source.
|
1531
|
+
# @return [String]
|
1532
|
+
#
|
1533
|
+
# @!attribute [rw] source_location_name
|
1534
|
+
# The name of the source location associated with this Live Source.
|
1535
|
+
# @return [String]
|
1536
|
+
#
|
1537
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeLiveSourceRequest AWS API Documentation
|
1538
|
+
#
|
1539
|
+
class DescribeLiveSourceRequest < Struct.new(
|
1540
|
+
:live_source_name,
|
1541
|
+
:source_location_name)
|
1417
1542
|
SENSITIVE = []
|
1418
1543
|
include Aws::Structure
|
1419
1544
|
end
|
1420
1545
|
|
1421
|
-
#
|
1422
|
-
#
|
1546
|
+
# @!attribute [rw] arn
|
1547
|
+
# The ARN of the live source.
|
1548
|
+
# @return [String]
|
1549
|
+
#
|
1550
|
+
# @!attribute [rw] creation_time
|
1551
|
+
# The timestamp that indicates when the live source was created.
|
1552
|
+
# @return [Time]
|
1553
|
+
#
|
1554
|
+
# @!attribute [rw] http_package_configurations
|
1555
|
+
# The HTTP package configurations.
|
1556
|
+
# @return [Array<Types::HttpPackageConfiguration>]
|
1557
|
+
#
|
1558
|
+
# @!attribute [rw] last_modified_time
|
1559
|
+
# The timestamp that indicates when the live source was modified.
|
1560
|
+
# @return [Time]
|
1561
|
+
#
|
1562
|
+
# @!attribute [rw] live_source_name
|
1563
|
+
# The name of the live source.
|
1564
|
+
# @return [String]
|
1565
|
+
#
|
1566
|
+
# @!attribute [rw] source_location_name
|
1567
|
+
# The name of the source location associated with the live source.
|
1568
|
+
# @return [String]
|
1569
|
+
#
|
1570
|
+
# @!attribute [rw] tags
|
1571
|
+
# The tags assigned to the live source. Tags are key-value pairs that
|
1572
|
+
# you can associate with Amazon resources to help with organization,
|
1573
|
+
# access control, and cost tracking. For more information, see
|
1574
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
1575
|
+
#
|
1576
|
+
#
|
1577
|
+
#
|
1578
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
1579
|
+
# @return [Hash<String,String>]
|
1423
1580
|
#
|
1424
|
-
#
|
1425
|
-
# channel_name: "__string", # required
|
1426
|
-
# program_name: "__string", # required
|
1427
|
-
# }
|
1581
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeLiveSourceResponse AWS API Documentation
|
1428
1582
|
#
|
1583
|
+
class DescribeLiveSourceResponse < Struct.new(
|
1584
|
+
:arn,
|
1585
|
+
:creation_time,
|
1586
|
+
:http_package_configurations,
|
1587
|
+
:last_modified_time,
|
1588
|
+
:live_source_name,
|
1589
|
+
:source_location_name,
|
1590
|
+
:tags)
|
1591
|
+
SENSITIVE = []
|
1592
|
+
include Aws::Structure
|
1593
|
+
end
|
1594
|
+
|
1429
1595
|
# @!attribute [rw] channel_name
|
1596
|
+
# The name of the channel associated with this Program.
|
1430
1597
|
# @return [String]
|
1431
1598
|
#
|
1432
1599
|
# @!attribute [rw] program_name
|
1600
|
+
# The name of the program.
|
1433
1601
|
# @return [String]
|
1434
1602
|
#
|
1435
1603
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeProgramRequest AWS API Documentation
|
@@ -1441,8 +1609,6 @@ module Aws::MediaTailor
|
|
1441
1609
|
include Aws::Structure
|
1442
1610
|
end
|
1443
1611
|
|
1444
|
-
# This program's configuration parameters.
|
1445
|
-
#
|
1446
1612
|
# @!attribute [rw] ad_breaks
|
1447
1613
|
# The ad break configuration settings.
|
1448
1614
|
# @return [Array<Types::AdBreak>]
|
@@ -1455,10 +1621,22 @@ module Aws::MediaTailor
|
|
1455
1621
|
# The name of the channel that the program belongs to.
|
1456
1622
|
# @return [String]
|
1457
1623
|
#
|
1624
|
+
# @!attribute [rw] clip_range
|
1625
|
+
# The clip range configuration settings.
|
1626
|
+
# @return [Types::ClipRange]
|
1627
|
+
#
|
1458
1628
|
# @!attribute [rw] creation_time
|
1459
1629
|
# The timestamp of when the program was created.
|
1460
1630
|
# @return [Time]
|
1461
1631
|
#
|
1632
|
+
# @!attribute [rw] duration_millis
|
1633
|
+
# The duration of the live program in milliseconds.
|
1634
|
+
# @return [Integer]
|
1635
|
+
#
|
1636
|
+
# @!attribute [rw] live_source_name
|
1637
|
+
# The name of the LiveSource for this Program.
|
1638
|
+
# @return [String]
|
1639
|
+
#
|
1462
1640
|
# @!attribute [rw] program_name
|
1463
1641
|
# The name of the program.
|
1464
1642
|
# @return [String]
|
@@ -1484,7 +1662,10 @@ module Aws::MediaTailor
|
|
1484
1662
|
:ad_breaks,
|
1485
1663
|
:arn,
|
1486
1664
|
:channel_name,
|
1665
|
+
:clip_range,
|
1487
1666
|
:creation_time,
|
1667
|
+
:duration_millis,
|
1668
|
+
:live_source_name,
|
1488
1669
|
:program_name,
|
1489
1670
|
:scheduled_start_time,
|
1490
1671
|
:source_location_name,
|
@@ -1493,14 +1674,8 @@ module Aws::MediaTailor
|
|
1493
1674
|
include Aws::Structure
|
1494
1675
|
end
|
1495
1676
|
|
1496
|
-
# @note When making an API call, you may pass DescribeSourceLocationRequest
|
1497
|
-
# data as a hash:
|
1498
|
-
#
|
1499
|
-
# {
|
1500
|
-
# source_location_name: "__string", # required
|
1501
|
-
# }
|
1502
|
-
#
|
1503
1677
|
# @!attribute [rw] source_location_name
|
1678
|
+
# The name of the source location.
|
1504
1679
|
# @return [String]
|
1505
1680
|
#
|
1506
1681
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeSourceLocationRequest AWS API Documentation
|
@@ -1511,8 +1686,6 @@ module Aws::MediaTailor
|
|
1511
1686
|
include Aws::Structure
|
1512
1687
|
end
|
1513
1688
|
|
1514
|
-
# This response includes only the "type" : "object" property.
|
1515
|
-
#
|
1516
1689
|
# @!attribute [rw] access_configuration
|
1517
1690
|
# The access configuration for the source location.
|
1518
1691
|
# @return [Types::AccessConfiguration]
|
@@ -1538,12 +1711,24 @@ module Aws::MediaTailor
|
|
1538
1711
|
# modified.
|
1539
1712
|
# @return [Time]
|
1540
1713
|
#
|
1714
|
+
# @!attribute [rw] segment_delivery_configurations
|
1715
|
+
# A list of the segment delivery configurations associated with this
|
1716
|
+
# resource.
|
1717
|
+
# @return [Array<Types::SegmentDeliveryConfiguration>]
|
1718
|
+
#
|
1541
1719
|
# @!attribute [rw] source_location_name
|
1542
1720
|
# The name of the source location.
|
1543
1721
|
# @return [String]
|
1544
1722
|
#
|
1545
1723
|
# @!attribute [rw] tags
|
1546
|
-
# The tags assigned to the source location.
|
1724
|
+
# The tags assigned to the source location. Tags are key-value pairs
|
1725
|
+
# that you can associate with Amazon resources to help with
|
1726
|
+
# organization, access control, and cost tracking. For more
|
1727
|
+
# information, see [Tagging AWS Elemental MediaTailor Resources][1].
|
1728
|
+
#
|
1729
|
+
#
|
1730
|
+
#
|
1731
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
1547
1732
|
# @return [Hash<String,String>]
|
1548
1733
|
#
|
1549
1734
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeSourceLocationResponse AWS API Documentation
|
@@ -1555,24 +1740,19 @@ module Aws::MediaTailor
|
|
1555
1740
|
:default_segment_delivery_configuration,
|
1556
1741
|
:http_configuration,
|
1557
1742
|
:last_modified_time,
|
1743
|
+
:segment_delivery_configurations,
|
1558
1744
|
:source_location_name,
|
1559
1745
|
:tags)
|
1560
1746
|
SENSITIVE = []
|
1561
1747
|
include Aws::Structure
|
1562
1748
|
end
|
1563
1749
|
|
1564
|
-
# @note When making an API call, you may pass DescribeVodSourceRequest
|
1565
|
-
# data as a hash:
|
1566
|
-
#
|
1567
|
-
# {
|
1568
|
-
# source_location_name: "__string", # required
|
1569
|
-
# vod_source_name: "__string", # required
|
1570
|
-
# }
|
1571
|
-
#
|
1572
1750
|
# @!attribute [rw] source_location_name
|
1751
|
+
# The name of the source location associated with this VOD Source.
|
1573
1752
|
# @return [String]
|
1574
1753
|
#
|
1575
1754
|
# @!attribute [rw] vod_source_name
|
1755
|
+
# The name of the VOD Source.
|
1576
1756
|
# @return [String]
|
1577
1757
|
#
|
1578
1758
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeVodSourceRequest AWS API Documentation
|
@@ -1584,7 +1764,9 @@ module Aws::MediaTailor
|
|
1584
1764
|
include Aws::Structure
|
1585
1765
|
end
|
1586
1766
|
|
1587
|
-
#
|
1767
|
+
# @!attribute [rw] ad_break_opportunities
|
1768
|
+
# The ad break opportunities within the VOD source.
|
1769
|
+
# @return [Array<Types::AdBreakOpportunity>]
|
1588
1770
|
#
|
1589
1771
|
# @!attribute [rw] arn
|
1590
1772
|
# The ARN of the VOD source.
|
@@ -1599,7 +1781,7 @@ module Aws::MediaTailor
|
|
1599
1781
|
# @return [Array<Types::HttpPackageConfiguration>]
|
1600
1782
|
#
|
1601
1783
|
# @!attribute [rw] last_modified_time
|
1602
|
-
# The
|
1784
|
+
# The last modified time of the VOD source.
|
1603
1785
|
# @return [Time]
|
1604
1786
|
#
|
1605
1787
|
# @!attribute [rw] source_location_name
|
@@ -1607,7 +1789,14 @@ module Aws::MediaTailor
|
|
1607
1789
|
# @return [String]
|
1608
1790
|
#
|
1609
1791
|
# @!attribute [rw] tags
|
1610
|
-
# The tags assigned to the VOD source.
|
1792
|
+
# The tags assigned to the VOD source. Tags are key-value pairs that
|
1793
|
+
# you can associate with Amazon resources to help with organization,
|
1794
|
+
# access control, and cost tracking. For more information, see
|
1795
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
1796
|
+
#
|
1797
|
+
#
|
1798
|
+
#
|
1799
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
1611
1800
|
# @return [Hash<String,String>]
|
1612
1801
|
#
|
1613
1802
|
# @!attribute [rw] vod_source_name
|
@@ -1617,6 +1806,7 @@ module Aws::MediaTailor
|
|
1617
1806
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeVodSourceResponse AWS API Documentation
|
1618
1807
|
#
|
1619
1808
|
class DescribeVodSourceResponse < Struct.new(
|
1809
|
+
:ad_break_opportunities,
|
1620
1810
|
:arn,
|
1621
1811
|
:creation_time,
|
1622
1812
|
:http_package_configurations,
|
@@ -1628,14 +1818,8 @@ module Aws::MediaTailor
|
|
1628
1818
|
include Aws::Structure
|
1629
1819
|
end
|
1630
1820
|
|
1631
|
-
# @note When making an API call, you may pass GetChannelPolicyRequest
|
1632
|
-
# data as a hash:
|
1633
|
-
#
|
1634
|
-
# {
|
1635
|
-
# channel_name: "__string", # required
|
1636
|
-
# }
|
1637
|
-
#
|
1638
1821
|
# @!attribute [rw] channel_name
|
1822
|
+
# The name of the channel associated with this Channel Policy.
|
1639
1823
|
# @return [String]
|
1640
1824
|
#
|
1641
1825
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelPolicyRequest AWS API Documentation
|
@@ -1646,10 +1830,9 @@ module Aws::MediaTailor
|
|
1646
1830
|
include Aws::Structure
|
1647
1831
|
end
|
1648
1832
|
|
1649
|
-
# Returns the channel's IAM policy.
|
1650
|
-
#
|
1651
1833
|
# @!attribute [rw] policy
|
1652
|
-
# The IAM policy for the channel.
|
1834
|
+
# The IAM policy for the channel. IAM policies are used to control
|
1835
|
+
# access to your channel.
|
1653
1836
|
# @return [String]
|
1654
1837
|
#
|
1655
1838
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelPolicyResponse AWS API Documentation
|
@@ -1660,26 +1843,34 @@ module Aws::MediaTailor
|
|
1660
1843
|
include Aws::Structure
|
1661
1844
|
end
|
1662
1845
|
|
1663
|
-
# @note When making an API call, you may pass GetChannelScheduleRequest
|
1664
|
-
# data as a hash:
|
1665
|
-
#
|
1666
|
-
# {
|
1667
|
-
# channel_name: "__string", # required
|
1668
|
-
# duration_minutes: "__string",
|
1669
|
-
# max_results: 1,
|
1670
|
-
# next_token: "__string",
|
1671
|
-
# }
|
1672
|
-
#
|
1673
1846
|
# @!attribute [rw] channel_name
|
1847
|
+
# The name of the channel associated with this Channel Schedule.
|
1674
1848
|
# @return [String]
|
1675
1849
|
#
|
1676
1850
|
# @!attribute [rw] duration_minutes
|
1851
|
+
# The duration in minutes of the channel schedule.
|
1677
1852
|
# @return [String]
|
1678
1853
|
#
|
1679
1854
|
# @!attribute [rw] max_results
|
1855
|
+
# The maximum number of channel schedules that you want MediaTailor to
|
1856
|
+
# return in response to the current request. If there are more than
|
1857
|
+
# `MaxResults` channel schedules, use the value of `NextToken` in the
|
1858
|
+
# response to get the next page of results.
|
1680
1859
|
# @return [Integer]
|
1681
1860
|
#
|
1682
1861
|
# @!attribute [rw] next_token
|
1862
|
+
# (Optional) If the playback configuration has more than `MaxResults`
|
1863
|
+
# channel schedules, use `NextToken` to get the second and subsequent
|
1864
|
+
# pages of results.
|
1865
|
+
#
|
1866
|
+
# For the first `GetChannelScheduleRequest` request, omit this value.
|
1867
|
+
#
|
1868
|
+
# For the second and subsequent requests, get the value of `NextToken`
|
1869
|
+
# from the previous response and specify that value for `NextToken` in
|
1870
|
+
# the request.
|
1871
|
+
#
|
1872
|
+
# If the previous response didn't include a `NextToken` element,
|
1873
|
+
# there are no more channel schedules to get.
|
1683
1874
|
# @return [String]
|
1684
1875
|
#
|
1685
1876
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelScheduleRequest AWS API Documentation
|
@@ -1693,15 +1884,14 @@ module Aws::MediaTailor
|
|
1693
1884
|
include Aws::Structure
|
1694
1885
|
end
|
1695
1886
|
|
1696
|
-
# Returns the schedule entries for the channel.
|
1697
|
-
#
|
1698
1887
|
# @!attribute [rw] items
|
1699
|
-
#
|
1888
|
+
# A list of schedule entries for the channel.
|
1700
1889
|
# @return [Array<Types::ScheduleEntry>]
|
1701
1890
|
#
|
1702
1891
|
# @!attribute [rw] next_token
|
1703
|
-
# Pagination token
|
1704
|
-
# the next page of
|
1892
|
+
# Pagination token returned by the list request when results exceed
|
1893
|
+
# the maximum allowed. Use the token to fetch the next page of
|
1894
|
+
# results.
|
1705
1895
|
# @return [String]
|
1706
1896
|
#
|
1707
1897
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelScheduleResponse AWS API Documentation
|
@@ -1713,14 +1903,8 @@ module Aws::MediaTailor
|
|
1713
1903
|
include Aws::Structure
|
1714
1904
|
end
|
1715
1905
|
|
1716
|
-
# @note When making an API call, you may pass GetPlaybackConfigurationRequest
|
1717
|
-
# data as a hash:
|
1718
|
-
#
|
1719
|
-
# {
|
1720
|
-
# name: "__string", # required
|
1721
|
-
# }
|
1722
|
-
#
|
1723
1906
|
# @!attribute [rw] name
|
1907
|
+
# The identifier for the playback configuration.
|
1724
1908
|
# @return [String]
|
1725
1909
|
#
|
1726
1910
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPlaybackConfigurationRequest AWS API Documentation
|
@@ -1731,8 +1915,6 @@ module Aws::MediaTailor
|
|
1731
1915
|
include Aws::Structure
|
1732
1916
|
end
|
1733
1917
|
|
1734
|
-
# Returns the playback configuration for the specified name.
|
1735
|
-
#
|
1736
1918
|
# @!attribute [rw] ad_decision_server_url
|
1737
1919
|
# The URL for the ad decision server (ADS). This includes the
|
1738
1920
|
# specification of static parameters and placeholders for dynamic
|
@@ -1844,7 +2026,14 @@ module Aws::MediaTailor
|
|
1844
2026
|
# @return [String]
|
1845
2027
|
#
|
1846
2028
|
# @!attribute [rw] tags
|
1847
|
-
# The tags assigned to the playback configuration.
|
2029
|
+
# The tags assigned to the playback configuration. Tags are key-value
|
2030
|
+
# pairs that you can associate with Amazon resources to help with
|
2031
|
+
# organization, access control, and cost tracking. For more
|
2032
|
+
# information, see [Tagging AWS Elemental MediaTailor Resources][1].
|
2033
|
+
#
|
2034
|
+
#
|
2035
|
+
#
|
2036
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
1848
2037
|
# @return [Hash<String,String>]
|
1849
2038
|
#
|
1850
2039
|
# @!attribute [rw] transcode_profile_name
|
@@ -1885,18 +2074,17 @@ module Aws::MediaTailor
|
|
1885
2074
|
include Aws::Structure
|
1886
2075
|
end
|
1887
2076
|
|
1888
|
-
# @note When making an API call, you may pass GetPrefetchScheduleRequest
|
1889
|
-
# data as a hash:
|
1890
|
-
#
|
1891
|
-
# {
|
1892
|
-
# name: "__string", # required
|
1893
|
-
# playback_configuration_name: "__string", # required
|
1894
|
-
# }
|
1895
|
-
#
|
1896
2077
|
# @!attribute [rw] name
|
2078
|
+
# The name of the prefetch schedule. The name must be unique among all
|
2079
|
+
# prefetch schedules that are associated with the specified playback
|
2080
|
+
# configuration.
|
1897
2081
|
# @return [String]
|
1898
2082
|
#
|
1899
2083
|
# @!attribute [rw] playback_configuration_name
|
2084
|
+
# Returns information about the prefetch schedule for a specific
|
2085
|
+
# playback configuration. If you call `GetPrefetchSchedule` on an
|
2086
|
+
# expired prefetch schedule, MediaTailor returns an HTTP 404 status
|
2087
|
+
# code.
|
1900
2088
|
# @return [String]
|
1901
2089
|
#
|
1902
2090
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPrefetchScheduleRequest AWS API Documentation
|
@@ -1909,26 +2097,37 @@ module Aws::MediaTailor
|
|
1909
2097
|
end
|
1910
2098
|
|
1911
2099
|
# @!attribute [rw] arn
|
2100
|
+
# The Amazon Resource Name (ARN) of the prefetch schedule.
|
1912
2101
|
# @return [String]
|
1913
2102
|
#
|
1914
2103
|
# @!attribute [rw] consumption
|
1915
|
-
#
|
1916
|
-
#
|
2104
|
+
# Consumption settings determine how, and when, MediaTailor places the
|
2105
|
+
# prefetched ads into ad breaks. Ad consumption occurs within a span
|
2106
|
+
# of time that you define, called a *consumption window*. You can
|
2107
|
+
# designate which ad breaks that MediaTailor fills with prefetch ads
|
2108
|
+
# by setting avail matching criteria.
|
1917
2109
|
# @return [Types::PrefetchConsumption]
|
1918
2110
|
#
|
1919
2111
|
# @!attribute [rw] name
|
2112
|
+
# The name of the prefetch schedule. The name must be unique among all
|
2113
|
+
# prefetch schedules that are associated with the specified playback
|
2114
|
+
# configuration.
|
1920
2115
|
# @return [String]
|
1921
2116
|
#
|
1922
2117
|
# @!attribute [rw] playback_configuration_name
|
2118
|
+
# The name of the playback configuration to create the prefetch
|
2119
|
+
# schedule for.
|
1923
2120
|
# @return [String]
|
1924
2121
|
#
|
1925
2122
|
# @!attribute [rw] retrieval
|
1926
|
-
# A complex type that contains settings
|
1927
|
-
#
|
1928
|
-
# includes in the request to the ad decision server.
|
2123
|
+
# A complex type that contains settings for prefetch retrieval from
|
2124
|
+
# the ad decision server (ADS).
|
1929
2125
|
# @return [Types::PrefetchRetrieval]
|
1930
2126
|
#
|
1931
2127
|
# @!attribute [rw] stream_id
|
2128
|
+
# An optional stream identifier that you can specify in order to
|
2129
|
+
# prefetch for multiple streams that use the same playback
|
2130
|
+
# configuration.
|
1932
2131
|
# @return [String]
|
1933
2132
|
#
|
1934
2133
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPrefetchScheduleResponse AWS API Documentation
|
@@ -1961,21 +2160,22 @@ module Aws::MediaTailor
|
|
1961
2160
|
|
1962
2161
|
# HLS playlist configuration parameters.
|
1963
2162
|
#
|
1964
|
-
#
|
1965
|
-
#
|
1966
|
-
#
|
1967
|
-
#
|
1968
|
-
#
|
1969
|
-
#
|
2163
|
+
# @!attribute [rw] ad_markup_type
|
2164
|
+
# Determines the type of SCTE 35 tags to use in ad markup. Specify
|
2165
|
+
# `DATERANGE` to use `DATERANGE` tags (for live or VOD content).
|
2166
|
+
# Specify `SCTE35_ENHANCED` to use `EXT-X-CUE-OUT` and `EXT-X-CUE-IN`
|
2167
|
+
# tags (for VOD content only).
|
2168
|
+
# @return [Array<String>]
|
1970
2169
|
#
|
1971
2170
|
# @!attribute [rw] manifest_window_seconds
|
1972
|
-
# The total duration (in seconds) of each manifest. Minimum value:
|
1973
|
-
# seconds. Maximum value: 3600 seconds.
|
2171
|
+
# The total duration (in seconds) of each manifest. Minimum value:
|
2172
|
+
# `30` seconds. Maximum value: `3600` seconds.
|
1974
2173
|
# @return [Integer]
|
1975
2174
|
#
|
1976
2175
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/HlsPlaylistSettings AWS API Documentation
|
1977
2176
|
#
|
1978
2177
|
class HlsPlaylistSettings < Struct.new(
|
2178
|
+
:ad_markup_type,
|
1979
2179
|
:manifest_window_seconds)
|
1980
2180
|
SENSITIVE = []
|
1981
2181
|
include Aws::Structure
|
@@ -1983,13 +2183,6 @@ module Aws::MediaTailor
|
|
1983
2183
|
|
1984
2184
|
# The HTTP configuration for the source location.
|
1985
2185
|
#
|
1986
|
-
# @note When making an API call, you may pass HttpConfiguration
|
1987
|
-
# data as a hash:
|
1988
|
-
#
|
1989
|
-
# {
|
1990
|
-
# base_url: "__string", # required
|
1991
|
-
# }
|
1992
|
-
#
|
1993
2186
|
# @!attribute [rw] base_url
|
1994
2187
|
# The base URL for the source location host server. This string must
|
1995
2188
|
# include the protocol, such as **https://**.
|
@@ -2006,28 +2199,20 @@ module Aws::MediaTailor
|
|
2006
2199
|
# The HTTP package configuration properties for the requested VOD
|
2007
2200
|
# source.
|
2008
2201
|
#
|
2009
|
-
# @note When making an API call, you may pass HttpPackageConfiguration
|
2010
|
-
# data as a hash:
|
2011
|
-
#
|
2012
|
-
# {
|
2013
|
-
# path: "__string", # required
|
2014
|
-
# source_group: "__string", # required
|
2015
|
-
# type: "DASH", # required, accepts DASH, HLS
|
2016
|
-
# }
|
2017
|
-
#
|
2018
2202
|
# @!attribute [rw] path
|
2019
2203
|
# The relative path to the URL for this VOD source. This is combined
|
2020
|
-
# with SourceLocation::HttpConfiguration::BaseUrl to form a valid
|
2204
|
+
# with `SourceLocation::HttpConfiguration::BaseUrl` to form a valid
|
2205
|
+
# URL.
|
2021
2206
|
# @return [String]
|
2022
2207
|
#
|
2023
2208
|
# @!attribute [rw] source_group
|
2024
2209
|
# The name of the source group. This has to match one of the
|
2025
|
-
# Channel::Outputs::SourceGroup
|
2210
|
+
# `Channel::Outputs::SourceGroup`.
|
2026
2211
|
# @return [String]
|
2027
2212
|
#
|
2028
2213
|
# @!attribute [rw] type
|
2029
2214
|
# The streaming protocol for this package configuration. Supported
|
2030
|
-
# values are HLS and DASH
|
2215
|
+
# values are `HLS` and `DASH`.
|
2031
2216
|
# @return [String]
|
2032
2217
|
#
|
2033
2218
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/HttpPackageConfiguration AWS API Documentation
|
@@ -2040,22 +2225,47 @@ module Aws::MediaTailor
|
|
2040
2225
|
include Aws::Structure
|
2041
2226
|
end
|
2042
2227
|
|
2043
|
-
#
|
2044
|
-
#
|
2228
|
+
# For `SCTE35_ENHANCED` output, defines a key and corresponding value.
|
2229
|
+
# MediaTailor generates these pairs within the `EXT-X-ASSET`tag.
|
2230
|
+
#
|
2231
|
+
# @!attribute [rw] key
|
2232
|
+
# For `SCTE35_ENHANCED` output, defines a key. MediaTailor takes this
|
2233
|
+
# key, and its associated value, and generates the key/value pair
|
2234
|
+
# within the `EXT-X-ASSET`tag. If you specify a key, you must also
|
2235
|
+
# specify a corresponding value.
|
2236
|
+
# @return [String]
|
2237
|
+
#
|
2238
|
+
# @!attribute [rw] value
|
2239
|
+
# For `SCTE35_ENHANCED` output, defines a value. MediaTailor; takes
|
2240
|
+
# this value, and its associated key, and generates the key/value pair
|
2241
|
+
# within the `EXT-X-ASSET`tag. If you specify a value, you must also
|
2242
|
+
# specify a corresponding key.
|
2243
|
+
# @return [String]
|
2045
2244
|
#
|
2046
|
-
#
|
2047
|
-
# max_results: 1,
|
2048
|
-
# next_token: "__string",
|
2049
|
-
# resource_arn: "__string", # required
|
2050
|
-
# }
|
2245
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/KeyValuePair AWS API Documentation
|
2051
2246
|
#
|
2247
|
+
class KeyValuePair < Struct.new(
|
2248
|
+
:key,
|
2249
|
+
:value)
|
2250
|
+
SENSITIVE = []
|
2251
|
+
include Aws::Structure
|
2252
|
+
end
|
2253
|
+
|
2052
2254
|
# @!attribute [rw] max_results
|
2255
|
+
# The maximum number of alerts that you want MediaTailor to return in
|
2256
|
+
# response to the current request. If there are more than `MaxResults`
|
2257
|
+
# alerts, use the value of `NextToken` in the response to get the next
|
2258
|
+
# page of results.
|
2053
2259
|
# @return [Integer]
|
2054
2260
|
#
|
2055
2261
|
# @!attribute [rw] next_token
|
2262
|
+
# Pagination token returned by the list request when results exceed
|
2263
|
+
# the maximum allowed. Use the token to fetch the next page of
|
2264
|
+
# results.
|
2056
2265
|
# @return [String]
|
2057
2266
|
#
|
2058
2267
|
# @!attribute [rw] resource_arn
|
2268
|
+
# The Amazon Resource Name (ARN) of the resource.
|
2059
2269
|
# @return [String]
|
2060
2270
|
#
|
2061
2271
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListAlertsRequest AWS API Documentation
|
@@ -2068,15 +2278,14 @@ module Aws::MediaTailor
|
|
2068
2278
|
include Aws::Structure
|
2069
2279
|
end
|
2070
2280
|
|
2071
|
-
# Lists the alerts for a given resource.
|
2072
|
-
#
|
2073
2281
|
# @!attribute [rw] items
|
2074
|
-
#
|
2282
|
+
# A list of alerts that are associated with this resource.
|
2075
2283
|
# @return [Array<Types::Alert>]
|
2076
2284
|
#
|
2077
2285
|
# @!attribute [rw] next_token
|
2078
|
-
# Pagination token
|
2079
|
-
# next page of
|
2286
|
+
# Pagination token returned by the list request when results exceed
|
2287
|
+
# the maximum allowed. Use the token to fetch the next page of
|
2288
|
+
# results.
|
2080
2289
|
# @return [String]
|
2081
2290
|
#
|
2082
2291
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListAlertsResponse AWS API Documentation
|
@@ -2088,18 +2297,17 @@ module Aws::MediaTailor
|
|
2088
2297
|
include Aws::Structure
|
2089
2298
|
end
|
2090
2299
|
|
2091
|
-
# @note When making an API call, you may pass ListChannelsRequest
|
2092
|
-
# data as a hash:
|
2093
|
-
#
|
2094
|
-
# {
|
2095
|
-
# max_results: 1,
|
2096
|
-
# next_token: "__string",
|
2097
|
-
# }
|
2098
|
-
#
|
2099
2300
|
# @!attribute [rw] max_results
|
2301
|
+
# The maximum number of channels that you want MediaTailor to return
|
2302
|
+
# in response to the current request. If there are more than
|
2303
|
+
# `MaxResults` channels, use the value of `NextToken` in the response
|
2304
|
+
# to get the next page of results.
|
2100
2305
|
# @return [Integer]
|
2101
2306
|
#
|
2102
2307
|
# @!attribute [rw] next_token
|
2308
|
+
# Pagination token returned by the list request when results exceed
|
2309
|
+
# the maximum allowed. Use the token to fetch the next page of
|
2310
|
+
# results.
|
2103
2311
|
# @return [String]
|
2104
2312
|
#
|
2105
2313
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListChannelsRequest AWS API Documentation
|
@@ -2111,10 +2319,8 @@ module Aws::MediaTailor
|
|
2111
2319
|
include Aws::Structure
|
2112
2320
|
end
|
2113
2321
|
|
2114
|
-
# Returns a list of channels.
|
2115
|
-
#
|
2116
2322
|
# @!attribute [rw] items
|
2117
|
-
#
|
2323
|
+
# A list of channels that are associated with this account.
|
2118
2324
|
# @return [Array<Types::Channel>]
|
2119
2325
|
#
|
2120
2326
|
# @!attribute [rw] next_token
|
@@ -2132,18 +2338,64 @@ module Aws::MediaTailor
|
|
2132
2338
|
include Aws::Structure
|
2133
2339
|
end
|
2134
2340
|
|
2135
|
-
#
|
2136
|
-
#
|
2341
|
+
# @!attribute [rw] max_results
|
2342
|
+
# The maximum number of live sources that you want MediaTailor to
|
2343
|
+
# return in response to the current request. If there are more than
|
2344
|
+
# `MaxResults` live sources, use the value of `NextToken` in the
|
2345
|
+
# response to get the next page of results.
|
2346
|
+
# @return [Integer]
|
2347
|
+
#
|
2348
|
+
# @!attribute [rw] next_token
|
2349
|
+
# Pagination token returned by the list request when results exceed
|
2350
|
+
# the maximum allowed. Use the token to fetch the next page of
|
2351
|
+
# results.
|
2352
|
+
# @return [String]
|
2353
|
+
#
|
2354
|
+
# @!attribute [rw] source_location_name
|
2355
|
+
# The name of the source location associated with this Live Sources
|
2356
|
+
# list.
|
2357
|
+
# @return [String]
|
2358
|
+
#
|
2359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListLiveSourcesRequest AWS API Documentation
|
2360
|
+
#
|
2361
|
+
class ListLiveSourcesRequest < Struct.new(
|
2362
|
+
:max_results,
|
2363
|
+
:next_token,
|
2364
|
+
:source_location_name)
|
2365
|
+
SENSITIVE = []
|
2366
|
+
include Aws::Structure
|
2367
|
+
end
|
2368
|
+
|
2369
|
+
# @!attribute [rw] items
|
2370
|
+
# Lists the live sources.
|
2371
|
+
# @return [Array<Types::LiveSource>]
|
2372
|
+
#
|
2373
|
+
# @!attribute [rw] next_token
|
2374
|
+
# Pagination token returned by the list request when results exceed
|
2375
|
+
# the maximum allowed. Use the token to fetch the next page of
|
2376
|
+
# results.
|
2377
|
+
# @return [String]
|
2137
2378
|
#
|
2138
|
-
#
|
2139
|
-
# max_results: 1,
|
2140
|
-
# next_token: "__string",
|
2141
|
-
# }
|
2379
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListLiveSourcesResponse AWS API Documentation
|
2142
2380
|
#
|
2381
|
+
class ListLiveSourcesResponse < Struct.new(
|
2382
|
+
:items,
|
2383
|
+
:next_token)
|
2384
|
+
SENSITIVE = []
|
2385
|
+
include Aws::Structure
|
2386
|
+
end
|
2387
|
+
|
2143
2388
|
# @!attribute [rw] max_results
|
2389
|
+
# The maximum number of playback configurations that you want
|
2390
|
+
# MediaTailor to return in response to the current request. If there
|
2391
|
+
# are more than `MaxResults` playback configurations, use the value of
|
2392
|
+
# `NextToken` in the response to get the next page of results.
|
2144
2393
|
# @return [Integer]
|
2145
2394
|
#
|
2146
2395
|
# @!attribute [rw] next_token
|
2396
|
+
# Pagination token returned by the list request when results exceed
|
2397
|
+
# the maximum allowed. Use the token to fetch the next page of
|
2398
|
+
# results.
|
2147
2399
|
# @return [String]
|
2148
2400
|
#
|
2149
2401
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListPlaybackConfigurationsRequest AWS API Documentation
|
@@ -2155,8 +2407,6 @@ module Aws::MediaTailor
|
|
2155
2407
|
include Aws::Structure
|
2156
2408
|
end
|
2157
2409
|
|
2158
|
-
# Returns a list of playback configurations.
|
2159
|
-
#
|
2160
2410
|
# @!attribute [rw] items
|
2161
2411
|
# Array of playback configurations. This might be all the available
|
2162
2412
|
# configurations or a subset, depending on the settings that you
|
@@ -2178,42 +2428,32 @@ module Aws::MediaTailor
|
|
2178
2428
|
include Aws::Structure
|
2179
2429
|
end
|
2180
2430
|
|
2181
|
-
# Retrieves the prefetch schedule(s) for a specific playback
|
2182
|
-
# configuration.
|
2183
|
-
#
|
2184
|
-
# @note When making an API call, you may pass ListPrefetchSchedulesRequest
|
2185
|
-
# data as a hash:
|
2186
|
-
#
|
2187
|
-
# {
|
2188
|
-
# max_results: 1,
|
2189
|
-
# next_token: "__string",
|
2190
|
-
# playback_configuration_name: "__string", # required
|
2191
|
-
# stream_id: "__string",
|
2192
|
-
# }
|
2193
|
-
#
|
2194
2431
|
# @!attribute [rw] max_results
|
2195
2432
|
# The maximum number of prefetch schedules that you want MediaTailor
|
2196
|
-
# to return in response to the current request. If
|
2197
|
-
#
|
2198
|
-
#
|
2433
|
+
# to return in response to the current request. If there are more than
|
2434
|
+
# `MaxResults` prefetch schedules, use the value of `NextToken` in the
|
2435
|
+
# response to get the next page of results.
|
2199
2436
|
# @return [Integer]
|
2200
2437
|
#
|
2201
2438
|
# @!attribute [rw] next_token
|
2202
|
-
# (Optional) If the playback configuration has more than MaxResults
|
2203
|
-
# prefetch schedules, use NextToken to get the second and subsequent
|
2439
|
+
# (Optional) If the playback configuration has more than `MaxResults`
|
2440
|
+
# prefetch schedules, use `NextToken` to get the second and subsequent
|
2204
2441
|
# pages of results.
|
2205
2442
|
#
|
2206
|
-
# For the first ListPrefetchSchedulesRequest request, omit this
|
2443
|
+
# For the first `ListPrefetchSchedulesRequest` request, omit this
|
2444
|
+
# value.
|
2207
2445
|
#
|
2208
|
-
# For the second and subsequent requests, get the value of NextToken
|
2209
|
-
# from the previous response and specify that value for NextToken in
|
2446
|
+
# For the second and subsequent requests, get the value of `NextToken`
|
2447
|
+
# from the previous response and specify that value for `NextToken` in
|
2210
2448
|
# the request.
|
2211
2449
|
#
|
2212
|
-
# If the previous response didn't include a NextToken element,
|
2213
|
-
# are no more prefetch schedules to get.
|
2450
|
+
# If the previous response didn't include a `NextToken` element,
|
2451
|
+
# there are no more prefetch schedules to get.
|
2214
2452
|
# @return [String]
|
2215
2453
|
#
|
2216
2454
|
# @!attribute [rw] playback_configuration_name
|
2455
|
+
# Retrieves the prefetch schedule(s) for a specific playback
|
2456
|
+
# configuration.
|
2217
2457
|
# @return [String]
|
2218
2458
|
#
|
2219
2459
|
# @!attribute [rw] stream_id
|
@@ -2232,16 +2472,15 @@ module Aws::MediaTailor
|
|
2232
2472
|
include Aws::Structure
|
2233
2473
|
end
|
2234
2474
|
|
2235
|
-
# The list of prefetch schedules.
|
2236
|
-
#
|
2237
2475
|
# @!attribute [rw] items
|
2238
|
-
# Lists the prefetch schedules. An empty Items list doesn't mean
|
2476
|
+
# Lists the prefetch schedules. An empty `Items` list doesn't mean
|
2239
2477
|
# there aren't more items to fetch, just that that page was empty.
|
2240
2478
|
# @return [Array<Types::PrefetchSchedule>]
|
2241
2479
|
#
|
2242
2480
|
# @!attribute [rw] next_token
|
2243
|
-
#
|
2244
|
-
#
|
2481
|
+
# Pagination token returned by the list request when results exceed
|
2482
|
+
# the maximum allowed. Use the token to fetch the next page of
|
2483
|
+
# results.
|
2245
2484
|
# @return [String]
|
2246
2485
|
#
|
2247
2486
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListPrefetchSchedulesResponse AWS API Documentation
|
@@ -2253,18 +2492,17 @@ module Aws::MediaTailor
|
|
2253
2492
|
include Aws::Structure
|
2254
2493
|
end
|
2255
2494
|
|
2256
|
-
# @note When making an API call, you may pass ListSourceLocationsRequest
|
2257
|
-
# data as a hash:
|
2258
|
-
#
|
2259
|
-
# {
|
2260
|
-
# max_results: 1,
|
2261
|
-
# next_token: "__string",
|
2262
|
-
# }
|
2263
|
-
#
|
2264
2495
|
# @!attribute [rw] max_results
|
2496
|
+
# The maximum number of source locations that you want MediaTailor to
|
2497
|
+
# return in response to the current request. If there are more than
|
2498
|
+
# `MaxResults` source locations, use the value of `NextToken` in the
|
2499
|
+
# response to get the next page of results.
|
2265
2500
|
# @return [Integer]
|
2266
2501
|
#
|
2267
2502
|
# @!attribute [rw] next_token
|
2503
|
+
# Pagination token returned by the list request when results exceed
|
2504
|
+
# the maximum allowed. Use the token to fetch the next page of
|
2505
|
+
# results.
|
2268
2506
|
# @return [String]
|
2269
2507
|
#
|
2270
2508
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListSourceLocationsRequest AWS API Documentation
|
@@ -2276,15 +2514,14 @@ module Aws::MediaTailor
|
|
2276
2514
|
include Aws::Structure
|
2277
2515
|
end
|
2278
2516
|
|
2279
|
-
# Lists the source locations.
|
2280
|
-
#
|
2281
2517
|
# @!attribute [rw] items
|
2282
|
-
#
|
2518
|
+
# A list of source locations.
|
2283
2519
|
# @return [Array<Types::SourceLocation>]
|
2284
2520
|
#
|
2285
2521
|
# @!attribute [rw] next_token
|
2286
|
-
# Pagination token
|
2287
|
-
# next page of
|
2522
|
+
# Pagination token returned by the list request when results exceed
|
2523
|
+
# the maximum allowed. Use the token to fetch the next page of
|
2524
|
+
# results.
|
2288
2525
|
# @return [String]
|
2289
2526
|
#
|
2290
2527
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListSourceLocationsResponse AWS API Documentation
|
@@ -2296,14 +2533,8 @@ module Aws::MediaTailor
|
|
2296
2533
|
include Aws::Structure
|
2297
2534
|
end
|
2298
2535
|
|
2299
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
2300
|
-
# data as a hash:
|
2301
|
-
#
|
2302
|
-
# {
|
2303
|
-
# resource_arn: "__string", # required
|
2304
|
-
# }
|
2305
|
-
#
|
2306
2536
|
# @!attribute [rw] resource_arn
|
2537
|
+
# The Amazon Resource Name (ARN) associated with this resource.
|
2307
2538
|
# @return [String]
|
2308
2539
|
#
|
2309
2540
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListTagsForResourceRequest AWS API Documentation
|
@@ -2315,6 +2546,14 @@ module Aws::MediaTailor
|
|
2315
2546
|
end
|
2316
2547
|
|
2317
2548
|
# @!attribute [rw] tags
|
2549
|
+
# The tags associated with this resource. Tags are key-value pairs
|
2550
|
+
# that you can associate with Amazon resources to help with
|
2551
|
+
# organization, access control, and cost tracking. For more
|
2552
|
+
# information, see [Tagging AWS Elemental MediaTailor Resources][1].
|
2553
|
+
#
|
2554
|
+
#
|
2555
|
+
#
|
2556
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
2318
2557
|
# @return [Hash<String,String>]
|
2319
2558
|
#
|
2320
2559
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListTagsForResourceResponse AWS API Documentation
|
@@ -2325,22 +2564,22 @@ module Aws::MediaTailor
|
|
2325
2564
|
include Aws::Structure
|
2326
2565
|
end
|
2327
2566
|
|
2328
|
-
# @note When making an API call, you may pass ListVodSourcesRequest
|
2329
|
-
# data as a hash:
|
2330
|
-
#
|
2331
|
-
# {
|
2332
|
-
# max_results: 1,
|
2333
|
-
# next_token: "__string",
|
2334
|
-
# source_location_name: "__string", # required
|
2335
|
-
# }
|
2336
|
-
#
|
2337
2567
|
# @!attribute [rw] max_results
|
2568
|
+
# The maximum number of VOD sources that you want MediaTailor to
|
2569
|
+
# return in response to the current request. If there are more than
|
2570
|
+
# `MaxResults` VOD sources, use the value of `NextToken` in the
|
2571
|
+
# response to get the next page of results.
|
2338
2572
|
# @return [Integer]
|
2339
2573
|
#
|
2340
2574
|
# @!attribute [rw] next_token
|
2575
|
+
# Pagination token returned by the list request when results exceed
|
2576
|
+
# the maximum allowed. Use the token to fetch the next page of
|
2577
|
+
# results.
|
2341
2578
|
# @return [String]
|
2342
2579
|
#
|
2343
2580
|
# @!attribute [rw] source_location_name
|
2581
|
+
# The name of the source location associated with this VOD Source
|
2582
|
+
# list.
|
2344
2583
|
# @return [String]
|
2345
2584
|
#
|
2346
2585
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListVodSourcesRequest AWS API Documentation
|
@@ -2353,15 +2592,14 @@ module Aws::MediaTailor
|
|
2353
2592
|
include Aws::Structure
|
2354
2593
|
end
|
2355
2594
|
|
2356
|
-
# An array of VOD sources.
|
2357
|
-
#
|
2358
2595
|
# @!attribute [rw] items
|
2359
2596
|
# Lists the VOD sources.
|
2360
2597
|
# @return [Array<Types::VodSource>]
|
2361
2598
|
#
|
2362
2599
|
# @!attribute [rw] next_token
|
2363
|
-
# Pagination token
|
2364
|
-
# next page of
|
2600
|
+
# Pagination token returned by the list request when results exceed
|
2601
|
+
# the maximum allowed. Use the token to fetch the next page of
|
2602
|
+
# results.
|
2365
2603
|
# @return [String]
|
2366
2604
|
#
|
2367
2605
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListVodSourcesResponse AWS API Documentation
|
@@ -2375,14 +2613,6 @@ module Aws::MediaTailor
|
|
2375
2613
|
|
2376
2614
|
# The configuration for pre-roll ad insertion.
|
2377
2615
|
#
|
2378
|
-
# @note When making an API call, you may pass LivePreRollConfiguration
|
2379
|
-
# data as a hash:
|
2380
|
-
#
|
2381
|
-
# {
|
2382
|
-
# ad_decision_server_url: "__string",
|
2383
|
-
# max_duration_seconds: 1,
|
2384
|
-
# }
|
2385
|
-
#
|
2386
2616
|
# @!attribute [rw] ad_decision_server_url
|
2387
2617
|
# The URL for the ad decision server (ADS) for pre-roll ads. This
|
2388
2618
|
# includes the specification of static parameters and placeholders for
|
@@ -2408,18 +2638,69 @@ module Aws::MediaTailor
|
|
2408
2638
|
include Aws::Structure
|
2409
2639
|
end
|
2410
2640
|
|
2641
|
+
# Live source configuration parameters.
|
2642
|
+
#
|
2643
|
+
# @!attribute [rw] arn
|
2644
|
+
# The ARN for the live source.
|
2645
|
+
# @return [String]
|
2646
|
+
#
|
2647
|
+
# @!attribute [rw] creation_time
|
2648
|
+
# The timestamp that indicates when the live source was created.
|
2649
|
+
# @return [Time]
|
2650
|
+
#
|
2651
|
+
# @!attribute [rw] http_package_configurations
|
2652
|
+
# The HTTP package configurations for the live source.
|
2653
|
+
# @return [Array<Types::HttpPackageConfiguration>]
|
2654
|
+
#
|
2655
|
+
# @!attribute [rw] last_modified_time
|
2656
|
+
# The timestamp that indicates when the live source was last modified.
|
2657
|
+
# @return [Time]
|
2658
|
+
#
|
2659
|
+
# @!attribute [rw] live_source_name
|
2660
|
+
# The name that's used to refer to a live source.
|
2661
|
+
# @return [String]
|
2662
|
+
#
|
2663
|
+
# @!attribute [rw] source_location_name
|
2664
|
+
# The name of the source location.
|
2665
|
+
# @return [String]
|
2666
|
+
#
|
2667
|
+
# @!attribute [rw] tags
|
2668
|
+
# The tags assigned to the live source. Tags are key-value pairs that
|
2669
|
+
# you can associate with Amazon resources to help with organization,
|
2670
|
+
# access control, and cost tracking. For more information, see
|
2671
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
2672
|
+
#
|
2673
|
+
#
|
2674
|
+
#
|
2675
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
2676
|
+
# @return [Hash<String,String>]
|
2677
|
+
#
|
2678
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/LiveSource AWS API Documentation
|
2679
|
+
#
|
2680
|
+
class LiveSource < Struct.new(
|
2681
|
+
:arn,
|
2682
|
+
:creation_time,
|
2683
|
+
:http_package_configurations,
|
2684
|
+
:last_modified_time,
|
2685
|
+
:live_source_name,
|
2686
|
+
:source_location_name,
|
2687
|
+
:tags)
|
2688
|
+
SENSITIVE = []
|
2689
|
+
include Aws::Structure
|
2690
|
+
end
|
2691
|
+
|
2411
2692
|
# Returns Amazon CloudWatch log settings for a playback configuration.
|
2412
2693
|
#
|
2413
2694
|
# @!attribute [rw] percent_enabled
|
2414
2695
|
# The percentage of session logs that MediaTailor sends to your
|
2415
2696
|
# Cloudwatch Logs account. For example, if your playback configuration
|
2416
|
-
# has 1000 sessions and percentEnabled is set to 60
|
2417
|
-
# logs for 600 of the sessions to CloudWatch Logs. MediaTailor
|
2418
|
-
# at random which of the playback configuration sessions to
|
2419
|
-
# for. If you want to view logs for a specific session, you
|
2420
|
-
# the [debug log mode][1].
|
2697
|
+
# has 1000 sessions and `percentEnabled` is set to `60`, MediaTailor
|
2698
|
+
# sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor
|
2699
|
+
# decides at random which of the playback configuration sessions to
|
2700
|
+
# send logs for. If you want to view logs for a specific session, you
|
2701
|
+
# can use the [debug log mode][1].
|
2421
2702
|
#
|
2422
|
-
# Valid values: 0 - 100
|
2703
|
+
# Valid values: `0` - `100`
|
2423
2704
|
#
|
2424
2705
|
#
|
2425
2706
|
#
|
@@ -2434,27 +2715,33 @@ module Aws::MediaTailor
|
|
2434
2715
|
include Aws::Structure
|
2435
2716
|
end
|
2436
2717
|
|
2437
|
-
# The configuration for
|
2438
|
-
#
|
2439
|
-
#
|
2718
|
+
# The log configuration for the channel.
|
2719
|
+
#
|
2720
|
+
# @!attribute [rw] log_types
|
2721
|
+
# The log types.
|
2722
|
+
# @return [Array<String>]
|
2440
2723
|
#
|
2441
|
-
# @
|
2442
|
-
# data as a hash:
|
2724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/LogConfigurationForChannel AWS API Documentation
|
2443
2725
|
#
|
2444
|
-
|
2445
|
-
|
2446
|
-
|
2447
|
-
|
2448
|
-
|
2726
|
+
class LogConfigurationForChannel < Struct.new(
|
2727
|
+
:log_types)
|
2728
|
+
SENSITIVE = []
|
2729
|
+
include Aws::Structure
|
2730
|
+
end
|
2731
|
+
|
2732
|
+
# The configuration for manifest processing rules. Manifest processing
|
2733
|
+
# rules enable customization of the personalized manifests created by
|
2734
|
+
# MediaTailor.
|
2449
2735
|
#
|
2450
2736
|
# @!attribute [rw] ad_marker_passthrough
|
2451
|
-
# For HLS, when set to true
|
2452
|
-
# EXT-X-CUE-OUT
|
2453
|
-
# origin manifest to the MediaTailor personalized
|
2737
|
+
# For HLS, when set to `true`, MediaTailor passes through
|
2738
|
+
# `EXT-X-CUE-IN`, `EXT-X-CUE-OUT`, and `EXT-X-SPLICEPOINT-SCTE35` ad
|
2739
|
+
# markers from the origin manifest to the MediaTailor personalized
|
2740
|
+
# manifest.
|
2454
2741
|
#
|
2455
2742
|
# No logic is applied to these ad markers. For example, if
|
2456
|
-
# EXT-X-CUE-OUT has a value of 60
|
2457
|
-
# break, MediaTailor will not set the value to 0
|
2743
|
+
# `EXT-X-CUE-OUT` has a value of `60`, but no ads are filled for that
|
2744
|
+
# ad break, MediaTailor will not set the value to `0`.
|
2458
2745
|
# @return [Types::AdMarkerPassthrough]
|
2459
2746
|
#
|
2460
2747
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ManifestProcessingRules AWS API Documentation
|
@@ -2465,7 +2752,7 @@ module Aws::MediaTailor
|
|
2465
2752
|
include Aws::Structure
|
2466
2753
|
end
|
2467
2754
|
|
2468
|
-
#
|
2755
|
+
# A playback configuration. For information about MediaTailor
|
2469
2756
|
# configurations, see [Working with configurations in AWS Elemental
|
2470
2757
|
# MediaTailor][1].
|
2471
2758
|
#
|
@@ -2584,7 +2871,14 @@ module Aws::MediaTailor
|
|
2584
2871
|
# @return [String]
|
2585
2872
|
#
|
2586
2873
|
# @!attribute [rw] tags
|
2587
|
-
# The tags to assign to the playback configuration.
|
2874
|
+
# The tags to assign to the playback configuration. Tags are key-value
|
2875
|
+
# pairs that you can associate with Amazon resources to help with
|
2876
|
+
# organization, access control, and cost tracking. For more
|
2877
|
+
# information, see [Tagging AWS Elemental MediaTailor Resources][1].
|
2878
|
+
#
|
2879
|
+
#
|
2880
|
+
#
|
2881
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
2588
2882
|
# @return [Hash<String,String>]
|
2589
2883
|
#
|
2590
2884
|
# @!attribute [rw] transcode_profile_name
|
@@ -2628,24 +2922,10 @@ module Aws::MediaTailor
|
|
2628
2922
|
# A complex type that contains settings that determine how and when that
|
2629
2923
|
# MediaTailor places prefetched ads into upcoming ad breaks.
|
2630
2924
|
#
|
2631
|
-
# @note When making an API call, you may pass PrefetchConsumption
|
2632
|
-
# data as a hash:
|
2633
|
-
#
|
2634
|
-
# {
|
2635
|
-
# avail_matching_criteria: [
|
2636
|
-
# {
|
2637
|
-
# dynamic_variable: "__string", # required
|
2638
|
-
# operator: "EQUALS", # required, accepts EQUALS
|
2639
|
-
# },
|
2640
|
-
# ],
|
2641
|
-
# end_time: Time.now, # required
|
2642
|
-
# start_time: Time.now,
|
2643
|
-
# }
|
2644
|
-
#
|
2645
2925
|
# @!attribute [rw] avail_matching_criteria
|
2646
2926
|
# If you only want MediaTailor to insert prefetched ads into avails
|
2647
2927
|
# (ad breaks) that match specific dynamic variables, such as
|
2648
|
-
# scte.
|
2928
|
+
# `scte.event_id`, set the avail matching criteria.
|
2649
2929
|
# @return [Array<Types::AvailMatchingCriteria>]
|
2650
2930
|
#
|
2651
2931
|
# @!attribute [rw] end_time
|
@@ -2653,12 +2933,12 @@ module Aws::MediaTailor
|
|
2653
2933
|
# use in an ad break. MediaTailor automatically deletes prefetch
|
2654
2934
|
# schedules no less than seven days after the end time. If you'd like
|
2655
2935
|
# to manually delete the prefetch schedule, you can call
|
2656
|
-
# DeletePrefetchSchedule
|
2936
|
+
# `DeletePrefetchSchedule`.
|
2657
2937
|
# @return [Time]
|
2658
2938
|
#
|
2659
2939
|
# @!attribute [rw] start_time
|
2660
2940
|
# The time when prefetched ads are considered for use in an ad break.
|
2661
|
-
# If you don't specify StartTime
|
2941
|
+
# If you don't specify `StartTime`, the prefetched ads are available
|
2662
2942
|
# after MediaTailor retrives them from the ad decision server.
|
2663
2943
|
# @return [Time]
|
2664
2944
|
#
|
@@ -2676,24 +2956,13 @@ module Aws::MediaTailor
|
|
2676
2956
|
# prefetches ads, and which dynamic variables that MediaTailor includes
|
2677
2957
|
# in the request to the ad decision server.
|
2678
2958
|
#
|
2679
|
-
# @note When making an API call, you may pass PrefetchRetrieval
|
2680
|
-
# data as a hash:
|
2681
|
-
#
|
2682
|
-
# {
|
2683
|
-
# dynamic_variables: {
|
2684
|
-
# "__string" => "__string",
|
2685
|
-
# },
|
2686
|
-
# end_time: Time.now, # required
|
2687
|
-
# start_time: Time.now,
|
2688
|
-
# }
|
2689
|
-
#
|
2690
2959
|
# @!attribute [rw] dynamic_variables
|
2691
2960
|
# The dynamic variables to use for substitution during prefetch
|
2692
2961
|
# requests to the ad decision server (ADS).
|
2693
2962
|
#
|
2694
|
-
# You
|
2963
|
+
# You initially configure [dynamic variables][1] for the ADS URL when
|
2695
2964
|
# you set up your playback configuration. When you specify
|
2696
|
-
# DynamicVariables for prefetch retrieval, MediaTailor includes the
|
2965
|
+
# `DynamicVariables` for prefetch retrieval, MediaTailor includes the
|
2697
2966
|
# dynamic variables in the request to the ADS.
|
2698
2967
|
#
|
2699
2968
|
#
|
@@ -2724,7 +2993,14 @@ module Aws::MediaTailor
|
|
2724
2993
|
include Aws::Structure
|
2725
2994
|
end
|
2726
2995
|
|
2727
|
-
# A
|
2996
|
+
# A prefetch schedule allows you to tell MediaTailor to fetch and
|
2997
|
+
# prepare certain ads before an ad break happens. For more information
|
2998
|
+
# about ad prefetching, see [Using ad prefetching][1] in the
|
2999
|
+
# *MediaTailor User Guide*.
|
3000
|
+
#
|
3001
|
+
#
|
3002
|
+
#
|
3003
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
|
2728
3004
|
#
|
2729
3005
|
# @!attribute [rw] arn
|
2730
3006
|
# The Amazon Resource Name (ARN) of the prefetch schedule.
|
@@ -2773,17 +3049,8 @@ module Aws::MediaTailor
|
|
2773
3049
|
include Aws::Structure
|
2774
3050
|
end
|
2775
3051
|
|
2776
|
-
# Adds an IAM policy for the channel.
|
2777
|
-
#
|
2778
|
-
# @note When making an API call, you may pass PutChannelPolicyRequest
|
2779
|
-
# data as a hash:
|
2780
|
-
#
|
2781
|
-
# {
|
2782
|
-
# channel_name: "__string", # required
|
2783
|
-
# policy: "__string", # required
|
2784
|
-
# }
|
2785
|
-
#
|
2786
3052
|
# @!attribute [rw] channel_name
|
3053
|
+
# The channel name associated with this Channel Policy.
|
2787
3054
|
# @return [String]
|
2788
3055
|
#
|
2789
3056
|
# @!attribute [rw] policy
|
@@ -2799,59 +3066,10 @@ module Aws::MediaTailor
|
|
2799
3066
|
include Aws::Structure
|
2800
3067
|
end
|
2801
3068
|
|
2802
|
-
# This response includes only the "type" : "object" property.
|
2803
|
-
#
|
2804
3069
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PutChannelPolicyResponse AWS API Documentation
|
2805
3070
|
#
|
2806
3071
|
class PutChannelPolicyResponse < Aws::EmptyStructure; end
|
2807
3072
|
|
2808
|
-
# The configuration for creating a playback configuration.
|
2809
|
-
#
|
2810
|
-
# @note When making an API call, you may pass PutPlaybackConfigurationRequest
|
2811
|
-
# data as a hash:
|
2812
|
-
#
|
2813
|
-
# {
|
2814
|
-
# ad_decision_server_url: "__string",
|
2815
|
-
# avail_suppression: {
|
2816
|
-
# mode: "OFF", # accepts OFF, BEHIND_LIVE_EDGE
|
2817
|
-
# value: "__string",
|
2818
|
-
# },
|
2819
|
-
# bumper: {
|
2820
|
-
# end_url: "__string",
|
2821
|
-
# start_url: "__string",
|
2822
|
-
# },
|
2823
|
-
# cdn_configuration: {
|
2824
|
-
# ad_segment_url_prefix: "__string",
|
2825
|
-
# content_segment_url_prefix: "__string",
|
2826
|
-
# },
|
2827
|
-
# configuration_aliases: {
|
2828
|
-
# "__string" => {
|
2829
|
-
# "__string" => "__string",
|
2830
|
-
# },
|
2831
|
-
# },
|
2832
|
-
# dash_configuration: {
|
2833
|
-
# mpd_location: "__string",
|
2834
|
-
# origin_manifest_type: "SINGLE_PERIOD", # accepts SINGLE_PERIOD, MULTI_PERIOD
|
2835
|
-
# },
|
2836
|
-
# live_pre_roll_configuration: {
|
2837
|
-
# ad_decision_server_url: "__string",
|
2838
|
-
# max_duration_seconds: 1,
|
2839
|
-
# },
|
2840
|
-
# manifest_processing_rules: {
|
2841
|
-
# ad_marker_passthrough: {
|
2842
|
-
# enabled: false,
|
2843
|
-
# },
|
2844
|
-
# },
|
2845
|
-
# name: "__string",
|
2846
|
-
# personalization_threshold_seconds: 1,
|
2847
|
-
# slate_ad_url: "__string",
|
2848
|
-
# tags: {
|
2849
|
-
# "__string" => "__string",
|
2850
|
-
# },
|
2851
|
-
# transcode_profile_name: "__string",
|
2852
|
-
# video_content_source_url: "__string",
|
2853
|
-
# }
|
2854
|
-
#
|
2855
3073
|
# @!attribute [rw] ad_decision_server_url
|
2856
3074
|
# The URL for the ad decision server (ADS). This includes the
|
2857
3075
|
# specification of static parameters and placeholders for dynamic
|
@@ -2941,7 +3159,14 @@ module Aws::MediaTailor
|
|
2941
3159
|
# @return [String]
|
2942
3160
|
#
|
2943
3161
|
# @!attribute [rw] tags
|
2944
|
-
# The tags to assign to the playback configuration.
|
3162
|
+
# The tags to assign to the playback configuration. Tags are key-value
|
3163
|
+
# pairs that you can associate with Amazon resources to help with
|
3164
|
+
# organization, access control, and cost tracking. For more
|
3165
|
+
# information, see [Tagging AWS Elemental MediaTailor Resources][1].
|
3166
|
+
#
|
3167
|
+
#
|
3168
|
+
#
|
3169
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
2945
3170
|
# @return [Hash<String,String>]
|
2946
3171
|
#
|
2947
3172
|
# @!attribute [rw] transcode_profile_name
|
@@ -2978,6 +3203,12 @@ module Aws::MediaTailor
|
|
2978
3203
|
end
|
2979
3204
|
|
2980
3205
|
# @!attribute [rw] ad_decision_server_url
|
3206
|
+
# The URL for the ad decision server (ADS). This includes the
|
3207
|
+
# specification of static parameters and placeholders for dynamic
|
3208
|
+
# parameters. AWS Elemental MediaTailor substitutes player-specific
|
3209
|
+
# and session-specific parameters as needed when calling the ADS.
|
3210
|
+
# Alternately, for testing you can provide a static VAST URL. The
|
3211
|
+
# maximum length is 25,000 characters.
|
2981
3212
|
# @return [String]
|
2982
3213
|
#
|
2983
3214
|
# @!attribute [rw] avail_suppression
|
@@ -3006,7 +3237,13 @@ module Aws::MediaTailor
|
|
3006
3237
|
# @return [Types::CdnConfiguration]
|
3007
3238
|
#
|
3008
3239
|
# @!attribute [rw] configuration_aliases
|
3009
|
-
# The
|
3240
|
+
# The player parameters and aliases used as dynamic variables during
|
3241
|
+
# session initialization. For more information, see [Domain
|
3242
|
+
# Variables][1].
|
3243
|
+
#
|
3244
|
+
#
|
3245
|
+
#
|
3246
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html
|
3010
3247
|
# @return [Hash<String,Hash<String,String>>]
|
3011
3248
|
#
|
3012
3249
|
# @!attribute [rw] dash_configuration
|
@@ -3022,7 +3259,7 @@ module Aws::MediaTailor
|
|
3022
3259
|
# @return [Types::LivePreRollConfiguration]
|
3023
3260
|
#
|
3024
3261
|
# @!attribute [rw] log_configuration
|
3025
|
-
#
|
3262
|
+
# The Amazon CloudWatch log settings for a playback configuration.
|
3026
3263
|
# @return [Types::LogConfiguration]
|
3027
3264
|
#
|
3028
3265
|
# @!attribute [rw] manifest_processing_rules
|
@@ -3032,30 +3269,71 @@ module Aws::MediaTailor
|
|
3032
3269
|
# @return [Types::ManifestProcessingRules]
|
3033
3270
|
#
|
3034
3271
|
# @!attribute [rw] name
|
3272
|
+
# The identifier for the playback configuration.
|
3035
3273
|
# @return [String]
|
3036
3274
|
#
|
3037
3275
|
# @!attribute [rw] personalization_threshold_seconds
|
3276
|
+
# Defines the maximum duration of underfilled ad time (in seconds)
|
3277
|
+
# allowed in an ad break. If the duration of underfilled ad time
|
3278
|
+
# exceeds the personalization threshold, then the personalization of
|
3279
|
+
# the ad break is abandoned and the underlying content is shown. This
|
3280
|
+
# feature applies to *ad replacement* in live and VOD streams, rather
|
3281
|
+
# than ad insertion, because it relies on an underlying content
|
3282
|
+
# stream. For more information about ad break behavior, including ad
|
3283
|
+
# replacement and insertion, see [Ad Behavior in AWS Elemental
|
3284
|
+
# MediaTailor][1].
|
3285
|
+
#
|
3286
|
+
#
|
3287
|
+
#
|
3288
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
|
3038
3289
|
# @return [Integer]
|
3039
3290
|
#
|
3040
3291
|
# @!attribute [rw] playback_configuration_arn
|
3292
|
+
# The Amazon Resource Name (ARN) associated with the playback
|
3293
|
+
# configuration.
|
3041
3294
|
# @return [String]
|
3042
3295
|
#
|
3043
3296
|
# @!attribute [rw] playback_endpoint_prefix
|
3297
|
+
# The playback endpoint prefix associated with the playback
|
3298
|
+
# configuration.
|
3044
3299
|
# @return [String]
|
3045
3300
|
#
|
3046
3301
|
# @!attribute [rw] session_initialization_endpoint_prefix
|
3302
|
+
# The session initialization endpoint prefix associated with the
|
3303
|
+
# playback configuration.
|
3047
3304
|
# @return [String]
|
3048
3305
|
#
|
3049
3306
|
# @!attribute [rw] slate_ad_url
|
3307
|
+
# The URL for a high-quality video asset to transcode and use to fill
|
3308
|
+
# in time that's not used by ads. AWS Elemental MediaTailor shows the
|
3309
|
+
# slate to fill in gaps in media content. Configuring the slate is
|
3310
|
+
# optional for non-VPAID configurations. For VPAID, the slate is
|
3311
|
+
# required because MediaTailor provides it in the slots that are
|
3312
|
+
# designated for dynamic ad content. The slate must be a high-quality
|
3313
|
+
# asset that contains both audio and video.
|
3050
3314
|
# @return [String]
|
3051
3315
|
#
|
3052
3316
|
# @!attribute [rw] tags
|
3317
|
+
# The tags to assign to the playback configuration. Tags are key-value
|
3318
|
+
# pairs that you can associate with Amazon resources to help with
|
3319
|
+
# organization, access control, and cost tracking. For more
|
3320
|
+
# information, see [Tagging AWS Elemental MediaTailor Resources][1].
|
3321
|
+
#
|
3322
|
+
#
|
3323
|
+
#
|
3324
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
3053
3325
|
# @return [Hash<String,String>]
|
3054
3326
|
#
|
3055
3327
|
# @!attribute [rw] transcode_profile_name
|
3328
|
+
# The name that is used to associate this playback configuration with
|
3329
|
+
# a custom transcode profile. This overrides the dynamic transcoding
|
3330
|
+
# defaults of MediaTailor. Use this only if you have already set up
|
3331
|
+
# custom profiles with the help of AWS Support.
|
3056
3332
|
# @return [String]
|
3057
3333
|
#
|
3058
3334
|
# @!attribute [rw] video_content_source_url
|
3335
|
+
# The URL prefix for the parent manifest for the stream, minus the
|
3336
|
+
# asset ID. The maximum length is 512 characters.
|
3059
3337
|
# @return [String]
|
3060
3338
|
#
|
3061
3339
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PutPlaybackConfigurationResponse AWS API Documentation
|
@@ -3086,23 +3364,6 @@ module Aws::MediaTailor
|
|
3086
3364
|
|
3087
3365
|
# The output configuration for this channel.
|
3088
3366
|
#
|
3089
|
-
# @note When making an API call, you may pass RequestOutputItem
|
3090
|
-
# data as a hash:
|
3091
|
-
#
|
3092
|
-
# {
|
3093
|
-
# dash_playlist_settings: {
|
3094
|
-
# manifest_window_seconds: 1,
|
3095
|
-
# min_buffer_time_seconds: 1,
|
3096
|
-
# min_update_period_seconds: 1,
|
3097
|
-
# suggested_presentation_delay_seconds: 1,
|
3098
|
-
# },
|
3099
|
-
# hls_playlist_settings: {
|
3100
|
-
# manifest_window_seconds: 1,
|
3101
|
-
# },
|
3102
|
-
# manifest_name: "__string", # required
|
3103
|
-
# source_group: "__string", # required
|
3104
|
-
# }
|
3105
|
-
#
|
3106
3367
|
# @!attribute [rw] dash_playlist_settings
|
3107
3368
|
# DASH manifest configuration parameters.
|
3108
3369
|
# @return [Types::DashPlaylistSettings]
|
@@ -3113,12 +3374,12 @@ module Aws::MediaTailor
|
|
3113
3374
|
#
|
3114
3375
|
# @!attribute [rw] manifest_name
|
3115
3376
|
# The name of the manifest for the channel. The name appears in the
|
3116
|
-
# PlaybackUrl
|
3377
|
+
# `PlaybackUrl`.
|
3117
3378
|
# @return [String]
|
3118
3379
|
#
|
3119
3380
|
# @!attribute [rw] source_group
|
3120
|
-
# A string used to match which HttpPackageConfiguration is used for
|
3121
|
-
# each VodSource
|
3381
|
+
# A string used to match which `HttpPackageConfiguration` is used for
|
3382
|
+
# each `VodSource`.
|
3122
3383
|
# @return [String]
|
3123
3384
|
#
|
3124
3385
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/RequestOutputItem AWS API Documentation
|
@@ -3132,7 +3393,7 @@ module Aws::MediaTailor
|
|
3132
3393
|
include Aws::Structure
|
3133
3394
|
end
|
3134
3395
|
|
3135
|
-
#
|
3396
|
+
# The output item response.
|
3136
3397
|
#
|
3137
3398
|
# @!attribute [rw] dash_playlist_settings
|
3138
3399
|
# DASH manifest configuration settings.
|
@@ -3201,17 +3462,9 @@ module Aws::MediaTailor
|
|
3201
3462
|
# Schedule configuration parameters. A channel must be stopped before
|
3202
3463
|
# changes can be made to the schedule.
|
3203
3464
|
#
|
3204
|
-
#
|
3205
|
-
#
|
3206
|
-
#
|
3207
|
-
# {
|
3208
|
-
# transition: { # required
|
3209
|
-
# relative_position: "BEFORE_PROGRAM", # required, accepts BEFORE_PROGRAM, AFTER_PROGRAM
|
3210
|
-
# relative_program: "__string",
|
3211
|
-
# scheduled_start_time_millis: 1,
|
3212
|
-
# type: "__string", # required
|
3213
|
-
# },
|
3214
|
-
# }
|
3465
|
+
# @!attribute [rw] clip_range
|
3466
|
+
# Program clip range configuration.
|
3467
|
+
# @return [Types::ClipRange]
|
3215
3468
|
#
|
3216
3469
|
# @!attribute [rw] transition
|
3217
3470
|
# Program transition configurations.
|
@@ -3220,6 +3473,7 @@ module Aws::MediaTailor
|
|
3220
3473
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ScheduleConfiguration AWS API Documentation
|
3221
3474
|
#
|
3222
3475
|
class ScheduleConfiguration < Struct.new(
|
3476
|
+
:clip_range,
|
3223
3477
|
:transition)
|
3224
3478
|
SENSITIVE = []
|
3225
3479
|
include Aws::Structure
|
@@ -3243,6 +3497,10 @@ module Aws::MediaTailor
|
|
3243
3497
|
# The name of the channel that uses this schedule.
|
3244
3498
|
# @return [String]
|
3245
3499
|
#
|
3500
|
+
# @!attribute [rw] live_source_name
|
3501
|
+
# The name of the live source used for the program.
|
3502
|
+
# @return [String]
|
3503
|
+
#
|
3246
3504
|
# @!attribute [rw] program_name
|
3247
3505
|
# The name of the program.
|
3248
3506
|
# @return [String]
|
@@ -3253,8 +3511,6 @@ module Aws::MediaTailor
|
|
3253
3511
|
#
|
3254
3512
|
# @!attribute [rw] schedule_entry_type
|
3255
3513
|
# The type of schedule entry.
|
3256
|
-
#
|
3257
|
-
# Valid values: PROGRAM or FILLER\_SLATE.
|
3258
3514
|
# @return [String]
|
3259
3515
|
#
|
3260
3516
|
# @!attribute [rw] source_location_name
|
@@ -3272,6 +3528,7 @@ module Aws::MediaTailor
|
|
3272
3528
|
:approximate_start_time,
|
3273
3529
|
:arn,
|
3274
3530
|
:channel_name,
|
3531
|
+
:live_source_name,
|
3275
3532
|
:program_name,
|
3276
3533
|
:schedule_ad_breaks,
|
3277
3534
|
:schedule_entry_type,
|
@@ -3289,15 +3546,6 @@ module Aws::MediaTailor
|
|
3289
3546
|
#
|
3290
3547
|
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-access-configuration-access-token.html
|
3291
3548
|
#
|
3292
|
-
# @note When making an API call, you may pass SecretsManagerAccessTokenConfiguration
|
3293
|
-
# data as a hash:
|
3294
|
-
#
|
3295
|
-
# {
|
3296
|
-
# header_name: "__string",
|
3297
|
-
# secret_arn: "__string",
|
3298
|
-
# secret_string_key: "__string",
|
3299
|
-
# }
|
3300
|
-
#
|
3301
3549
|
# @!attribute [rw] header_name
|
3302
3550
|
# The name of the HTTP header used to supply the access token in
|
3303
3551
|
# requests to the source location.
|
@@ -3328,15 +3576,116 @@ module Aws::MediaTailor
|
|
3328
3576
|
include Aws::Structure
|
3329
3577
|
end
|
3330
3578
|
|
3331
|
-
#
|
3579
|
+
# The segment delivery configuration settings.
|
3580
|
+
#
|
3581
|
+
# @!attribute [rw] base_url
|
3582
|
+
# The base URL of the host or path of the segment delivery server that
|
3583
|
+
# you're using to serve segments. This is typically a content
|
3584
|
+
# delivery network (CDN). The URL can be absolute or relative. To use
|
3585
|
+
# an absolute URL include the protocol, such as
|
3586
|
+
# `https://example.com/some/path`. To use a relative URL specify the
|
3587
|
+
# relative path, such as `/some/path*`.
|
3588
|
+
# @return [String]
|
3589
|
+
#
|
3590
|
+
# @!attribute [rw] name
|
3591
|
+
# A unique identifier used to distinguish between multiple segment
|
3592
|
+
# delivery configurations in a source location.
|
3593
|
+
# @return [String]
|
3594
|
+
#
|
3595
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/SegmentDeliveryConfiguration AWS API Documentation
|
3596
|
+
#
|
3597
|
+
class SegmentDeliveryConfiguration < Struct.new(
|
3598
|
+
:base_url,
|
3599
|
+
:name)
|
3600
|
+
SENSITIVE = []
|
3601
|
+
include Aws::Structure
|
3602
|
+
end
|
3603
|
+
|
3604
|
+
# The `segmentation_descriptor` message can contain advanced metadata
|
3605
|
+
# fields, like content identifiers, to convey a wide range of
|
3606
|
+
# information about the ad break. MediaTailor writes the ad metadata in
|
3607
|
+
# the egress manifest as part of the `EXT-X-DATERANGE` or `EventStream`
|
3608
|
+
# ad marker's SCTE-35 data.
|
3609
|
+
#
|
3610
|
+
# `segmentation_descriptor` messages must be sent with the `time_signal`
|
3611
|
+
# message type.
|
3612
|
+
#
|
3613
|
+
# See the `segmentation_descriptor()` table of the 2022 SCTE-35
|
3614
|
+
# specification for more information.
|
3615
|
+
#
|
3616
|
+
# @!attribute [rw] segment_num
|
3617
|
+
# The segment number to assign to the
|
3618
|
+
# `segmentation_descriptor.segment_num` message, as defined in section
|
3619
|
+
# 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0
|
3620
|
+
# and 256, inclusive. The default value is 0.
|
3621
|
+
# @return [Integer]
|
3622
|
+
#
|
3623
|
+
# @!attribute [rw] segmentation_event_id
|
3624
|
+
# The Event Identifier to assign to the
|
3625
|
+
# `segmentation_descriptor.segmentation_event_id` message, as defined
|
3626
|
+
# in section 10.3.3.1 of the 2022 SCTE-35 specification. The default
|
3627
|
+
# value is 1.
|
3628
|
+
# @return [Integer]
|
3332
3629
|
#
|
3333
|
-
#
|
3334
|
-
#
|
3630
|
+
# @!attribute [rw] segmentation_type_id
|
3631
|
+
# The Type Identifier to assign to the
|
3632
|
+
# `segmentation_descriptor.segmentation_type_id` message, as defined
|
3633
|
+
# in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must
|
3634
|
+
# be between 0 and 256, inclusive. The default value is 48.
|
3635
|
+
# @return [Integer]
|
3636
|
+
#
|
3637
|
+
# @!attribute [rw] segmentation_upid
|
3638
|
+
# The Upid to assign to the
|
3639
|
+
# `segmentation_descriptor.segmentation_upid` message, as defined in
|
3640
|
+
# section 10.3.3.1 of the 2022 SCTE-35 specification. The value must
|
3641
|
+
# be a hexadecimal string containing only the characters 0 though 9
|
3642
|
+
# and A through F. The default value is "" (an empty string).
|
3643
|
+
# @return [String]
|
3335
3644
|
#
|
3336
|
-
#
|
3337
|
-
#
|
3338
|
-
#
|
3339
|
-
#
|
3645
|
+
# @!attribute [rw] segmentation_upid_type
|
3646
|
+
# The Upid Type to assign to the
|
3647
|
+
# `segmentation_descriptor.segmentation_upid_type` message, as defined
|
3648
|
+
# in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must
|
3649
|
+
# be between 0 and 256, inclusive. The default value is 14.
|
3650
|
+
# @return [Integer]
|
3651
|
+
#
|
3652
|
+
# @!attribute [rw] segments_expected
|
3653
|
+
# The number of segments expected, which is assigned to the
|
3654
|
+
# `segmentation_descriptor.segments_expectedS` message, as defined in
|
3655
|
+
# section 10.3.3.1 of the 2022 SCTE-35 specification Values must be
|
3656
|
+
# between 0 and 256, inclusive. The default value is 0.
|
3657
|
+
# @return [Integer]
|
3658
|
+
#
|
3659
|
+
# @!attribute [rw] sub_segment_num
|
3660
|
+
# The sub-segment number to assign to the
|
3661
|
+
# `segmentation_descriptor.sub_segment_num` message, as defined in
|
3662
|
+
# section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be
|
3663
|
+
# between 0 and 256, inclusive. The defualt value is null.
|
3664
|
+
# @return [Integer]
|
3665
|
+
#
|
3666
|
+
# @!attribute [rw] sub_segments_expected
|
3667
|
+
# The number of sub-segments expected, which is assigned to the
|
3668
|
+
# `segmentation_descriptor.sub_segments_expected` message, as defined
|
3669
|
+
# in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must
|
3670
|
+
# be between 0 and 256, inclusive. The default value is null.
|
3671
|
+
# @return [Integer]
|
3672
|
+
#
|
3673
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/SegmentationDescriptor AWS API Documentation
|
3674
|
+
#
|
3675
|
+
class SegmentationDescriptor < Struct.new(
|
3676
|
+
:segment_num,
|
3677
|
+
:segmentation_event_id,
|
3678
|
+
:segmentation_type_id,
|
3679
|
+
:segmentation_upid,
|
3680
|
+
:segmentation_upid_type,
|
3681
|
+
:segments_expected,
|
3682
|
+
:sub_segment_num,
|
3683
|
+
:sub_segments_expected)
|
3684
|
+
SENSITIVE = []
|
3685
|
+
include Aws::Structure
|
3686
|
+
end
|
3687
|
+
|
3688
|
+
# Slate VOD source configuration.
|
3340
3689
|
#
|
3341
3690
|
# @!attribute [rw] source_location_name
|
3342
3691
|
# The name of the source location where the slate VOD source is
|
@@ -3357,7 +3706,13 @@ module Aws::MediaTailor
|
|
3357
3706
|
include Aws::Structure
|
3358
3707
|
end
|
3359
3708
|
|
3360
|
-
#
|
3709
|
+
# A source location is a container for sources. For more information
|
3710
|
+
# about source locations, see [Working with source locations][1] in the
|
3711
|
+
# *MediaTailor User Guide*.
|
3712
|
+
#
|
3713
|
+
#
|
3714
|
+
#
|
3715
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
|
3361
3716
|
#
|
3362
3717
|
# @!attribute [rw] access_configuration
|
3363
3718
|
# The access configuration for the source location.
|
@@ -3384,12 +3739,23 @@ module Aws::MediaTailor
|
|
3384
3739
|
# modified.
|
3385
3740
|
# @return [Time]
|
3386
3741
|
#
|
3742
|
+
# @!attribute [rw] segment_delivery_configurations
|
3743
|
+
# The segment delivery configurations for the source location.
|
3744
|
+
# @return [Array<Types::SegmentDeliveryConfiguration>]
|
3745
|
+
#
|
3387
3746
|
# @!attribute [rw] source_location_name
|
3388
3747
|
# The name of the source location.
|
3389
3748
|
# @return [String]
|
3390
3749
|
#
|
3391
3750
|
# @!attribute [rw] tags
|
3392
|
-
# The tags assigned to the source location.
|
3751
|
+
# The tags assigned to the source location. Tags are key-value pairs
|
3752
|
+
# that you can associate with Amazon resources to help with
|
3753
|
+
# organization, access control, and cost tracking. For more
|
3754
|
+
# information, see [Tagging AWS Elemental MediaTailor Resources][1].
|
3755
|
+
#
|
3756
|
+
#
|
3757
|
+
#
|
3758
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
3393
3759
|
# @return [Hash<String,String>]
|
3394
3760
|
#
|
3395
3761
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/SourceLocation AWS API Documentation
|
@@ -3401,6 +3767,7 @@ module Aws::MediaTailor
|
|
3401
3767
|
:default_segment_delivery_configuration,
|
3402
3768
|
:http_configuration,
|
3403
3769
|
:last_modified_time,
|
3770
|
+
:segment_delivery_configurations,
|
3404
3771
|
:source_location_name,
|
3405
3772
|
:tags)
|
3406
3773
|
SENSITIVE = []
|
@@ -3409,38 +3776,28 @@ module Aws::MediaTailor
|
|
3409
3776
|
|
3410
3777
|
# Splice insert message configuration.
|
3411
3778
|
#
|
3412
|
-
# @note When making an API call, you may pass SpliceInsertMessage
|
3413
|
-
# data as a hash:
|
3414
|
-
#
|
3415
|
-
# {
|
3416
|
-
# avail_num: 1,
|
3417
|
-
# avails_expected: 1,
|
3418
|
-
# splice_event_id: 1,
|
3419
|
-
# unique_program_id: 1,
|
3420
|
-
# }
|
3421
|
-
#
|
3422
3779
|
# @!attribute [rw] avail_num
|
3423
|
-
# This is written to
|
3424
|
-
# 9.7.3.1 of the SCTE-35 specification. The default value is 0
|
3425
|
-
# must be between 0 and 256
|
3780
|
+
# This is written to `splice_insert.avail_num`, as defined in section
|
3781
|
+
# 9.7.3.1 of the SCTE-35 specification. The default value is `0`.
|
3782
|
+
# Values must be between `0` and `256`, inclusive.
|
3426
3783
|
# @return [Integer]
|
3427
3784
|
#
|
3428
3785
|
# @!attribute [rw] avails_expected
|
3429
|
-
# This is written to
|
3786
|
+
# This is written to `splice_insert.avails_expected`, as defined in
|
3430
3787
|
# section 9.7.3.1 of the SCTE-35 specification. The default value is
|
3431
|
-
# 0
|
3788
|
+
# `0`. Values must be between `0` and `256`, inclusive.
|
3432
3789
|
# @return [Integer]
|
3433
3790
|
#
|
3434
3791
|
# @!attribute [rw] splice_event_id
|
3435
|
-
# This is written to
|
3792
|
+
# This is written to `splice_insert.splice_event_id`, as defined in
|
3436
3793
|
# section 9.7.3.1 of the SCTE-35 specification. The default value is
|
3437
|
-
# 1
|
3794
|
+
# `1`.
|
3438
3795
|
# @return [Integer]
|
3439
3796
|
#
|
3440
3797
|
# @!attribute [rw] unique_program_id
|
3441
|
-
# This is written to
|
3798
|
+
# This is written to `splice_insert.unique_program_id`, as defined in
|
3442
3799
|
# section 9.7.3.1 of the SCTE-35 specification. The default value is
|
3443
|
-
# 0
|
3800
|
+
# `0`. Values must be between `0` and `256`, inclusive.
|
3444
3801
|
# @return [Integer]
|
3445
3802
|
#
|
3446
3803
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/SpliceInsertMessage AWS API Documentation
|
@@ -3454,14 +3811,8 @@ module Aws::MediaTailor
|
|
3454
3811
|
include Aws::Structure
|
3455
3812
|
end
|
3456
3813
|
|
3457
|
-
# @note When making an API call, you may pass StartChannelRequest
|
3458
|
-
# data as a hash:
|
3459
|
-
#
|
3460
|
-
# {
|
3461
|
-
# channel_name: "__string", # required
|
3462
|
-
# }
|
3463
|
-
#
|
3464
3814
|
# @!attribute [rw] channel_name
|
3815
|
+
# The name of the channel.
|
3465
3816
|
# @return [String]
|
3466
3817
|
#
|
3467
3818
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/StartChannelRequest AWS API Documentation
|
@@ -3476,14 +3827,8 @@ module Aws::MediaTailor
|
|
3476
3827
|
#
|
3477
3828
|
class StartChannelResponse < Aws::EmptyStructure; end
|
3478
3829
|
|
3479
|
-
# @note When making an API call, you may pass StopChannelRequest
|
3480
|
-
# data as a hash:
|
3481
|
-
#
|
3482
|
-
# {
|
3483
|
-
# channel_name: "__string", # required
|
3484
|
-
# }
|
3485
|
-
#
|
3486
3830
|
# @!attribute [rw] channel_name
|
3831
|
+
# The name of the channel.
|
3487
3832
|
# @return [String]
|
3488
3833
|
#
|
3489
3834
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/StopChannelRequest AWS API Documentation
|
@@ -3498,20 +3843,19 @@ module Aws::MediaTailor
|
|
3498
3843
|
#
|
3499
3844
|
class StopChannelResponse < Aws::EmptyStructure; end
|
3500
3845
|
|
3501
|
-
# @note When making an API call, you may pass TagResourceRequest
|
3502
|
-
# data as a hash:
|
3503
|
-
#
|
3504
|
-
# {
|
3505
|
-
# resource_arn: "__string", # required
|
3506
|
-
# tags: { # required
|
3507
|
-
# "__string" => "__string",
|
3508
|
-
# },
|
3509
|
-
# }
|
3510
|
-
#
|
3511
3846
|
# @!attribute [rw] resource_arn
|
3847
|
+
# The Amazon Resource Name (ARN) associated with the resource.
|
3512
3848
|
# @return [String]
|
3513
3849
|
#
|
3514
3850
|
# @!attribute [rw] tags
|
3851
|
+
# The tags to assign to the resource. Tags are key-value pairs that
|
3852
|
+
# you can associate with Amazon resources to help with organization,
|
3853
|
+
# access control, and cost tracking. For more information, see
|
3854
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
3855
|
+
#
|
3856
|
+
#
|
3857
|
+
#
|
3858
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
3515
3859
|
# @return [Hash<String,String>]
|
3516
3860
|
#
|
3517
3861
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/TagResourceRequest AWS API Documentation
|
@@ -3523,26 +3867,45 @@ module Aws::MediaTailor
|
|
3523
3867
|
include Aws::Structure
|
3524
3868
|
end
|
3525
3869
|
|
3526
|
-
#
|
3870
|
+
# The SCTE-35 `time_signal` message can be sent with one or more
|
3871
|
+
# `segmentation_descriptor` messages. A `time_signal` message can be
|
3872
|
+
# sent only if a single `segmentation_descriptor` message is sent.
|
3873
|
+
#
|
3874
|
+
# The `time_signal` message contains only the `splice_time` field which
|
3875
|
+
# is constructed using a given presentation timestamp. When sending a
|
3876
|
+
# `time_signal` message, the `splice_command_type` field in the
|
3877
|
+
# `splice_info_section` message is set to 6 (0x06).
|
3527
3878
|
#
|
3528
|
-
#
|
3529
|
-
#
|
3879
|
+
# See the `time_signal()` table of the 2022 SCTE-35 specification for
|
3880
|
+
# more information.
|
3530
3881
|
#
|
3531
|
-
#
|
3532
|
-
#
|
3533
|
-
#
|
3534
|
-
#
|
3535
|
-
#
|
3536
|
-
#
|
3882
|
+
# @!attribute [rw] segmentation_descriptors
|
3883
|
+
# The configurations for the SCTE-35 `segmentation_descriptor`
|
3884
|
+
# message(s) sent with the `time_signal` message.
|
3885
|
+
# @return [Array<Types::SegmentationDescriptor>]
|
3886
|
+
#
|
3887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/TimeSignalMessage AWS API Documentation
|
3888
|
+
#
|
3889
|
+
class TimeSignalMessage < Struct.new(
|
3890
|
+
:segmentation_descriptors)
|
3891
|
+
SENSITIVE = []
|
3892
|
+
include Aws::Structure
|
3893
|
+
end
|
3894
|
+
|
3895
|
+
# Program transition configuration.
|
3896
|
+
#
|
3897
|
+
# @!attribute [rw] duration_millis
|
3898
|
+
# The duration of the live program in seconds.
|
3899
|
+
# @return [Integer]
|
3537
3900
|
#
|
3538
3901
|
# @!attribute [rw] relative_position
|
3539
3902
|
# The position where this program will be inserted relative to the
|
3540
|
-
# RelativePosition
|
3903
|
+
# `RelativePosition`.
|
3541
3904
|
# @return [String]
|
3542
3905
|
#
|
3543
3906
|
# @!attribute [rw] relative_program
|
3544
3907
|
# The name of the program that this program will be inserted next to,
|
3545
|
-
# as defined by RelativePosition
|
3908
|
+
# as defined by `RelativePosition`.
|
3546
3909
|
# @return [String]
|
3547
3910
|
#
|
3548
3911
|
# @!attribute [rw] scheduled_start_time_millis
|
@@ -3552,27 +3915,29 @@ module Aws::MediaTailor
|
|
3552
3915
|
#
|
3553
3916
|
# @!attribute [rw] type
|
3554
3917
|
# Defines when the program plays in the schedule. You can set the
|
3555
|
-
# value to ABSOLUTE or RELATIVE
|
3918
|
+
# value to `ABSOLUTE` or `RELATIVE`.
|
3556
3919
|
#
|
3557
|
-
# ABSOLUTE - The program plays at a specific wall clock time. This
|
3558
|
-
# setting can only be used for channels using the LINEAR
|
3920
|
+
# `ABSOLUTE` - The program plays at a specific wall clock time. This
|
3921
|
+
# setting can only be used for channels using the `LINEAR`
|
3922
|
+
# `PlaybackMode`.
|
3559
3923
|
#
|
3560
|
-
# Note the following considerations when using ABSOLUTE transitions:
|
3924
|
+
# Note the following considerations when using `ABSOLUTE` transitions:
|
3561
3925
|
#
|
3562
3926
|
# If the preceding program in the schedule has a duration that extends
|
3563
3927
|
# past the wall clock time, MediaTailor truncates the preceding
|
3564
3928
|
# program on a common segment boundary.
|
3565
3929
|
#
|
3566
|
-
# If there are gaps in playback, MediaTailor plays the FillerSlate
|
3567
|
-
# configured for your linear channel.
|
3930
|
+
# If there are gaps in playback, MediaTailor plays the `FillerSlate`
|
3931
|
+
# you configured for your linear channel.
|
3568
3932
|
#
|
3569
|
-
# RELATIVE - The program is inserted into the schedule either before
|
3570
|
-
# or after a program that you specify via RelativePosition
|
3933
|
+
# `RELATIVE` - The program is inserted into the schedule either before
|
3934
|
+
# or after a program that you specify via `RelativePosition`.
|
3571
3935
|
# @return [String]
|
3572
3936
|
#
|
3573
3937
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/Transition AWS API Documentation
|
3574
3938
|
#
|
3575
3939
|
class Transition < Struct.new(
|
3940
|
+
:duration_millis,
|
3576
3941
|
:relative_position,
|
3577
3942
|
:relative_program,
|
3578
3943
|
:scheduled_start_time_millis,
|
@@ -3581,18 +3946,12 @@ module Aws::MediaTailor
|
|
3581
3946
|
include Aws::Structure
|
3582
3947
|
end
|
3583
3948
|
|
3584
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
3585
|
-
# data as a hash:
|
3586
|
-
#
|
3587
|
-
# {
|
3588
|
-
# resource_arn: "__string", # required
|
3589
|
-
# tag_keys: ["__string"], # required
|
3590
|
-
# }
|
3591
|
-
#
|
3592
3949
|
# @!attribute [rw] resource_arn
|
3950
|
+
# The Amazon Resource Name (ARN) of the resource to untag.
|
3593
3951
|
# @return [String]
|
3594
3952
|
#
|
3595
3953
|
# @!attribute [rw] tag_keys
|
3954
|
+
# The tag keys associated with the resource.
|
3596
3955
|
# @return [Array<String>]
|
3597
3956
|
#
|
3598
3957
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UntagResourceRequest AWS API Documentation
|
@@ -3604,33 +3963,17 @@ module Aws::MediaTailor
|
|
3604
3963
|
include Aws::Structure
|
3605
3964
|
end
|
3606
3965
|
|
3607
|
-
# Updates a channel's Outputs.
|
3608
|
-
#
|
3609
|
-
# @note When making an API call, you may pass UpdateChannelRequest
|
3610
|
-
# data as a hash:
|
3611
|
-
#
|
3612
|
-
# {
|
3613
|
-
# channel_name: "__string", # required
|
3614
|
-
# outputs: [ # required
|
3615
|
-
# {
|
3616
|
-
# dash_playlist_settings: {
|
3617
|
-
# manifest_window_seconds: 1,
|
3618
|
-
# min_buffer_time_seconds: 1,
|
3619
|
-
# min_update_period_seconds: 1,
|
3620
|
-
# suggested_presentation_delay_seconds: 1,
|
3621
|
-
# },
|
3622
|
-
# hls_playlist_settings: {
|
3623
|
-
# manifest_window_seconds: 1,
|
3624
|
-
# },
|
3625
|
-
# manifest_name: "__string", # required
|
3626
|
-
# source_group: "__string", # required
|
3627
|
-
# },
|
3628
|
-
# ],
|
3629
|
-
# }
|
3630
|
-
#
|
3631
3966
|
# @!attribute [rw] channel_name
|
3967
|
+
# The name of the channel.
|
3632
3968
|
# @return [String]
|
3633
3969
|
#
|
3970
|
+
# @!attribute [rw] filler_slate
|
3971
|
+
# The slate used to fill gaps between programs in the schedule. You
|
3972
|
+
# must configure filler slate if your channel uses the `LINEAR`
|
3973
|
+
# `PlaybackMode`. MediaTailor doesn't support filler slate for
|
3974
|
+
# channels using the `LOOP` `PlaybackMode`.
|
3975
|
+
# @return [Types::SlateSource]
|
3976
|
+
#
|
3634
3977
|
# @!attribute [rw] outputs
|
3635
3978
|
# The channel's output properties.
|
3636
3979
|
# @return [Array<Types::RequestOutputItem>]
|
@@ -3639,39 +3982,68 @@ module Aws::MediaTailor
|
|
3639
3982
|
#
|
3640
3983
|
class UpdateChannelRequest < Struct.new(
|
3641
3984
|
:channel_name,
|
3985
|
+
:filler_slate,
|
3642
3986
|
:outputs)
|
3643
3987
|
SENSITIVE = []
|
3644
3988
|
include Aws::Structure
|
3645
3989
|
end
|
3646
3990
|
|
3647
3991
|
# @!attribute [rw] arn
|
3992
|
+
# The Amazon Resource Name (ARN) associated with the channel.
|
3648
3993
|
# @return [String]
|
3649
3994
|
#
|
3650
3995
|
# @!attribute [rw] channel_name
|
3996
|
+
# The name of the channel.
|
3651
3997
|
# @return [String]
|
3652
3998
|
#
|
3653
3999
|
# @!attribute [rw] channel_state
|
4000
|
+
# Returns the state whether the channel is running or not.
|
3654
4001
|
# @return [String]
|
3655
4002
|
#
|
3656
4003
|
# @!attribute [rw] creation_time
|
4004
|
+
# The timestamp of when the channel was created.
|
3657
4005
|
# @return [Time]
|
3658
4006
|
#
|
3659
4007
|
# @!attribute [rw] filler_slate
|
3660
|
-
#
|
4008
|
+
# The slate used to fill gaps between programs in the schedule. You
|
4009
|
+
# must configure filler slate if your channel uses the `LINEAR`
|
4010
|
+
# `PlaybackMode`. MediaTailor doesn't support filler slate for
|
4011
|
+
# channels using the `LOOP` `PlaybackMode`.
|
3661
4012
|
# @return [Types::SlateSource]
|
3662
4013
|
#
|
3663
4014
|
# @!attribute [rw] last_modified_time
|
4015
|
+
# The timestamp that indicates when the channel was last modified.
|
3664
4016
|
# @return [Time]
|
3665
4017
|
#
|
3666
4018
|
# @!attribute [rw] outputs
|
4019
|
+
# The channel's output properties.
|
3667
4020
|
# @return [Array<Types::ResponseOutputItem>]
|
3668
4021
|
#
|
3669
4022
|
# @!attribute [rw] playback_mode
|
4023
|
+
# The type of playback mode for this channel.
|
4024
|
+
#
|
4025
|
+
# `LINEAR` - Programs play back-to-back only once.
|
4026
|
+
#
|
4027
|
+
# `LOOP` - Programs play back-to-back in an endless loop. When the
|
4028
|
+
# last program in the schedule plays, playback loops back to the first
|
4029
|
+
# program in the schedule.
|
3670
4030
|
# @return [String]
|
3671
4031
|
#
|
3672
4032
|
# @!attribute [rw] tags
|
4033
|
+
# The tags to assign to the channel. Tags are key-value pairs that you
|
4034
|
+
# can associate with Amazon resources to help with organization,
|
4035
|
+
# access control, and cost tracking. For more information, see
|
4036
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
4037
|
+
#
|
4038
|
+
#
|
4039
|
+
#
|
4040
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
3673
4041
|
# @return [Hash<String,String>]
|
3674
4042
|
#
|
4043
|
+
# @!attribute [rw] tier
|
4044
|
+
# The tier associated with this Channel.
|
4045
|
+
# @return [String]
|
4046
|
+
#
|
3675
4047
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateChannelResponse AWS API Documentation
|
3676
4048
|
#
|
3677
4049
|
class UpdateChannelResponse < Struct.new(
|
@@ -3683,34 +4055,213 @@ module Aws::MediaTailor
|
|
3683
4055
|
:last_modified_time,
|
3684
4056
|
:outputs,
|
3685
4057
|
:playback_mode,
|
4058
|
+
:tags,
|
4059
|
+
:tier)
|
4060
|
+
SENSITIVE = []
|
4061
|
+
include Aws::Structure
|
4062
|
+
end
|
4063
|
+
|
4064
|
+
# @!attribute [rw] http_package_configurations
|
4065
|
+
# A list of HTTP package configurations for the live source on this
|
4066
|
+
# account.
|
4067
|
+
# @return [Array<Types::HttpPackageConfiguration>]
|
4068
|
+
#
|
4069
|
+
# @!attribute [rw] live_source_name
|
4070
|
+
# The name of the live source.
|
4071
|
+
# @return [String]
|
4072
|
+
#
|
4073
|
+
# @!attribute [rw] source_location_name
|
4074
|
+
# The name of the source location associated with this Live Source.
|
4075
|
+
# @return [String]
|
4076
|
+
#
|
4077
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateLiveSourceRequest AWS API Documentation
|
4078
|
+
#
|
4079
|
+
class UpdateLiveSourceRequest < Struct.new(
|
4080
|
+
:http_package_configurations,
|
4081
|
+
:live_source_name,
|
4082
|
+
:source_location_name)
|
4083
|
+
SENSITIVE = []
|
4084
|
+
include Aws::Structure
|
4085
|
+
end
|
4086
|
+
|
4087
|
+
# @!attribute [rw] arn
|
4088
|
+
# The Amazon Resource Name (ARN) associated with this live source.
|
4089
|
+
# @return [String]
|
4090
|
+
#
|
4091
|
+
# @!attribute [rw] creation_time
|
4092
|
+
# The timestamp that indicates when the live source was created.
|
4093
|
+
# @return [Time]
|
4094
|
+
#
|
4095
|
+
# @!attribute [rw] http_package_configurations
|
4096
|
+
# A list of HTTP package configurations for the live source on this
|
4097
|
+
# account.
|
4098
|
+
# @return [Array<Types::HttpPackageConfiguration>]
|
4099
|
+
#
|
4100
|
+
# @!attribute [rw] last_modified_time
|
4101
|
+
# The timestamp that indicates when the live source was last modified.
|
4102
|
+
# @return [Time]
|
4103
|
+
#
|
4104
|
+
# @!attribute [rw] live_source_name
|
4105
|
+
# The name of the live source.
|
4106
|
+
# @return [String]
|
4107
|
+
#
|
4108
|
+
# @!attribute [rw] source_location_name
|
4109
|
+
# The name of the source location associated with the live source.
|
4110
|
+
# @return [String]
|
4111
|
+
#
|
4112
|
+
# @!attribute [rw] tags
|
4113
|
+
# The tags to assign to the live source. Tags are key-value pairs that
|
4114
|
+
# you can associate with Amazon resources to help with organization,
|
4115
|
+
# access control, and cost tracking. For more information, see
|
4116
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
4117
|
+
#
|
4118
|
+
#
|
4119
|
+
#
|
4120
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
4121
|
+
# @return [Hash<String,String>]
|
4122
|
+
#
|
4123
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateLiveSourceResponse AWS API Documentation
|
4124
|
+
#
|
4125
|
+
class UpdateLiveSourceResponse < Struct.new(
|
4126
|
+
:arn,
|
4127
|
+
:creation_time,
|
4128
|
+
:http_package_configurations,
|
4129
|
+
:last_modified_time,
|
4130
|
+
:live_source_name,
|
4131
|
+
:source_location_name,
|
3686
4132
|
:tags)
|
3687
4133
|
SENSITIVE = []
|
3688
4134
|
include Aws::Structure
|
3689
4135
|
end
|
3690
4136
|
|
3691
|
-
#
|
4137
|
+
# @!attribute [rw] ad_breaks
|
4138
|
+
# The ad break configuration settings.
|
4139
|
+
# @return [Array<Types::AdBreak>]
|
4140
|
+
#
|
4141
|
+
# @!attribute [rw] channel_name
|
4142
|
+
# The name of the channel for this Program.
|
4143
|
+
# @return [String]
|
4144
|
+
#
|
4145
|
+
# @!attribute [rw] program_name
|
4146
|
+
# The name of the Program.
|
4147
|
+
# @return [String]
|
4148
|
+
#
|
4149
|
+
# @!attribute [rw] schedule_configuration
|
4150
|
+
# The schedule configuration settings.
|
4151
|
+
# @return [Types::UpdateProgramScheduleConfiguration]
|
4152
|
+
#
|
4153
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateProgramRequest AWS API Documentation
|
4154
|
+
#
|
4155
|
+
class UpdateProgramRequest < Struct.new(
|
4156
|
+
:ad_breaks,
|
4157
|
+
:channel_name,
|
4158
|
+
:program_name,
|
4159
|
+
:schedule_configuration)
|
4160
|
+
SENSITIVE = []
|
4161
|
+
include Aws::Structure
|
4162
|
+
end
|
4163
|
+
|
4164
|
+
# @!attribute [rw] ad_breaks
|
4165
|
+
# The ad break configuration settings.
|
4166
|
+
# @return [Array<Types::AdBreak>]
|
4167
|
+
#
|
4168
|
+
# @!attribute [rw] arn
|
4169
|
+
# The ARN to assign to the program.
|
4170
|
+
# @return [String]
|
4171
|
+
#
|
4172
|
+
# @!attribute [rw] channel_name
|
4173
|
+
# The name to assign to the channel for this program.
|
4174
|
+
# @return [String]
|
3692
4175
|
#
|
3693
|
-
#
|
3694
|
-
#
|
4176
|
+
# @!attribute [rw] clip_range
|
4177
|
+
# The clip range configuration settings.
|
4178
|
+
# @return [Types::ClipRange]
|
3695
4179
|
#
|
3696
|
-
#
|
3697
|
-
#
|
3698
|
-
#
|
3699
|
-
# secrets_manager_access_token_configuration: {
|
3700
|
-
# header_name: "__string",
|
3701
|
-
# secret_arn: "__string",
|
3702
|
-
# secret_string_key: "__string",
|
3703
|
-
# },
|
3704
|
-
# },
|
3705
|
-
# default_segment_delivery_configuration: {
|
3706
|
-
# base_url: "__string",
|
3707
|
-
# },
|
3708
|
-
# http_configuration: { # required
|
3709
|
-
# base_url: "__string", # required
|
3710
|
-
# },
|
3711
|
-
# source_location_name: "__string", # required
|
3712
|
-
# }
|
4180
|
+
# @!attribute [rw] creation_time
|
4181
|
+
# The time the program was created.
|
4182
|
+
# @return [Time]
|
3713
4183
|
#
|
4184
|
+
# @!attribute [rw] duration_millis
|
4185
|
+
# The duration of the live program in milliseconds.
|
4186
|
+
# @return [Integer]
|
4187
|
+
#
|
4188
|
+
# @!attribute [rw] live_source_name
|
4189
|
+
# The name of the LiveSource for this Program.
|
4190
|
+
# @return [String]
|
4191
|
+
#
|
4192
|
+
# @!attribute [rw] program_name
|
4193
|
+
# The name to assign to this program.
|
4194
|
+
# @return [String]
|
4195
|
+
#
|
4196
|
+
# @!attribute [rw] scheduled_start_time
|
4197
|
+
# The scheduled start time for this Program.
|
4198
|
+
# @return [Time]
|
4199
|
+
#
|
4200
|
+
# @!attribute [rw] source_location_name
|
4201
|
+
# The name to assign to the source location for this program.
|
4202
|
+
# @return [String]
|
4203
|
+
#
|
4204
|
+
# @!attribute [rw] vod_source_name
|
4205
|
+
# The name that's used to refer to a VOD source.
|
4206
|
+
# @return [String]
|
4207
|
+
#
|
4208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateProgramResponse AWS API Documentation
|
4209
|
+
#
|
4210
|
+
class UpdateProgramResponse < Struct.new(
|
4211
|
+
:ad_breaks,
|
4212
|
+
:arn,
|
4213
|
+
:channel_name,
|
4214
|
+
:clip_range,
|
4215
|
+
:creation_time,
|
4216
|
+
:duration_millis,
|
4217
|
+
:live_source_name,
|
4218
|
+
:program_name,
|
4219
|
+
:scheduled_start_time,
|
4220
|
+
:source_location_name,
|
4221
|
+
:vod_source_name)
|
4222
|
+
SENSITIVE = []
|
4223
|
+
include Aws::Structure
|
4224
|
+
end
|
4225
|
+
|
4226
|
+
# Schedule configuration parameters.
|
4227
|
+
#
|
4228
|
+
# @!attribute [rw] clip_range
|
4229
|
+
# Program clip range configuration.
|
4230
|
+
# @return [Types::ClipRange]
|
4231
|
+
#
|
4232
|
+
# @!attribute [rw] transition
|
4233
|
+
# Program transition configuration.
|
4234
|
+
# @return [Types::UpdateProgramTransition]
|
4235
|
+
#
|
4236
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateProgramScheduleConfiguration AWS API Documentation
|
4237
|
+
#
|
4238
|
+
class UpdateProgramScheduleConfiguration < Struct.new(
|
4239
|
+
:clip_range,
|
4240
|
+
:transition)
|
4241
|
+
SENSITIVE = []
|
4242
|
+
include Aws::Structure
|
4243
|
+
end
|
4244
|
+
|
4245
|
+
# Program transition configuration.
|
4246
|
+
#
|
4247
|
+
# @!attribute [rw] duration_millis
|
4248
|
+
# The duration of the live program in seconds.
|
4249
|
+
# @return [Integer]
|
4250
|
+
#
|
4251
|
+
# @!attribute [rw] scheduled_start_time_millis
|
4252
|
+
# The date and time that the program is scheduled to start, in epoch
|
4253
|
+
# milliseconds.
|
4254
|
+
# @return [Integer]
|
4255
|
+
#
|
4256
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateProgramTransition AWS API Documentation
|
4257
|
+
#
|
4258
|
+
class UpdateProgramTransition < Struct.new(
|
4259
|
+
:duration_millis,
|
4260
|
+
:scheduled_start_time_millis)
|
4261
|
+
SENSITIVE = []
|
4262
|
+
include Aws::Structure
|
4263
|
+
end
|
4264
|
+
|
3714
4265
|
# @!attribute [rw] access_configuration
|
3715
4266
|
# Access configuration parameters. Configures the type of
|
3716
4267
|
# authentication used to access content from your source location.
|
@@ -3724,7 +4275,13 @@ module Aws::MediaTailor
|
|
3724
4275
|
# The HTTP configuration for the source location.
|
3725
4276
|
# @return [Types::HttpConfiguration]
|
3726
4277
|
#
|
4278
|
+
# @!attribute [rw] segment_delivery_configurations
|
4279
|
+
# A list of the segment delivery configurations associated with this
|
4280
|
+
# resource.
|
4281
|
+
# @return [Array<Types::SegmentDeliveryConfiguration>]
|
4282
|
+
#
|
3727
4283
|
# @!attribute [rw] source_location_name
|
4284
|
+
# The name of the source location.
|
3728
4285
|
# @return [String]
|
3729
4286
|
#
|
3730
4287
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateSourceLocationRequest AWS API Documentation
|
@@ -3733,29 +4290,27 @@ module Aws::MediaTailor
|
|
3733
4290
|
:access_configuration,
|
3734
4291
|
:default_segment_delivery_configuration,
|
3735
4292
|
:http_configuration,
|
4293
|
+
:segment_delivery_configurations,
|
3736
4294
|
:source_location_name)
|
3737
4295
|
SENSITIVE = []
|
3738
4296
|
include Aws::Structure
|
3739
4297
|
end
|
3740
4298
|
|
3741
4299
|
# @!attribute [rw] access_configuration
|
3742
|
-
# Access configuration parameters.
|
4300
|
+
# Access configuration parameters. Configures the type of
|
4301
|
+
# authentication used to access content from your source location.
|
3743
4302
|
# @return [Types::AccessConfiguration]
|
3744
4303
|
#
|
3745
4304
|
# @!attribute [rw] arn
|
4305
|
+
# The Amazon Resource Name (ARN) associated with the source location.
|
3746
4306
|
# @return [String]
|
3747
4307
|
#
|
3748
4308
|
# @!attribute [rw] creation_time
|
4309
|
+
# The timestamp that indicates when the source location was created.
|
3749
4310
|
# @return [Time]
|
3750
4311
|
#
|
3751
4312
|
# @!attribute [rw] default_segment_delivery_configuration
|
3752
|
-
# The optional configuration for
|
3753
|
-
# this if you want the segment delivery server to be different from
|
3754
|
-
# the source location server. For example, you can configure your
|
3755
|
-
# source location server to be an origination server, such as
|
3756
|
-
# MediaPackage, and the segment delivery server to be a content
|
3757
|
-
# delivery network (CDN), such as CloudFront. If you don't specify a
|
3758
|
-
# segment delivery server, then the source location server is used.
|
4313
|
+
# The optional configuration for the host server that serves segments.
|
3759
4314
|
# @return [Types::DefaultSegmentDeliveryConfiguration]
|
3760
4315
|
#
|
3761
4316
|
# @!attribute [rw] http_configuration
|
@@ -3763,12 +4318,33 @@ module Aws::MediaTailor
|
|
3763
4318
|
# @return [Types::HttpConfiguration]
|
3764
4319
|
#
|
3765
4320
|
# @!attribute [rw] last_modified_time
|
4321
|
+
# The timestamp that indicates when the source location was last
|
4322
|
+
# modified.
|
3766
4323
|
# @return [Time]
|
3767
4324
|
#
|
4325
|
+
# @!attribute [rw] segment_delivery_configurations
|
4326
|
+
# The segment delivery configurations for the source location. For
|
4327
|
+
# information about MediaTailor configurations, see [Working with
|
4328
|
+
# configurations in AWS Elemental MediaTailor][1].
|
4329
|
+
#
|
4330
|
+
#
|
4331
|
+
#
|
4332
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
|
4333
|
+
# @return [Array<Types::SegmentDeliveryConfiguration>]
|
4334
|
+
#
|
3768
4335
|
# @!attribute [rw] source_location_name
|
4336
|
+
# The name of the source location.
|
3769
4337
|
# @return [String]
|
3770
4338
|
#
|
3771
4339
|
# @!attribute [rw] tags
|
4340
|
+
# The tags to assign to the source location. Tags are key-value pairs
|
4341
|
+
# that you can associate with Amazon resources to help with
|
4342
|
+
# organization, access control, and cost tracking. For more
|
4343
|
+
# information, see [Tagging AWS Elemental MediaTailor Resources][1].
|
4344
|
+
#
|
4345
|
+
#
|
4346
|
+
#
|
4347
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
3772
4348
|
# @return [Hash<String,String>]
|
3773
4349
|
#
|
3774
4350
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateSourceLocationResponse AWS API Documentation
|
@@ -3780,38 +4356,24 @@ module Aws::MediaTailor
|
|
3780
4356
|
:default_segment_delivery_configuration,
|
3781
4357
|
:http_configuration,
|
3782
4358
|
:last_modified_time,
|
4359
|
+
:segment_delivery_configurations,
|
3783
4360
|
:source_location_name,
|
3784
4361
|
:tags)
|
3785
4362
|
SENSITIVE = []
|
3786
4363
|
include Aws::Structure
|
3787
4364
|
end
|
3788
4365
|
|
3789
|
-
# Updates a VOD source's configuration.
|
3790
|
-
#
|
3791
|
-
# @note When making an API call, you may pass UpdateVodSourceRequest
|
3792
|
-
# data as a hash:
|
3793
|
-
#
|
3794
|
-
# {
|
3795
|
-
# http_package_configurations: [ # required
|
3796
|
-
# {
|
3797
|
-
# path: "__string", # required
|
3798
|
-
# source_group: "__string", # required
|
3799
|
-
# type: "DASH", # required, accepts DASH, HLS
|
3800
|
-
# },
|
3801
|
-
# ],
|
3802
|
-
# source_location_name: "__string", # required
|
3803
|
-
# vod_source_name: "__string", # required
|
3804
|
-
# }
|
3805
|
-
#
|
3806
4366
|
# @!attribute [rw] http_package_configurations
|
3807
|
-
#
|
4367
|
+
# A list of HTTP package configurations for the VOD source on this
|
3808
4368
|
# account.
|
3809
4369
|
# @return [Array<Types::HttpPackageConfiguration>]
|
3810
4370
|
#
|
3811
4371
|
# @!attribute [rw] source_location_name
|
4372
|
+
# The name of the source location associated with this VOD Source.
|
3812
4373
|
# @return [String]
|
3813
4374
|
#
|
3814
4375
|
# @!attribute [rw] vod_source_name
|
4376
|
+
# The name of the VOD source.
|
3815
4377
|
# @return [String]
|
3816
4378
|
#
|
3817
4379
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateVodSourceRequest AWS API Documentation
|
@@ -3825,25 +4387,39 @@ module Aws::MediaTailor
|
|
3825
4387
|
end
|
3826
4388
|
|
3827
4389
|
# @!attribute [rw] arn
|
4390
|
+
# The Amazon Resource Name (ARN) associated with the VOD source.
|
3828
4391
|
# @return [String]
|
3829
4392
|
#
|
3830
4393
|
# @!attribute [rw] creation_time
|
4394
|
+
# The timestamp that indicates when the VOD source was created.
|
3831
4395
|
# @return [Time]
|
3832
4396
|
#
|
3833
4397
|
# @!attribute [rw] http_package_configurations
|
3834
|
-
#
|
4398
|
+
# A list of HTTP package configurations for the VOD source on this
|
4399
|
+
# account.
|
3835
4400
|
# @return [Array<Types::HttpPackageConfiguration>]
|
3836
4401
|
#
|
3837
4402
|
# @!attribute [rw] last_modified_time
|
4403
|
+
# The timestamp that indicates when the VOD source was last modified.
|
3838
4404
|
# @return [Time]
|
3839
4405
|
#
|
3840
4406
|
# @!attribute [rw] source_location_name
|
4407
|
+
# The name of the source location associated with the VOD source.
|
3841
4408
|
# @return [String]
|
3842
4409
|
#
|
3843
4410
|
# @!attribute [rw] tags
|
4411
|
+
# The tags to assign to the VOD source. Tags are key-value pairs that
|
4412
|
+
# you can associate with Amazon resources to help with organization,
|
4413
|
+
# access control, and cost tracking. For more information, see
|
4414
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
4415
|
+
#
|
4416
|
+
#
|
4417
|
+
#
|
4418
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
3844
4419
|
# @return [Hash<String,String>]
|
3845
4420
|
#
|
3846
4421
|
# @!attribute [rw] vod_source_name
|
4422
|
+
# The name of the VOD source.
|
3847
4423
|
# @return [String]
|
3848
4424
|
#
|
3849
4425
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateVodSourceResponse AWS API Documentation
|
@@ -3884,7 +4460,14 @@ module Aws::MediaTailor
|
|
3884
4460
|
# @return [String]
|
3885
4461
|
#
|
3886
4462
|
# @!attribute [rw] tags
|
3887
|
-
# The tags assigned to the VOD source.
|
4463
|
+
# The tags assigned to the VOD source. Tags are key-value pairs that
|
4464
|
+
# you can associate with Amazon resources to help with organization,
|
4465
|
+
# access control, and cost tracking. For more information, see
|
4466
|
+
# [Tagging AWS Elemental MediaTailor Resources][1].
|
4467
|
+
#
|
4468
|
+
#
|
4469
|
+
#
|
4470
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
3888
4471
|
# @return [Hash<String,String>]
|
3889
4472
|
#
|
3890
4473
|
# @!attribute [rw] vod_source_name
|