aws-sdk-mediatailor 1.54.0 → 1.56.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -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/signature_v4.rb'
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::SignatureV4)
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
- # Configures Amazon CloudWatch log settings for a playback
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, MediaTailor sends
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 PlaybackMode.
408
- # MediaTailor doesn't support filler slate for channels using the LOOP
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,25 @@ 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
455
+ #
456
+ # @option params [String] :tier
457
+ # The tier of the channel.
426
458
  #
427
459
  # @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
428
460
  #
@@ -435,6 +467,7 @@ module Aws::MediaTailor
435
467
  # * {Types::CreateChannelResponse#outputs #outputs} => Array&lt;Types::ResponseOutputItem&gt;
436
468
  # * {Types::CreateChannelResponse#playback_mode #playback_mode} => String
437
469
  # * {Types::CreateChannelResponse#tags #tags} => Hash&lt;String,String&gt;
470
+ # * {Types::CreateChannelResponse#tier #tier} => String
438
471
  #
439
472
  # @example Request syntax with placeholder values
440
473
  #
@@ -463,6 +496,7 @@ module Aws::MediaTailor
463
496
  # tags: {
464
497
  # "__string" => "__string",
465
498
  # },
499
+ # tier: "BASIC", # accepts BASIC, STANDARD
466
500
  # })
467
501
  #
468
502
  # @example Response structure
@@ -486,6 +520,7 @@ module Aws::MediaTailor
486
520
  # resp.playback_mode #=> String
487
521
  # resp.tags #=> Hash
488
522
  # resp.tags["__string"] #=> String
523
+ # resp.tier #=> String
489
524
  #
490
525
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateChannel AWS API Documentation
491
526
  #
@@ -496,8 +531,86 @@ module Aws::MediaTailor
496
531
  req.send_request(options)
497
532
  end
498
533
 
499
- # Creates a new prefetch schedule for the specified playback
500
- # configuration.
534
+ # The live source configuration.
535
+ #
536
+ # @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
537
+ # A list of HTTP package configuration parameters for this live source.
538
+ #
539
+ # @option params [required, String] :live_source_name
540
+ # The name of the live source.
541
+ #
542
+ # @option params [required, String] :source_location_name
543
+ # The name of the source location.
544
+ #
545
+ # @option params [Hash<String,String>] :tags
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
554
+ #
555
+ # @return [Types::CreateLiveSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
556
+ #
557
+ # * {Types::CreateLiveSourceResponse#arn #arn} => String
558
+ # * {Types::CreateLiveSourceResponse#creation_time #creation_time} => Time
559
+ # * {Types::CreateLiveSourceResponse#http_package_configurations #http_package_configurations} => Array&lt;Types::HttpPackageConfiguration&gt;
560
+ # * {Types::CreateLiveSourceResponse#last_modified_time #last_modified_time} => Time
561
+ # * {Types::CreateLiveSourceResponse#live_source_name #live_source_name} => String
562
+ # * {Types::CreateLiveSourceResponse#source_location_name #source_location_name} => String
563
+ # * {Types::CreateLiveSourceResponse#tags #tags} => Hash&lt;String,String&gt;
564
+ #
565
+ # @example Request syntax with placeholder values
566
+ #
567
+ # resp = client.create_live_source({
568
+ # http_package_configurations: [ # required
569
+ # {
570
+ # path: "__string", # required
571
+ # source_group: "__string", # required
572
+ # type: "DASH", # required, accepts DASH, HLS
573
+ # },
574
+ # ],
575
+ # live_source_name: "__string", # required
576
+ # source_location_name: "__string", # required
577
+ # tags: {
578
+ # "__string" => "__string",
579
+ # },
580
+ # })
581
+ #
582
+ # @example Response structure
583
+ #
584
+ # resp.arn #=> String
585
+ # resp.creation_time #=> Time
586
+ # resp.http_package_configurations #=> Array
587
+ # resp.http_package_configurations[0].path #=> String
588
+ # resp.http_package_configurations[0].source_group #=> String
589
+ # resp.http_package_configurations[0].type #=> String, one of "DASH", "HLS"
590
+ # resp.last_modified_time #=> Time
591
+ # resp.live_source_name #=> String
592
+ # resp.source_location_name #=> String
593
+ # resp.tags #=> Hash
594
+ # resp.tags["__string"] #=> String
595
+ #
596
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateLiveSource AWS API Documentation
597
+ #
598
+ # @overload create_live_source(params = {})
599
+ # @param [Hash] params ({})
600
+ def create_live_source(params = {}, options = {})
601
+ req = build_request(:create_live_source, params)
602
+ req.send_request(options)
603
+ end
604
+
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
501
614
  #
502
615
  # @option params [required, Types::PrefetchConsumption] :consumption
503
616
  # The configuration settings for MediaTailor's *consumption* of the
@@ -507,8 +620,10 @@ module Aws::MediaTailor
507
620
  # expire no earlier than seven days after the end time.
508
621
  #
509
622
  # @option params [required, String] :name
623
+ # The name to assign to the schedule request.
510
624
  #
511
625
  # @option params [required, String] :playback_configuration_name
626
+ # The name to assign to the playback configuration.
512
627
  #
513
628
  # @option params [required, Types::PrefetchRetrieval] :retrieval
514
629
  # The configuration settings for retrieval of prefetched ads from the ad
@@ -518,10 +633,10 @@ module Aws::MediaTailor
518
633
  # @option params [String] :stream_id
519
634
  # An optional stream identifier that MediaTailor uses to prefetch ads
520
635
  # for multiple streams that use the same playback configuration. If
521
- # StreamId is specified, MediaTailor returns all of the prefetch
522
- # schedules with an exact match on StreamId. If not specified,
636
+ # `StreamId` is specified, MediaTailor returns all of the prefetch
637
+ # schedules with an exact match on `StreamId`. If not specified,
523
638
  # MediaTailor returns all of the prefetch schedules for the playback
524
- # configuration, regardless of StreamId.
639
+ # configuration, regardless of `StreamId`.
525
640
  #
526
641
  # @return [Types::CreatePrefetchScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
527
642
  #
@@ -582,14 +697,24 @@ module Aws::MediaTailor
582
697
  req.send_request(options)
583
698
  end
584
699
 
585
- # 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
586
706
  #
587
707
  # @option params [Array<Types::AdBreak>] :ad_breaks
588
708
  # The ad break configuration settings.
589
709
  #
590
710
  # @option params [required, String] :channel_name
711
+ # The name of the channel for this Program.
712
+ #
713
+ # @option params [String] :live_source_name
714
+ # The name of the LiveSource for this Program.
591
715
  #
592
716
  # @option params [required, String] :program_name
