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
@@ -27,7 +27,11 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
-
require 'aws-sdk-core/plugins/
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/request_compression.rb'
|
32
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
33
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
34
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
31
35
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
36
|
|
33
37
|
Aws::Plugins::GlobalConfiguration.add_identifier(:mediatailor)
|
@@ -73,8 +77,13 @@ module Aws::MediaTailor
|
|
73
77
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
78
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
79
|
add_plugin(Aws::Plugins::HttpChecksum)
|
76
|
-
add_plugin(Aws::Plugins::
|
80
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
81
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
82
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
83
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
84
|
+
add_plugin(Aws::Plugins::Sign)
|
77
85
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
86
|
+
add_plugin(Aws::MediaTailor::Plugins::Endpoints)
|
78
87
|
|
79
88
|
# @overload initialize(options)
|
80
89
|
# @param [Hash] options
|
@@ -175,10 +184,18 @@ module Aws::MediaTailor
|
|
175
184
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
176
185
|
# a clock skew correction and retry requests with skewed client clocks.
|
177
186
|
#
|
187
|
+
# @option options [String] :defaults_mode ("legacy")
|
188
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
189
|
+
# accepted modes and the configuration defaults that are included.
|
190
|
+
#
|
178
191
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
179
192
|
# Set to true to disable SDK automatically adding host prefix
|
180
193
|
# to default service endpoint when available.
|
181
194
|
#
|
195
|
+
# @option options [Boolean] :disable_request_compression (false)
|
196
|
+
# When set to 'true' the request body will not be compressed
|
197
|
+
# for supported operations.
|
198
|
+
#
|
182
199
|
# @option options [String] :endpoint
|
183
200
|
# The client endpoint is normally constructed from the `:region`
|
184
201
|
# option. You should only configure an `:endpoint` when connecting
|
@@ -199,6 +216,10 @@ module Aws::MediaTailor
|
|
199
216
|
# @option options [Boolean] :endpoint_discovery (false)
|
200
217
|
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
201
218
|
#
|
219
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
220
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
221
|
+
# variables and the shared configuration file.
|
222
|
+
#
|
202
223
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
203
224
|
# The log formatter.
|
204
225
|
#
|
@@ -219,6 +240,11 @@ module Aws::MediaTailor
|
|
219
240
|
# Used when loading credentials from the shared credentials file
|
220
241
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
221
242
|
#
|
243
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
244
|
+
# The minimum size in bytes that triggers compression for request
|
245
|
+
# bodies. The value must be non-negative integer value between 0
|
246
|
+
# and 10485780 bytes inclusive.
|
247
|
+
#
|
222
248
|
# @option options [Proc] :retry_backoff
|
223
249
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
224
250
|
# This option is only used in the `legacy` retry mode.
|
@@ -264,6 +290,11 @@ module Aws::MediaTailor
|
|
264
290
|
# in the future.
|
265
291
|
#
|
266
292
|
#
|
293
|
+
# @option options [String] :sdk_ua_app_id
|
294
|
+
# A unique and opaque application ID that is appended to the
|
295
|
+
# User-Agent header as app/<sdk_ua_app_id>. It should have a
|
296
|
+
# maximum length of 50.
|
297
|
+
#
|
267
298
|
# @option options [String] :secret_access_key
|
268
299
|
#
|
269
300
|
# @option options [String] :session_token
|
@@ -277,6 +308,19 @@ module Aws::MediaTailor
|
|
277
308
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
278
309
|
# requests are made, and retries are disabled.
|
279
310
|
#
|
311
|
+
# @option options [Aws::TokenProvider] :token_provider
|
312
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
313
|
+
# following classes:
|
314
|
+
#
|
315
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
316
|
+
# tokens.
|
317
|
+
#
|
318
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
319
|
+
# access token generated from `aws login`.
|
320
|
+
#
|
321
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
322
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
323
|
+
#
|
280
324
|
# @option options [Boolean] :use_dualstack_endpoint
|
281
325
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
282
326
|
# will be used if available.
|
@@ -290,6 +334,9 @@ module Aws::MediaTailor
|
|
290
334
|
# When `true`, request parameters are validated before
|
291
335
|
# sending the request.
|
292
336
|
#
|
337
|
+
# @option options [Aws::MediaTailor::EndpointProvider] :endpoint_provider
|
338
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::MediaTailor::EndpointParameters`
|
339
|
+
#
|
293
340
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
294
341
|
# requests through. Formatted like 'http://proxy.com:123'.
|
295
342
|
#
|
@@ -297,7 +344,7 @@ module Aws::MediaTailor
|
|
297
344
|
# seconds to wait when opening a HTTP session before raising a
|
298
345
|
# `Timeout::Error`.
|
299
346
|
#
|
300
|
-
# @option options [
|
347
|
+
# @option options [Float] :http_read_timeout (60) The default
|
301
348
|
# number of seconds to wait for response data. This value can
|
302
349
|
# safely be set per-request on the session.
|
303
350
|
#
|
@@ -313,6 +360,9 @@ module Aws::MediaTailor
|
|
313
360
|
# disables this behaviour. This value can safely be set per
|
314
361
|
# request on the session.
|
315
362
|
#
|
363
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
364
|
+
# in seconds.
|
365
|
+
#
|
316
366
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
317
367
|
# HTTP debug output will be sent to the `:logger`.
|
318
368
|
#
|
@@ -338,19 +388,53 @@ module Aws::MediaTailor
|
|
338
388
|
|
339
389
|
# @!group API Operations
|
340
390
|
|
341
|
-
# Configures Amazon CloudWatch log settings for a
|
342
|
-
#
|
391
|
+
# Configures Amazon CloudWatch log settings for a channel.
|
392
|
+
#
|
393
|
+
# @option params [required, String] :channel_name
|
394
|
+
# The name of the channel.
|
395
|
+
#
|
396
|
+
# @option params [required, Array<String>] :log_types
|
397
|
+
# The types of logs to collect.
|
398
|
+
#
|
399
|
+
# @return [Types::ConfigureLogsForChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
400
|
+
#
|
401
|
+
# * {Types::ConfigureLogsForChannelResponse#channel_name #channel_name} => String
|
402
|
+
# * {Types::ConfigureLogsForChannelResponse#log_types #log_types} => Array<String>
|
403
|
+
#
|
404
|
+
# @example Request syntax with placeholder values
|
405
|
+
#
|
406
|
+
# resp = client.configure_logs_for_channel({
|
407
|
+
# channel_name: "__string", # required
|
408
|
+
# log_types: ["AS_RUN"], # required, accepts AS_RUN
|
409
|
+
# })
|
410
|
+
#
|
411
|
+
# @example Response structure
|
412
|
+
#
|
413
|
+
# resp.channel_name #=> String
|
414
|
+
# resp.log_types #=> Array
|
415
|
+
# resp.log_types[0] #=> String, one of "AS_RUN"
|
416
|
+
#
|
417
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ConfigureLogsForChannel AWS API Documentation
|
418
|
+
#
|
419
|
+
# @overload configure_logs_for_channel(params = {})
|
420
|
+
# @param [Hash] params ({})
|
421
|
+
def configure_logs_for_channel(params = {}, options = {})
|
422
|
+
req = build_request(:configure_logs_for_channel, params)
|
423
|
+
req.send_request(options)
|
424
|
+
end
|
425
|
+
|
426
|
+
# Amazon CloudWatch log settings for a playback configuration.
|
343
427
|
#
|
344
428
|
# @option params [required, Integer] :percent_enabled
|
345
429
|
# The percentage of session logs that MediaTailor sends to your
|
346
430
|
# Cloudwatch Logs account. For example, if your playback configuration
|
347
|
-
# has 1000 sessions and percentEnabled is set to 60
|
431
|
+
# has 1000 sessions and percentEnabled is set to `60`, MediaTailor sends
|
348
432
|
# logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides
|
349
433
|
# at random which of the playback configuration sessions to send logs
|
350
434
|
# for. If you want to view logs for a specific session, you can use the
|
351
435
|
# [debug log mode][1].
|
352
436
|
#
|
353
|
-
# Valid values: 0 - 100
|
437
|
+
# Valid values: `0` - `100`
|
354
438
|
#
|
355
439
|
#
|
356
440
|
#
|
@@ -385,13 +469,21 @@ module Aws::MediaTailor
|
|
385
469
|
req.send_request(options)
|
386
470
|
end
|
387
471
|
|
388
|
-
# Creates a channel.
|
472
|
+
# Creates a channel. For information about MediaTailor channels, see
|
473
|
+
# [Working with channels][1] in the *MediaTailor User Guide*.
|
474
|
+
#
|
475
|
+
#
|
476
|
+
#
|
477
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
|
389
478
|
#
|
390
479
|
# @option params [required, String] :channel_name
|
480
|
+
# The name of the channel.
|
391
481
|
#
|
392
482
|
# @option params [Types::SlateSource] :filler_slate
|
393
483
|
# The slate used to fill gaps between programs in the schedule. You must
|
394
|
-
# configure filler slate if your channel uses
|
484
|
+
# configure filler slate if your channel uses the `LINEAR`
|
485
|
+
# `PlaybackMode`. MediaTailor doesn't support filler slate for channels
|
486
|
+
# using the `LOOP` `PlaybackMode`.
|
395
487
|
#
|
396
488
|
# @option params [required, Array<Types::RequestOutputItem>] :outputs
|
397
489
|
# The channel's output properties.
|
@@ -399,15 +491,25 @@ module Aws::MediaTailor
|
|
399
491
|
# @option params [required, String] :playback_mode
|
400
492
|
# The type of playback mode to use for this channel.
|
401
493
|
#
|
402
|
-
# LINEAR - The programs in the schedule play once back-to-back in the
|
494
|
+
# `LINEAR` - The programs in the schedule play once back-to-back in the
|
403
495
|
# schedule.
|
404
496
|
#
|
405
|
-
# LOOP - The programs in the schedule play back-to-back in an endless
|
497
|
+
# `LOOP` - The programs in the schedule play back-to-back in an endless
|
406
498
|
# loop. When the last program in the schedule stops playing, playback
|
407
499
|
# loops back to the first program in the schedule.
|
408
500
|
#
|
409
501
|
# @option params [Hash<String,String>] :tags
|
410
|
-
# The tags to assign to the channel.
|
502
|
+
# The tags to assign to the channel. Tags are key-value pairs that you
|
503
|
+
# can associate with Amazon resources to help with organization, access
|
504
|
+
# control, and cost tracking. For more information, see [Tagging AWS
|
505
|
+
# Elemental MediaTailor Resources][1].
|
506
|
+
#
|
507
|
+
#
|
508
|
+
#
|
509
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
510
|
+
#
|
511
|
+
# @option params [String] :tier
|
512
|
+
# The tier of the channel.
|
411
513
|
#
|
412
514
|
# @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
413
515
|
#
|
@@ -420,6 +522,7 @@ module Aws::MediaTailor
|
|
420
522
|
# * {Types::CreateChannelResponse#outputs #outputs} => Array<Types::ResponseOutputItem>
|
421
523
|
# * {Types::CreateChannelResponse#playback_mode #playback_mode} => String
|
422
524
|
# * {Types::CreateChannelResponse#tags #tags} => Hash<String,String>
|
525
|
+
# * {Types::CreateChannelResponse#tier #tier} => String
|
423
526
|
#
|
424
527
|
# @example Request syntax with placeholder values
|
425
528
|
#
|
@@ -438,6 +541,7 @@ module Aws::MediaTailor
|
|
438
541
|
# suggested_presentation_delay_seconds: 1,
|
439
542
|
# },
|
440
543
|
# hls_playlist_settings: {
|
544
|
+
# ad_markup_type: ["DATERANGE"], # accepts DATERANGE, SCTE35_ENHANCED
|
441
545
|
# manifest_window_seconds: 1,
|
442
546
|
# },
|
443
547
|
# manifest_name: "__string", # required
|
@@ -448,6 +552,7 @@ module Aws::MediaTailor
|
|
448
552
|
# tags: {
|
449
553
|
# "__string" => "__string",
|
450
554
|
# },
|
555
|
+
# tier: "BASIC", # accepts BASIC, STANDARD
|
451
556
|
# })
|
452
557
|
#
|
453
558
|
# @example Response structure
|
@@ -464,6 +569,8 @@ module Aws::MediaTailor
|
|
464
569
|
# resp.outputs[0].dash_playlist_settings.min_buffer_time_seconds #=> Integer
|
465
570
|
# resp.outputs[0].dash_playlist_settings.min_update_period_seconds #=> Integer
|
466
571
|
# resp.outputs[0].dash_playlist_settings.suggested_presentation_delay_seconds #=> Integer
|
572
|
+
# resp.outputs[0].hls_playlist_settings.ad_markup_type #=> Array
|
573
|
+
# resp.outputs[0].hls_playlist_settings.ad_markup_type[0] #=> String, one of "DATERANGE", "SCTE35_ENHANCED"
|
467
574
|
# resp.outputs[0].hls_playlist_settings.manifest_window_seconds #=> Integer
|
468
575
|
# resp.outputs[0].manifest_name #=> String
|
469
576
|
# resp.outputs[0].playback_url #=> String
|
@@ -471,6 +578,7 @@ module Aws::MediaTailor
|
|
471
578
|
# resp.playback_mode #=> String
|
472
579
|
# resp.tags #=> Hash
|
473
580
|
# resp.tags["__string"] #=> String
|
581
|
+
# resp.tier #=> String
|
474
582
|
#
|
475
583
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateChannel AWS API Documentation
|
476
584
|
#
|
@@ -481,8 +589,86 @@ module Aws::MediaTailor
|
|
481
589
|
req.send_request(options)
|
482
590
|
end
|
483
591
|
|
484
|
-
#
|
485
|
-
#
|
592
|
+
# The live source configuration.
|
593
|
+
#
|
594
|
+
# @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
|
595
|
+
# A list of HTTP package configuration parameters for this live source.
|
596
|
+
#
|
597
|
+
# @option params [required, String] :live_source_name
|
598
|
+
# The name of the live source.
|
599
|
+
#
|
600
|
+
# @option params [required, String] :source_location_name
|
601
|
+
# The name of the source location.
|
602
|
+
#
|
603
|
+
# @option params [Hash<String,String>] :tags
|
604
|
+
# The tags to assign to the live source. Tags are key-value pairs that
|
605
|
+
# you can associate with Amazon resources to help with organization,
|
606
|
+
# access control, and cost tracking. For more information, see [Tagging
|
607
|
+
# AWS Elemental MediaTailor Resources][1].
|
608
|
+
#
|
609
|
+
#
|
610
|
+
#
|
611
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
612
|
+
#
|
613
|
+
# @return [Types::CreateLiveSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
614
|
+
#
|
615
|
+
# * {Types::CreateLiveSourceResponse#arn #arn} => String
|
616
|
+
# * {Types::CreateLiveSourceResponse#creation_time #creation_time} => Time
|
617
|
+
# * {Types::CreateLiveSourceResponse#http_package_configurations #http_package_configurations} => Array<Types::HttpPackageConfiguration>
|
618
|
+
# * {Types::CreateLiveSourceResponse#last_modified_time #last_modified_time} => Time
|
619
|
+
# * {Types::CreateLiveSourceResponse#live_source_name #live_source_name} => String
|
620
|
+
# * {Types::CreateLiveSourceResponse#source_location_name #source_location_name} => String
|
621
|
+
# * {Types::CreateLiveSourceResponse#tags #tags} => Hash<String,String>
|
622
|
+
#
|
623
|
+
# @example Request syntax with placeholder values
|
624
|
+
#
|
625
|
+
# resp = client.create_live_source({
|
626
|
+
# http_package_configurations: [ # required
|
627
|
+
# {
|
628
|
+
# path: "__string", # required
|
629
|
+
# source_group: "__string", # required
|
630
|
+
# type: "DASH", # required, accepts DASH, HLS
|
631
|
+
# },
|
632
|
+
# ],
|
633
|
+
# live_source_name: "__string", # required
|
634
|
+
# source_location_name: "__string", # required
|
635
|
+
# tags: {
|
636
|
+
# "__string" => "__string",
|
637
|
+
# },
|
638
|
+
# })
|
639
|
+
#
|
640
|
+
# @example Response structure
|
641
|
+
#
|
642
|
+
# resp.arn #=> String
|
643
|
+
# resp.creation_time #=> Time
|
644
|
+
# resp.http_package_configurations #=> Array
|
645
|
+
# resp.http_package_configurations[0].path #=> String
|
646
|
+
# resp.http_package_configurations[0].source_group #=> String
|
647
|
+
# resp.http_package_configurations[0].type #=> String, one of "DASH", "HLS"
|
648
|
+
# resp.last_modified_time #=> Time
|
649
|
+
# resp.live_source_name #=> String
|
650
|
+
# resp.source_location_name #=> String
|
651
|
+
# resp.tags #=> Hash
|
652
|
+
# resp.tags["__string"] #=> String
|
653
|
+
#
|
654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateLiveSource AWS API Documentation
|
655
|
+
#
|
656
|
+
# @overload create_live_source(params = {})
|
657
|
+
# @param [Hash] params ({})
|
658
|
+
def create_live_source(params = {}, options = {})
|
659
|
+
req = build_request(:create_live_source, params)
|
660
|
+
req.send_request(options)
|
661
|
+
end
|
662
|
+
|
663
|
+
# Creates a prefetch schedule for a playback configuration. A prefetch
|
664
|
+
# schedule allows you to tell MediaTailor to fetch and prepare certain
|
665
|
+
# ads before an ad break happens. For more information about ad
|
666
|
+
# prefetching, see [Using ad prefetching][1] in the *MediaTailor User
|
667
|
+
# Guide*.
|
668
|
+
#
|
669
|
+
#
|
670
|
+
#
|
671
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
|
486
672
|
#
|
487
673
|
# @option params [required, Types::PrefetchConsumption] :consumption
|
488
674
|
# The configuration settings for MediaTailor's *consumption* of the
|
@@ -492,8 +678,10 @@ module Aws::MediaTailor
|
|
492
678
|
# expire no earlier than seven days after the end time.
|
493
679
|
#
|
494
680
|
# @option params [required, String] :name
|
681
|
+
# The name to assign to the schedule request.
|
495
682
|
#
|
496
683
|
# @option params [required, String] :playback_configuration_name
|
684
|
+
# The name to assign to the playback configuration.
|
497
685
|
#
|
498
686
|
# @option params [required, Types::PrefetchRetrieval] :retrieval
|
499
687
|
# The configuration settings for retrieval of prefetched ads from the ad
|
@@ -503,10 +691,10 @@ module Aws::MediaTailor
|
|
503
691
|
# @option params [String] :stream_id
|
504
692
|
# An optional stream identifier that MediaTailor uses to prefetch ads
|
505
693
|
# for multiple streams that use the same playback configuration. If
|
506
|
-
# StreamId is specified, MediaTailor returns all of the prefetch
|
507
|
-
# schedules with an exact match on StreamId
|
694
|
+
# `StreamId` is specified, MediaTailor returns all of the prefetch
|
695
|
+
# schedules with an exact match on `StreamId`. If not specified,
|
508
696
|
# MediaTailor returns all of the prefetch schedules for the playback
|
509
|
-
# configuration, regardless of StreamId
|
697
|
+
# configuration, regardless of `StreamId`.
|
510
698
|
#
|
511
699
|
# @return [Types::CreatePrefetchScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
512
700
|
#
|
@@ -567,14 +755,24 @@ module Aws::MediaTailor
|
|
567
755
|
req.send_request(options)
|
568
756
|
end
|
569
757
|
|
570
|
-
# Creates a program.
|
758
|
+
# Creates a program within a channel. For information about programs,
|
759
|
+
# see [Working with programs][1] in the *MediaTailor User Guide*.
|
760
|
+
#
|
761
|
+
#
|
762
|
+
#
|
763
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html
|
571
764
|
#
|
572
765
|
# @option params [Array<Types::AdBreak>] :ad_breaks
|
573
766
|
# The ad break configuration settings.
|
574
767
|
#
|
575
768
|
# @option params [required, String] :channel_name
|
769
|
+
# The name of the channel for this Program.
|
770
|
+
#
|
771
|
+
# @option params [String] :live_source_name
|
772
|
+
# The name of the LiveSource for this Program.
|
576
773
|
#
|
577
774
|
# @option params [required, String] :program_name
|
775
|
+
# The name of the Program.
|
578
776
|
#
|
579
777
|
# @option params [required, Types::ScheduleConfiguration] :schedule_configuration
|
580
778
|
# The schedule configuration settings.
|
@@ -582,7 +780,7 @@ module Aws::MediaTailor
|
|
582
780
|
# @option params [required, String] :source_location_name
|
583
781
|
# The name of the source location.
|
584
782
|
#
|
585
|
-
# @option params [
|
783
|
+
# @option params [String] :vod_source_name
|
586
784
|
# The name that's used to refer to a VOD source.
|
587
785
|
#
|
588
786
|
# @return [Types::CreateProgramResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -590,7 +788,10 @@ module Aws::MediaTailor
|
|
590
788
|
# * {Types::CreateProgramResponse#ad_breaks #ad_breaks} => Array<Types::AdBreak>
|
591
789
|
# * {Types::CreateProgramResponse#arn #arn} => String
|
592
790
|
# * {Types::CreateProgramResponse#channel_name #channel_name} => String
|
791
|
+
# * {Types::CreateProgramResponse#clip_range #clip_range} => Types::ClipRange
|
593
792
|
# * {Types::CreateProgramResponse#creation_time #creation_time} => Time
|
793
|
+
# * {Types::CreateProgramResponse#duration_millis #duration_millis} => Integer
|
794
|
+
# * {Types::CreateProgramResponse#live_source_name #live_source_name} => String
|
594
795
|
# * {Types::CreateProgramResponse#program_name #program_name} => String
|
595
796
|
# * {Types::CreateProgramResponse#scheduled_start_time #scheduled_start_time} => Time
|
596
797
|
# * {Types::CreateProgramResponse#source_location_name #source_location_name} => String
|
@@ -601,7 +802,13 @@ module Aws::MediaTailor
|
|
601
802
|
# resp = client.create_program({
|
602
803
|
# ad_breaks: [
|
603
804
|
# {
|
604
|
-
#
|
805
|
+
# ad_break_metadata: [
|
806
|
+
# {
|
807
|
+
# key: "String", # required
|
808
|
+
# value: "String", # required
|
809
|
+
# },
|
810
|
+
# ],
|
811
|
+
# message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT, TIME_SIGNAL
|
605
812
|
# offset_millis: 1,
|
606
813
|
# slate: {
|
607
814
|
# source_location_name: "__string",
|
@@ -613,12 +820,31 @@ module Aws::MediaTailor
|
|
613
820
|
# splice_event_id: 1,
|
614
821
|
# unique_program_id: 1,
|
615
822
|
# },
|
823
|
+
# time_signal_message: {
|
824
|
+
# segmentation_descriptors: [
|
825
|
+
# {
|
826
|
+
# segment_num: 1,
|
827
|
+
# segmentation_event_id: 1,
|
828
|
+
# segmentation_type_id: 1,
|
829
|
+
# segmentation_upid: "String",
|
830
|
+
# segmentation_upid_type: 1,
|
831
|
+
# segments_expected: 1,
|
832
|
+
# sub_segment_num: 1,
|
833
|
+
# sub_segments_expected: 1,
|
834
|
+
# },
|
835
|
+
# ],
|
836
|
+
# },
|
616
837
|
# },
|
617
838
|
# ],
|
618
839
|
# channel_name: "__string", # required
|
840
|
+
# live_source_name: "__string",
|
619
841
|
# program_name: "__string", # required
|
620
842
|
# schedule_configuration: { # required
|
843
|
+
# clip_range: {
|
844
|
+
# end_offset_millis: 1, # required
|
845
|
+
# },
|
621
846
|
# transition: { # required
|
847
|
+
# duration_millis: 1,
|
622
848
|
# relative_position: "BEFORE_PROGRAM", # required, accepts BEFORE_PROGRAM, AFTER_PROGRAM
|
623
849
|
# relative_program: "__string",
|
624
850
|
# scheduled_start_time_millis: 1,
|
@@ -626,13 +852,16 @@ module Aws::MediaTailor
|
|
626
852
|
# },
|
627
853
|
# },
|
628
854
|
# source_location_name: "__string", # required
|
629
|
-
# vod_source_name: "__string",
|
855
|
+
# vod_source_name: "__string",
|
630
856
|
# })
|
631
857
|
#
|
632
858
|
# @example Response structure
|
633
859
|
#
|
634
860
|
# resp.ad_breaks #=> Array
|
635
|
-
# resp.ad_breaks[0].
|
861
|
+
# resp.ad_breaks[0].ad_break_metadata #=> Array
|
862
|
+
# resp.ad_breaks[0].ad_break_metadata[0].key #=> String
|
863
|
+
# resp.ad_breaks[0].ad_break_metadata[0].value #=> String
|
864
|
+
# resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT", "TIME_SIGNAL"
|
636
865
|
# resp.ad_breaks[0].offset_millis #=> Integer
|
637
866
|
# resp.ad_breaks[0].slate.source_location_name #=> String
|
638
867
|
# resp.ad_breaks[0].slate.vod_source_name #=> String
|
@@ -640,9 +869,21 @@ module Aws::MediaTailor
|
|
640
869
|
# resp.ad_breaks[0].splice_insert_message.avails_expected #=> Integer
|
641
870
|
# resp.ad_breaks[0].splice_insert_message.splice_event_id #=> Integer
|
642
871
|
# resp.ad_breaks[0].splice_insert_message.unique_program_id #=> Integer
|
872
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors #=> Array
|
873
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> Integer
|
874
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_event_id #=> Integer
|
875
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_type_id #=> Integer
|
876
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid #=> String
|
877
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> Integer
|
878
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segments_expected #=> Integer
|
879
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segment_num #=> Integer
|
880
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segments_expected #=> Integer
|
643
881
|
# resp.arn #=> String
|
644
882
|
# resp.channel_name #=> String
|
883
|
+
# resp.clip_range.end_offset_millis #=> Integer
|
645
884
|
# resp.creation_time #=> Time
|
885
|
+
# resp.duration_millis #=> Integer
|
886
|
+
# resp.live_source_name #=> String
|
646
887
|
# resp.program_name #=> String
|
647
888
|
# resp.scheduled_start_time #=> Time
|
648
889
|
# resp.source_location_name #=> String
|
@@ -657,7 +898,13 @@ module Aws::MediaTailor
|
|
657
898
|
req.send_request(options)
|
658
899
|
end
|
659
900
|
|
660
|
-
# Creates a source location
|
901
|
+
# Creates a source location. A source location is a container for
|
902
|
+
# sources. For more information about source locations, see [Working
|
903
|
+
# with source locations][1] in the *MediaTailor User Guide*.
|
904
|
+
#
|
905
|
+
#
|
906
|
+
#
|
907
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
|
661
908
|
#
|
662
909
|
# @option params [Types::AccessConfiguration] :access_configuration
|
663
910
|
# Access configuration parameters. Configures the type of authentication
|
@@ -669,10 +916,22 @@ module Aws::MediaTailor
|
|
669
916
|
# @option params [required, Types::HttpConfiguration] :http_configuration
|
670
917
|
# The source's HTTP package configurations.
|
671
918
|
#
|
919
|
+
# @option params [Array<Types::SegmentDeliveryConfiguration>] :segment_delivery_configurations
|
920
|
+
# A list of the segment delivery configurations associated with this
|
921
|
+
# resource.
|
922
|
+
#
|
672
923
|
# @option params [required, String] :source_location_name
|
924
|
+
# The name associated with the source location.
|
673
925
|
#
|
674
926
|
# @option params [Hash<String,String>] :tags
|
675
|
-
# The tags to assign to the source location.
|
927
|
+
# The tags to assign to the source location. Tags are key-value pairs
|
928
|
+
# that you can associate with Amazon resources to help with
|
929
|
+
# organization, access control, and cost tracking. For more information,
|
930
|
+
# see [Tagging AWS Elemental MediaTailor Resources][1].
|
931
|
+
#
|
932
|
+
#
|
933
|
+
#
|
934
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
676
935
|
#
|
677
936
|
# @return [Types::CreateSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
678
937
|
#
|
@@ -682,6 +941,7 @@ module Aws::MediaTailor
|
|
682
941
|
# * {Types::CreateSourceLocationResponse#default_segment_delivery_configuration #default_segment_delivery_configuration} => Types::DefaultSegmentDeliveryConfiguration
|
683
942
|
# * {Types::CreateSourceLocationResponse#http_configuration #http_configuration} => Types::HttpConfiguration
|
684
943
|
# * {Types::CreateSourceLocationResponse#last_modified_time #last_modified_time} => Time
|
944
|
+
# * {Types::CreateSourceLocationResponse#segment_delivery_configurations #segment_delivery_configurations} => Array<Types::SegmentDeliveryConfiguration>
|
685
945
|
# * {Types::CreateSourceLocationResponse#source_location_name #source_location_name} => String
|
686
946
|
# * {Types::CreateSourceLocationResponse#tags #tags} => Hash<String,String>
|
687
947
|
#
|
@@ -689,7 +949,7 @@ module Aws::MediaTailor
|
|
689
949
|
#
|
690
950
|
# resp = client.create_source_location({
|
691
951
|
# access_configuration: {
|
692
|
-
# access_type: "S3_SIGV4", # accepts S3_SIGV4, SECRETS_MANAGER_ACCESS_TOKEN
|
952
|
+
# access_type: "S3_SIGV4", # accepts S3_SIGV4, SECRETS_MANAGER_ACCESS_TOKEN, AUTODETECT_SIGV4
|
693
953
|
# secrets_manager_access_token_configuration: {
|
694
954
|
# header_name: "__string",
|
695
955
|
# secret_arn: "__string",
|
@@ -702,6 +962,12 @@ module Aws::MediaTailor
|
|
702
962
|
# http_configuration: { # required
|
703
963
|
# base_url: "__string", # required
|
704
964
|
# },
|
965
|
+
# segment_delivery_configurations: [
|
966
|
+
# {
|
967
|
+
# base_url: "__string",
|
968
|
+
# name: "__string",
|
969
|
+
# },
|
970
|
+
# ],
|
705
971
|
# source_location_name: "__string", # required
|
706
972
|
# tags: {
|
707
973
|
# "__string" => "__string",
|
@@ -710,7 +976,7 @@ module Aws::MediaTailor
|
|
710
976
|
#
|
711
977
|
# @example Response structure
|
712
978
|
#
|
713
|
-
# resp.access_configuration.access_type #=> String, one of "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN"
|
979
|
+
# resp.access_configuration.access_type #=> String, one of "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN", "AUTODETECT_SIGV4"
|
714
980
|
# resp.access_configuration.secrets_manager_access_token_configuration.header_name #=> String
|
715
981
|
# resp.access_configuration.secrets_manager_access_token_configuration.secret_arn #=> String
|
716
982
|
# resp.access_configuration.secrets_manager_access_token_configuration.secret_string_key #=> String
|
@@ -719,6 +985,9 @@ module Aws::MediaTailor
|
|
719
985
|
# resp.default_segment_delivery_configuration.base_url #=> String
|
720
986
|
# resp.http_configuration.base_url #=> String
|
721
987
|
# resp.last_modified_time #=> Time
|
988
|
+
# resp.segment_delivery_configurations #=> Array
|
989
|
+
# resp.segment_delivery_configurations[0].base_url #=> String
|
990
|
+
# resp.segment_delivery_configurations[0].name #=> String
|
722
991
|
# resp.source_location_name #=> String
|
723
992
|
# resp.tags #=> Hash
|
724
993
|
# resp.tags["__string"] #=> String
|
@@ -732,17 +1001,26 @@ module Aws::MediaTailor
|
|
732
1001
|
req.send_request(options)
|
733
1002
|
end
|
734
1003
|
|
735
|
-
#
|
1004
|
+
# The VOD source configuration parameters.
|
736
1005
|
#
|
737
1006
|
# @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
|
738
|
-
#
|
1007
|
+
# A list of HTTP package configuration parameters for this VOD source.
|
739
1008
|
#
|
740
1009
|
# @option params [required, String] :source_location_name
|
1010
|
+
# The name of the source location for this VOD source.
|
741
1011
|
#
|
742
1012
|
# @option params [Hash<String,String>] :tags
|
743
|
-
# The tags to assign to the VOD source.
|
1013
|
+
# The tags to assign to the VOD source. Tags are key-value pairs that
|
1014
|
+
# you can associate with Amazon resources to help with organization,
|
1015
|
+
# access control, and cost tracking. For more information, see [Tagging
|
1016
|
+
# AWS Elemental MediaTailor Resources][1].
|
1017
|
+
#
|
1018
|
+
#
|
1019
|
+
#
|
1020
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
744
1021
|
#
|
745
1022
|
# @option params [required, String] :vod_source_name
|
1023
|
+
# The name associated with the VOD source.>
|
746
1024
|
#
|
747
1025
|
# @return [Types::CreateVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
748
1026
|
#
|
@@ -794,9 +1072,15 @@ module Aws::MediaTailor
|
|
794
1072
|
req.send_request(options)
|
795
1073
|
end
|
796
1074
|
|
797
|
-
# Deletes a channel.
|
1075
|
+
# Deletes a channel. For information about MediaTailor channels, see
|
1076
|
+
# [Working with channels][1] in the *MediaTailor User Guide*.
|
1077
|
+
#
|
1078
|
+
#
|
1079
|
+
#
|
1080
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
|
798
1081
|
#
|
799
1082
|
# @option params [required, String] :channel_name
|
1083
|
+
# The name of the channel.
|
800
1084
|
#
|
801
1085
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
802
1086
|
#
|
@@ -815,9 +1099,10 @@ module Aws::MediaTailor
|
|
815
1099
|
req.send_request(options)
|
816
1100
|
end
|
817
1101
|
|
818
|
-
#
|
1102
|
+
# The channel policy to delete.
|
819
1103
|
#
|
820
1104
|
# @option params [required, String] :channel_name
|
1105
|
+
# The name of the channel associated with this channel policy.
|
821
1106
|
#
|
822
1107
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
823
1108
|
#
|
@@ -836,9 +1121,42 @@ module Aws::MediaTailor
|
|
836
1121
|
req.send_request(options)
|
837
1122
|
end
|
838
1123
|
|
839
|
-
#
|
1124
|
+
# The live source to delete.
|
1125
|
+
#
|
1126
|
+
# @option params [required, String] :live_source_name
|
1127
|
+
# The name of the live source.
|
1128
|
+
#
|
1129
|
+
# @option params [required, String] :source_location_name
|
1130
|
+
# The name of the source location associated with this Live Source.
|
1131
|
+
#
|
1132
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1133
|
+
#
|
1134
|
+
# @example Request syntax with placeholder values
|
1135
|
+
#
|
1136
|
+
# resp = client.delete_live_source({
|
1137
|
+
# live_source_name: "__string", # required
|
1138
|
+
# source_location_name: "__string", # required
|
1139
|
+
# })
|
1140
|
+
#
|
1141
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteLiveSource AWS API Documentation
|
1142
|
+
#
|
1143
|
+
# @overload delete_live_source(params = {})
|
1144
|
+
# @param [Hash] params ({})
|
1145
|
+
def delete_live_source(params = {}, options = {})
|
1146
|
+
req = build_request(:delete_live_source, params)
|
1147
|
+
req.send_request(options)
|
1148
|
+
end
|
1149
|
+
|
1150
|
+
# Deletes a playback configuration. For information about MediaTailor
|
1151
|
+
# configurations, see [Working with configurations in AWS Elemental
|
1152
|
+
# MediaTailor][1].
|
1153
|
+
#
|
1154
|
+
#
|
1155
|
+
#
|
1156
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
|
840
1157
|
#
|
841
1158
|
# @option params [required, String] :name
|
1159
|
+
# The name of the playback configuration.
|
842
1160
|
#
|
843
1161
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
844
1162
|
#
|
@@ -858,12 +1176,21 @@ module Aws::MediaTailor
|
|
858
1176
|
end
|
859
1177
|
|
860
1178
|
# Deletes a prefetch schedule for a specific playback configuration. If
|
861
|
-
# you call DeletePrefetchSchedule on an expired prefetch schedule,
|
862
|
-
# MediaTailor returns an HTTP 404 status code.
|
1179
|
+
# you call `DeletePrefetchSchedule` on an expired prefetch schedule,
|
1180
|
+
# MediaTailor returns an HTTP 404 status code. For more information
|
1181
|
+
# about ad prefetching, see [Using ad prefetching][1] in the
|
1182
|
+
# *MediaTailor User Guide*.
|
1183
|
+
#
|
1184
|
+
#
|
1185
|
+
#
|
1186
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
|
863
1187
|
#
|
864
1188
|
# @option params [required, String] :name
|
1189
|
+
# The name of the prefetch schedule. If the action is successful, the
|
1190
|
+
# service sends back an HTTP 204 response with an empty HTTP body.
|
865
1191
|
#
|
866
1192
|
# @option params [required, String] :playback_configuration_name
|
1193
|
+
# The name of the playback configuration for this prefetch schedule.
|
867
1194
|
#
|
868
1195
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
869
1196
|
#
|
@@ -883,11 +1210,18 @@ module Aws::MediaTailor
|
|
883
1210
|
req.send_request(options)
|
884
1211
|
end
|
885
1212
|
|
886
|
-
# Deletes a
|
1213
|
+
# Deletes a program within a channel. For information about programs,
|
1214
|
+
# see [Working with programs][1] in the *MediaTailor User Guide*.
|
1215
|
+
#
|
1216
|
+
#
|
1217
|
+
#
|
1218
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html
|
887
1219
|
#
|
888
1220
|
# @option params [required, String] :channel_name
|
1221
|
+
# The name of the channel.
|
889
1222
|
#
|
890
1223
|
# @option params [required, String] :program_name
|
1224
|
+
# The name of the program.
|
891
1225
|
#
|
892
1226
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
893
1227
|
#
|
@@ -907,9 +1241,16 @@ module Aws::MediaTailor
|
|
907
1241
|
req.send_request(options)
|
908
1242
|
end
|
909
1243
|
|
910
|
-
# Deletes a source location
|
1244
|
+
# Deletes a source location. A source location is a container for
|
1245
|
+
# sources. For more information about source locations, see [Working
|
1246
|
+
# with source locations][1] in the *MediaTailor User Guide*.
|
1247
|
+
#
|
1248
|
+
#
|
1249
|
+
#
|
1250
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
|
911
1251
|
#
|
912
1252
|
# @option params [required, String] :source_location_name
|
1253
|
+
# The name of the source location.
|
913
1254
|
#
|
914
1255
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
915
1256
|
#
|
@@ -928,11 +1269,13 @@ module Aws::MediaTailor
|
|
928
1269
|
req.send_request(options)
|
929
1270
|
end
|
930
1271
|
|
931
|
-
#
|
1272
|
+
# The video on demand (VOD) source to delete.
|
932
1273
|
#
|
933
1274
|
# @option params [required, String] :source_location_name
|
1275
|
+
# The name of the source location associated with this VOD Source.
|
934
1276
|
#
|
935
1277
|
# @option params [required, String] :vod_source_name
|
1278
|
+
# The name of the VOD source.
|
936
1279
|
#
|
937
1280
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
938
1281
|
#
|
@@ -952,9 +1295,15 @@ module Aws::MediaTailor
|
|
952
1295
|
req.send_request(options)
|
953
1296
|
end
|
954
1297
|
|
955
|
-
# Describes
|
1298
|
+
# Describes a channel. For information about MediaTailor channels, see
|
1299
|
+
# [Working with channels][1] in the *MediaTailor User Guide*.
|
1300
|
+
#
|
1301
|
+
#
|
1302
|
+
#
|
1303
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
|
956
1304
|
#
|
957
1305
|
# @option params [required, String] :channel_name
|
1306
|
+
# The name of the channel.
|
958
1307
|
#
|
959
1308
|
# @return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
960
1309
|
#
|
@@ -964,9 +1313,11 @@ module Aws::MediaTailor
|
|
964
1313
|
# * {Types::DescribeChannelResponse#creation_time #creation_time} => Time
|
965
1314
|
# * {Types::DescribeChannelResponse#filler_slate #filler_slate} => Types::SlateSource
|
966
1315
|
# * {Types::DescribeChannelResponse#last_modified_time #last_modified_time} => Time
|
1316
|
+
# * {Types::DescribeChannelResponse#log_configuration #log_configuration} => Types::LogConfigurationForChannel
|
967
1317
|
# * {Types::DescribeChannelResponse#outputs #outputs} => Array<Types::ResponseOutputItem>
|
968
1318
|
# * {Types::DescribeChannelResponse#playback_mode #playback_mode} => String
|
969
1319
|
# * {Types::DescribeChannelResponse#tags #tags} => Hash<String,String>
|
1320
|
+
# * {Types::DescribeChannelResponse#tier #tier} => String
|
970
1321
|
#
|
971
1322
|
# @example Request syntax with placeholder values
|
972
1323
|
#
|
@@ -983,11 +1334,15 @@ module Aws::MediaTailor
|
|
983
1334
|
# resp.filler_slate.source_location_name #=> String
|
984
1335
|
# resp.filler_slate.vod_source_name #=> String
|
985
1336
|
# resp.last_modified_time #=> Time
|
1337
|
+
# resp.log_configuration.log_types #=> Array
|
1338
|
+
# resp.log_configuration.log_types[0] #=> String, one of "AS_RUN"
|
986
1339
|
# resp.outputs #=> Array
|
987
1340
|
# resp.outputs[0].dash_playlist_settings.manifest_window_seconds #=> Integer
|
988
1341
|
# resp.outputs[0].dash_playlist_settings.min_buffer_time_seconds #=> Integer
|
989
1342
|
# resp.outputs[0].dash_playlist_settings.min_update_period_seconds #=> Integer
|
990
1343
|
# resp.outputs[0].dash_playlist_settings.suggested_presentation_delay_seconds #=> Integer
|
1344
|
+
# resp.outputs[0].hls_playlist_settings.ad_markup_type #=> Array
|
1345
|
+
# resp.outputs[0].hls_playlist_settings.ad_markup_type[0] #=> String, one of "DATERANGE", "SCTE35_ENHANCED"
|
991
1346
|
# resp.outputs[0].hls_playlist_settings.manifest_window_seconds #=> Integer
|
992
1347
|
# resp.outputs[0].manifest_name #=> String
|
993
1348
|
# resp.outputs[0].playback_url #=> String
|
@@ -995,6 +1350,7 @@ module Aws::MediaTailor
|
|
995
1350
|
# resp.playback_mode #=> String
|
996
1351
|
# resp.tags #=> Hash
|
997
1352
|
# resp.tags["__string"] #=> String
|
1353
|
+
# resp.tier #=> String
|
998
1354
|
#
|
999
1355
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeChannel AWS API Documentation
|
1000
1356
|
#
|
@@ -1005,18 +1361,76 @@ module Aws::MediaTailor
|
|
1005
1361
|
req.send_request(options)
|
1006
1362
|
end
|
1007
1363
|
|
1008
|
-
#
|
1364
|
+
# The live source to describe.
|
1365
|
+
#
|
1366
|
+
# @option params [required, String] :live_source_name
|
1367
|
+
# The name of the live source.
|
1368
|
+
#
|
1369
|
+
# @option params [required, String] :source_location_name
|
1370
|
+
# The name of the source location associated with this Live Source.
|
1371
|
+
#
|
1372
|
+
# @return [Types::DescribeLiveSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1373
|
+
#
|
1374
|
+
# * {Types::DescribeLiveSourceResponse#arn #arn} => String
|
1375
|
+
# * {Types::DescribeLiveSourceResponse#creation_time #creation_time} => Time
|
1376
|
+
# * {Types::DescribeLiveSourceResponse#http_package_configurations #http_package_configurations} => Array<Types::HttpPackageConfiguration>
|
1377
|
+
# * {Types::DescribeLiveSourceResponse#last_modified_time #last_modified_time} => Time
|
1378
|
+
# * {Types::DescribeLiveSourceResponse#live_source_name #live_source_name} => String
|
1379
|
+
# * {Types::DescribeLiveSourceResponse#source_location_name #source_location_name} => String
|
1380
|
+
# * {Types::DescribeLiveSourceResponse#tags #tags} => Hash<String,String>
|
1381
|
+
#
|
1382
|
+
# @example Request syntax with placeholder values
|
1383
|
+
#
|
1384
|
+
# resp = client.describe_live_source({
|
1385
|
+
# live_source_name: "__string", # required
|
1386
|
+
# source_location_name: "__string", # required
|
1387
|
+
# })
|
1388
|
+
#
|
1389
|
+
# @example Response structure
|
1390
|
+
#
|
1391
|
+
# resp.arn #=> String
|
1392
|
+
# resp.creation_time #=> Time
|
1393
|
+
# resp.http_package_configurations #=> Array
|
1394
|
+
# resp.http_package_configurations[0].path #=> String
|
1395
|
+
# resp.http_package_configurations[0].source_group #=> String
|
1396
|
+
# resp.http_package_configurations[0].type #=> String, one of "DASH", "HLS"
|
1397
|
+
# resp.last_modified_time #=> Time
|
1398
|
+
# resp.live_source_name #=> String
|
1399
|
+
# resp.source_location_name #=> String
|
1400
|
+
# resp.tags #=> Hash
|
1401
|
+
# resp.tags["__string"] #=> String
|
1402
|
+
#
|
1403
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeLiveSource AWS API Documentation
|
1404
|
+
#
|
1405
|
+
# @overload describe_live_source(params = {})
|
1406
|
+
# @param [Hash] params ({})
|
1407
|
+
def describe_live_source(params = {}, options = {})
|
1408
|
+
req = build_request(:describe_live_source, params)
|
1409
|
+
req.send_request(options)
|
1410
|
+
end
|
1411
|
+
|
1412
|
+
# Describes a program within a channel. For information about programs,
|
1413
|
+
# see [Working with programs][1] in the *MediaTailor User Guide*.
|
1414
|
+
#
|
1415
|
+
#
|
1416
|
+
#
|
1417
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html
|
1009
1418
|
#
|
1010
1419
|
# @option params [required, String] :channel_name
|
1420
|
+
# The name of the channel associated with this Program.
|
1011
1421
|
#
|
1012
1422
|
# @option params [required, String] :program_name
|
1423
|
+
# The name of the program.
|
1013
1424
|
#
|
1014
1425
|
# @return [Types::DescribeProgramResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1015
1426
|
#
|
1016
1427
|
# * {Types::DescribeProgramResponse#ad_breaks #ad_breaks} => Array<Types::AdBreak>
|
1017
1428
|
# * {Types::DescribeProgramResponse#arn #arn} => String
|
1018
1429
|
# * {Types::DescribeProgramResponse#channel_name #channel_name} => String
|
1430
|
+
# * {Types::DescribeProgramResponse#clip_range #clip_range} => Types::ClipRange
|
1019
1431
|
# * {Types::DescribeProgramResponse#creation_time #creation_time} => Time
|
1432
|
+
# * {Types::DescribeProgramResponse#duration_millis #duration_millis} => Integer
|
1433
|
+
# * {Types::DescribeProgramResponse#live_source_name #live_source_name} => String
|
1020
1434
|
# * {Types::DescribeProgramResponse#program_name #program_name} => String
|
1021
1435
|
# * {Types::DescribeProgramResponse#scheduled_start_time #scheduled_start_time} => Time
|
1022
1436
|
# * {Types::DescribeProgramResponse#source_location_name #source_location_name} => String
|
@@ -1032,7 +1446,10 @@ module Aws::MediaTailor
|
|
1032
1446
|
# @example Response structure
|
1033
1447
|
#
|
1034
1448
|
# resp.ad_breaks #=> Array
|
1035
|
-
# resp.ad_breaks[0].
|
1449
|
+
# resp.ad_breaks[0].ad_break_metadata #=> Array
|
1450
|
+
# resp.ad_breaks[0].ad_break_metadata[0].key #=> String
|
1451
|
+
# resp.ad_breaks[0].ad_break_metadata[0].value #=> String
|
1452
|
+
# resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT", "TIME_SIGNAL"
|
1036
1453
|
# resp.ad_breaks[0].offset_millis #=> Integer
|
1037
1454
|
# resp.ad_breaks[0].slate.source_location_name #=> String
|
1038
1455
|
# resp.ad_breaks[0].slate.vod_source_name #=> String
|
@@ -1040,9 +1457,21 @@ module Aws::MediaTailor
|
|
1040
1457
|
# resp.ad_breaks[0].splice_insert_message.avails_expected #=> Integer
|
1041
1458
|
# resp.ad_breaks[0].splice_insert_message.splice_event_id #=> Integer
|
1042
1459
|
# resp.ad_breaks[0].splice_insert_message.unique_program_id #=> Integer
|
1460
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors #=> Array
|
1461
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> Integer
|
1462
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_event_id #=> Integer
|
1463
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_type_id #=> Integer
|
1464
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid #=> String
|
1465
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> Integer
|
1466
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segments_expected #=> Integer
|
1467
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segment_num #=> Integer
|
1468
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segments_expected #=> Integer
|
1043
1469
|
# resp.arn #=> String
|
1044
1470
|
# resp.channel_name #=> String
|
1471
|
+
# resp.clip_range.end_offset_millis #=> Integer
|
1045
1472
|
# resp.creation_time #=> Time
|
1473
|
+
# resp.duration_millis #=> Integer
|
1474
|
+
# resp.live_source_name #=> String
|
1046
1475
|
# resp.program_name #=> String
|
1047
1476
|
# resp.scheduled_start_time #=> Time
|
1048
1477
|
# resp.source_location_name #=> String
|
@@ -1057,9 +1486,16 @@ module Aws::MediaTailor
|
|
1057
1486
|
req.send_request(options)
|
1058
1487
|
end
|
1059
1488
|
|
1060
|
-
#
|
1489
|
+
# Describes a source location. A source location is a container for
|
1490
|
+
# sources. For more information about source locations, see [Working
|
1491
|
+
# with source locations][1] in the *MediaTailor User Guide*.
|
1492
|
+
#
|
1493
|
+
#
|
1494
|
+
#
|
1495
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
|
1061
1496
|
#
|
1062
1497
|
# @option params [required, String] :source_location_name
|
1498
|
+
# The name of the source location.
|
1063
1499
|
#
|
1064
1500
|
# @return [Types::DescribeSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1065
1501
|
#
|
@@ -1069,6 +1505,7 @@ module Aws::MediaTailor
|
|
1069
1505
|
# * {Types::DescribeSourceLocationResponse#default_segment_delivery_configuration #default_segment_delivery_configuration} => Types::DefaultSegmentDeliveryConfiguration
|
1070
1506
|
# * {Types::DescribeSourceLocationResponse#http_configuration #http_configuration} => Types::HttpConfiguration
|
1071
1507
|
# * {Types::DescribeSourceLocationResponse#last_modified_time #last_modified_time} => Time
|
1508
|
+
# * {Types::DescribeSourceLocationResponse#segment_delivery_configurations #segment_delivery_configurations} => Array<Types::SegmentDeliveryConfiguration>
|
1072
1509
|
# * {Types::DescribeSourceLocationResponse#source_location_name #source_location_name} => String
|
1073
1510
|
# * {Types::DescribeSourceLocationResponse#tags #tags} => Hash<String,String>
|
1074
1511
|
#
|
@@ -1080,7 +1517,7 @@ module Aws::MediaTailor
|
|
1080
1517
|
#
|
1081
1518
|
# @example Response structure
|
1082
1519
|
#
|
1083
|
-
# resp.access_configuration.access_type #=> String, one of "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN"
|
1520
|
+
# resp.access_configuration.access_type #=> String, one of "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN", "AUTODETECT_SIGV4"
|
1084
1521
|
# resp.access_configuration.secrets_manager_access_token_configuration.header_name #=> String
|
1085
1522
|
# resp.access_configuration.secrets_manager_access_token_configuration.secret_arn #=> String
|
1086
1523
|
# resp.access_configuration.secrets_manager_access_token_configuration.secret_string_key #=> String
|
@@ -1089,6 +1526,9 @@ module Aws::MediaTailor
|
|
1089
1526
|
# resp.default_segment_delivery_configuration.base_url #=> String
|
1090
1527
|
# resp.http_configuration.base_url #=> String
|
1091
1528
|
# resp.last_modified_time #=> Time
|
1529
|
+
# resp.segment_delivery_configurations #=> Array
|
1530
|
+
# resp.segment_delivery_configurations[0].base_url #=> String
|
1531
|
+
# resp.segment_delivery_configurations[0].name #=> String
|
1092
1532
|
# resp.source_location_name #=> String
|
1093
1533
|
# resp.tags #=> Hash
|
1094
1534
|
# resp.tags["__string"] #=> String
|
@@ -1102,15 +1542,18 @@ module Aws::MediaTailor
|
|
1102
1542
|
req.send_request(options)
|
1103
1543
|
end
|
1104
1544
|
|
1105
|
-
# Provides details about a specific VOD source in a
|
1106
|
-
# location.
|
1545
|
+
# Provides details about a specific video on demand (VOD) source in a
|
1546
|
+
# specific source location.
|
1107
1547
|
#
|
1108
1548
|
# @option params [required, String] :source_location_name
|
1549
|
+
# The name of the source location associated with this VOD Source.
|
1109
1550
|
#
|
1110
1551
|
# @option params [required, String] :vod_source_name
|
1552
|
+
# The name of the VOD Source.
|
1111
1553
|
#
|
1112
1554
|
# @return [Types::DescribeVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1113
1555
|
#
|
1556
|
+
# * {Types::DescribeVodSourceResponse#ad_break_opportunities #ad_break_opportunities} => Array<Types::AdBreakOpportunity>
|
1114
1557
|
# * {Types::DescribeVodSourceResponse#arn #arn} => String
|
1115
1558
|
# * {Types::DescribeVodSourceResponse#creation_time #creation_time} => Time
|
1116
1559
|
# * {Types::DescribeVodSourceResponse#http_package_configurations #http_package_configurations} => Array<Types::HttpPackageConfiguration>
|
@@ -1128,6 +1571,8 @@ module Aws::MediaTailor
|
|
1128
1571
|
#
|
1129
1572
|
# @example Response structure
|
1130
1573
|
#
|
1574
|
+
# resp.ad_break_opportunities #=> Array
|
1575
|
+
# resp.ad_break_opportunities[0].offset_millis #=> Integer
|
1131
1576
|
# resp.arn #=> String
|
1132
1577
|
# resp.creation_time #=> Time
|
1133
1578
|
# resp.http_package_configurations #=> Array
|
@@ -1149,9 +1594,11 @@ module Aws::MediaTailor
|
|
1149
1594
|
req.send_request(options)
|
1150
1595
|
end
|
1151
1596
|
|
1152
|
-
#
|
1597
|
+
# Returns the channel's IAM policy. IAM policies are used to control
|
1598
|
+
# access to your channel.
|
1153
1599
|
#
|
1154
1600
|
# @option params [required, String] :channel_name
|
1601
|
+
# The name of the channel associated with this Channel Policy.
|
1155
1602
|
#
|
1156
1603
|
# @return [Types::GetChannelPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1157
1604
|
#
|
@@ -1179,12 +1626,30 @@ module Aws::MediaTailor
|
|
1179
1626
|
# Retrieves information about your channel's schedule.
|
1180
1627
|
#
|
1181
1628
|
# @option params [required, String] :channel_name
|
1629
|
+
# The name of the channel associated with this Channel Schedule.
|
1182
1630
|
#
|
1183
1631
|
# @option params [String] :duration_minutes
|
1632
|
+
# The duration in minutes of the channel schedule.
|
1184
1633
|
#
|
1185
1634
|
# @option params [Integer] :max_results
|
1635
|
+
# The maximum number of channel schedules that you want MediaTailor to
|
1636
|
+
# return in response to the current request. If there are more than
|
1637
|
+
# `MaxResults` channel schedules, use the value of `NextToken` in the
|
1638
|
+
# response to get the next page of results.
|
1186
1639
|
#
|
1187
1640
|
# @option params [String] :next_token
|
1641
|
+
# (Optional) If the playback configuration has more than `MaxResults`
|
1642
|
+
# channel schedules, use `NextToken` to get the second and subsequent
|
1643
|
+
# pages of results.
|
1644
|
+
#
|
1645
|
+
# For the first `GetChannelScheduleRequest` request, omit this value.
|
1646
|
+
#
|
1647
|
+
# For the second and subsequent requests, get the value of `NextToken`
|
1648
|
+
# from the previous response and specify that value for `NextToken` in
|
1649
|
+
# the request.
|
1650
|
+
#
|
1651
|
+
# If the previous response didn't include a `NextToken` element, there
|
1652
|
+
# are no more channel schedules to get.
|
1188
1653
|
#
|
1189
1654
|
# @return [Types::GetChannelScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1190
1655
|
#
|
@@ -1209,6 +1674,7 @@ module Aws::MediaTailor
|
|
1209
1674
|
# resp.items[0].approximate_start_time #=> Time
|
1210
1675
|
# resp.items[0].arn #=> String
|
1211
1676
|
# resp.items[0].channel_name #=> String
|
1677
|
+
# resp.items[0].live_source_name #=> String
|
1212
1678
|
# resp.items[0].program_name #=> String
|
1213
1679
|
# resp.items[0].schedule_ad_breaks #=> Array
|
1214
1680
|
# resp.items[0].schedule_ad_breaks[0].approximate_duration_seconds #=> Integer
|
@@ -1229,9 +1695,16 @@ module Aws::MediaTailor
|
|
1229
1695
|
req.send_request(options)
|
1230
1696
|
end
|
1231
1697
|
|
1232
|
-
#
|
1698
|
+
# Retrieves a playback configuration. For information about MediaTailor
|
1699
|
+
# configurations, see [Working with configurations in AWS Elemental
|
1700
|
+
# MediaTailor][1].
|
1701
|
+
#
|
1702
|
+
#
|
1703
|
+
#
|
1704
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
|
1233
1705
|
#
|
1234
1706
|
# @option params [required, String] :name
|
1707
|
+
# The identifier for the playback configuration.
|
1235
1708
|
#
|
1236
1709
|
# @return [Types::GetPlaybackConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1237
1710
|
#
|
@@ -1264,7 +1737,8 @@ module Aws::MediaTailor
|
|
1264
1737
|
# @example Response structure
|
1265
1738
|
#
|
1266
1739
|
# resp.ad_decision_server_url #=> String
|
1267
|
-
# resp.avail_suppression.
|
1740
|
+
# resp.avail_suppression.fill_policy #=> String, one of "FULL_AVAIL_ONLY", "PARTIAL_AVAIL"
|
1741
|
+
# resp.avail_suppression.mode #=> String, one of "OFF", "BEHIND_LIVE_EDGE", "AFTER_LIVE_EDGE"
|
1268
1742
|
# resp.avail_suppression.value #=> String
|
1269
1743
|
# resp.bumper.end_url #=> String
|
1270
1744
|
# resp.bumper.start_url #=> String
|
@@ -1301,13 +1775,26 @@ module Aws::MediaTailor
|
|
1301
1775
|
req.send_request(options)
|
1302
1776
|
end
|
1303
1777
|
|
1304
|
-
#
|
1305
|
-
#
|
1306
|
-
#
|
1778
|
+
# Retrieves a prefetch schedule for a playback configuration. A prefetch
|
1779
|
+
# schedule allows you to tell MediaTailor to fetch and prepare certain
|
1780
|
+
# ads before an ad break happens. For more information about ad
|
1781
|
+
# prefetching, see [Using ad prefetching][1] in the *MediaTailor User
|
1782
|
+
# Guide*.
|
1783
|
+
#
|
1784
|
+
#
|
1785
|
+
#
|
1786
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
|
1307
1787
|
#
|
1308
1788
|
# @option params [required, String] :name
|
1789
|
+
# The name of the prefetch schedule. The name must be unique among all
|
1790
|
+
# prefetch schedules that are associated with the specified playback
|
1791
|
+
# configuration.
|
1309
1792
|
#
|
1310
1793
|
# @option params [required, String] :playback_configuration_name
|
1794
|
+
# Returns information about the prefetch schedule for a specific
|
1795
|
+
# playback configuration. If you call `GetPrefetchSchedule` on an
|
1796
|
+
# expired prefetch schedule, MediaTailor returns an HTTP 404 status
|
1797
|
+
# code.
|
1311
1798
|
#
|
1312
1799
|
# @return [Types::GetPrefetchScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1313
1800
|
#
|
@@ -1350,13 +1837,21 @@ module Aws::MediaTailor
|
|
1350
1837
|
req.send_request(options)
|
1351
1838
|
end
|
1352
1839
|
|
1353
|
-
#
|
1840
|
+
# Lists the alerts that are associated with a MediaTailor channel
|
1841
|
+
# assembly resource.
|
1354
1842
|
#
|
1355
1843
|
# @option params [Integer] :max_results
|
1844
|
+
# The maximum number of alerts that you want MediaTailor to return in
|
1845
|
+
# response to the current request. If there are more than `MaxResults`
|
1846
|
+
# alerts, use the value of `NextToken` in the response to get the next
|
1847
|
+
# page of results.
|
1356
1848
|
#
|
1357
1849
|
# @option params [String] :next_token
|
1850
|
+
# Pagination token returned by the list request when results exceed the
|
1851
|
+
# maximum allowed. Use the token to fetch the next page of results.
|
1358
1852
|
#
|
1359
1853
|
# @option params [required, String] :resource_arn
|
1854
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1360
1855
|
#
|
1361
1856
|
# @return [Types::ListAlertsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1362
1857
|
#
|
@@ -1378,6 +1873,7 @@ module Aws::MediaTailor
|
|
1378
1873
|
# resp.items #=> Array
|
1379
1874
|
# resp.items[0].alert_code #=> String
|
1380
1875
|
# resp.items[0].alert_message #=> String
|
1876
|
+
# resp.items[0].category #=> String, one of "SCHEDULING_ERROR", "PLAYBACK_WARNING", "INFO"
|
1381
1877
|
# resp.items[0].last_modified_time #=> Time
|
1382
1878
|
# resp.items[0].related_resource_arns #=> Array
|
1383
1879
|
# resp.items[0].related_resource_arns[0] #=> String
|
@@ -1393,11 +1889,18 @@ module Aws::MediaTailor
|
|
1393
1889
|
req.send_request(options)
|
1394
1890
|
end
|
1395
1891
|
|
1396
|
-
# Retrieves
|
1892
|
+
# Retrieves information about the channels that are associated with the
|
1893
|
+
# current AWS account.
|
1397
1894
|
#
|
1398
1895
|
# @option params [Integer] :max_results
|
1896
|
+
# The maximum number of channels that you want MediaTailor to return in
|
1897
|
+
# response to the current request. If there are more than `MaxResults`
|
1898
|
+
# channels, use the value of `NextToken` in the response to get the next
|
1899
|
+
# page of results.
|
1399
1900
|
#
|
1400
1901
|
# @option params [String] :next_token
|
1902
|
+
# Pagination token returned by the list request when results exceed the
|
1903
|
+
# maximum allowed. Use the token to fetch the next page of results.
|
1401
1904
|
#
|
1402
1905
|
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1403
1906
|
#
|
@@ -1423,11 +1926,15 @@ module Aws::MediaTailor
|
|
1423
1926
|
# resp.items[0].filler_slate.source_location_name #=> String
|
1424
1927
|
# resp.items[0].filler_slate.vod_source_name #=> String
|
1425
1928
|
# resp.items[0].last_modified_time #=> Time
|
1929
|
+
# resp.items[0].log_configuration.log_types #=> Array
|
1930
|
+
# resp.items[0].log_configuration.log_types[0] #=> String, one of "AS_RUN"
|
1426
1931
|
# resp.items[0].outputs #=> Array
|
1427
1932
|
# resp.items[0].outputs[0].dash_playlist_settings.manifest_window_seconds #=> Integer
|
1428
1933
|
# resp.items[0].outputs[0].dash_playlist_settings.min_buffer_time_seconds #=> Integer
|
1429
1934
|
# resp.items[0].outputs[0].dash_playlist_settings.min_update_period_seconds #=> Integer
|
1430
1935
|
# resp.items[0].outputs[0].dash_playlist_settings.suggested_presentation_delay_seconds #=> Integer
|
1936
|
+
# resp.items[0].outputs[0].hls_playlist_settings.ad_markup_type #=> Array
|
1937
|
+
# resp.items[0].outputs[0].hls_playlist_settings.ad_markup_type[0] #=> String, one of "DATERANGE", "SCTE35_ENHANCED"
|
1431
1938
|
# resp.items[0].outputs[0].hls_playlist_settings.manifest_window_seconds #=> Integer
|
1432
1939
|
# resp.items[0].outputs[0].manifest_name #=> String
|
1433
1940
|
# resp.items[0].outputs[0].playback_url #=> String
|
@@ -1435,6 +1942,7 @@ module Aws::MediaTailor
|
|
1435
1942
|
# resp.items[0].playback_mode #=> String
|
1436
1943
|
# resp.items[0].tags #=> Hash
|
1437
1944
|
# resp.items[0].tags["__string"] #=> String
|
1945
|
+
# resp.items[0].tier #=> String
|
1438
1946
|
# resp.next_token #=> String
|
1439
1947
|
#
|
1440
1948
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListChannels AWS API Documentation
|
@@ -1446,16 +1954,80 @@ module Aws::MediaTailor
|
|
1446
1954
|
req.send_request(options)
|
1447
1955
|
end
|
1448
1956
|
|
1449
|
-
#
|
1450
|
-
#
|
1451
|
-
# return at a time. The default maximum is 50. Results are returned in
|
1452
|
-
# pagefuls. If MediaTailor has more configurations than the specified
|
1453
|
-
# maximum, it provides parameters in the response that you can use to
|
1454
|
-
# retrieve the next pageful.
|
1957
|
+
# Lists the live sources contained in a source location. A source
|
1958
|
+
# represents a piece of content.
|
1455
1959
|
#
|
1456
1960
|
# @option params [Integer] :max_results
|
1961
|
+
# The maximum number of live sources that you want MediaTailor to return
|
1962
|
+
# in response to the current request. If there are more than
|
1963
|
+
# `MaxResults` live sources, use the value of `NextToken` in the
|
1964
|
+
# response to get the next page of results.
|
1457
1965
|
#
|
1458
1966
|
# @option params [String] :next_token
|
1967
|
+
# Pagination token returned by the list request when results exceed the
|
1968
|
+
# maximum allowed. Use the token to fetch the next page of results.
|
1969
|
+
#
|
1970
|
+
# @option params [required, String] :source_location_name
|
1971
|
+
# The name of the source location associated with this Live Sources
|
1972
|
+
# list.
|
1973
|
+
#
|
1974
|
+
# @return [Types::ListLiveSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1975
|
+
#
|
1976
|
+
# * {Types::ListLiveSourcesResponse#items #items} => Array<Types::LiveSource>
|
1977
|
+
# * {Types::ListLiveSourcesResponse#next_token #next_token} => String
|
1978
|
+
#
|
1979
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1980
|
+
#
|
1981
|
+
# @example Request syntax with placeholder values
|
1982
|
+
#
|
1983
|
+
# resp = client.list_live_sources({
|
1984
|
+
# max_results: 1,
|
1985
|
+
# next_token: "__string",
|
1986
|
+
# source_location_name: "__string", # required
|
1987
|
+
# })
|
1988
|
+
#
|
1989
|
+
# @example Response structure
|
1990
|
+
#
|
1991
|
+
# resp.items #=> Array
|
1992
|
+
# resp.items[0].arn #=> String
|
1993
|
+
# resp.items[0].creation_time #=> Time
|
1994
|
+
# resp.items[0].http_package_configurations #=> Array
|
1995
|
+
# resp.items[0].http_package_configurations[0].path #=> String
|
1996
|
+
# resp.items[0].http_package_configurations[0].source_group #=> String
|
1997
|
+
# resp.items[0].http_package_configurations[0].type #=> String, one of "DASH", "HLS"
|
1998
|
+
# resp.items[0].last_modified_time #=> Time
|
1999
|
+
# resp.items[0].live_source_name #=> String
|
2000
|
+
# resp.items[0].source_location_name #=> String
|
2001
|
+
# resp.items[0].tags #=> Hash
|
2002
|
+
# resp.items[0].tags["__string"] #=> String
|
2003
|
+
# resp.next_token #=> String
|
2004
|
+
#
|
2005
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListLiveSources AWS API Documentation
|
2006
|
+
#
|
2007
|
+
# @overload list_live_sources(params = {})
|
2008
|
+
# @param [Hash] params ({})
|
2009
|
+
def list_live_sources(params = {}, options = {})
|
2010
|
+
req = build_request(:list_live_sources, params)
|
2011
|
+
req.send_request(options)
|
2012
|
+
end
|
2013
|
+
|
2014
|
+
# Retrieves existing playback configurations. For information about
|
2015
|
+
# MediaTailor configurations, see [Working with Configurations in AWS
|
2016
|
+
# Elemental MediaTailor][1].
|
2017
|
+
#
|
2018
|
+
#
|
2019
|
+
#
|
2020
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
|
2021
|
+
#
|
2022
|
+
# @option params [Integer] :max_results
|
2023
|
+
# The maximum number of playback configurations that you want
|
2024
|
+
# MediaTailor to return in response to the current request. If there are
|
2025
|
+
# more than `MaxResults` playback configurations, use the value of
|
2026
|
+
# `NextToken` in the response to get the next page of results.
|
2027
|
+
#
|
2028
|
+
# @option params [String] :next_token
|
2029
|
+
# Pagination token returned by the list request when results exceed the
|
2030
|
+
# maximum allowed. Use the token to fetch the next page of results.
|
1459
2031
|
#
|
1460
2032
|
# @return [Types::ListPlaybackConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1461
2033
|
#
|
@@ -1475,7 +2047,8 @@ module Aws::MediaTailor
|
|
1475
2047
|
#
|
1476
2048
|
# resp.items #=> Array
|
1477
2049
|
# resp.items[0].ad_decision_server_url #=> String
|
1478
|
-
# resp.items[0].avail_suppression.
|
2050
|
+
# resp.items[0].avail_suppression.fill_policy #=> String, one of "FULL_AVAIL_ONLY", "PARTIAL_AVAIL"
|
2051
|
+
# resp.items[0].avail_suppression.mode #=> String, one of "OFF", "BEHIND_LIVE_EDGE", "AFTER_LIVE_EDGE"
|
1479
2052
|
# resp.items[0].avail_suppression.value #=> String
|
1480
2053
|
# resp.items[0].bumper.end_url #=> String
|
1481
2054
|
# resp.items[0].bumper.start_url #=> String
|
@@ -1513,29 +2086,31 @@ module Aws::MediaTailor
|
|
1513
2086
|
req.send_request(options)
|
1514
2087
|
end
|
1515
2088
|
|
1516
|
-
#
|
2089
|
+
# Lists the prefetch schedules for a playback configuration.
|
1517
2090
|
#
|
1518
2091
|
# @option params [Integer] :max_results
|
1519
2092
|
# The maximum number of prefetch schedules that you want MediaTailor to
|
1520
|
-
# return in response to the current request. If
|
1521
|
-
#
|
1522
|
-
#
|
2093
|
+
# return in response to the current request. If there are more than
|
2094
|
+
# `MaxResults` prefetch schedules, use the value of `NextToken` in the
|
2095
|
+
# response to get the next page of results.
|
1523
2096
|
#
|
1524
2097
|
# @option params [String] :next_token
|
1525
|
-
# (Optional) If the playback configuration has more than MaxResults
|
1526
|
-
# prefetch schedules, use NextToken to get the second and subsequent
|
2098
|
+
# (Optional) If the playback configuration has more than `MaxResults`
|
2099
|
+
# prefetch schedules, use `NextToken` to get the second and subsequent
|
1527
2100
|
# pages of results.
|
1528
2101
|
#
|
1529
|
-
# For the first ListPrefetchSchedulesRequest request, omit this value.
|
2102
|
+
# For the first `ListPrefetchSchedulesRequest` request, omit this value.
|
1530
2103
|
#
|
1531
|
-
# For the second and subsequent requests, get the value of NextToken
|
1532
|
-
# from the previous response and specify that value for NextToken in
|
1533
|
-
# request.
|
2104
|
+
# For the second and subsequent requests, get the value of `NextToken`
|
2105
|
+
# from the previous response and specify that value for `NextToken` in
|
2106
|
+
# the request.
|
1534
2107
|
#
|
1535
|
-
# If the previous response didn't include a NextToken element, there
|
2108
|
+
# If the previous response didn't include a `NextToken` element, there
|
1536
2109
|
# are no more prefetch schedules to get.
|
1537
2110
|
#
|
1538
2111
|
# @option params [required, String] :playback_configuration_name
|
2112
|
+
# Retrieves the prefetch schedule(s) for a specific playback
|
2113
|
+
# configuration.
|
1539
2114
|
#
|
1540
2115
|
# @option params [String] :stream_id
|
1541
2116
|
# An optional filtering parameter whereby MediaTailor filters the
|
@@ -1584,11 +2159,18 @@ module Aws::MediaTailor
|
|
1584
2159
|
req.send_request(options)
|
1585
2160
|
end
|
1586
2161
|
|
1587
|
-
#
|
2162
|
+
# Lists the source locations for a channel. A source location defines
|
2163
|
+
# the host server URL, and contains a list of sources.
|
1588
2164
|
#
|
1589
2165
|
# @option params [Integer] :max_results
|
2166
|
+
# The maximum number of source locations that you want MediaTailor to
|
2167
|
+
# return in response to the current request. If there are more than
|
2168
|
+
# `MaxResults` source locations, use the value of `NextToken` in the
|
2169
|
+
# response to get the next page of results.
|
1590
2170
|
#
|
1591
2171
|
# @option params [String] :next_token
|
2172
|
+
# Pagination token returned by the list request when results exceed the
|
2173
|
+
# maximum allowed. Use the token to fetch the next page of results.
|
1592
2174
|
#
|
1593
2175
|
# @return [Types::ListSourceLocationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1594
2176
|
#
|
@@ -1607,7 +2189,7 @@ module Aws::MediaTailor
|
|
1607
2189
|
# @example Response structure
|
1608
2190
|
#
|
1609
2191
|
# resp.items #=> Array
|
1610
|
-
# resp.items[0].access_configuration.access_type #=> String, one of "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN"
|
2192
|
+
# resp.items[0].access_configuration.access_type #=> String, one of "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN", "AUTODETECT_SIGV4"
|
1611
2193
|
# resp.items[0].access_configuration.secrets_manager_access_token_configuration.header_name #=> String
|
1612
2194
|
# resp.items[0].access_configuration.secrets_manager_access_token_configuration.secret_arn #=> String
|
1613
2195
|
# resp.items[0].access_configuration.secrets_manager_access_token_configuration.secret_string_key #=> String
|
@@ -1616,6 +2198,9 @@ module Aws::MediaTailor
|
|
1616
2198
|
# resp.items[0].default_segment_delivery_configuration.base_url #=> String
|
1617
2199
|
# resp.items[0].http_configuration.base_url #=> String
|
1618
2200
|
# resp.items[0].last_modified_time #=> Time
|
2201
|
+
# resp.items[0].segment_delivery_configurations #=> Array
|
2202
|
+
# resp.items[0].segment_delivery_configurations[0].base_url #=> String
|
2203
|
+
# resp.items[0].segment_delivery_configurations[0].name #=> String
|
1619
2204
|
# resp.items[0].source_location_name #=> String
|
1620
2205
|
# resp.items[0].tags #=> Hash
|
1621
2206
|
# resp.items[0].tags["__string"] #=> String
|
@@ -1630,10 +2215,17 @@ module Aws::MediaTailor
|
|
1630
2215
|
req.send_request(options)
|
1631
2216
|
end
|
1632
2217
|
|
1633
|
-
#
|
1634
|
-
#
|
2218
|
+
# A list of tags that are associated with this resource. Tags are
|
2219
|
+
# key-value pairs that you can associate with Amazon resources to help
|
2220
|
+
# with organization, access control, and cost tracking. For more
|
2221
|
+
# information, see [Tagging AWS Elemental MediaTailor Resources][1].
|
2222
|
+
#
|
2223
|
+
#
|
2224
|
+
#
|
2225
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
1635
2226
|
#
|
1636
2227
|
# @option params [required, String] :resource_arn
|
2228
|
+
# The Amazon Resource Name (ARN) associated with this resource.
|
1637
2229
|
#
|
1638
2230
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1639
2231
|
#
|
@@ -1659,13 +2251,21 @@ module Aws::MediaTailor
|
|
1659
2251
|
req.send_request(options)
|
1660
2252
|
end
|
1661
2253
|
|
1662
|
-
# Lists
|
2254
|
+
# Lists the VOD sources contained in a source location. A source
|
2255
|
+
# represents a piece of content.
|
1663
2256
|
#
|
1664
2257
|
# @option params [Integer] :max_results
|
2258
|
+
# The maximum number of VOD sources that you want MediaTailor to return
|
2259
|
+
# in response to the current request. If there are more than
|
2260
|
+
# `MaxResults` VOD sources, use the value of `NextToken` in the response
|
2261
|
+
# to get the next page of results.
|
1665
2262
|
#
|
1666
2263
|
# @option params [String] :next_token
|
2264
|
+
# Pagination token returned by the list request when results exceed the
|
2265
|
+
# maximum allowed. Use the token to fetch the next page of results.
|
1667
2266
|
#
|
1668
2267
|
# @option params [required, String] :source_location_name
|
2268
|
+
# The name of the source location associated with this VOD Source list.
|
1669
2269
|
#
|
1670
2270
|
# @return [Types::ListVodSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1671
2271
|
#
|
@@ -1707,9 +2307,11 @@ module Aws::MediaTailor
|
|
1707
2307
|
req.send_request(options)
|
1708
2308
|
end
|
1709
2309
|
|
1710
|
-
# Creates an IAM policy for the channel.
|
2310
|
+
# Creates an IAM policy for the channel. IAM policies are used to
|
2311
|
+
# control access to your channel.
|
1711
2312
|
#
|
1712
2313
|
# @option params [required, String] :channel_name
|
2314
|
+
# The channel name associated with this Channel Policy.
|
1713
2315
|
#
|
1714
2316
|
# @option params [required, String] :policy
|
1715
2317
|
# Adds an IAM role that determines the permissions of your channel.
|
@@ -1732,7 +2334,13 @@ module Aws::MediaTailor
|
|
1732
2334
|
req.send_request(options)
|
1733
2335
|
end
|
1734
2336
|
|
1735
|
-
#
|
2337
|
+
# Creates a playback configuration. For information about MediaTailor
|
2338
|
+
# configurations, see [Working with configurations in AWS Elemental
|
2339
|
+
# MediaTailor][1].
|
2340
|
+
#
|
2341
|
+
#
|
2342
|
+
#
|
2343
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
|
1736
2344
|
#
|
1737
2345
|
# @option params [String] :ad_decision_server_url
|
1738
2346
|
# The URL for the ad decision server (ADS). This includes the
|
@@ -1783,7 +2391,7 @@ module Aws::MediaTailor
|
|
1783
2391
|
# rules enable customization of the personalized manifests created by
|
1784
2392
|
# MediaTailor.
|
1785
2393
|
#
|
1786
|
-
# @option params [String] :name
|
2394
|
+
# @option params [required, String] :name
|
1787
2395
|
# The identifier for the playback configuration.
|
1788
2396
|
#
|
1789
2397
|
# @option params [Integer] :personalization_threshold_seconds
|
@@ -1810,7 +2418,14 @@ module Aws::MediaTailor
|
|
1810
2418
|
# asset that contains both audio and video.
|
1811
2419
|
#
|
1812
2420
|
# @option params [Hash<String,String>] :tags
|
1813
|
-
# The tags to assign to the playback configuration.
|
2421
|
+
# The tags to assign to the playback configuration. Tags are key-value
|
2422
|
+
# pairs that you can associate with Amazon resources to help with
|
2423
|
+
# organization, access control, and cost tracking. For more information,
|
2424
|
+
# see [Tagging AWS Elemental MediaTailor Resources][1].
|
2425
|
+
#
|
2426
|
+
#
|
2427
|
+
#
|
2428
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
1814
2429
|
#
|
1815
2430
|
# @option params [String] :transcode_profile_name
|
1816
2431
|
# The name that is used to associate this playback configuration with a
|
@@ -1849,7 +2464,8 @@ module Aws::MediaTailor
|
|
1849
2464
|
# resp = client.put_playback_configuration({
|
1850
2465
|
# ad_decision_server_url: "__string",
|
1851
2466
|
# avail_suppression: {
|
1852
|
-
#
|
2467
|
+
# fill_policy: "FULL_AVAIL_ONLY", # accepts FULL_AVAIL_ONLY, PARTIAL_AVAIL
|
2468
|
+
# mode: "OFF", # accepts OFF, BEHIND_LIVE_EDGE, AFTER_LIVE_EDGE
|
1853
2469
|
# value: "__string",
|
1854
2470
|
# },
|
1855
2471
|
# bumper: {
|
@@ -1878,7 +2494,7 @@ module Aws::MediaTailor
|
|
1878
2494
|
# enabled: false,
|
1879
2495
|
# },
|
1880
2496
|
# },
|
1881
|
-
# name: "__string",
|
2497
|
+
# name: "__string", # required
|
1882
2498
|
# personalization_threshold_seconds: 1,
|
1883
2499
|
# slate_ad_url: "__string",
|
1884
2500
|
# tags: {
|
@@ -1891,7 +2507,8 @@ module Aws::MediaTailor
|
|
1891
2507
|
# @example Response structure
|
1892
2508
|
#
|
1893
2509
|
# resp.ad_decision_server_url #=> String
|
1894
|
-
# resp.avail_suppression.
|
2510
|
+
# resp.avail_suppression.fill_policy #=> String, one of "FULL_AVAIL_ONLY", "PARTIAL_AVAIL"
|
2511
|
+
# resp.avail_suppression.mode #=> String, one of "OFF", "BEHIND_LIVE_EDGE", "AFTER_LIVE_EDGE"
|
1895
2512
|
# resp.avail_suppression.value #=> String
|
1896
2513
|
# resp.bumper.end_url #=> String
|
1897
2514
|
# resp.bumper.start_url #=> String
|
@@ -1928,9 +2545,15 @@ module Aws::MediaTailor
|
|
1928
2545
|
req.send_request(options)
|
1929
2546
|
end
|
1930
2547
|
|
1931
|
-
# Starts a
|
2548
|
+
# Starts a channel. For information about MediaTailor channels, see
|
2549
|
+
# [Working with channels][1] in the *MediaTailor User Guide*.
|
2550
|
+
#
|
2551
|
+
#
|
2552
|
+
#
|
2553
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
|
1932
2554
|
#
|
1933
2555
|
# @option params [required, String] :channel_name
|
2556
|
+
# The name of the channel.
|
1934
2557
|
#
|
1935
2558
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1936
2559
|
#
|
@@ -1949,9 +2572,15 @@ module Aws::MediaTailor
|
|
1949
2572
|
req.send_request(options)
|
1950
2573
|
end
|
1951
2574
|
|
1952
|
-
# Stops a
|
2575
|
+
# Stops a channel. For information about MediaTailor channels, see
|
2576
|
+
# [Working with channels][1] in the *MediaTailor User Guide*.
|
2577
|
+
#
|
2578
|
+
#
|
2579
|
+
#
|
2580
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
|
1953
2581
|
#
|
1954
2582
|
# @option params [required, String] :channel_name
|
2583
|
+
# The name of the channel.
|
1955
2584
|
#
|
1956
2585
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1957
2586
|
#
|
@@ -1970,12 +2599,27 @@ module Aws::MediaTailor
|
|
1970
2599
|
req.send_request(options)
|
1971
2600
|
end
|
1972
2601
|
|
1973
|
-
#
|
1974
|
-
#
|
2602
|
+
# The resource to tag. Tags are key-value pairs that you can associate
|
2603
|
+
# with Amazon resources to help with organization, access control, and
|
2604
|
+
# cost tracking. For more information, see [Tagging AWS Elemental
|
2605
|
+
# MediaTailor Resources][1].
|
2606
|
+
#
|
2607
|
+
#
|
2608
|
+
#
|
2609
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
1975
2610
|
#
|
1976
2611
|
# @option params [required, String] :resource_arn
|
2612
|
+
# The Amazon Resource Name (ARN) associated with the resource.
|
1977
2613
|
#
|
1978
2614
|
# @option params [required, Hash<String,String>] :tags
|
2615
|
+
# The tags to assign to the resource. Tags are key-value pairs that you
|
2616
|
+
# can associate with Amazon resources to help with organization, access
|
2617
|
+
# control, and cost tracking. For more information, see [Tagging AWS
|
2618
|
+
# Elemental MediaTailor Resources][1].
|
2619
|
+
#
|
2620
|
+
#
|
2621
|
+
#
|
2622
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
1979
2623
|
#
|
1980
2624
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1981
2625
|
#
|
@@ -1997,12 +2641,13 @@ module Aws::MediaTailor
|
|
1997
2641
|
req.send_request(options)
|
1998
2642
|
end
|
1999
2643
|
|
2000
|
-
#
|
2001
|
-
# can specify one or more tags to remove.
|
2644
|
+
# The resource to untag.
|
2002
2645
|
#
|
2003
2646
|
# @option params [required, String] :resource_arn
|
2647
|
+
# The Amazon Resource Name (ARN) of the resource to untag.
|
2004
2648
|
#
|
2005
2649
|
# @option params [required, Array<String>] :tag_keys
|
2650
|
+
# The tag keys associated with the resource.
|
2006
2651
|
#
|
2007
2652
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2008
2653
|
#
|
@@ -2022,9 +2667,21 @@ module Aws::MediaTailor
|
|
2022
2667
|
req.send_request(options)
|
2023
2668
|
end
|
2024
2669
|
|
2025
|
-
# Updates
|
2670
|
+
# Updates a channel. For information about MediaTailor channels, see
|
2671
|
+
# [Working with channels][1] in the *MediaTailor User Guide*.
|
2672
|
+
#
|
2673
|
+
#
|
2674
|
+
#
|
2675
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
|
2026
2676
|
#
|
2027
2677
|
# @option params [required, String] :channel_name
|
2678
|
+
# The name of the channel.
|
2679
|
+
#
|
2680
|
+
# @option params [Types::SlateSource] :filler_slate
|
2681
|
+
# The slate used to fill gaps between programs in the schedule. You must
|
2682
|
+
# configure filler slate if your channel uses the `LINEAR`
|
2683
|
+
# `PlaybackMode`. MediaTailor doesn't support filler slate for channels
|
2684
|
+
# using the `LOOP` `PlaybackMode`.
|
2028
2685
|
#
|
2029
2686
|
# @option params [required, Array<Types::RequestOutputItem>] :outputs
|
2030
2687
|
# The channel's output properties.
|
@@ -2040,11 +2697,16 @@ module Aws::MediaTailor
|
|
2040
2697
|
# * {Types::UpdateChannelResponse#outputs #outputs} => Array<Types::ResponseOutputItem>
|
2041
2698
|
# * {Types::UpdateChannelResponse#playback_mode #playback_mode} => String
|
2042
2699
|
# * {Types::UpdateChannelResponse#tags #tags} => Hash<String,String>
|
2700
|
+
# * {Types::UpdateChannelResponse#tier #tier} => String
|
2043
2701
|
#
|
2044
2702
|
# @example Request syntax with placeholder values
|
2045
2703
|
#
|
2046
2704
|
# resp = client.update_channel({
|
2047
2705
|
# channel_name: "__string", # required
|
2706
|
+
# filler_slate: {
|
2707
|
+
# source_location_name: "__string",
|
2708
|
+
# vod_source_name: "__string",
|
2709
|
+
# },
|
2048
2710
|
# outputs: [ # required
|
2049
2711
|
# {
|
2050
2712
|
# dash_playlist_settings: {
|
@@ -2054,6 +2716,7 @@ module Aws::MediaTailor
|
|
2054
2716
|
# suggested_presentation_delay_seconds: 1,
|
2055
2717
|
# },
|
2056
2718
|
# hls_playlist_settings: {
|
2719
|
+
# ad_markup_type: ["DATERANGE"], # accepts DATERANGE, SCTE35_ENHANCED
|
2057
2720
|
# manifest_window_seconds: 1,
|
2058
2721
|
# },
|
2059
2722
|
# manifest_name: "__string", # required
|
@@ -2076,6 +2739,8 @@ module Aws::MediaTailor
|
|
2076
2739
|
# resp.outputs[0].dash_playlist_settings.min_buffer_time_seconds #=> Integer
|
2077
2740
|
# resp.outputs[0].dash_playlist_settings.min_update_period_seconds #=> Integer
|
2078
2741
|
# resp.outputs[0].dash_playlist_settings.suggested_presentation_delay_seconds #=> Integer
|
2742
|
+
# resp.outputs[0].hls_playlist_settings.ad_markup_type #=> Array
|
2743
|
+
# resp.outputs[0].hls_playlist_settings.ad_markup_type[0] #=> String, one of "DATERANGE", "SCTE35_ENHANCED"
|
2079
2744
|
# resp.outputs[0].hls_playlist_settings.manifest_window_seconds #=> Integer
|
2080
2745
|
# resp.outputs[0].manifest_name #=> String
|
2081
2746
|
# resp.outputs[0].playback_url #=> String
|
@@ -2083,6 +2748,7 @@ module Aws::MediaTailor
|
|
2083
2748
|
# resp.playback_mode #=> String
|
2084
2749
|
# resp.tags #=> Hash
|
2085
2750
|
# resp.tags["__string"] #=> String
|
2751
|
+
# resp.tier #=> String
|
2086
2752
|
#
|
2087
2753
|
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateChannel AWS API Documentation
|
2088
2754
|
#
|
@@ -2093,7 +2759,195 @@ module Aws::MediaTailor
|
|
2093
2759
|
req.send_request(options)
|
2094
2760
|
end
|
2095
2761
|
|
2096
|
-
# Updates a source
|
2762
|
+
# Updates a live source's configuration.
|
2763
|
+
#
|
2764
|
+
# @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
|
2765
|
+
# A list of HTTP package configurations for the live source on this
|
2766
|
+
# account.
|
2767
|
+
#
|
2768
|
+
# @option params [required, String] :live_source_name
|
2769
|
+
# The name of the live source.
|
2770
|
+
#
|
2771
|
+
# @option params [required, String] :source_location_name
|
2772
|
+
# The name of the source location associated with this Live Source.
|
2773
|
+
#
|
2774
|
+
# @return [Types::UpdateLiveSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2775
|
+
#
|
2776
|
+
# * {Types::UpdateLiveSourceResponse#arn #arn} => String
|
2777
|
+
# * {Types::UpdateLiveSourceResponse#creation_time #creation_time} => Time
|
2778
|
+
# * {Types::UpdateLiveSourceResponse#http_package_configurations #http_package_configurations} => Array<Types::HttpPackageConfiguration>
|
2779
|
+
# * {Types::UpdateLiveSourceResponse#last_modified_time #last_modified_time} => Time
|
2780
|
+
# * {Types::UpdateLiveSourceResponse#live_source_name #live_source_name} => String
|
2781
|
+
# * {Types::UpdateLiveSourceResponse#source_location_name #source_location_name} => String
|
2782
|
+
# * {Types::UpdateLiveSourceResponse#tags #tags} => Hash<String,String>
|
2783
|
+
#
|
2784
|
+
# @example Request syntax with placeholder values
|
2785
|
+
#
|
2786
|
+
# resp = client.update_live_source({
|
2787
|
+
# http_package_configurations: [ # required
|
2788
|
+
# {
|
2789
|
+
# path: "__string", # required
|
2790
|
+
# source_group: "__string", # required
|
2791
|
+
# type: "DASH", # required, accepts DASH, HLS
|
2792
|
+
# },
|
2793
|
+
# ],
|
2794
|
+
# live_source_name: "__string", # required
|
2795
|
+
# source_location_name: "__string", # required
|
2796
|
+
# })
|
2797
|
+
#
|
2798
|
+
# @example Response structure
|
2799
|
+
#
|
2800
|
+
# resp.arn #=> String
|
2801
|
+
# resp.creation_time #=> Time
|
2802
|
+
# resp.http_package_configurations #=> Array
|
2803
|
+
# resp.http_package_configurations[0].path #=> String
|
2804
|
+
# resp.http_package_configurations[0].source_group #=> String
|
2805
|
+
# resp.http_package_configurations[0].type #=> String, one of "DASH", "HLS"
|
2806
|
+
# resp.last_modified_time #=> Time
|
2807
|
+
# resp.live_source_name #=> String
|
2808
|
+
# resp.source_location_name #=> String
|
2809
|
+
# resp.tags #=> Hash
|
2810
|
+
# resp.tags["__string"] #=> String
|
2811
|
+
#
|
2812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateLiveSource AWS API Documentation
|
2813
|
+
#
|
2814
|
+
# @overload update_live_source(params = {})
|
2815
|
+
# @param [Hash] params ({})
|
2816
|
+
def update_live_source(params = {}, options = {})
|
2817
|
+
req = build_request(:update_live_source, params)
|
2818
|
+
req.send_request(options)
|
2819
|
+
end
|
2820
|
+
|
2821
|
+
# Updates a program within a channel.
|
2822
|
+
#
|
2823
|
+
# @option params [Array<Types::AdBreak>] :ad_breaks
|
2824
|
+
# The ad break configuration settings.
|
2825
|
+
#
|
2826
|
+
# @option params [required, String] :channel_name
|
2827
|
+
# The name of the channel for this Program.
|
2828
|
+
#
|
2829
|
+
# @option params [required, String] :program_name
|
2830
|
+
# The name of the Program.
|
2831
|
+
#
|
2832
|
+
# @option params [required, Types::UpdateProgramScheduleConfiguration] :schedule_configuration
|
2833
|
+
# The schedule configuration settings.
|
2834
|
+
#
|
2835
|
+
# @return [Types::UpdateProgramResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2836
|
+
#
|
2837
|
+
# * {Types::UpdateProgramResponse#ad_breaks #ad_breaks} => Array<Types::AdBreak>
|
2838
|
+
# * {Types::UpdateProgramResponse#arn #arn} => String
|
2839
|
+
# * {Types::UpdateProgramResponse#channel_name #channel_name} => String
|
2840
|
+
# * {Types::UpdateProgramResponse#clip_range #clip_range} => Types::ClipRange
|
2841
|
+
# * {Types::UpdateProgramResponse#creation_time #creation_time} => Time
|
2842
|
+
# * {Types::UpdateProgramResponse#duration_millis #duration_millis} => Integer
|
2843
|
+
# * {Types::UpdateProgramResponse#live_source_name #live_source_name} => String
|
2844
|
+
# * {Types::UpdateProgramResponse#program_name #program_name} => String
|
2845
|
+
# * {Types::UpdateProgramResponse#scheduled_start_time #scheduled_start_time} => Time
|
2846
|
+
# * {Types::UpdateProgramResponse#source_location_name #source_location_name} => String
|
2847
|
+
# * {Types::UpdateProgramResponse#vod_source_name #vod_source_name} => String
|
2848
|
+
#
|
2849
|
+
# @example Request syntax with placeholder values
|
2850
|
+
#
|
2851
|
+
# resp = client.update_program({
|
2852
|
+
# ad_breaks: [
|
2853
|
+
# {
|
2854
|
+
# ad_break_metadata: [
|
2855
|
+
# {
|
2856
|
+
# key: "String", # required
|
2857
|
+
# value: "String", # required
|
2858
|
+
# },
|
2859
|
+
# ],
|
2860
|
+
# message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT, TIME_SIGNAL
|
2861
|
+
# offset_millis: 1,
|
2862
|
+
# slate: {
|
2863
|
+
# source_location_name: "__string",
|
2864
|
+
# vod_source_name: "__string",
|
2865
|
+
# },
|
2866
|
+
# splice_insert_message: {
|
2867
|
+
# avail_num: 1,
|
2868
|
+
# avails_expected: 1,
|
2869
|
+
# splice_event_id: 1,
|
2870
|
+
# unique_program_id: 1,
|
2871
|
+
# },
|
2872
|
+
# time_signal_message: {
|
2873
|
+
# segmentation_descriptors: [
|
2874
|
+
# {
|
2875
|
+
# segment_num: 1,
|
2876
|
+
# segmentation_event_id: 1,
|
2877
|
+
# segmentation_type_id: 1,
|
2878
|
+
# segmentation_upid: "String",
|
2879
|
+
# segmentation_upid_type: 1,
|
2880
|
+
# segments_expected: 1,
|
2881
|
+
# sub_segment_num: 1,
|
2882
|
+
# sub_segments_expected: 1,
|
2883
|
+
# },
|
2884
|
+
# ],
|
2885
|
+
# },
|
2886
|
+
# },
|
2887
|
+
# ],
|
2888
|
+
# channel_name: "__string", # required
|
2889
|
+
# program_name: "__string", # required
|
2890
|
+
# schedule_configuration: { # required
|
2891
|
+
# clip_range: {
|
2892
|
+
# end_offset_millis: 1, # required
|
2893
|
+
# },
|
2894
|
+
# transition: {
|
2895
|
+
# duration_millis: 1,
|
2896
|
+
# scheduled_start_time_millis: 1,
|
2897
|
+
# },
|
2898
|
+
# },
|
2899
|
+
# })
|
2900
|
+
#
|
2901
|
+
# @example Response structure
|
2902
|
+
#
|
2903
|
+
# resp.ad_breaks #=> Array
|
2904
|
+
# resp.ad_breaks[0].ad_break_metadata #=> Array
|
2905
|
+
# resp.ad_breaks[0].ad_break_metadata[0].key #=> String
|
2906
|
+
# resp.ad_breaks[0].ad_break_metadata[0].value #=> String
|
2907
|
+
# resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT", "TIME_SIGNAL"
|
2908
|
+
# resp.ad_breaks[0].offset_millis #=> Integer
|
2909
|
+
# resp.ad_breaks[0].slate.source_location_name #=> String
|
2910
|
+
# resp.ad_breaks[0].slate.vod_source_name #=> String
|
2911
|
+
# resp.ad_breaks[0].splice_insert_message.avail_num #=> Integer
|
2912
|
+
# resp.ad_breaks[0].splice_insert_message.avails_expected #=> Integer
|
2913
|
+
# resp.ad_breaks[0].splice_insert_message.splice_event_id #=> Integer
|
2914
|
+
# resp.ad_breaks[0].splice_insert_message.unique_program_id #=> Integer
|
2915
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors #=> Array
|
2916
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> Integer
|
2917
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_event_id #=> Integer
|
2918
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_type_id #=> Integer
|
2919
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid #=> String
|
2920
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> Integer
|
2921
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segments_expected #=> Integer
|
2922
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segment_num #=> Integer
|
2923
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segments_expected #=> Integer
|
2924
|
+
# resp.arn #=> String
|
2925
|
+
# resp.channel_name #=> String
|
2926
|
+
# resp.clip_range.end_offset_millis #=> Integer
|
2927
|
+
# resp.creation_time #=> Time
|
2928
|
+
# resp.duration_millis #=> Integer
|
2929
|
+
# resp.live_source_name #=> String
|
2930
|
+
# resp.program_name #=> String
|
2931
|
+
# resp.scheduled_start_time #=> Time
|
2932
|
+
# resp.source_location_name #=> String
|
2933
|
+
# resp.vod_source_name #=> String
|
2934
|
+
#
|
2935
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateProgram AWS API Documentation
|
2936
|
+
#
|
2937
|
+
# @overload update_program(params = {})
|
2938
|
+
# @param [Hash] params ({})
|
2939
|
+
def update_program(params = {}, options = {})
|
2940
|
+
req = build_request(:update_program, params)
|
2941
|
+
req.send_request(options)
|
2942
|
+
end
|
2943
|
+
|
2944
|
+
# Updates a source location. A source location is a container for
|
2945
|
+
# sources. For more information about source locations, see [Working
|
2946
|
+
# with source locations][1] in the *MediaTailor User Guide*.
|
2947
|
+
#
|
2948
|
+
#
|
2949
|
+
#
|
2950
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
|
2097
2951
|
#
|
2098
2952
|
# @option params [Types::AccessConfiguration] :access_configuration
|
2099
2953
|
# Access configuration parameters. Configures the type of authentication
|
@@ -2105,7 +2959,12 @@ module Aws::MediaTailor
|
|
2105
2959
|
# @option params [required, Types::HttpConfiguration] :http_configuration
|
2106
2960
|
# The HTTP configuration for the source location.
|
2107
2961
|
#
|
2962
|
+
# @option params [Array<Types::SegmentDeliveryConfiguration>] :segment_delivery_configurations
|
2963
|
+
# A list of the segment delivery configurations associated with this
|
2964
|
+
# resource.
|
2965
|
+
#
|
2108
2966
|
# @option params [required, String] :source_location_name
|
2967
|
+
# The name of the source location.
|
2109
2968
|
#
|
2110
2969
|
# @return [Types::UpdateSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2111
2970
|
#
|
@@ -2115,6 +2974,7 @@ module Aws::MediaTailor
|
|
2115
2974
|
# * {Types::UpdateSourceLocationResponse#default_segment_delivery_configuration #default_segment_delivery_configuration} => Types::DefaultSegmentDeliveryConfiguration
|
2116
2975
|
# * {Types::UpdateSourceLocationResponse#http_configuration #http_configuration} => Types::HttpConfiguration
|
2117
2976
|
# * {Types::UpdateSourceLocationResponse#last_modified_time #last_modified_time} => Time
|
2977
|
+
# * {Types::UpdateSourceLocationResponse#segment_delivery_configurations #segment_delivery_configurations} => Array<Types::SegmentDeliveryConfiguration>
|
2118
2978
|
# * {Types::UpdateSourceLocationResponse#source_location_name #source_location_name} => String
|
2119
2979
|
# * {Types::UpdateSourceLocationResponse#tags #tags} => Hash<String,String>
|
2120
2980
|
#
|
@@ -2122,7 +2982,7 @@ module Aws::MediaTailor
|
|
2122
2982
|
#
|
2123
2983
|
# resp = client.update_source_location({
|
2124
2984
|
# access_configuration: {
|
2125
|
-
# access_type: "S3_SIGV4", # accepts S3_SIGV4, SECRETS_MANAGER_ACCESS_TOKEN
|
2985
|
+
# access_type: "S3_SIGV4", # accepts S3_SIGV4, SECRETS_MANAGER_ACCESS_TOKEN, AUTODETECT_SIGV4
|
2126
2986
|
# secrets_manager_access_token_configuration: {
|
2127
2987
|
# header_name: "__string",
|
2128
2988
|
# secret_arn: "__string",
|
@@ -2135,12 +2995,18 @@ module Aws::MediaTailor
|
|
2135
2995
|
# http_configuration: { # required
|
2136
2996
|
# base_url: "__string", # required
|
2137
2997
|
# },
|
2998
|
+
# segment_delivery_configurations: [
|
2999
|
+
# {
|
3000
|
+
# base_url: "__string",
|
3001
|
+
# name: "__string",
|
3002
|
+
# },
|
3003
|
+
# ],
|
2138
3004
|
# source_location_name: "__string", # required
|
2139
3005
|
# })
|
2140
3006
|
#
|
2141
3007
|
# @example Response structure
|
2142
3008
|
#
|
2143
|
-
# resp.access_configuration.access_type #=> String, one of "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN"
|
3009
|
+
# resp.access_configuration.access_type #=> String, one of "S3_SIGV4", "SECRETS_MANAGER_ACCESS_TOKEN", "AUTODETECT_SIGV4"
|
2144
3010
|
# resp.access_configuration.secrets_manager_access_token_configuration.header_name #=> String
|
2145
3011
|
# resp.access_configuration.secrets_manager_access_token_configuration.secret_arn #=> String
|
2146
3012
|
# resp.access_configuration.secrets_manager_access_token_configuration.secret_string_key #=> String
|
@@ -2149,6 +3015,9 @@ module Aws::MediaTailor
|
|
2149
3015
|
# resp.default_segment_delivery_configuration.base_url #=> String
|
2150
3016
|
# resp.http_configuration.base_url #=> String
|
2151
3017
|
# resp.last_modified_time #=> Time
|
3018
|
+
# resp.segment_delivery_configurations #=> Array
|
3019
|
+
# resp.segment_delivery_configurations[0].base_url #=> String
|
3020
|
+
# resp.segment_delivery_configurations[0].name #=> String
|
2152
3021
|
# resp.source_location_name #=> String
|
2153
3022
|
# resp.tags #=> Hash
|
2154
3023
|
# resp.tags["__string"] #=> String
|
@@ -2162,15 +3031,17 @@ module Aws::MediaTailor
|
|
2162
3031
|
req.send_request(options)
|
2163
3032
|
end
|
2164
3033
|
|
2165
|
-
# Updates a
|
3034
|
+
# Updates a VOD source's configuration.
|
2166
3035
|
#
|
2167
3036
|
# @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
|
2168
|
-
#
|
3037
|
+
# A list of HTTP package configurations for the VOD source on this
|
2169
3038
|
# account.
|
2170
3039
|
#
|
2171
3040
|
# @option params [required, String] :source_location_name
|
3041
|
+
# The name of the source location associated with this VOD Source.
|
2172
3042
|
#
|
2173
3043
|
# @option params [required, String] :vod_source_name
|
3044
|
+
# The name of the VOD source.
|
2174
3045
|
#
|
2175
3046
|
# @return [Types::UpdateVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2176
3047
|
#
|
@@ -2232,7 +3103,7 @@ module Aws::MediaTailor
|
|
2232
3103
|
params: params,
|
2233
3104
|
config: config)
|
2234
3105
|
context[:gem_name] = 'aws-sdk-mediatailor'
|
2235
|
-
context[:gem_version] = '1.
|
3106
|
+
context[:gem_version] = '1.71.0'
|
2236
3107
|
Seahorse::Client::Request.new(handlers, context)
|
2237
3108
|
end
|
2238
3109
|
|