aws-sdk-mediatailor 1.55.0 → 1.56.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.
@@ -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,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
- # Creates name for a specific live source in a source location.
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 new prefetch schedule for the specified playback
568
- # configuration.
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. If not specified,
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.
@@ -747,7 +801,13 @@ module Aws::MediaTailor
747
801
  req.send_request(options)
748
802
  end
749
803
 
750
- # 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
751
811
  #
752
812
  # @option params [Types::AccessConfiguration] :access_configuration
753
813
  # Access configuration parameters. Configures the type of authentication
@@ -764,9 +824,17 @@ module Aws::MediaTailor
764
824
  # resource.
765
825
  #
766
826
  # @option params [required, String] :source_location_name
827
+ # The name associated with the source location.
767
828
  #
768
829
  # @option params [Hash<String,String>] :tags
769
- # 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
770
838
  #
771
839
  # @return [Types::CreateSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
772
840
  #
@@ -836,17 +904,26 @@ module Aws::MediaTailor
836
904
  req.send_request(options)
837
905
  end
838
906
 
839
- # Creates name for a specific VOD source in a source location.
907
+ # The VOD source configuration parameters.
840
908
  #
841
909
  # @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
842
910
  # A list of HTTP package configuration parameters for this VOD source.
843
911
  #
844
912
  # @option params [required, String] :source_location_name
913
+ # The name of the source location for this VOD source.
845
914
  #
846
915
  # @option params [Hash<String,String>] :tags
847
- # 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
848
924
  #
849
925
  # @option params [required, String] :vod_source_name
926
+ # The name associated with the VOD source.&gt;
850
927
  #
851
928
  # @return [Types::CreateVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
852
929
  #
@@ -898,9 +975,15 @@ module Aws::MediaTailor
898
975
  req.send_request(options)
899
976
  end
900
977
 
901
- # 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
902
984
  #
903
985
  # @option params [required, String] :channel_name
986
+ # The name of the channel.
904
987
  #
905
988
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
906
989
  #
@@ -919,9 +1002,10 @@ module Aws::MediaTailor
919
1002
  req.send_request(options)
920
1003
  end
921
1004
 
922
- # Deletes a channel's IAM policy.
1005
+ # The channel policy to delete.
923
1006
  #
924
1007
  # @option params [required, String] :channel_name
1008
+ # The name of the channel associated with this channel policy.
925
1009
  #
926
1010
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
927
1011
  #
@@ -940,11 +1024,13 @@ module Aws::MediaTailor
940
1024
  req.send_request(options)
941
1025
  end
942
1026
 
943
- # Deletes a specific live source in a specific source location.
1027
+ # The live source to delete.
944
1028
  #
945
1029
  # @option params [required, String] :live_source_name
1030
+ # The name of the live source.
946
1031
  #
947
1032
  # @option params [required, String] :source_location_name
1033
+ # The name of the source location associated with this Live Source.
948
1034
  #
949
1035
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
950
1036
  #
@@ -964,9 +1050,16 @@ module Aws::MediaTailor
964
1050
  req.send_request(options)
965
1051
  end
966
1052
 
967
- # Deletes the playback configuration for the specified name.
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
968
1060
  #
969
1061
  # @option params [required, String] :name
1062
+ # The name of the playback configuration.
970
1063
  #
971
1064
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
972
1065
  #
@@ -986,12 +1079,21 @@ module Aws::MediaTailor
986
1079
  end
987
1080
 
988
1081
  # 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.
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
991
1090
  #
992
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.
993
1094
  #
994
1095
  # @option params [required, String] :playback_configuration_name
1096
+ # The name of the playback configuration for this prefetch schedule.
995
1097
  #
996
1098
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
997
1099
  #
@@ -1011,11 +1113,18 @@ module Aws::MediaTailor
1011
1113
  req.send_request(options)
1012
1114
  end
1013
1115
 
1014
- # 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
1015
1122
  #
1016
1123
  # @option params [required, String] :channel_name
1124
+ # The name of the channel.
1017
1125
  #
1018
1126
  # @option params [required, String] :program_name
1127
+ # The name of the program.
1019
1128
  #
1020
1129
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1021
1130
  #
@@ -1035,9 +1144,16 @@ module Aws::MediaTailor
1035
1144
  req.send_request(options)
1036
1145
  end
1037
1146
 
1038
- # 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
1039
1154
  #
1040
1155
  # @option params [required, String] :source_location_name
1156
+ # The name of the source location.
1041
1157
  #