717
+ # The name of the Program.
593
718
  #
594
719
  # @option params [required, Types::ScheduleConfiguration] :schedule_configuration
595
720
  # The schedule configuration settings.
@@ -597,7 +722,7 @@ module Aws::MediaTailor
597
722
  # @option params [required, String] :source_location_name
598
723
  # The name of the source location.
599
724
  #
600
- # @option params [required, String] :vod_source_name
725
+ # @option params [String] :vod_source_name
601
726
  # The name that's used to refer to a VOD source.
602
727
  #
603
728
  # @return [Types::CreateProgramResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -606,6 +731,7 @@ module Aws::MediaTailor
606
731
  # * {Types::CreateProgramResponse#arn #arn} => String
607
732
  # * {Types::CreateProgramResponse#channel_name #channel_name} => String
608
733
  # * {Types::CreateProgramResponse#creation_time #creation_time} => Time
734
+ # * {Types::CreateProgramResponse#live_source_name #live_source_name} => String
609
735
  # * {Types::CreateProgramResponse#program_name #program_name} => String
610
736
  # * {Types::CreateProgramResponse#scheduled_start_time #scheduled_start_time} => Time
611
737
  # * {Types::CreateProgramResponse#source_location_name #source_location_name} => String
@@ -631,9 +757,11 @@ module Aws::MediaTailor
631
757
  # },
632
758
  # ],
633
759
  # channel_name: "__string", # required
760
+ # live_source_name: "__string",
634
761
  # program_name: "__string", # required
635
762
  # schedule_configuration: { # required
636
763
  # transition: { # required
764
+ # duration_millis: 1,
637
765
  # relative_position: "BEFORE_PROGRAM", # required, accepts BEFORE_PROGRAM, AFTER_PROGRAM
638
766
  # relative_program: "__string",
639
767
  # scheduled_start_time_millis: 1,
@@ -641,7 +769,7 @@ module Aws::MediaTailor
641
769
  # },
642
770
  # },
643
771
  # source_location_name: "__string", # required
644
- # vod_source_name: "__string", # required
772
+ # vod_source_name: "__string",
645
773
  # })
646
774
  #
647
775
  # @example Response structure
@@ -658,6 +786,7 @@ module Aws::MediaTailor
658
786
  # resp.arn #=> String
659
787
  # resp.channel_name #=> String
660
788
  # resp.creation_time #=> Time
789
+ # resp.live_source_name #=> String
661
790
  # resp.program_name #=> String
662
791
  # resp.scheduled_start_time #=> Time
663
792
  # resp.source_location_name #=> String
@@ -672,7 +801,13 @@ module Aws::MediaTailor
672
801
  req.send_request(options)
673
802
  end
674
803
 
675
- # Creates a source location on a specific channel.
804
+ # Creates a source location. A source location is a container for
805
+ # sources. For more information about source locations, see [Working
806
+ # with source locations][1] in the *MediaTailor User Guide*.
807
+ #
808
+ #
809
+ #
810
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
676
811
  #
677
812
  # @option params [Types::AccessConfiguration] :access_configuration
678
813
  # Access configuration parameters. Configures the type of authentication
@@ -685,12 +820,21 @@ module Aws::MediaTailor
685
820
  # The source's HTTP package configurations.
686
821
  #
687
822
  # @option params [Array<Types::SegmentDeliveryConfiguration>] :segment_delivery_configurations
688
- # An array of segment delivery configurations for this source location.
823
+ # A list of the segment delivery configurations associated with this
824
+ # resource.
689
825
  #
690
826
  # @option params [required, String] :source_location_name
827
+ # The name associated with the source location.
691
828
  #
692
829
  # @option params [Hash<String,String>] :tags
693
- # The tags to assign to the source location.
830
+ # The tags to assign to the source location. Tags are key-value pairs
831
+ # that you can associate with Amazon resources to help with
832
+ # organization, access control, and cost tracking. For more information,
833
+ # see [Tagging AWS Elemental MediaTailor Resources][1].
834
+ #
835
+ #
836
+ #
837
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
694
838
  #
695
839
  # @return [Types::CreateSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
696
840
  #
@@ -760,17 +904,26 @@ module Aws::MediaTailor
760
904
  req.send_request(options)
761
905
  end
762
906
 
763
- # Creates name for a specific VOD source in a source location.
907
+ # The VOD source configuration parameters.
764
908
  #
765
909
  # @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
766
- # An array of HTTP package configuration parameters for this VOD source.
910
+ # A list of HTTP package configuration parameters for this VOD source.
767
911
  #
768
912
  # @option params [required, String] :source_location_name
913
+ # The name of the source location for this VOD source.
769
914
  #
770
915
  # @option params [Hash<String,String>] :tags
771
- # The tags to assign to the VOD source.
916
+ # The tags to assign to the VOD source. Tags are key-value pairs that
917
+ # you can associate with Amazon resources to help with organization,
918
+ # access control, and cost tracking. For more information, see [Tagging
919
+ # AWS Elemental MediaTailor Resources][1].
920
+ #
921
+ #
922
+ #
923
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
772
924
  #
773
925
  # @option params [required, String] :vod_source_name
926
+ # The name associated with the VOD source.&gt;
774
927
  #
775
928
  # @return [Types::CreateVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
776
929
  #
@@ -822,9 +975,15 @@ module Aws::MediaTailor
822
975
  req.send_request(options)
823
976
  end
824
977
 
825
- # Deletes a channel. You must stop the channel before it can be deleted.
978
+ # Deletes a channel. For information about MediaTailor channels, see
979
+ # [Working with channels][1] in the *MediaTailor User Guide*.
980
+ #
981
+ #
982
+ #
983
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
826
984
  #
827
985
  # @option params [required, String] :channel_name
986
+ # The name of the channel.
828
987
  #
829
988
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
830
989
  #
@@ -843,9 +1002,10 @@ module Aws::MediaTailor
843
1002
  req.send_request(options)
844
1003
  end
845
1004
 
846
- # Deletes a channel's IAM policy.
1005
+ # The channel policy to delete.
847
1006
  #
848
1007
  # @option params [required, String] :channel_name
1008
+ # The name of the channel associated with this channel policy.
849
1009
  #
850
1010
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
851
1011
  #
@@ -864,9 +1024,42 @@ module Aws::MediaTailor
864
1024
  req.send_request(options)
865
1025
  end
866
1026
 
