aws-sdk-mediatailor 1.55.0 → 1.57.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-mediatailor/client.rb +420 -92
- data/lib/aws-sdk-mediatailor/client_api.rb +88 -67
- data/lib/aws-sdk-mediatailor/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-mediatailor/endpoint_provider.rb +112 -0
- data/lib/aws-sdk-mediatailor/endpoints.rb +603 -0
- data/lib/aws-sdk-mediatailor/plugins/endpoints.rb +152 -0
- data/lib/aws-sdk-mediatailor/types.rb +871 -293
- data/lib/aws-sdk-mediatailor.rb +5 -1
- metadata +8 -4
@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
30
30
|
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
-
require 'aws-sdk-core/plugins/
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
34
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
35
35
|
|
36
36
|
Aws::Plugins::GlobalConfiguration.add_identifier(:mediatailor)
|
@@ -79,8 +79,9 @@ module Aws::MediaTailor
|
|
79
79
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
80
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
81
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
82
|
-
add_plugin(Aws::Plugins::
|
82
|
+
add_plugin(Aws::Plugins::Sign)
|
83
83
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
84
|
+
add_plugin(Aws::MediaTailor::Plugins::Endpoints)
|
84
85
|
|
85
86
|
# @overload initialize(options)
|
86
87
|
# @param [Hash] options
|
@@ -287,6 +288,19 @@ module Aws::MediaTailor
|
|
287
288
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
288
289
|
# requests are made, and retries are disabled.
|
289
290
|
#
|
291
|
+
# @option options [Aws::TokenProvider] :token_provider
|
292
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
293
|
+
# following classes:
|
294
|
+
#
|
295
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
296
|
+
# tokens.
|
297
|
+
#
|
298
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
299
|
+
# access token generated from `aws login`.
|
300
|
+
#
|
301
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
302
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
303
|
+
#
|
290
304
|
# @option options [Boolean] :use_dualstack_endpoint
|
291
305
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
292
306
|
# will be used if available.
|
@@ -300,6 +314,9 @@ module Aws::MediaTailor
|
|
300
314
|
# When `true`, request parameters are validated before
|
301
315
|
# sending the request.
|
302
316
|
#
|
317
|
+
# @option options [Aws::MediaTailor::EndpointProvider] :endpoint_provider
|
318
|
+
# 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`
|
319
|
+
#
|
303
320
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
304
321
|
# requests through. Formatted like 'http://proxy.com:123'.
|
305
322
|
#
|
@@ -351,19 +368,18 @@ module Aws::MediaTailor
|
|
351
368
|
|
352
369
|
# @!group API Operations
|
353
370
|
|
354
|
-
#
|
355
|
-
# configuration.
|
371
|
+
# Amazon CloudWatch log settings for a playback configuration.
|
356
372
|
#
|
357
373
|
# @option params [required, Integer] :percent_enabled
|
358
374
|
# The percentage of session logs that MediaTailor sends to your
|
359
375
|
# Cloudwatch Logs account. For example, if your playback configuration
|
360
|
-
# has 1000 sessions and percentEnabled is set to 60
|
376
|
+
# has 1000 sessions and percentEnabled is set to `60`, MediaTailor sends
|
361
377
|
# logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides
|
362
378
|
# at random which of the playback configuration sessions to send logs
|
363
379
|
# for. If you want to view logs for a specific session, you can use the
|
364
380
|
# [debug log mode][1].
|
365
381
|
#
|
366
|
-
# Valid values: 0 - 100
|
382
|
+
# Valid values: `0` - `100`
|
367
383
|
#
|
368
384
|
#
|
369
385
|
#
|
@@ -398,15 +414,21 @@ module Aws::MediaTailor
|
|
398
414
|
req.send_request(options)
|
399
415
|
end
|
400
416
|
|
401
|
-
# Creates a channel.
|
417
|
+
# Creates a channel. For information about MediaTailor channels, see
|
418
|
+
# [Working with channels][1] in the *MediaTailor User Guide*.
|
419
|
+
#
|
420
|
+
#
|
421
|
+
#
|
422
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
|
402
423
|
#
|
403
424
|
# @option params [required, String] :channel_name
|
425
|
+
# The name of the channel.
|
404
426
|
#
|
405
427
|
# @option params [Types::SlateSource] :filler_slate
|
406
428
|
# The slate used to fill gaps between programs in the schedule. You must
|
407
|
-
# configure filler slate if your channel uses the LINEAR
|
408
|
-
# MediaTailor doesn't support filler slate for channels
|
409
|
-
# PlaybackMode
|
429
|
+
# configure filler slate if your channel uses the `LINEAR`
|
430
|
+
# `PlaybackMode`. MediaTailor doesn't support filler slate for channels
|
431
|
+
# using the `LOOP` `PlaybackMode`.
|
410
432
|
#
|
411
433
|
# @option params [required, Array<Types::RequestOutputItem>] :outputs
|
412
434
|
# The channel's output properties.
|
@@ -414,15 +436,22 @@ module Aws::MediaTailor
|
|
414
436
|
# @option params [required, String] :playback_mode
|
415
437
|
# The type of playback mode to use for this channel.
|
416
438
|
#
|
417
|
-
# LINEAR - The programs in the schedule play once back-to-back in the
|
439
|
+
# `LINEAR` - The programs in the schedule play once back-to-back in the
|
418
440
|
# schedule.
|
419
441
|
#
|
420
|
-
# LOOP - The programs in the schedule play back-to-back in an endless
|
442
|
+
# `LOOP` - The programs in the schedule play back-to-back in an endless
|
421
443
|
# loop. When the last program in the schedule stops playing, playback
|
422
444
|
# loops back to the first program in the schedule.
|
423
445
|
#
|
424
446
|
# @option params [Hash<String,String>] :tags
|
425
|
-
# The tags to assign to the channel.
|
447
|
+
# The tags to assign to the channel. Tags are key-value pairs that you
|
448
|
+
# can associate with Amazon resources to help with organization, access
|
449
|
+
# control, and cost tracking. For more information, see [Tagging AWS
|
450
|
+
# Elemental MediaTailor Resources][1].
|
451
|
+
#
|
452
|
+
#
|
453
|
+
#
|
454
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
426
455
|
#
|
427
456
|
# @option params [String] :tier
|
428
457
|
# The tier of the channel.
|
@@ -502,17 +531,26 @@ module Aws::MediaTailor
|
|
502
531
|
req.send_request(options)
|
503
532
|
end
|
504
533
|
|
505
|
-
#
|
534
|
+
# The live source configuration.
|
506
535
|
#
|
507
536
|
# @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
|
508
537
|
# A list of HTTP package configuration parameters for this live source.
|
509
538
|
#
|
510
539
|
# @option params [required, String] :live_source_name
|
540
|
+
# The name of the live source.
|
511
541
|
#
|
512
542
|
# @option params [required, String] :source_location_name
|
543
|
+
# The name of the source location.
|
513
544
|
#
|
514
545
|
# @option params [Hash<String,String>] :tags
|
515
|
-
# The tags to assign to the live source.
|
546
|
+
# The tags to assign to the live source. Tags are key-value pairs that
|
547
|
+
# you can associate with Amazon resources to help with organization,
|
548
|
+
# access control, and cost tracking. For more information, see [Tagging
|
549
|
+
# AWS Elemental MediaTailor Resources][1].
|
550
|
+
#
|
551
|
+
#
|
552
|
+
#
|
553
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
516
554
|
#
|
517
555
|
# @return [Types::CreateLiveSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
518
556
|
#
|
@@ -564,8 +602,15 @@ module Aws::MediaTailor
|
|
564
602
|
req.send_request(options)
|
565
603
|
end
|
566
604
|
|
567
|
-
# Creates a
|
568
|
-
#
|
605
|
+
# Creates a prefetch schedule for a playback configuration. A prefetch
|
606
|
+
# schedule allows you to tell MediaTailor to fetch and prepare certain
|
607
|
+
# ads before an ad break happens. For more information about ad
|
608
|
+
# prefetching, see [Using ad prefetching][1] in the *MediaTailor User
|
609
|
+
# Guide*.
|
610
|
+
#
|
611
|
+
#
|
612
|
+
#
|
613
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
|
569
614
|
#
|
570
615
|
# @option params [required, Types::PrefetchConsumption] :consumption
|
571
616
|
# The configuration settings for MediaTailor's *consumption* of the
|
@@ -575,8 +620,10 @@ module Aws::MediaTailor
|
|
575
620
|
# expire no earlier than seven days after the end time.
|
576
621
|
#
|
577
622
|
# @option params [required, String] :name
|
623
|
+
# The name to assign to the schedule request.
|
578
624
|
#
|
579
625
|
# @option params [required, String] :playback_configuration_name
|
626
|
+
# The name to assign to the playback configuration.
|
580
627
|
#
|
581
628
|
# @option params [required, Types::PrefetchRetrieval] :retrieval
|
582
629
|
# The configuration settings for retrieval of prefetched ads from the ad
|
@@ -586,10 +633,10 @@ module Aws::MediaTailor
|
|
586
633
|
# @option params [String] :stream_id
|
587
634
|
# An optional stream identifier that MediaTailor uses to prefetch ads
|
588
635
|
# for multiple streams that use the same playback configuration. If
|
589
|
-
# StreamId is specified, MediaTailor returns all of the prefetch
|
590
|
-
# schedules with an exact match on StreamId
|
636
|
+
# `StreamId` is specified, MediaTailor returns all of the prefetch
|
637
|
+
# schedules with an exact match on `StreamId`. If not specified,
|
591
638
|
# MediaTailor returns all of the prefetch schedules for the playback
|
592
|
-
# configuration, regardless of StreamId
|
639
|
+
# configuration, regardless of `StreamId`.
|
593
640
|
#
|
594
641
|
# @return [Types::CreatePrefetchScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
595
642
|
#
|
@@ -650,17 +697,24 @@ module Aws::MediaTailor
|
|
650
697
|
req.send_request(options)
|
651
698
|
end
|
652
699
|
|
653
|
-
# Creates a program.
|
700
|
+
# Creates a program within a channel. For information about programs,
|
701
|
+
# see [Working with programs][1] in the *MediaTailor User Guide*.
|
702
|
+
#
|
703
|
+
#
|
704
|
+
#
|
705
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html
|
654
706
|
#
|
655
707
|
# @option params [Array<Types::AdBreak>] :ad_breaks
|
656
708
|
# The ad break configuration settings.
|
657
709
|
#
|
658
710
|
# @option params [required, String] :channel_name
|
711
|
+
# The name of the channel for this Program.
|
659
712
|
#
|
660
713
|
# @option params [String] :live_source_name
|
661
714
|
# The name of the LiveSource for this Program.
|
662
715
|
#
|
663
716
|
# @option params [required, String] :program_name
|
717
|
+
# The name of the Program.
|
664
718
|
#
|
665
719
|
# @option params [required, Types::ScheduleConfiguration] :schedule_configuration
|
666
720
|
# The schedule configuration settings.
|
@@ -688,7 +742,7 @@ module Aws::MediaTailor
|
|
688
742
|
# resp = client.create_program({
|
689
743
|
# ad_breaks: [
|
690
744
|
# {
|
691
|
-
# message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT
|
745
|
+
# message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT, TIME_SIGNAL
|
692
746
|
# offset_millis: 1,
|
693
747
|
# slate: {
|
694
748
|
# source_location_name: "__string",
|
@@ -700,6 +754,20 @@ module Aws::MediaTailor
|
|
700
754
|
# splice_event_id: 1,
|
701
755
|
# unique_program_id: 1,
|
702
756
|
# },
|
757
|
+
# time_signal_message: {
|
758
|
+
# segmentation_descriptors: [
|
759
|
+
# {
|
760
|
+
# segment_num: 1,
|
761
|
+
# segmentation_event_id: 1,
|
762
|
+
# segmentation_type_id: 1,
|
763
|
+
# segmentation_upid: "String",
|
764
|
+
# segmentation_upid_type: 1,
|
765
|
+
# segments_expected: 1,
|
766
|
+
# sub_segment_num: 1,
|
767
|
+
# sub_segments_expected: 1,
|
768
|
+
# },
|
769
|
+
# ],
|
770
|
+
# },
|
703
771
|
# },
|
704
772
|
# ],
|
705
773
|
# channel_name: "__string", # required
|
@@ -721,7 +789,7 @@ module Aws::MediaTailor
|
|
721
789
|
# @example Response structure
|
722
790
|
#
|
723
791
|
# resp.ad_breaks #=> Array
|
724
|
-
# resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT"
|
792
|
+
# resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT", "TIME_SIGNAL"
|
725
793
|
# resp.ad_breaks[0].offset_millis #=> Integer
|
726
794
|
# resp.ad_breaks[0].slate.source_location_name #=> String
|
727
795
|
# resp.ad_breaks[0].slate.vod_source_name #=> String
|
@@ -729,6 +797,15 @@ module Aws::MediaTailor
|
|
729
797
|
# resp.ad_breaks[0].splice_insert_message.avails_expected #=> Integer
|
730
798
|
# resp.ad_breaks[0].splice_insert_message.splice_event_id #=> Integer
|
731
799
|
# resp.ad_breaks[0].splice_insert_message.unique_program_id #=> Integer
|
800
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors #=> Array
|
801
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> Integer
|
802
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_event_id #=> Integer
|
803
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_type_id #=> Integer
|
804
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid #=> String
|
805
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> Integer
|
806
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segments_expected #=> Integer
|
807
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segment_num #=> Integer
|
808
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segments_expected #=> Integer
|
732
809
|
# resp.arn #=> String
|
733
810
|
# resp.channel_name #=> String
|
734
811
|
# resp.creation_time #=> Time
|
@@ -747,7 +824,13 @@ module Aws::MediaTailor
|
|
747
824
|
req.send_request(options)
|
748
825
|
end
|
749
826
|
|
750
|
-
# Creates a source location
|
827
|
+
# Creates a source location. A source location is a container for
|
828
|
+
# sources. For more information about source locations, see [Working
|
829
|
+
# with source locations][1] in the *MediaTailor User Guide*.
|
830
|
+
#
|
831
|
+
#
|
832
|
+
#
|
833
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
|
751
834
|
#
|
752
835
|
# @option params [Types::AccessConfiguration] :access_configuration
|
753
836
|
# Access configuration parameters. Configures the type of authentication
|
@@ -764,9 +847,17 @@ module Aws::MediaTailor
|
|
764
847
|
# resource.
|
765
848
|
#
|
766
849
|
# @option params [required, String] :source_location_name
|
850
|
+
# The name associated with the source location.
|
767
851
|
#
|
768
852
|
# @option params [Hash<String,String>] :tags
|
769
|
-
# The tags to assign to the source location.
|
853
|
+
# The tags to assign to the source location. Tags are key-value pairs
|
854
|
+
# that you can associate with Amazon resources to help with
|
855
|
+
# organization, access control, and cost tracking. For more information,
|
856
|
+
# see [Tagging AWS Elemental MediaTailor Resources][1].
|
857
|
+
#
|
858
|
+
#
|
859
|
+
#
|
860
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
770
861
|
#
|
771
862
|
# @return [Types::CreateSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
772
863
|
#
|
@@ -836,17 +927,26 @@ module Aws::MediaTailor
|
|
836
927
|
req.send_request(options)
|
837
928
|
end
|
838
929
|
|
839
|
-
#
|
930
|
+
# The VOD source configuration parameters.
|
840
931
|
#
|
841
932
|
# @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
|
842
933
|
# A list of HTTP package configuration parameters for this VOD source.
|
843
934
|
#
|
844
935
|
# @option params [required, String] :source_location_name
|
936
|
+
# The name of the source location for this VOD source.
|
845
937
|
#
|
846
938
|
# @option params [Hash<String,String>] :tags
|
847
|
-
# The tags to assign to the VOD source.
|
939
|
+
# The tags to assign to the VOD source. Tags are key-value pairs that
|
940
|
+
# you can associate with Amazon resources to help with organization,
|
941
|
+
# access control, and cost tracking. For more information, see [Tagging
|
942
|
+
# AWS Elemental MediaTailor Resources][1].
|
943
|
+
#
|
944
|
+
#
|
945
|
+
#
|
946
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
848
947
|
#
|
849
948
|
# @option params [required, String] :vod_source_name
|
949
|
+
# The name associated with the VOD source.>
|
850
950
|
#
|
851
951
|
# @return [Types::CreateVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
852
952
|
#
|
@@ -898,9 +998,15 @@ module Aws::MediaTailor
|
|
898
998
|
req.send_request(options)
|
899
999
|
end
|
900
1000
|
|
901
|
-
# Deletes a channel.
|
1001
|
+
# Deletes a channel. For information about MediaTailor channels, see
|
1002
|
+
# [Working with channels][1] in the *MediaTailor User Guide*.
|
1003
|
+
#
|
1004
|
+
#
|
1005
|
+
#
|
1006
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
|
902
1007
|
#
|
903
1008
|
# @option params [required, String] :channel_name
|
1009
|
+
# The name of the channel.
|
904
1010
|
#
|
905
1011
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
906
1012
|
#
|
@@ -919,9 +1025,10 @@ module Aws::MediaTailor
|
|
919
1025
|
req.send_request(options)
|
920
1026
|
end
|
921
1027
|
|
922
|
-
#
|
1028
|
+
# The channel policy to delete.
|
923
1029
|
#
|
924
1030
|
# @option params [required, String] :channel_name
|
1031
|
+
# The name of the channel associated with this channel policy.
|
925
1032
|
#
|
926
1033
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
927
1034
|
#
|
@@ -940,11 +1047,13 @@ module Aws::MediaTailor
|
|
940
1047
|
req.send_request(options)
|
941
1048
|
end
|
942
1049
|
|
943
|
-
#
|
1050
|
+
# The live source to delete.
|
944
1051
|
#
|
945
1052
|
# @option params [required, String] :live_source_name
|
1053
|
+
# The name of the live source.
|
946
1054
|
#
|
947
1055
|
# @option params [required, String] :source_location_name
|
1056
|
+
# The name of the source location associated with this Live Source.
|
948
1057
|
#
|
949
1058
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
950
1059
|
#
|
@@ -964,9 +1073,16 @@ module Aws::MediaTailor
|
|
964
1073
|
req.send_request(options)
|
965
1074
|
end
|
966
1075
|
|
967
|
-
# Deletes
|
1076
|
+
# Deletes a playback configuration. For information about MediaTailor
|
1077
|
+
# configurations, see [Working with configurations in AWS Elemental
|
1078
|
+
# MediaTailor][1].
|
1079
|
+
#
|
1080
|
+
#
|
1081
|
+
#
|
1082
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
|
968
1083
|
#
|
969
1084
|
# @option params [required, String] :name
|
1085
|
+
# The name of the playback configuration.
|
970
1086
|
#
|
971
1087
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
972
1088
|
#
|
@@ -986,12 +1102,21 @@ module Aws::MediaTailor
|
|
986
1102
|
end
|
987
1103
|
|
988
1104
|
# Deletes a prefetch schedule for a specific playback configuration. If
|
989
|
-
# you call DeletePrefetchSchedule on an expired prefetch schedule,
|
990
|
-
# MediaTailor returns an HTTP 404 status code.
|
1105
|
+
# you call `DeletePrefetchSchedule` on an expired prefetch schedule,
|
1106
|
+
# MediaTailor returns an HTTP 404 status code. For more information
|
1107
|
+
# about ad prefetching, see [Using ad prefetching][1] in the
|
1108
|
+
# *MediaTailor User Guide*.
|
1109
|
+
#
|
1110
|
+
#
|
1111
|
+
#
|
1112
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
|
991
1113
|
#
|
992
1114
|
# @option params [required, String] :name
|
1115
|
+
# The name of the prefetch schedule. If the action is successful, the
|
1116
|
+
# service sends back an HTTP 204 response with an empty HTTP body.
|
993
1117
|
#
|
994
1118
|
# @option params [required, String] :playback_configuration_name
|
1119
|
+
# The name of the playback configuration for this prefetch schedule.
|
995
1120
|
#
|
996
1121
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
997
1122
|
#
|
@@ -1011,11 +1136,18 @@ module Aws::MediaTailor
|
|
1011
1136
|
req.send_request(options)
|
1012
1137
|
end
|
1013
1138
|
|
1014
|
-
# Deletes a
|
1139
|
+
# Deletes a program within a channel. For information about programs,
|
1140
|
+
# see [Working with programs][1] in the *MediaTailor User Guide*.
|
1141
|
+
#
|
1142
|
+
#
|
1143
|
+
#
|
1144
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html
|
1015
1145
|
#
|
1016
1146
|
# @option params [required, String] :channel_name
|
1147
|
+
# The name of the channel.
|
1017
1148
|
#
|
1018
1149
|
# @option params [required, String] :program_name
|
1150
|
+
# The name of the program.
|
1019
1151
|
#
|
1020
1152
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1021
1153
|
#
|
@@ -1035,9 +1167,16 @@ module Aws::MediaTailor
|
|
1035
1167
|
req.send_request(options)
|
1036
1168
|
end
|
1037
1169
|
|
1038
|
-
# Deletes a source location
|
1170
|
+
# Deletes a source location. A source location is a container for
|
1171
|
+
# sources. For more information about source locations, see [Working
|
1172
|
+
# with source locations][1] in the *MediaTailor User Guide*.
|
1173
|
+
#
|
1174
|
+
#
|
1175
|
+
#
|
1176
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
|
1039
1177
|
#
|
1040
1178
|
# @option params [required, String] :source_location_name
|
1179
|
+
# The name of the source location.
|
1041
1180
|
#
|
1042
1181
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1043
1182
|
#
|
@@ -1056,11 +1195,13 @@ module Aws::MediaTailor
|
|
1056
1195
|
req.send_request(options)
|
1057
1196
|
end
|
1058
1197
|
|
1059
|
-
#
|
1198
|
+
# The video on demand (VOD) source to delete.
|
1060
1199
|
#
|
1061
1200
|
# @option params [required, String] :source_location_name
|
1201
|
+
# The name of the source location associated with this VOD Source.
|
1062
1202
|
#
|
1063
1203
|
# @option params [required, String] :vod_source_name
|
1204
|
+
# The name of the VOD source.
|
1064
1205
|
#
|
1065
1206
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1066
1207
|
#
|
@@ -1080,9 +1221,15 @@ module Aws::MediaTailor
|
|
1080
1221
|
req.send_request(options)
|
1081
1222
|
end
|
1082
1223
|
|
1083
|
-
# Describes
|
1224
|
+
# Describes a channel. For information about MediaTailor channels, see
|
1225
|
+
# [Working with channels][1] in the *MediaTailor User Guide*.
|
1226
|
+
#
|
1227
|
+
#
|
1228
|
+
#
|
1229
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
|
1084
1230
|
#
|
1085
1231
|
# @option params [required, String] :channel_name
|
1232
|
+
# The name of the channel.
|
1086
1233
|
#
|
1087
1234
|
# @return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1088
1235
|
#
|
@@ -1135,12 +1282,13 @@ module Aws::MediaTailor
|
|
1135
1282
|
req.send_request(options)
|
1136
1283
|
end
|
1137
1284
|
|
1138
|
-
#
|
1139
|
-
# location.
|
1285
|
+
# The live source to describe.
|
1140
1286
|
#
|
1141
1287
|
# @option params [required, String] :live_source_name
|
1288
|
+
# The name of the live source.
|
1142
1289
|
#
|
1143
1290
|
# @option params [required, String] :source_location_name
|
1291
|
+
# The name of the source location associated with this Live Source.
|
1144
1292
|
#
|
1145
1293
|
# @return [Types::DescribeLiveSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1146
1294
|
#
|
@@ -1182,11 +1330,18 @@ module Aws::MediaTailor
|
|
1182
1330
|
req.send_request(options)
|
1183
1331
|
end
|
1184
1332
|
|
1185
|
-
#
|
1333
|
+
# Describes a program within a channel. For information about programs,
|
1334
|
+
# see [Working with programs][1] in the *MediaTailor User Guide*.
|
1335
|
+
#
|
1336
|
+
#
|
1337
|
+
#
|
1338
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html
|
1186
1339
|
#
|
1187
1340
|
# @option params [required, String] :channel_name
|
1341
|
+
# The name of the channel associated with this Program.
|
1188
1342
|
#
|
1189
1343
|
# @option params [required, String] :program_name
|
1344
|
+
# The name of the program.
|
1190
1345
|
#
|
1191
1346
|
# @return [Types::DescribeProgramResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1192
1347
|
#
|
@@ -1210,7 +1365,7 @@ module Aws::MediaTailor
|
|
1210
1365
|
# @example Response structure
|
1211
1366
|
#
|
1212
1367
|
# resp.ad_breaks #=> Array
|
1213
|
-
# resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT"
|
1368
|
+
# resp.ad_breaks[0].message_type #=> String, one of "SPLICE_INSERT", "TIME_SIGNAL"
|
1214
1369
|
# resp.ad_breaks[0].offset_millis #=> Integer
|
1215
1370
|
# resp.ad_breaks[0].slate.source_location_name #=> String
|
1216
1371
|
# resp.ad_breaks[0].slate.vod_source_name #=> String
|
@@ -1218,6 +1373,15 @@ module Aws::MediaTailor
|
|
1218
1373
|
# resp.ad_breaks[0].splice_insert_message.avails_expected #=> Integer
|
1219
1374
|
# resp.ad_breaks[0].splice_insert_message.splice_event_id #=> Integer
|
1220
1375
|
# resp.ad_breaks[0].splice_insert_message.unique_program_id #=> Integer
|
1376
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors #=> Array
|
1377
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segment_num #=> Integer
|
1378
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_event_id #=> Integer
|
1379
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_type_id #=> Integer
|
1380
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid #=> String
|
1381
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segmentation_upid_type #=> Integer
|
1382
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].segments_expected #=> Integer
|
1383
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segment_num #=> Integer
|
1384
|
+
# resp.ad_breaks[0].time_signal_message.segmentation_descriptors[0].sub_segments_expected #=> Integer
|
1221
1385
|
# resp.arn #=> String
|
1222
1386
|
# resp.channel_name #=> String
|
1223
1387
|
# resp.creation_time #=> Time
|
@@ -1236,9 +1400,16 @@ module Aws::MediaTailor
|
|
1236
1400
|
req.send_request(options)
|
1237
1401
|
end
|
1238
1402
|
|
1239
|
-
#
|
1403
|
+
# Describes a source location. A source location is a container for
|
1404
|
+
# sources. For more information about source locations, see [Working
|
1405
|
+
# with source locations][1] in the *MediaTailor User Guide*.
|
1406
|
+
#
|
1407
|
+
#
|
1408
|
+
#
|
1409
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
|
1240
1410
|
#
|
1241
1411
|
# @option params [required, String] :source_location_name
|
1412
|
+
# The name of the source location.
|
1242
1413
|
#
|
1243
1414
|
# @return [Types::DescribeSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1244
1415
|
#
|
@@ -1285,12 +1456,14 @@ module Aws::MediaTailor
|
|
1285
1456
|
req.send_request(options)
|
1286
1457
|
end
|
1287
1458
|
|
1288
|
-
# Provides details about a specific VOD source in a
|
1289
|
-
# location.
|
1459
|
+
# Provides details about a specific video on demand (VOD) source in a
|
1460
|
+
# specific source location.
|
1290
1461
|
#
|
1291
1462
|
# @option params [required, String] :source_location_name
|
1463
|
+
# The name of the source location associated with this VOD Source.
|
1292
1464
|
#
|
1293
1465
|
# @option params [required, String] :vod_source_name
|
1466
|
+
# The name of the VOD Source.
|
1294
1467
|
#
|
1295
1468
|
# @return [Types::DescribeVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1296
1469
|
#
|
@@ -1332,9 +1505,11 @@ module Aws::MediaTailor
|
|
1332
1505
|
req.send_request(options)
|
1333
1506
|
end
|
1334
1507
|
|
1335
|
-
#
|
1508
|
+
# Returns the channel's IAM policy. IAM policies are used to control
|
1509
|
+
# access to your channel.
|
1336
1510
|
#
|
1337
1511
|
# @option params [required, String] :channel_name
|
1512
|
+
# The name of the channel associated with this Channel Policy.
|
1338
1513
|
#
|
1339
1514
|
# @return [Types::GetChannelPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1340
1515
|
#
|
@@ -1362,12 +1537,30 @@ module Aws::MediaTailor
|
|
1362
1537
|
# Retrieves information about your channel's schedule.
|
1363
1538
|
#
|
1364
1539
|
# @option params [required, String] :channel_name
|
1540
|
+
# The name of the channel associated with this Channel Schedule.
|
1365
1541
|
#
|
1366
1542
|
# @option params [String] :duration_minutes
|
1543
|
+
# The duration in minutes of the channel schedule.
|
1367
1544
|
#
|
1368
1545
|
# @option params [Integer] :max_results
|
1546
|
+
# The maximum number of channel schedules that you want MediaTailor to
|
1547
|
+
# return in response to the current request. If there are more than
|
1548
|
+
# `MaxResults` channel schedules, use the value of `NextToken` in the
|
1549
|
+
# response to get the next page of results.
|
1369
1550
|
#
|
1370
1551
|
# @option params [String] :next_token
|
1552
|
+
# (Optional) If the playback configuration has more than `MaxResults`
|
1553
|
+
# channel schedules, use `NextToken` to get the second and subsequent
|
1554
|
+
# pages of results.
|
1555
|
+
#
|
1556
|
+
# For the first `GetChannelScheduleRequest` request, omit this value.
|
1557
|
+
#
|
1558
|
+
# For the second and subsequent requests, get the value of `NextToken`
|
1559
|
+
# from the previous response and specify that value for `NextToken` in
|
1560
|
+
# the request.
|
1561
|
+
#
|
1562
|
+
# If the previous response didn't include a `NextToken` element, there
|
1563
|
+
# are no more channel schedules to get.
|
1371
1564
|
#
|
1372
1565
|
# @return [Types::GetChannelScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1373
1566
|
#
|
@@ -1413,9 +1606,16 @@ module Aws::MediaTailor
|
|
1413
1606
|
req.send_request(options)
|
1414
1607
|
end
|
1415
1608
|
|
1416
|
-
#
|
1609
|
+
# Retrieves a playback configuration. For information about MediaTailor
|
1610
|
+
# configurations, see [Working with configurations in AWS Elemental
|
1611
|
+
# MediaTailor][1].
|
1612
|
+
#
|
1613
|
+
#
|
1614
|
+
#
|
1615
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
|
1417
1616
|
#
|
1418
1617
|
# @option params [required, String] :name
|
1618
|
+
# The identifier for the playback configuration.
|
1419
1619
|
#
|
1420
1620
|
# @return [Types::GetPlaybackConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1421
1621
|
#
|
@@ -1485,13 +1685,26 @@ module Aws::MediaTailor
|
|
1485
1685
|
req.send_request(options)
|
1486
1686
|
end
|
1487
1687
|
|
1488
|
-
#
|
1489
|
-
#
|
1490
|
-
#
|
1688
|
+
# Retrieves a prefetch schedule for a playback configuration. A prefetch
|
1689
|
+
# schedule allows you to tell MediaTailor to fetch and prepare certain
|
1690
|
+
# ads before an ad break happens. For more information about ad
|
1691
|
+
# prefetching, see [Using ad prefetching][1] in the *MediaTailor User
|
1692
|
+
# Guide*.
|
1693
|
+
#
|
1694
|
+
#
|
1695
|
+
#
|
1696
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
|
1491
1697
|
#
|
1492
1698
|
# @option params [required, String] :name
|
1699
|
+
# The name of the prefetch schedule. The name must be unique among all
|
1700
|
+
# prefetch schedules that are associated with the specified playback
|
1701
|
+
# configuration.
|
1493
1702
|
#
|
1494
1703
|
# @option params [required, String] :playback_configuration_name
|
1704
|
+
# Returns information about the prefetch schedule for a specific
|
1705
|
+
# playback configuration. If you call `GetPrefetchSchedule` on an
|
1706
|
+
# expired prefetch schedule, MediaTailor returns an HTTP 404 status
|
1707
|
+
# code.
|
1495
1708
|
#
|
1496
1709
|
# @return [Types::GetPrefetchScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1497
1710
|
#
|
@@ -1534,13 +1747,21 @@ module Aws::MediaTailor
|
|
1534
1747
|
req.send_request(options)
|
1535
1748
|
end
|
1536
1749
|
|
1537
|
-
#
|
1750
|
+
# Lists the alerts that are associated with a MediaTailor channel
|
1751
|
+
# assembly resource.
|
1538
1752
|
#
|
1539
1753
|
# @option params [Integer] :max_results
|
1754
|
+
# The maximum number of alerts that you want MediaTailor to return in
|
1755
|
+
# response to the current request. If there are more than `MaxResults`
|
1756
|
+
# alerts, use the value of `NextToken` in the response to get the next
|
1757
|
+
# page of results.
|
1540
1758
|
#
|
1541
1759
|
# @option params [String] :next_token
|
1760
|
+
# Pagination token returned by the list request when results exceed the
|
1761
|
+
# maximum allowed. Use the token to fetch the next page of results.
|
1542
1762
|
#
|
1543
1763
|
# @option params [required, String] :resource_arn
|
1764
|
+
# The Amazon Resource Name (ARN) of the resource.
|
1544
1765
|
#
|
1545
1766
|
# @return [Types::ListAlertsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1546
1767
|
#
|
@@ -1577,11 +1798,18 @@ module Aws::MediaTailor
|
|
1577
1798
|
req.send_request(options)
|
1578
1799
|
end
|
1579
1800
|
|
1580
|
-
# Retrieves
|
1801
|
+
# Retrieves information about the channels that are associated with the
|
1802
|
+
# current AWS account.
|
1581
1803
|
#
|
1582
1804
|
# @option params [Integer] :max_results
|
1805
|
+
# The maximum number of channels that you want MediaTailor to return in
|
1806
|
+
# response to the current request. If there are more than `MaxResults`
|
1807
|
+
# channels, use the value of `NextToken` in the response to get the next
|
1808
|
+
# page of results.
|
1583
1809
|
#
|
1584
1810
|
# @option params [String] :next_token
|
1811
|
+
# Pagination token returned by the list request when results exceed the
|
1812
|
+
# maximum allowed. Use the token to fetch the next page of results.
|
1585
1813
|
#
|
1586
1814
|
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1587
1815
|
#
|
@@ -1631,13 +1859,22 @@ module Aws::MediaTailor
|
|
1631
1859
|
req.send_request(options)
|
1632
1860
|
end
|
1633
1861
|
|
1634
|
-
#
|
1862
|
+
# Lists the live sources contained in a source location. A source
|
1863
|
+
# represents a piece of content.
|
1635
1864
|
#
|
1636
1865
|
# @option params [Integer] :max_results
|
1866
|
+
# The maximum number of live sources that you want MediaTailor to return
|
1867
|
+
# in response to the current request. If there are more than
|
1868
|
+
# `MaxResults` live sources, use the value of `NextToken` in the
|
1869
|
+
# response to get the next page of results.
|
1637
1870
|
#
|
1638
1871
|
# @option params [String] :next_token
|
1872
|
+
# Pagination token returned by the list request when results exceed the
|
1873
|
+
# maximum allowed. Use the token to fetch the next page of results.
|
1639
1874
|
#
|
1640
1875
|
# @option params [required, String] :source_location_name
|
1876
|
+
# The name of the source location associated with this Live Sources
|
1877
|
+
# list.
|
1641
1878
|
#
|
1642
1879
|
# @return [Types::ListLiveSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1643
1880
|
#
|
@@ -1679,16 +1916,23 @@ module Aws::MediaTailor
|
|
1679
1916
|
req.send_request(options)
|
1680
1917
|
end
|
1681
1918
|
|
1682
|
-
#
|
1683
|
-
# MediaTailor
|
1684
|
-
#
|
1685
|
-
#
|
1686
|
-
#
|
1687
|
-
#
|
1919
|
+
# Retrieves existing playback configurations. For information about
|
1920
|
+
# MediaTailor configurations, see [Working with Configurations in AWS
|
1921
|
+
# Elemental MediaTailor][1].
|
1922
|
+
#
|
1923
|
+
#
|
1924
|
+
#
|
1925
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
|
1688
1926
|
#
|
1689
1927
|
# @option params [Integer] :max_results
|
1928
|
+
# The maximum number of playback configurations that you want
|
1929
|
+
# MediaTailor to return in response to the current request. If there are
|
1930
|
+
# more than `MaxResults` playback configurations, use the value of
|
1931
|
+
# `NextToken` in the response to get the next page of results.
|
1690
1932
|
#
|
1691
1933
|
# @option params [String] :next_token
|
1934
|
+
# Pagination token returned by the list request when results exceed the
|
1935
|
+
# maximum allowed. Use the token to fetch the next page of results.
|
1692
1936
|
#
|
1693
1937
|
# @return [Types::ListPlaybackConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1694
1938
|
#
|
@@ -1746,29 +1990,31 @@ module Aws::MediaTailor
|
|
1746
1990
|
req.send_request(options)
|
1747
1991
|
end
|
1748
1992
|
|
1749
|
-
#
|
1993
|
+
# Lists the prefetch schedules for a playback configuration.
|
1750
1994
|
#
|
1751
1995
|
# @option params [Integer] :max_results
|
1752
1996
|
# The maximum number of prefetch schedules that you want MediaTailor to
|
1753
|
-
# return in response to the current request. If
|
1754
|
-
#
|
1755
|
-
#
|
1997
|
+
# return in response to the current request. If there are more than
|
1998
|
+
# `MaxResults` prefetch schedules, use the value of `NextToken` in the
|
1999
|
+
# response to get the next page of results.
|
1756
2000
|
#
|
1757
2001
|
# @option params [String] :next_token
|
1758
|
-
# (Optional) If the playback configuration has more than MaxResults
|
1759
|
-
# prefetch schedules, use NextToken to get the second and subsequent
|
2002
|
+
# (Optional) If the playback configuration has more than `MaxResults`
|
2003
|
+
# prefetch schedules, use `NextToken` to get the second and subsequent
|
1760
2004
|
# pages of results.
|
1761
2005
|
#
|
1762
|
-
# For the first ListPrefetchSchedulesRequest request, omit this value.
|
2006
|
+
# For the first `ListPrefetchSchedulesRequest` request, omit this value.
|
1763
2007
|
#
|
1764
|
-
# For the second and subsequent requests, get the value of NextToken
|
1765
|
-
# from the previous response and specify that value for NextToken in
|
1766
|
-
# request.
|
2008
|
+
# For the second and subsequent requests, get the value of `NextToken`
|
2009
|
+
# from the previous response and specify that value for `NextToken` in
|
2010
|
+
# the request.
|
1767
2011
|
#
|
1768
|
-
# If the previous response didn't include a NextToken element, there
|
2012
|
+
# If the previous response didn't include a `NextToken` element, there
|
1769
2013
|
# are no more prefetch schedules to get.
|
1770
2014
|
#
|
1771
2015
|
# @option params [required, String] :playback_configuration_name
|
2016
|
+
# Retrieves the prefetch schedule(s) for a specific playback
|
2017
|
+
# configuration.
|
1772
2018
|
#
|
1773
2019
|
# @option params [String] :stream_id
|
1774
2020
|
# An optional filtering parameter whereby MediaTailor filters the
|
@@ -1817,11 +2063,18 @@ module Aws::MediaTailor
|
|
1817
2063
|
req.send_request(options)
|
1818
2064
|
end
|
1819
2065
|
|
1820
|
-
#
|
2066
|
+
# Lists the source locations for a channel. A source location defines
|
2067
|
+
# the host server URL, and contains a list of sources.
|
1821
2068
|
#
|
1822
2069
|
# @option params [Integer] :max_results
|
2070
|
+
# The maximum number of source locations that you want MediaTailor to
|
2071
|
+
# return in response to the current request. If there are more than
|
2072
|
+
# `MaxResults` source locations, use the value of `NextToken` in the
|
2073
|
+
# response to get the next page of results.
|
1823
2074
|
#
|
1824
2075
|
# @option params [String] :next_token
|
2076
|
+
# Pagination token returned by the list request when results exceed the
|
2077
|
+
# maximum allowed. Use the token to fetch the next page of results.
|
1825
2078
|
#
|
1826
2079
|
# @return [Types::ListSourceLocationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1827
2080
|
#
|
@@ -1866,10 +2119,17 @@ module Aws::MediaTailor
|
|
1866
2119
|
req.send_request(options)
|
1867
2120
|
end
|
1868
2121
|
|
1869
|
-
#
|
1870
|
-
#
|
2122
|
+
# A list of tags that are associated with this resource. Tags are
|
2123
|
+
# key-value pairs that you can associate with Amazon resources to help
|
2124
|
+
# with organization, access control, and cost tracking. For more
|
2125
|
+
# information, see [Tagging AWS Elemental MediaTailor Resources][1].
|
2126
|
+
#
|
2127
|
+
#
|
2128
|
+
#
|
2129
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
1871
2130
|
#
|
1872
2131
|
# @option params [required, String] :resource_arn
|
2132
|
+
# The Amazon Resource Name (ARN) associated with this resource.
|
1873
2133
|
#
|
1874
2134
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1875
2135
|
#
|
@@ -1895,13 +2155,21 @@ module Aws::MediaTailor
|
|
1895
2155
|
req.send_request(options)
|
1896
2156
|
end
|
1897
2157
|
|
1898
|
-
# Lists
|
2158
|
+
# Lists the VOD sources contained in a source location. A source
|
2159
|
+
# represents a piece of content.
|
1899
2160
|
#
|
1900
2161
|
# @option params [Integer] :max_results
|
2162
|
+
# The maximum number of VOD sources that you want MediaTailor to return
|
2163
|
+
# in response to the current request. If there are more than
|
2164
|
+
# `MaxResults` VOD sources, use the value of `NextToken` in the response
|
2165
|
+
# to get the next page of results.
|
1901
2166
|
#
|
1902
2167
|
# @option params [String] :next_token
|
2168
|
+
# Pagination token returned by the list request when results exceed the
|
2169
|
+
# maximum allowed. Use the token to fetch the next page of results.
|
1903
2170
|
#
|
1904
2171
|
# @option params [required, String] :source_location_name
|
2172
|
+
# The name of the source location associated with this VOD Source list.
|
1905
2173
|
#
|
1906
2174
|
# @return [Types::ListVodSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1907
2175
|
#
|
@@ -1943,9 +2211,11 @@ module Aws::MediaTailor
|
|
1943
2211
|
req.send_request(options)
|
1944
2212
|
end
|
1945
2213
|
|
1946
|
-
# Creates an IAM policy for the channel.
|
2214
|
+
# Creates an IAM policy for the channel. IAM policies are used to
|
2215
|
+
# control access to your channel.
|
1947
2216
|
#
|
1948
2217
|
# @option params [required, String] :channel_name
|
2218
|
+
# The channel name associated with this Channel Policy.
|
1949
2219
|
#
|
1950
2220
|
# @option params [required, String] :policy
|
1951
2221
|
# Adds an IAM role that determines the permissions of your channel.
|
@@ -1968,7 +2238,13 @@ module Aws::MediaTailor
|
|
1968
2238
|
req.send_request(options)
|
1969
2239
|
end
|
1970
2240
|
|
1971
|
-
#
|
2241
|
+
# Creates a playback configuration. For information about MediaTailor
|
2242
|
+
# configurations, see [Working with configurations in AWS Elemental
|
2243
|
+
# MediaTailor][1].
|
2244
|
+
#
|
2245
|
+
#
|
2246
|
+
#
|
2247
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
|
1972
2248
|
#
|
1973
2249
|
# @option params [String] :ad_decision_server_url
|
1974
2250
|
# The URL for the ad decision server (ADS). This includes the
|
@@ -2019,7 +2295,7 @@ module Aws::MediaTailor
|
|
2019
2295
|
# rules enable customization of the personalized manifests created by
|
2020
2296
|
# MediaTailor.
|
2021
2297
|
#
|
2022
|
-
# @option params [String] :name
|
2298
|
+
# @option params [required, String] :name
|
2023
2299
|
# The identifier for the playback configuration.
|
2024
2300
|
#
|
2025
2301
|
# @option params [Integer] :personalization_threshold_seconds
|
@@ -2046,7 +2322,14 @@ module Aws::MediaTailor
|
|
2046
2322
|
# asset that contains both audio and video.
|
2047
2323
|
#
|
2048
2324
|
# @option params [Hash<String,String>] :tags
|
2049
|
-
# The tags to assign to the playback configuration.
|
2325
|
+
# The tags to assign to the playback configuration. Tags are key-value
|
2326
|
+
# pairs that you can associate with Amazon resources to help with
|
2327
|
+
# organization, access control, and cost tracking. For more information,
|
2328
|
+
# see [Tagging AWS Elemental MediaTailor Resources][1].
|
2329
|
+
#
|
2330
|
+
#
|
2331
|
+
#
|
2332
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
2050
2333
|
#
|
2051
2334
|
# @option params [String] :transcode_profile_name
|
2052
2335
|
# The name that is used to associate this playback configuration with a
|
@@ -2114,7 +2397,7 @@ module Aws::MediaTailor
|
|
2114
2397
|
# enabled: false,
|
2115
2398
|
# },
|
2116
2399
|
# },
|
2117
|
-
# name: "__string",
|
2400
|
+
# name: "__string", # required
|
2118
2401
|
# personalization_threshold_seconds: 1,
|
2119
2402
|
# slate_ad_url: "__string",
|
2120
2403
|
# tags: {
|
@@ -2164,9 +2447,15 @@ module Aws::MediaTailor
|
|
2164
2447
|
req.send_request(options)
|
2165
2448
|
end
|
2166
2449
|
|
2167
|
-
# Starts a
|
2450
|
+
# Starts a channel. For information about MediaTailor channels, see
|
2451
|
+
# [Working with channels][1] in the *MediaTailor User Guide*.
|
2452
|
+
#
|
2453
|
+
#
|
2454
|
+
#
|
2455
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
|
2168
2456
|
#
|
2169
2457
|
# @option params [required, String] :channel_name
|
2458
|
+
# The name of the channel.
|
2170
2459
|
#
|
2171
2460
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2172
2461
|
#
|
@@ -2185,9 +2474,15 @@ module Aws::MediaTailor
|
|
2185
2474
|
req.send_request(options)
|
2186
2475
|
end
|
2187
2476
|
|
2188
|
-
# Stops a
|
2477
|
+
# Stops a channel. For information about MediaTailor channels, see
|
2478
|
+
# [Working with channels][1] in the *MediaTailor User Guide*.
|
2479
|
+
#
|
2480
|
+
#
|
2481
|
+
#
|
2482
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
|
2189
2483
|
#
|
2190
2484
|
# @option params [required, String] :channel_name
|
2485
|
+
# The name of the channel.
|
2191
2486
|
#
|
2192
2487
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2193
2488
|
#
|
@@ -2206,12 +2501,27 @@ module Aws::MediaTailor
|
|
2206
2501
|
req.send_request(options)
|
2207
2502
|
end
|
2208
2503
|
|
2209
|
-
#
|
2210
|
-
#
|
2504
|
+
# The resource to tag. Tags are key-value pairs that you can associate
|
2505
|
+
# with Amazon resources to help with organization, access control, and
|
2506
|
+
# cost tracking. For more information, see [Tagging AWS Elemental
|
2507
|
+
# MediaTailor Resources][1].
|
2508
|
+
#
|
2509
|
+
#
|
2510
|
+
#
|
2511
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
2211
2512
|
#
|
2212
2513
|
# @option params [required, String] :resource_arn
|
2514
|
+
# The Amazon Resource Name (ARN) associated with the resource.
|
2213
2515
|
#
|
2214
2516
|
# @option params [required, Hash<String,String>] :tags
|
2517
|
+
# The tags to assign to the resource. Tags are key-value pairs that you
|
2518
|
+
# can associate with Amazon resources to help with organization, access
|
2519
|
+
# control, and cost tracking. For more information, see [Tagging AWS
|
2520
|
+
# Elemental MediaTailor Resources][1].
|
2521
|
+
#
|
2522
|
+
#
|
2523
|
+
#
|
2524
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
|
2215
2525
|
#
|
2216
2526
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2217
2527
|
#
|
@@ -2233,12 +2543,13 @@ module Aws::MediaTailor
|
|
2233
2543
|
req.send_request(options)
|
2234
2544
|
end
|
2235
2545
|
|
2236
|
-
#
|
2237
|
-
# can specify one or more tags to remove.
|
2546
|
+
# The resource to untag.
|
2238
2547
|
#
|
2239
2548
|
# @option params [required, String] :resource_arn
|
2549
|
+
# The Amazon Resource Name (ARN) of the resource to untag.
|
2240
2550
|
#
|
2241
2551
|
# @option params [required, Array<String>] :tag_keys
|
2552
|
+
# The tag keys associated with the resource.
|
2242
2553
|
#
|
2243
2554
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2244
2555
|
#
|
@@ -2258,15 +2569,21 @@ module Aws::MediaTailor
|
|
2258
2569
|
req.send_request(options)
|
2259
2570
|
end
|
2260
2571
|
|
2261
|
-
# Updates
|
2572
|
+
# Updates a channel. For information about MediaTailor channels, see
|
2573
|
+
# [Working with channels][1] in the *MediaTailor User Guide*.
|
2574
|
+
#
|
2575
|
+
#
|
2576
|
+
#
|
2577
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
|
2262
2578
|
#
|
2263
2579
|
# @option params [required, String] :channel_name
|
2580
|
+
# The name of the channel.
|
2264
2581
|
#
|
2265
2582
|
# @option params [Types::SlateSource] :filler_slate
|
2266
2583
|
# The slate used to fill gaps between programs in the schedule. You must
|
2267
|
-
# configure filler slate if your channel uses the LINEAR
|
2268
|
-
# MediaTailor doesn't support filler slate for channels
|
2269
|
-
# PlaybackMode
|
2584
|
+
# configure filler slate if your channel uses the `LINEAR`
|
2585
|
+
# `PlaybackMode`. MediaTailor doesn't support filler slate for channels
|
2586
|
+
# using the `LOOP` `PlaybackMode`.
|
2270
2587
|
#
|
2271
2588
|
# @option params [required, Array<Types::RequestOutputItem>] :outputs
|
2272
2589
|
# The channel's output properties.
|
@@ -2341,15 +2658,17 @@ module Aws::MediaTailor
|
|
2341
2658
|
req.send_request(options)
|
2342
2659
|
end
|
2343
2660
|
|
2344
|
-
# Updates a
|
2661
|
+
# Updates a live source's configuration.
|
2345
2662
|
#
|
2346
2663
|
# @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
|
2347
2664
|
# A list of HTTP package configurations for the live source on this
|
2348
2665
|
# account.
|
2349
2666
|
#
|
2350
2667
|
# @option params [required, String] :live_source_name
|
2668
|
+
# The name of the live source.
|
2351
2669
|
#
|
2352
2670
|
# @option params [required, String] :source_location_name
|
2671
|
+
# The name of the source location associated with this Live Source.
|
2353
2672
|
#
|
2354
2673
|
# @return [Types::UpdateLiveSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2355
2674
|
#
|
@@ -2398,7 +2717,13 @@ module Aws::MediaTailor
|
|
2398
2717
|
req.send_request(options)
|
2399
2718
|
end
|
2400
2719
|
|
2401
|
-
# Updates a source location
|
2720
|
+
# Updates a source location. A source location is a container for
|
2721
|
+
# sources. For more information about source locations, see [Working
|
2722
|
+
# with source locations][1] in the *MediaTailor User Guide*.
|
2723
|
+
#
|
2724
|
+
#
|
2725
|
+
#
|
2726
|
+
# [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
|
2402
2727
|
#
|
2403
2728
|
# @option params [Types::AccessConfiguration] :access_configuration
|
2404
2729
|
# Access configuration parameters. Configures the type of authentication
|
@@ -2415,6 +2740,7 @@ module Aws::MediaTailor
|
|
2415
2740
|
# resource.
|
2416
2741
|
#
|
2417
2742
|
# @option params [required, String] :source_location_name
|
2743
|
+
# The name of the source location.
|
2418
2744
|
#
|
2419
2745
|
# @return [Types::UpdateSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2420
2746
|
#
|
@@ -2481,15 +2807,17 @@ module Aws::MediaTailor
|
|
2481
2807
|
req.send_request(options)
|
2482
2808
|
end
|
2483
2809
|
|
2484
|
-
# Updates a
|
2810
|
+
# Updates a VOD source's configuration.
|
2485
2811
|
#
|
2486
2812
|
# @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
|
2487
2813
|
# A list of HTTP package configurations for the VOD source on this
|
2488
2814
|
# account.
|
2489
2815
|
#
|
2490
2816
|
# @option params [required, String] :source_location_name
|
2817
|
+
# The name of the source location associated with this VOD Source.
|
2491
2818
|
#
|
2492
2819
|
# @option params [required, String] :vod_source_name
|
2820
|
+
# The name of the VOD source.
|
2493
2821
|
#
|
2494
2822
|
# @return [Types::UpdateVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2495
2823
|
#
|
@@ -2551,7 +2879,7 @@ module Aws::MediaTailor
|
|
2551
2879
|
params: params,
|
2552
2880
|
config: config)
|
2553
2881
|
context[:gem_name] = 'aws-sdk-mediatailor'
|
2554
|
-
context[:gem_version] = '1.
|
2882
|
+
context[:gem_version] = '1.57.0'
|
2555
2883
|
Seahorse::Client::Request.new(handlers, context)
|
2556
2884
|
end
|
2557
2885
|
|