1042
1158
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1043
1159
  #
@@ -1056,11 +1172,13 @@ module Aws::MediaTailor
1056
1172
  req.send_request(options)
1057
1173
  end
1058
1174
 
1059
- # Deletes a specific VOD source in a specific source location.
1175
+ # The video on demand (VOD) source to delete.
1060
1176
  #
1061
1177
  # @option params [required, String] :source_location_name
1178
+ # The name of the source location associated with this VOD Source.
1062
1179
  #
1063
1180
  # @option params [required, String] :vod_source_name
1181
+ # The name of the VOD source.
1064
1182
  #
1065
1183
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1066
1184
  #
@@ -1080,9 +1198,15 @@ module Aws::MediaTailor
1080
1198
  req.send_request(options)
1081
1199
  end
1082
1200
 
1083
- # 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
1084
1207
  #
1085
1208
  # @option params [required, String] :channel_name
1209
+ # The name of the channel.
1086
1210
  #
1087
1211
  # @return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1088
1212
  #
@@ -1135,12 +1259,13 @@ module Aws::MediaTailor
1135
1259
  req.send_request(options)
1136
1260
  end
1137
1261
 
1138
- # Provides details about a specific live source in a specific source
1139
- # location.
1262
+ # The live source to describe.
1140
1263
  #
1141
1264
  # @option params [required, String] :live_source_name
1265
+ # The name of the live source.
1142
1266
  #
1143
1267
  # @option params [required, String] :source_location_name
1268
+ # The name of the source location associated with this Live Source.
1144
1269
  #
1145
1270
  # @return [Types::DescribeLiveSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1146
1271
  #
@@ -1182,11 +1307,18 @@ module Aws::MediaTailor
1182
1307
  req.send_request(options)
1183
1308
  end
1184
1309
 
1185
- # Retrieves the properties of the requested program.
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
1186
1316
  #
1187
1317
  # @option params [required, String] :channel_name
1318
+ # The name of the channel associated with this Program.
1188
1319
  #
1189
1320
  # @option params [required, String] :program_name
1321
+ # The name of the program.
1190
1322
  #
1191
1323
  # @return [Types::DescribeProgramResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1192
1324
  #
@@ -1236,9 +1368,16 @@ module Aws::MediaTailor
1236
1368
  req.send_request(options)
1237
1369
  end
1238
1370
 
1239
- # 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
1240
1378
  #
1241
1379
  # @option params [required, String] :source_location_name
1380
+ # The name of the source location.
1242
1381
  #
1243
1382
  # @return [Types::DescribeSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1244
1383
  #
@@ -1285,12 +1424,14 @@ module Aws::MediaTailor
1285
1424
  req.send_request(options)
1286
1425
  end
1287
1426
 
1288
- # Provides details about a specific VOD source in a specific source
1289
- # location.
1427
+ # Provides details about a specific video on demand (VOD) source in a
1428
+ # specific source location.
1290
1429
  #
1291
1430
  # @option params [required, String] :source_location_name
1431
+ # The name of the source location associated with this VOD Source.
1292
1432
  #
1293
1433
  # @option params [required, String] :vod_source_name
1434
+ # The name of the VOD Source.
1294
1435
  #
1295
1436
  # @return [Types::DescribeVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1296
1437
  #
@@ -1332,9 +1473,11 @@ module Aws::MediaTailor
1332
1473
  req.send_request(options)
1333
1474
  end
1334
1475
 
1335
- # 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.
1336
1478
  #
1337
1479
  # @option params [required, String] :channel_name
1480
+ # The name of the channel associated with this Channel Policy.
1338
1481
  #
1339
1482
  # @return [Types::GetChannelPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1340
1483
  #
@@ -1362,12 +1505,30 @@ module Aws::MediaTailor
1362
1505
  # Retrieves information about your channel's schedule.
1363
1506
  #
1364
1507
  # @option params [required, String] :channel_name
1508
+ # The name of the channel associated with this Channel Schedule.
1365
1509
  #
1366
1510
  # @option params [String] :duration_minutes
1511
+ # The duration in minutes of the channel schedule.
1367
1512
  #
1368
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.
1369
1518
  #
1370
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.
1371
1532
  #
1372
1533
  # @return [Types::GetChannelScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1373
1534
  #
@@ -1413,9 +1574,16 @@ module Aws::MediaTailor
1413
1574
  req.send_request(options)
1414
1575
  end
1415
1576
 
1416
- # 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
1417
1584
  #