867
- # Deletes the playback configuration for the specified name.
1027
+ # The live source to delete.
1028
+ #
1029
+ # @option params [required, String] :live_source_name
1030
+ # The name of the live source.
1031
+ #
1032
+ # @option params [required, String] :source_location_name
1033
+ # The name of the source location associated with this Live Source.
1034
+ #
1035
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1036
+ #
1037
+ # @example Request syntax with placeholder values
1038
+ #
1039
+ # resp = client.delete_live_source({
1040
+ # live_source_name: "__string", # required
1041
+ # source_location_name: "__string", # required
1042
+ # })
1043
+ #
1044
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteLiveSource AWS API Documentation
1045
+ #
1046
+ # @overload delete_live_source(params = {})
1047
+ # @param [Hash] params ({})
1048
+ def delete_live_source(params = {}, options = {})
1049
+ req = build_request(:delete_live_source, params)
1050
+ req.send_request(options)
1051
+ end
1052
+
1053
+ # Deletes a playback configuration. For information about MediaTailor
1054
+ # configurations, see [Working with configurations in AWS Elemental
1055
+ # MediaTailor][1].
1056
+ #
1057
+ #
1058
+ #
1059
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
868
1060
  #
869
1061
  # @option params [required, String] :name
1062
+ # The name of the playback configuration.
870
1063
  #
871
1064
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
872
1065
  #
@@ -886,12 +1079,21 @@ module Aws::MediaTailor
886
1079
  end
887
1080
 
888
1081
  # Deletes a prefetch schedule for a specific playback configuration. If
889
- # you call DeletePrefetchSchedule on an expired prefetch schedule,
890
- # MediaTailor returns an HTTP 404 status code.
1082
+ # you call `DeletePrefetchSchedule` on an expired prefetch schedule,
1083
+ # MediaTailor returns an HTTP 404 status code. For more information
1084
+ # about ad prefetching, see [Using ad prefetching][1] in the
1085
+ # *MediaTailor User Guide*.
1086
+ #
1087
+ #
1088
+ #
1089
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
891
1090
  #
892
1091
  # @option params [required, String] :name
1092
+ # The name of the prefetch schedule. If the action is successful, the
1093
+ # service sends back an HTTP 204 response with an empty HTTP body.
893
1094
  #
894
1095
  # @option params [required, String] :playback_configuration_name
1096
+ # The name of the playback configuration for this prefetch schedule.
895
1097
  #
896
1098
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
897
1099
  #
@@ -911,11 +1113,18 @@ module Aws::MediaTailor
911
1113
  req.send_request(options)
912
1114
  end
913
1115
 
914
- # Deletes a specific program on a specific channel.
1116
+ # Deletes a program within a channel. For information about programs,
1117
+ # see [Working with programs][1] in the *MediaTailor User Guide*.
1118
+ #
1119
+ #
1120
+ #
1121
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html
915
1122
  #
916
1123
  # @option params [required, String] :channel_name
1124
+ # The name of the channel.
917
1125
  #
918
1126
  # @option params [required, String] :program_name
1127
+ # The name of the program.
919
1128
  #
920
1129
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
921
1130
  #
@@ -935,9 +1144,16 @@ module Aws::MediaTailor
935
1144
  req.send_request(options)
936
1145
  end
937
1146
 
938
- # Deletes a source location on a specific channel.
1147
+ # Deletes a source location. A source location is a container for
1148
+ # sources. For more information about source locations, see [Working
1149
+ # with source locations][1] in the *MediaTailor User Guide*.
1150
+ #
1151
+ #
1152
+ #
1153
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
939
1154
  #
940
1155
  # @option params [required, String] :source_location_name
1156
+ # The name of the source location.
941
1157
  #
942
1158
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
943
1159
  #
@@ -956,11 +1172,13 @@ module Aws::MediaTailor
956
1172
  req.send_request(options)
957
1173
  end
958
1174
 
959
- # Deletes a specific VOD source in a specific source location.
1175
+ # The video on demand (VOD) source to delete.
960
1176
  #
961
1177
  # @option params [required, String] :source_location_name
1178
+ # The name of the source location associated with this VOD Source.
962
1179
  #
963
1180
  # @option params [required, String] :vod_source_name
1181
+ # The name of the VOD source.
964
1182
  #
965
1183
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
966
1184
  #
@@ -980,9 +1198,15 @@ module Aws::MediaTailor
980
1198
  req.send_request(options)
981
1199
  end
982
1200
 
983
- # Describes the properties of a specific channel.
1201
+ # Describes a channel. For information about MediaTailor channels, see
1202
+ # [Working with channels][1] in the *MediaTailor User Guide*.
1203
+ #
1204
+ #
1205
+ #
1206
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
984
1207
  #
985
1208
  # @option params [required, String] :channel_name
1209
+ # The name of the channel.
986
1210
  #
987
1211
  # @return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
988
1212
  #
@@ -995,6 +1219,7 @@ module Aws::MediaTailor
995
1219
  # * {Types::DescribeChannelResponse#outputs #outputs} => Array&lt;Types::ResponseOutputItem&gt;
996
1220
  # * {Types::DescribeChannelResponse#playback_mode #playback_mode} => String
997
1221
  # * {Types::DescribeChannelResponse#tags #tags} => Hash&lt;String,String&gt;
1222
+ # * {Types::DescribeChannelResponse#tier #tier} => String
998
1223
  #
999
1224
  # @example Request syntax with placeholder values
1000
1225
  #
@@ -1023,6 +1248,7 @@ module Aws::MediaTailor
1023
1248
  # resp.playback_mode #=> String
1024
1249
  # resp.tags #=> Hash
1025
1250
  # resp.tags["__string"] #=> String
1251
+ # resp.tier #=> String
1026
1252
  #
1027
1253
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeChannel AWS API Documentation
1028
1254
  #
@@ -1033,11 +1259,66 @@ module Aws::MediaTailor
1033
1259
  req.send_request(options)
1034
1260
  end
1035
1261
 