1418
1585
  # @option params [required, String] :name
1586
+ # The identifier for the playback configuration.
1419
1587
  #
1420
1588
  # @return [Types::GetPlaybackConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1421
1589
  #
@@ -1485,13 +1653,26 @@ module Aws::MediaTailor
1485
1653
  req.send_request(options)
1486
1654
  end
1487
1655
 
1488
- # Returns information about the prefetch schedule for a specific
1489
- # playback configuration. If you call GetPrefetchSchedule on an expired
1490
- # 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
1491
1665
  #
1492
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.
1493
1670
  #
1494
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.
1495
1676
  #
1496
1677
  # @return [Types::GetPrefetchScheduleResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1497
1678
  #
@@ -1534,13 +1715,21 @@ module Aws::MediaTailor
1534
1715
  req.send_request(options)
1535
1716
  end
1536
1717
 
1537
- # Returns a list of alerts for the given resource.
1718
+ # Lists the alerts that are associated with a MediaTailor channel
1719
+ # assembly resource.
1538
1720
  #
1539
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.
1540
1726
  #
1541
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.
1542
1730
  #
1543
1731
  # @option params [required, String] :resource_arn
1732
+ # The Amazon Resource Name (ARN) of the resource.
1544
1733
  #
1545
1734
  # @return [Types::ListAlertsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1546
1735
  #
@@ -1577,11 +1766,18 @@ module Aws::MediaTailor
1577
1766
  req.send_request(options)
1578
1767
  end
1579
1768
 
1580
- # 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.
1581
1771
  #
1582
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.
1583
1777
  #
1584
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.
1585
1781
  #
1586
1782
  # @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1587
1783
  #
@@ -1631,13 +1827,22 @@ module Aws::MediaTailor
1631
1827
  req.send_request(options)
1632
1828
  end
1633
1829
 
1634
- # lists all the live sources in a source location.
1830
+ # Lists the live sources contained in a source location. A source
1831
+ # represents a piece of content.
1635
1832
  #
1636
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.
1637
1838
  #
1638
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.
1639
1842
  #
1640
1843
  # @option params [required, String] :source_location_name
1844
+ # The name of the source location associated with this Live Sources
1845
+ # list.
1641
1846
  #
1642
1847
  # @return [Types::ListLiveSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1643
1848
  #
@@ -1679,16 +1884,23 @@ module Aws::MediaTailor
1679
1884
  req.send_request(options)
1680
1885
  end
1681
1886
 
1682
- # Returns a list of the playback configurations defined in AWS Elemental
1683
- # MediaTailor. You can specify a maximum number of configurations to
1684
- # return at a time. The default maximum is 50. Results are returned in
1685
- # pagefuls. If MediaTailor has more configurations than the specified
1686
- # maximum, it provides parameters in the response that you can use to
1687
- # retrieve the next pageful.
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
1688
1894
  #
1689
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.
1690
1900
  #
1691
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.
1692
1904
  #
1693
1905
  # @return [Types::ListPlaybackConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1694
1906
  #
@@ -1746,29 +1958,31 @@ module Aws::MediaTailor
1746
1958
  req.send_request(options)
1747
1959
  end
1748
1960
 
1749
- # Creates a new prefetch schedule.
1961
+ # Lists the prefetch schedules for a playback configuration.
1750
1962
  #
1751
1963
  # @option params [Integer] :max_results
1752
1964
  # The maximum number of prefetch schedules that you want MediaTailor to
1753
- # return in response to the current request. If the playback
1754
- # configuration has more than MaxResults prefetch schedules, use the
1755
- # 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.
1756
1968
  #
1757
1969
  # @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
1970
+ # (Optional) If the playback configuration has more than `MaxResults`
1971
+ # prefetch schedules, use `NextToken` to get the second and subsequent
1760
1972
  # pages of results.
1761
1973
  #
1762
- # For the first ListPrefetchSchedulesRequest request, omit this value.
1974
+ # For the first `ListPrefetchSchedulesRequest` request, omit this value.
1763
1975
  #
1764
- # For the second and subsequent requests, get the value of NextToken
1765
- # from the previous response and specify that value for NextToken in the
1766
- # 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.
1767
1979
  #
1768
- # If the previous response didn't include a NextToken element, there
1980
+ # If the previous response didn't include a `NextToken` element, there
1769
1981
  # are no more prefetch schedules to get.
1770
1982
  #
1771
1983
  # @option params [required, String] :playback_configuration_name
1984
+ # Retrieves the prefetch schedule(s) for a specific playback
1985
+ # configuration.
1772
1986
  #
1773
1987
  # @option params [String] :stream_id
1774
1988
  # An optional filtering parameter whereby MediaTailor filters the
@@ -1817,11 +2031,18 @@ module Aws::MediaTailor
1817
2031
  req.send_request(options)
1818
2032
  end
1819
2033
 
1820
- # 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.
1821
2036
  #
1822
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.
1823
2042
  #
1824
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.
1825
2046
  #
1826
2047
  # @return [Types::ListSourceLocationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1827
2048
  #
@@ -1866,10 +2087,17 @@ module Aws::MediaTailor
1866
2087
  req.send_request(options)
1867
2088
  end
1868
2089
 
1869
- # Returns a list of the tags assigned to the specified playback
1870
- # 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
1871
2098
  #
1872
2099
  # @option params [required, String] :resource_arn
2100
+ # The Amazon Resource Name (ARN) associated with this resource.
1873
2101
  #
1874
2102
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1875
2103
  #
@@ -1895,13 +2123,21 @@ module Aws::MediaTailor
1895
2123
  req.send_request(options)
1896
2124
  end
1897
2125
 
1898
- # 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.
1899
2128
  #
1900
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.
1901
2134
  #
1902
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.
1903
2138
  #
1904
2139
  # @option params [required, String] :source_location_name
2140
+ # The name of the source location associated with this VOD Source list.
1905
2141
  #
1906
2142
  # @return [Types::ListVodSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1907
2143
  #
@@ -1943,9 +2179,11 @@ module Aws::MediaTailor
1943
2179
  req.send_request(options)
1944
2180
  end
1945
2181
 
1946
- # 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.
1947
2184
  #
1948
2185
  # @option params [required, String] :channel_name
2186
+ # The channel name associated with this Channel Policy.
1949
2187
  #
1950
2188
  # @option params [required, String] :policy
1951
2189
  # Adds an IAM role that determines the permissions of your channel.
@@ -1968,7 +2206,13 @@ module Aws::MediaTailor
1968
2206
  req.send_request(options)
1969
2207
  end
1970
2208
 
1971
- # 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
1972
2216
  #
1973
2217
  # @option params [String] :ad_decision_server_url
1974
2218
  # The URL for the ad decision server (ADS). This includes the
@@ -2019,7 +2263,7 @@ module Aws::MediaTailor
2019
2263
  # rules enable customization of the personalized manifests created by
2020
2264
  # MediaTailor.
2021
2265
  #
2022
- # @option params [String] :name
2266
+ # @option params [required, String] :name
2023
2267
  # The identifier for the playback configuration.
2024
2268
  #
2025
2269
  # @option params [Integer] :personalization_threshold_seconds
@@ -2046,7 +2290,14 @@ module Aws::MediaTailor
2046
2290
  # asset that contains both audio and video.
2047
2291
  #
2048
2292
  # @option params [Hash<String,String>] :tags
2049
- # 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
2050
2301
  #
2051
2302
  # @option params [String] :transcode_profile_name
2052
2303
  # The name that is used to associate this playback configuration with a
@@ -2114,7 +2365,7 @@ module Aws::MediaTailor
2114
2365
  # enabled: false,
2115
2366
  # },
2116
2367
  # },
2117
- # name: "__string",
2368
+ # name: "__string", # required
2118
2369
  # personalization_threshold_seconds: 1,
2119
2370
  # slate_ad_url: "__string",
2120
2371
  # tags: {
@@ -2164,9 +2415,15 @@ module Aws::MediaTailor
2164
2415
  req.send_request(options)
2165
2416
  end
2166
2417
 
2167
- # 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
2168
2424
  #
2169
2425
  # @option params [required, String] :channel_name
2426
+ # The name of the channel.
2170
2427
  #
2171
2428
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2172
2429
  #
@@ -2185,9 +2442,15 @@ module Aws::MediaTailor
2185
2442
  req.send_request(options)
2186
2443
  end
2187
2444
 
2188
- # 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
2189
2451
  #
2190
2452
  # @option params [required, String] :channel_name
2453
+ # The name of the channel.
2191
2454
  #
2192
2455
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2193
2456
  #
@@ -2206,12 +2469,27 @@ module Aws::MediaTailor
2206
2469
  req.send_request(options)
2207
2470
  end
2208
2471
 
2209
- # Adds tags to the specified playback configuration resource. You can
2210
- # 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
2211
2480
  #