1036
- # Retrieves the properties of the requested program.
1262
+ # The live source to describe.
1263
+ #
1264
+ # @option params [required, String] :live_source_name
1265
+ # The name of the live source.
1266
+ #
1267
+ # @option params [required, String] :source_location_name
1268
+ # The name of the source location associated with this Live Source.
1269
+ #
1270
+ # @return [Types::DescribeLiveSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1271
+ #
1272
+ # * {Types::DescribeLiveSourceResponse#arn #arn} => String
1273
+ # * {Types::DescribeLiveSourceResponse#creation_time #creation_time} => Time
1274
+ # * {Types::DescribeLiveSourceResponse#http_package_configurations #http_package_configurations} => Array&lt;Types::HttpPackageConfiguration&gt;
1275
+ # * {Types::DescribeLiveSourceResponse#last_modified_time #last_modified_time} => Time
1276
+ # * {Types::DescribeLiveSourceResponse#live_source_name #live_source_name} => String
1277
+ # * {Types::DescribeLiveSourceResponse#source_location_name #source_location_name} => String
1278
+ # * {Types::DescribeLiveSourceResponse#tags #tags} => Hash&lt;String,String&gt;
1279
+ #
1280
+ # @example Request syntax with placeholder values
1281
+ #
1282
+ # resp = client.describe_live_source({
1283
+ # live_source_name: "__string", # required
1284
+ # source_location_name: "__string", # required
1285
+ # })
1286
+ #
1287
+ # @example Response structure
1288
+ #
1289
+ # resp.arn #=> String
1290
+ # resp.creation_time #=> Time
1291
+ # resp.http_package_configurations #=> Array
1292
+ # resp.http_package_configurations[0].path #=> String
1293
+ # resp.http_package_configurations[0].source_group #=> String
1294
+ # resp.http_package_configurations[0].type #=> String, one of "DASH", "HLS"
1295
+ # resp.last_modified_time #=> Time
1296
+ # resp.live_source_name #=> String
1297
+ # resp.source_location_name #=> String
1298
+ # resp.tags #=> Hash
1299
+ # resp.tags["__string"] #=> String
1300
+ #
1301
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeLiveSource AWS API Documentation
1302
+ #
1303
+ # @overload describe_live_source(params = {})
1304
+ # @param [Hash] params ({})
1305
+ def describe_live_source(params = {}, options = {})
1306
+ req = build_request(:describe_live_source, params)
1307
+ req.send_request(options)
1308
+ end
1309
+
1310
+ # Describes a program within a channel. For information about programs,
1311
+ # see [Working with programs][1] in the *MediaTailor User Guide*.
1312
+ #
1313
+ #
1314
+ #
1315
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-programs.html
1037
1316
  #
1038
1317
  # @option params [required, String] :channel_name
1318
+ # The name of the channel associated with this Program.
1039
1319
  #
1040
1320
  # @option params [required, String] :program_name
1321
+ # The name of the program.
1041
1322
  #
1042
1323
  # @return [Types::DescribeProgramResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1043
1324
  #
@@ -1045,6 +1326,7 @@ module Aws::MediaTailor
1045
1326
  # * {Types::DescribeProgramResponse#arn #arn} => String
1046
1327
  # * {Types::DescribeProgramResponse#channel_name #channel_name} => String
1047
1328
  # * {Types::DescribeProgramResponse#creation_time #creation_time} => Time
1329
+ # * {Types::DescribeProgramResponse#live_source_name #live_source_name} => String
1048
1330
  # * {Types::DescribeProgramResponse#program_name #program_name} => String
1049
1331
  # * {Types::DescribeProgramResponse#scheduled_start_time #scheduled_start_time} => Time
1050
1332
  # * {Types::DescribeProgramResponse#source_location_name #source_location_name} => String
@@ -1071,6 +1353,7 @@ module Aws::MediaTailor
1071
1353
  # resp.arn #=> String
1072
1354
  # resp.channel_name #=> String
1073
1355
  # resp.creation_time #=> Time
1356
+ # resp.live_source_name #=> String
1074
1357
  # resp.program_name #=> String
1075
1358
  # resp.scheduled_start_time #=> Time
1076
1359
  # resp.source_location_name #=> String
@@ -1085,9 +1368,16 @@ module Aws::MediaTailor
1085
1368
  req.send_request(options)
1086
1369
  end
1087
1370
 
1088
- # Retrieves the properties of the requested source location.
1371
+ # Describes a source location. A source location is a container for
1372
+ # sources. For more information about source locations, see [Working
1373
+ # with source locations][1] in the *MediaTailor User Guide*.
1374
+ #
1375
+ #
1376
+ #
1377
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
1089
1378
  #
1090
1379
  # @option params [required, String] :source_location_name
1380
+ # The name of the source location.
1091
1381
  #
1092
1382
  # @return [Types::DescribeSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1093
1383
  #
@@ -1134,12 +1424,14 @@ module Aws::MediaTailor
1134
1424
  req.send_request(options)
1135
1425
  end
1136
1426
 
1137
- # Provides details about a specific VOD source in a specific source
1138
- # location.
1427
+ # Provides details about a specific video on demand (VOD) source in a
1428
+ # specific source location.
1139
1429
  #
1140
1430
  # @option params [required, String] :source_location_name
1431
+ # The name of the source location associated with this VOD Source.
1141
1432
  #
1142
1433
  # @option params [required, String] :vod_source_name
1434
+ # The name of the VOD Source.
1143
1435
  #
1144
1436
  # @return [Types::DescribeVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1145
1437
  #
@@ -1181,9 +1473,11 @@ module Aws::MediaTailor
1181
1473
  req.send_request(options)
1182
1474
  end
1183
1475
 
1184
- # Retrieves information about a channel's IAM policy.
1476
+ # Returns the channel's IAM policy. IAM policies are used to control
1477
+ # access to your channel.
1185
1478
  #
1186
1479
  # @option params [required, String] :channel_name
1480
+ # The name of the channel associated with this Channel Policy.
1187
1481
  #
1188
1482
  # @return [Types::GetChannelPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1189
1483
  #
@@ -1211,12 +1505,30 @@ module Aws::MediaTailor
1211
1505
  # Retrieves information about your channel's schedule.
1212
1506
  #
1213
1507
  # @option params [required, String] :channel_name
1508
+ # The name of the channel associated with this Channel Schedule.
1214
1509
  #
1215
1510
  # @option params [String] :duration_minutes
1511
+ # The duration in minutes of the channel schedule.
1216
1512
  #
1217
1513
  # @option params [Integer] :max_results
1514
+ # The maximum number of channel schedules that you want MediaTailor to
1515
+ # return in response to the current request. If there are more than
1516
+ # `MaxResults` channel schedules, use the value of `NextToken` in the
1517
+ # response to get the next page of results.
1218
1518
  #
1219
1519
  # @option params [String] :next_token
1520
+ # (Optional) If the playback configuration has more than `MaxResults`
1521
+ # channel schedules, use `NextToken` to get the second and subsequent
1522
+ # pages of results.
1523
+ #
1524
+ # For the first `GetChannelScheduleRequest` request, omit this value.
1525
+ #
1526
+ # For the second and subsequent requests, get the value of `NextToken`
1527
+ # from the previous response and specify that value for `NextToken` in
1528
+ # the request.
1529
+ #
1530
+ # If the previous response didn't include a `NextToken` element, there
1531
+ # are no more channel schedules to get.
1220
1532
  #
1221
1533
  # @return [Types::GetChannelScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1222
1534
  #
@@ -1241,6 +1553,7 @@ module Aws::MediaTailor
1241
1553
  # resp.items[0].approximate_start_time #=> Time
1242
1554
  # resp.items[0].arn #=> String
1243
1555
  # resp.items[0].channel_name #=> String
1556
+ # resp.items[0].live_source_name #=> String
1244
1557
  # resp.items[0].program_name #=> String
1245
1558
  # resp.items[0].schedule_ad_breaks #=> Array
1246
1559
  # resp.items[0].schedule_ad_breaks[0].approximate_duration_seconds #=> Integer
@@ -1261,9 +1574,16 @@ module Aws::MediaTailor
1261
1574
  req.send_request(options)
1262
1575
  end
1263
1576
 
1264
- # Returns the playback configuration for the specified name.
1577
+ # Retrieves a playback configuration. For information about MediaTailor
1578
+ # configurations, see [Working with configurations in AWS Elemental
1579
+ # MediaTailor][1].
1580
+ #
1581
+ #
1582
+ #
1583
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
1265
1584
  #
1266
1585
  # @option params [required, String] :name
1586
+ # The identifier for the playback configuration.
1267
1587
  #
1268
1588
  # @return [Types::GetPlaybackConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1269
1589
  #
@@ -1333,13 +1653,26 @@ module Aws::MediaTailor
1333
1653
  req.send_request(options)
1334
1654
  end
1335
1655
 
1336
- # Returns information about the prefetch schedule for a specific
1337
- # playback configuration. If you call GetPrefetchSchedule on an expired
1338
- # prefetch schedule, MediaTailor returns an HTTP 404 status code.
1656
+ # Retrieves a prefetch schedule for a playback configuration. A prefetch
1657
+ # schedule allows you to tell MediaTailor to fetch and prepare certain
1658
+ # ads before an ad break happens. For more information about ad
1659
+ # prefetching, see [Using ad prefetching][1] in the *MediaTailor User
1660
+ # Guide*.
1661
+ #
1662
+ #
1663
+ #
1664
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
1339
1665
  #
1340
1666
  # @option params [required, String] :name
1667
+ # The name of the prefetch schedule. The name must be unique among all
1668
+ # prefetch schedules that are associated with the specified playback
1669
+ # configuration.
1341
1670
  #
1342
1671
  # @option params [required, String] :playback_configuration_name
1672
+ # Returns information about the prefetch schedule for a specific
1673
+ # playback configuration. If you call `GetPrefetchSchedule` on an
1674
+ # expired prefetch schedule, MediaTailor returns an HTTP 404 status
1675
+ # code.
1343
1676
  #
1344
1677
  # @return [Types::GetPrefetchScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1345
1678
  #
@@ -1382,13 +1715,21 @@ module Aws::MediaTailor
1382
1715
  req.send_request(options)
1383
1716
  end
1384
1717
 
1385
- # Returns a list of alerts for the given resource.
1718
+ # Lists the alerts that are associated with a MediaTailor channel
1719
+ # assembly resource.
1386
1720
  #
1387
1721
  # @option params [Integer] :max_results
1722
+ # The maximum number of alerts that you want MediaTailor to return in
1723
+ # response to the current request. If there are more than `MaxResults`
1724
+ # alerts, use the value of `NextToken` in the response to get the next
1725
+ # page of results.
1388
1726
  #
1389
1727
  # @option params [String] :next_token
1728
+ # Pagination token returned by the list request when results exceed the
1729
+ # maximum allowed. Use the token to fetch the next page of results.
1390
1730
  #
1391
1731
  # @option params [required, String] :resource_arn
1732
+ # The Amazon Resource Name (ARN) of the resource.
1392
1733
  #
1393
1734
  # @return [Types::ListAlertsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1394
1735
  #
@@ -1425,11 +1766,18 @@ module Aws::MediaTailor
1425
1766
  req.send_request(options)
1426
1767
  end
1427
1768
 
1428
- # Retrieves a list of channels that are associated with this account.
1769
+ # Retrieves information about the channels that are associated with the
1770
+ # current AWS account.
1429
1771
  #
1430
1772
  # @option params [Integer] :max_results
1773
+ # The maximum number of channels that you want MediaTailor to return in
1774
+ # response to the current request. If there are more than `MaxResults`
1775
+ # channels, use the value of `NextToken` in the response to get the next
1776
+ # page of results.
1431
1777
  #
1432
1778
  # @option params [String] :next_token
1779
+ # Pagination token returned by the list request when results exceed the
1780
+ # maximum allowed. Use the token to fetch the next page of results.
1433
1781
  #
1434
1782
  # @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1435
1783
  #
@@ -1467,6 +1815,7 @@ module Aws::MediaTailor
1467
1815
  # resp.items[0].playback_mode #=> String
1468
1816
  # resp.items[0].tags #=> Hash
1469
1817
  # resp.items[0].tags["__string"] #=> String
1818
+ # resp.items[0].tier #=> String
1470
1819
  # resp.next_token #=> String
1471
1820
  #
1472
1821
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListChannels AWS API Documentation
@@ -1478,16 +1827,80 @@ module Aws::MediaTailor
1478
1827
  req.send_request(options)
1479
1828
  end
1480
1829
 
1481
- # Returns a list of the playback configurations defined in AWS Elemental
1482
- # MediaTailor. You can specify a maximum number of configurations to
1483
- # return at a time. The default maximum is 50. Results are returned in
1484
- # pagefuls. If MediaTailor has more configurations than the specified
1485
- # maximum, it provides parameters in the response that you can use to
1486
- # retrieve the next pageful.
1830
+ # Lists the live sources contained in a source location. A source
1831
+ # represents a piece of content.
1832
+ #
1833
+ # @option params [Integer] :max_results
1834
+ # The maximum number of live sources that you want MediaTailor to return
1835
+ # in response to the current request. If there are more than
1836
+ # `MaxResults` live sources, use the value of `NextToken` in the
1837
+ # response to get the next page of results.
1838
+ #
1839
+ # @option params [String] :next_token
1840
+ # Pagination token returned by the list request when results exceed the
1841
+ # maximum allowed. Use the token to fetch the next page of results.
1842
+ #
1843
+ # @option params [required, String] :source_location_name
1844
+ # The name of the source location associated with this Live Sources
1845
+ # list.
1846
+ #
1847
+ # @return [Types::ListLiveSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1848
+ #
1849
+ # * {Types::ListLiveSourcesResponse#items #items} => Array&lt;Types::LiveSource&gt;
1850
+ # * {Types::ListLiveSourcesResponse#next_token #next_token} => String
1851
+ #
1852
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1853
+ #
1854
+ # @example Request syntax with placeholder values
1855
+ #
1856
+ # resp = client.list_live_sources({
1857
+ # max_results: 1,
1858
+ # next_token: "__string",
1859
+ # source_location_name: "__string", # required
1860
+ # })
1861
+ #
1862
+ # @example Response structure
1863
+ #
1864
+ # resp.items #=> Array
1865
+ # resp.items[0].arn #=> String
1866
+ # resp.items[0].creation_time #=> Time
1867
+ # resp.items[0].http_package_configurations #=> Array
1868
+ # resp.items[0].http_package_configurations[0].path #=> String
1869
+ # resp.items[0].http_package_configurations[0].source_group #=> String
1870
+ # resp.items[0].http_package_configurations[0].type #=> String, one of "DASH", "HLS"
1871
+ # resp.items[0].last_modified_time #=> Time
1872
+ # resp.items[0].live_source_name #=> String
1873
+ # resp.items[0].source_location_name #=> String
1874
+ # resp.items[0].tags #=> Hash
1875
+ # resp.items[0].tags["__string"] #=> String
1876
+ # resp.next_token #=> String
1877
+ #
1878
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListLiveSources AWS API Documentation
1879
+ #
1880
+ # @overload list_live_sources(params = {})
1881
+ # @param [Hash] params ({})
1882
+ def list_live_sources(params = {}, options = {})
1883
+ req = build_request(:list_live_sources, params)
1884
+ req.send_request(options)
1885
+ end
1886
+
1887
+ # Retrieves existing playback configurations. For information about
1888
+ # MediaTailor configurations, see [Working with Configurations in AWS
1889
+ # Elemental MediaTailor][1].
1890
+ #
1891
+ #
1892
+ #
1893
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
1487
1894
  #