2212
2481
  # @option params [required, String] :resource_arn
2482
+ # The Amazon Resource Name (ARN) associated with the resource.
2213
2483
  #
2214
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
2215
2493
  #
2216
2494
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2217
2495
  #
@@ -2233,12 +2511,13 @@ module Aws::MediaTailor
2233
2511
  req.send_request(options)
2234
2512
  end
2235
2513
 
2236
- # Removes tags from the specified playback configuration resource. You
2237
- # can specify one or more tags to remove.
2514
+ # The resource to untag.
2238
2515
  #
2239
2516
  # @option params [required, String] :resource_arn
2517
+ # The Amazon Resource Name (ARN) of the resource to untag.
2240
2518
  #
2241
2519
  # @option params [required, Array<String>] :tag_keys
2520
+ # The tag keys associated with the resource.
2242
2521
  #
2243
2522
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2244
2523
  #
@@ -2258,15 +2537,21 @@ module Aws::MediaTailor
2258
2537
  req.send_request(options)
2259
2538
  end
2260
2539
 
2261
- # 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
2262
2546
  #
2263
2547
  # @option params [required, String] :channel_name
2548
+ # The name of the channel.
2264
2549
  #
2265
2550
  # @option params [Types::SlateSource] :filler_slate
2266
2551
  # The slate used to fill gaps between programs in the schedule. You must
2267
- # configure filler slate if your channel uses the LINEAR PlaybackMode.
2268
- # MediaTailor doesn't support filler slate for channels using the LOOP
2269
- # 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`.
2270
2555
  #
2271
2556
  # @option params [required, Array<Types::RequestOutputItem>] :outputs
2272
2557
  # The channel's output properties.
@@ -2341,15 +2626,17 @@ module Aws::MediaTailor
2341
2626
  req.send_request(options)
2342
2627
  end
2343
2628
 
2344
- # Updates a specific live source in a specific source location.
2629
+ # Updates a live source's configuration.
2345
2630
  #
2346
2631
  # @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
2347
2632
  # A list of HTTP package configurations for the live source on this
2348
2633
  # account.
2349
2634
  #
2350
2635
  # @option params [required, String] :live_source_name
2636
+ # The name of the live source.
2351
2637
  #
2352
2638
  # @option params [required, String] :source_location_name
2639
+ # The name of the source location associated with this Live Source.
2353
2640
  #
2354
2641
  # @return [Types::UpdateLiveSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2355
2642
  #
@@ -2398,7 +2685,13 @@ module Aws::MediaTailor
2398
2685
  req.send_request(options)
2399
2686
  end
2400
2687
 
2401
- # Updates a source location on a specific channel.
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
2402
2695
  #
2403
2696
  # @option params [Types::AccessConfiguration] :access_configuration
2404
2697
  # Access configuration parameters. Configures the type of authentication
@@ -2415,6 +2708,7 @@ module Aws::MediaTailor
2415
2708
  # resource.
2416
2709
  #
2417
2710
  # @option params [required, String] :source_location_name
2711
+ # The name of the source location.
2418
2712
  #
2419
2713
  # @return [Types::UpdateSourceLocationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2420
2714
  #
@@ -2481,15 +2775,17 @@ module Aws::MediaTailor
2481
2775
  req.send_request(options)
2482
2776
  end
2483
2777
 
2484
- # Updates a specific VOD source in a specific source location.
2778
+ # Updates a VOD source's configuration.
2485
2779
  #
2486
2780
  # @option params [required, Array<Types::HttpPackageConfiguration>] :http_package_configurations
2487
2781
  # A list of HTTP package configurations for the VOD source on this
2488
2782
  # account.
2489
2783
  #
2490
2784
  # @option params [required, String] :source_location_name
2785
+ # The name of the source location associated with this VOD Source.
2491
2786
  #
2492
2787
  # @option params [required, String] :vod_source_name
2788
+ # The name of the VOD source.
2493
2789
  #
2494
2790
  # @return [Types::UpdateVodSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2495
2791
  #
@@ -2551,7 +2847,7 @@ module Aws::MediaTailor
2551
2847
  params: params,
2552
2848
  config: config)
2553
2849
  context[:gem_name] = 'aws-sdk-mediatailor'
2554
- context[:gem_version] = '1.55.0'
2850
+ context[:gem_version] = '1.56.0'
2555
2851
  Seahorse::Client::Request.new(handlers, context)
2556
2852
  end
2557
2853