1488
1895
  # @option params [Integer] :max_results
1896
+ # The maximum number of playback configurations that you want
1897
+ # MediaTailor to return in response to the current request. If there are
1898
+ # more than `MaxResults` playback configurations, use the value of
1899
+ # `NextToken` in the response to get the next page of results.
1489
1900
  #
1490
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.
1491
1904
  #
1492
1905
  # @return [Types::ListPlaybackConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1493
1906
  #
@@ -1545,29 +1958,31 @@ module Aws::MediaTailor
1545
1958
  req.send_request(options)
1546
1959
  end
1547
1960
 
1548
- # Creates a new prefetch schedule.
1961
+ # Lists the prefetch schedules for a playback configuration.
1549
1962
  #
1550
1963
  # @option params [Integer] :max_results
1551
1964
  # The maximum number of prefetch schedules that you want MediaTailor to
1552
- # return in response to the current request. If the playback
1553
- # configuration has more than MaxResults prefetch schedules, use the
1554
- # value of NextToken in the response to get the next page of results.
1965
+ # return in response to the current request. If there are more than
1966
+ # `MaxResults` prefetch schedules, use the value of `NextToken` in the
1967
+ # response to get the next page of results.
1555
1968
  #
1556
1969
  # @option params [String] :next_token
1557
- # (Optional) If the playback configuration has more than MaxResults
1558
- # prefetch schedules, use NextToken to get the second and subsequent
1970
+ # (Optional) If the playback configuration has more than `MaxResults`
1971
+ # prefetch schedules, use `NextToken` to get the second and subsequent
1559
1972
  # pages of results.
1560
1973
  #
1561
- # For the first ListPrefetchSchedulesRequest request, omit this value.
1974
+ # For the first `ListPrefetchSchedulesRequest` request, omit this value.
1562
1975
  #
1563
- # For the second and subsequent requests, get the value of NextToken
1564
- # from the previous response and specify that value for NextToken in the
1565
- # request.
1976
+ # For the second and subsequent requests, get the value of `NextToken`
1977
+ # from the previous response and specify that value for `NextToken` in
1978
+ # the request.
1566
1979
  #
1567
- # If the previous response didn't include a NextToken element, there
1980
+ # If the previous response didn't include a `NextToken` element, there
1568
1981
  # are no more prefetch schedules to get.
1569
1982
  #
1570
1983
  # @option params [required, String] :playback_configuration_name
1984
+ # Retrieves the prefetch schedule(s) for a specific playback
1985
+ # configuration.
1571
1986
  #
1572
1987
  # @option params [String] :stream_id
1573
1988
  # An optional filtering parameter whereby MediaTailor filters the
@@ -1616,11 +2031,18 @@ module Aws::MediaTailor
1616
2031
  req.send_request(options)
1617
2032
  end
1618
2033
 
1619
- # Retrieves a list of source locations.
2034
+ # Lists the source locations for a channel. A source location defines
2035
+ # the host server URL, and contains a list of sources.
1620
2036
  #
1621
2037
  # @option params [Integer] :max_results
2038
+ # The maximum number of source locations that you want MediaTailor to
2039
+ # return in response to the current request. If there are more than
2040
+ # `MaxResults` source locations, use the value of `NextToken` in the
2041
+ # response to get the next page of results.
1622
2042
  #
1623
2043
  # @option params [String] :next_token
2044
+ # Pagination token returned by the list request when results exceed the
2045
+ # maximum allowed. Use the token to fetch the next page of results.
1624
2046
  #
1625
2047
  # @return [Types::ListSourceLocationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1626
2048
  #
@@ -1665,10 +2087,17 @@ module Aws::MediaTailor
1665
2087
  req.send_request(options)
1666
2088
  end
1667
2089
 
1668
- # Returns a list of the tags assigned to the specified playback
1669
- # configuration resource.
2090
+ # A list of tags that are associated with this resource. Tags are
2091
+ # key-value pairs that you can associate with Amazon resources to help
2092
+ # with organization, access control, and cost tracking. For more
2093
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
2094
+ #
2095
+ #
2096
+ #
2097
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1670
2098
  #
1671
2099
  # @option params [required, String] :resource_arn
2100
+ # The Amazon Resource Name (ARN) associated with this resource.
1672
2101
  #
1673
2102
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1674
2103
  #
@@ -1694,13 +2123,21 @@ module Aws::MediaTailor
1694
2123
  req.send_request(options)
1695
2124
  end
1696
2125
 
1697
- # Lists all the VOD sources in a source location.
2126
+ # Lists the VOD sources contained in a source location. A source
2127
+ # represents a piece of content.
1698
2128
  #
1699
2129
  # @option params [Integer] :max_results
2130
+ # The maximum number of VOD sources that you want MediaTailor to return
2131
+ # in response to the current request. If there are more than
2132
+ # `MaxResults` VOD sources, use the value of `NextToken` in the response
2133
+ # to get the next page of results.
1700
2134
  #
1701
2135
  # @option params [String] :next_token
2136
+ # Pagination token returned by the list request when results exceed the
2137
+ # maximum allowed. Use the token to fetch the next page of results.
1702
2138
  #
1703
2139
  # @option params [required, String] :source_location_name
2140
+ # The name of the source location associated with this VOD Source list.
1704
2141
  #
1705
2142
  # @return [Types::ListVodSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1706
2143
  #
@@ -1742,9 +2179,11 @@ module Aws::MediaTailor
1742
2179
  req.send_request(options)
1743
2180
  end
1744
2181
 
1745
- # Creates an IAM policy for the channel.
2182
+ # Creates an IAM policy for the channel. IAM policies are used to
2183
+ # control access to your channel.
1746
2184
  #
1747
2185
  # @option params [required, String] :channel_name
2186
+ # The channel name associated with this Channel Policy.
1748
2187
  #
1749
2188
  # @option params [required, String] :policy
1750
2189
  # Adds an IAM role that determines the permissions of your channel.
@@ -1767,7 +2206,13 @@ module Aws::MediaTailor
1767
2206
  req.send_request(options)
1768
2207
  end
1769
2208
 
1770
- # Adds a new playback configuration to AWS Elemental MediaTailor.
2209
+ # Creates a playback configuration. For information about MediaTailor
2210
+ # configurations, see [Working with configurations in AWS Elemental
2211
+ # MediaTailor][1].
2212
+ #
2213
+ #
2214
+ #
2215
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
1771
2216
  #
1772
2217
  # @option params [String] :ad_decision_server_url
1773
2218
  # The URL for the ad decision server (ADS). This includes the
@@ -1818,7 +2263,7 @@ module Aws::MediaTailor
1818
2263
  # rules enable customization of the personalized manifests created by
1819
2264
  # MediaTailor.
1820
2265
  #
1821
- # @option params [String] :name
2266
+ # @option params [required, String] :name
1822
2267
  # The identifier for the playback configuration.
1823
2268
  #
1824
2269
  # @option params [Integer] :personalization_threshold_seconds
@@ -1845,7 +2290,14 @@ module Aws::MediaTailor
1845
2290
  # asset that contains both audio and video.
1846
2291
  #
1847
2292
  # @option params [Hash<String,String>] :tags
1848
- # The tags to assign to the playback configuration.
2293
+ # The tags to assign to the playback configuration. Tags are key-value
2294
+ # pairs that you can associate with Amazon resources to help with
2295
+ # organization, access control, and cost tracking. For more information,
2296
+ # see [Tagging AWS Elemental MediaTailor Resources][1].
2297
+ #
2298
+ #
2299
+ #
2300
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1849
2301
  #
1850
2302
  # @option params [String] :transcode_profile_name
1851
2303
  # The name that is used to associate this playback configuration with a
@@ -1913,7 +2365,7 @@ module Aws::MediaTailor
1913
2365
  # enabled: false,
1914
2366
  # },
1915
2367
  # },
1916
- # name: "__string",
2368
+ # name: "__string", # required
1917
2369
  # personalization_threshold_seconds: 1,
1918
2370
  # slate_ad_url: "__string",
1919
2371
  # tags: {
@@ -1963,9 +2415,15 @@ module Aws::MediaTailor
1963
2415
  req.send_request(options)
1964
2416
  end
1965
2417
 
1966
- # Starts a specific channel.
2418
+ # Starts a channel. For information about MediaTailor channels, see
2419
+ # [Working with channels][1] in the *MediaTailor User Guide*.
2420
+ #
2421
+ #
2422
+ #
2423
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
1967
2424
  #
1968
2425
  # @option params [required, String] :channel_name
2426
+ # The name of the channel.
1969
2427
  #
1970
2428
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1971
2429
  #
@@ -1984,9 +2442,15 @@ module Aws::MediaTailor
1984
2442
  req.send_request(options)
1985
2443
  end
1986
2444
 
1987
- # Stops a specific channel.
2445
+ # Stops a channel. For information about MediaTailor channels, see
2446
+ # [Working with channels][1] in the *MediaTailor User Guide*.
2447
+ #
2448
+ #
2449
+ #
2450
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
1988
2451
  #
1989
2452
  # @option params [required, String] :channel_name
2453
+ # The name of the channel.
1990
2454
  #
1991
2455
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1992
2456
  #
@@ -2005,12 +2469,27 @@ module Aws::MediaTailor
2005
2469
  req.send_request(options)
2006
2470
  end
2007
2471
 
2008
- # Adds tags to the specified playback configuration resource. You can
2009
- # specify one or more tags to add.
2472
+ # The resource to tag. Tags are key-value pairs that you can associate
2473
+ # with Amazon resources to help with organization, access control, and
2474
+ # cost tracking. For more information, see [Tagging AWS Elemental
2475
+ # MediaTailor Resources][1].
2476
+ #
2477
+ #
2478
+ #
2479
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
2010
2480
  #
2011
2481
  # @option params [required, String] :resource_arn
2482
+ # The Amazon Resource Name (ARN) associated with the resource.
2012
2483
  #
2013
2484
  # @option params [required, Hash<String,String>] :tags
2485
+ # The tags to assign to the resource. Tags are key-value pairs that you
2486
+ # can associate with Amazon resources to help with organization, access
2487
+ # control, and cost tracking. For more information, see [Tagging AWS
2488
+ # Elemental MediaTailor Resources][1].
2489
+ #
2490
+ #
2491
+ #
2492
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
2014
2493
  #
2015
2494
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2016
2495
  #
@@ -2032,12 +2511,13 @@ module Aws::MediaTailor
2032
2511
  req.send_request(options)
2033
2512
  end
2034
2513
 
2035
- # Removes tags from the specified playback configuration resource. You
2036
- # can specify one or more tags to remove.
2514
+ # The resource to untag.
2037
2515
  #
2038
2516
  # @option params [required, String] :resource_arn
2517
+ # The Amazon Resource Name (ARN) of the resource to untag.
2039
2518
  #
2040
2519
  # @option params [required, Array<String>] :tag_keys
2520
+ # The tag keys associated with the resource.
2041
2521
  #
2042
2522
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2043
2523
  #
@@ -2057,15 +2537,21 @@ module Aws::MediaTailor
2057
2537
  req.send_request(options)
2058
2538
  end
2059
2539
 
2060
- # Updates an existing channel.
2540
+ # Updates a channel. For information about MediaTailor channels, see
2541
+ # [Working with channels][1] in the *MediaTailor User Guide*.
2542
+ #
2543
+ #
2544
+ #
2545
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
2061
2546
  #
2062
2547
  # @option params [required, String] :channel_name
2548
+ # The name of the channel.
2063
2549
  #
2064
2550
  # @option params [Types::SlateSource] :filler_slate
2065
2551
  # The slate used to fill gaps between programs in the schedule. You must
2066
- # configure filler slate if your channel uses the LINEAR PlaybackMode.
2067
- # MediaTailor doesn't support filler slate for channels using the LOOP
2068
- # PlaybackMode.
2552
+ # configure filler slate if your channel uses the `LINEAR`
2553
+ # `PlaybackMode`. MediaTailor doesn't support filler slate for channels
2554
+ # using the `LOOP` `PlaybackMode`.
2069
2555
  #
2070
2556
  # @option params [required, Array<Types::RequestOutputItem>] :outputs
2071
2557
  # The channel's output properties.
@@ -2081,6 +2567,7 @@ module Aws::MediaTailor
2081
2567
  # * {Types::UpdateChannelResponse#outputs #outputs} => Array&lt;Types::ResponseOutputItem&gt;
2082
2568
  # * {Types::UpdateChannelResponse#playback_mode #playback_mode} => String
2083
2569
  # * {Types::UpdateChannelResponse#tags #tags} => Hash&lt;String,String&gt;
2570
+ # * {Types::UpdateChannelResponse#tier #tier} => String
2084
2571
  #
2085
2572
  # @example Request syntax with placeholder values
2086
2573
  #
@@ -2128,6 +2615,7 @@ module Aws::MediaTailor
2128
2615
  # resp.playback_mode #=> String
2129
2616
  # resp.tags #=> Hash
2130
2617
  # resp.tags["__string"] #=> String
2618
+ # resp.tier #=> String
2131
2619
  #
2132
2620
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateChannel AWS API Documentation
2133
2621
  #
@@ -2138,7 +2626,72 @@ module Aws::MediaTailor
2138
2626
  req.send_request(options)
2139
2627
  end
2140
2628
 
2141
- # Updates a source location on a specific channel.
2629
+ # Updates a live source's configuration.
2630
+ #
2631
+ # @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
2632
+ # A list of HTTP package configurations for the live source on this
2633
+ # account.
2634
+ #
2635
+ # @option params [required, String] :live_source_name
2636
+ # The name of the live source.
2637
+ #
2638
+ # @option params [required, String] :source_location_name
2639
+ # The name of the source location associated with this Live Source.
2640
+ #
2641
+ # @return [Types::UpdateLiveSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2642
+ #
2643
+ # * {Types::UpdateLiveSourceResponse#arn #arn} => String
2644
+ # * {Types::UpdateLiveSourceResponse#creation_time #creation_time} => Time
2645
+ # * {Types::UpdateLiveSourceResponse#http_package_configurations #http_package_configurations} => Array&lt;Types::HttpPackageConfiguration&gt;
2646
+ # * {Types::UpdateLiveSourceResponse#last_modified_time #last_modified_time} => Time
2647
+ # * {Types::UpdateLiveSourceResponse#live_source_name #live_source_name} => String
2648
+ # * {Types::UpdateLiveSourceResponse#source_location_name #source_location_name} => String
2649
+ # * {Types::UpdateLiveSourceResponse#tags #tags} => Hash&lt;String,String&gt;
2650
+ #
2651
+ # @example Request syntax with placeholder values
2652
+ #
2653
+ # resp = client.update_live_source({
2654
+ # http_package_configurations: [ # required
2655
+ # {
2656
+ # path: "__string", # required
2657
+ # source_group: "__string", # required
2658
+ # type: "DASH", # required, accepts DASH, HLS
2659
+ # },
2660
+ # ],
2661
+ # live_source_name: "__string", # required
2662
+ # source_location_name: "__string", # required
2663
+ # })
2664
+ #
2665
+ # @example Response structure
2666
+ #
2667
+ # resp.arn #=> String
2668
+ # resp.creation_time #=> Time
2669
+ # resp.http_package_configurations #=> Array
2670
+ # resp.http_package_configurations[0].path #=> String
2671
+ # resp.http_package_configurations[0].source_group #=> String
2672
+ # resp.http_package_configurations[0].type #=> String, one of "DASH", "HLS"
2673
+ # resp.last_modified_time #=> Time
2674
+ # resp.live_source_name #=> String
2675
+ # resp.source_location_name #=> String
2676
+ # resp.tags #=> Hash
2677
+ # resp.tags["__string"] #=> String
2678
+ #
2679
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateLiveSource AWS API Documentation
2680
+ #
2681
+ # @overload update_live_source(params = {})
2682
+ # @param [Hash] params ({})
2683
+ def update_live_source(params = {}, options = {})
2684
+ req = build_request(:update_live_source, params)
2685
+ req.send_request(options)
2686
+ end
2687
+
2688
+ # Updates a source location. A source location is a container for
2689
+ # sources. For more information about source locations, see [Working
2690
+ # with source locations][1] in the *MediaTailor User Guide*.
2691
+ #
2692
+ #
2693
+ #
2694
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
2142
2695
  #
2143
2696
  # @option params [Types::AccessConfiguration] :access_configuration
2144
2697
  # Access configuration parameters. Configures the type of authentication
@@ -2151,9 +2704,11 @@ module Aws::MediaTailor
2151
2704
  # The HTTP configuration for the source location.
2152
2705
  #
2153
2706
  # @option params [Array<Types::SegmentDeliveryConfiguration>] :segment_delivery_configurations
2154
- # An array of segment delivery configurations for this source location.
2707
+ # A list of the segment delivery configurations associated with this
2708
+ # resource.
2155
2709
  #
2156
2710
  # @option params [required, String] :source_location_name
2711
+ # The name of the source location.
2157
2712
  #
2158
2713
  # @return [Types::UpdateSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2159
2714
  #
@@ -2220,15 +2775,17 @@ module Aws::MediaTailor
2220
2775
  req.send_request(options)
2221
2776
  end
2222
2777
 
2223
- # Updates a specific VOD source in a specific source location.
2778
+ # Updates a VOD source's configuration.
2224
2779
  #
2225
2780
  # @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
2226
- # An array of HTTP package configurations for the VOD source on this
2781
+ # A list of HTTP package configurations for the VOD source on this
2227
2782
  # account.
2228
2783
  #
2229
2784
  # @option params [required, String] :source_location_name
2785
+ # The name of the source location associated with this VOD Source.
2230
2786
  #
2231
2787
  # @option params [required, String] :vod_source_name
2788
+ # The name of the VOD source.
2232
2789
  #
2233
2790
  # @return [Types::UpdateVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2234
2791
  #
@@ -2290,7 +2847,7 @@ module Aws::MediaTailor
2290
2847
  params: params,
2291
2848
  config: config)
2292
2849
  context[:gem_name] = 'aws-sdk-mediatailor'
2293
- context[:gem_version] = '1.54.0'
2850
+ context[:gem_version] = '1.56.0'
2294
2851
  Seahorse::Client::Request.new(handlers, context)
2295
2852
  end
2296
2853