aws-sdk-mediatailor 1.55.0 → 1.56.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -26,10 +26,10 @@ module Aws::MediaTailor
26
26
  #
27
27
  # @!attribute [rw] access_type
28
28
  # The type of authentication used to access content from
29
- # HttpConfiguration::BaseUrl on your source location. Accepted value:
30
- # S3\_SIGV4.
29
+ # `HttpConfiguration::BaseUrl` on your source location. Accepted
30
+ # value: `S3_SIGV4`.
31
31
  #
32
- # S3\_SIGV4 - AWS Signature Version 4 authentication for Amazon S3
32
+ # `S3_SIGV4` - AWS Signature Version 4 authentication for Amazon S3
33
33
  # hosted virtual-style access. If your source location base URL is an
34
34
  # Amazon S3 bucket, MediaTailor can use AWS Signature Version 4
35
35
  # (SigV4) authentication to access the bucket where your source
@@ -37,7 +37,7 @@ module Aws::MediaTailor
37
37
  # follow the S3 virtual hosted-style request URL format. For example,
38
38
  # https://bucket-name.s3.Region.amazonaws.com/key-name.
39
39
  #
40
- # Before you can use S3\_SIGV4, you must meet these requirements:
40
+ # Before you can use `S3_SIGV4`, you must meet these requirements:
41
41
  #
42
42
  # • You must allow MediaTailor to access your S3 bucket by granting
43
43
  # mediatailor.amazonaws.com principal access in IAM. For information
@@ -87,7 +87,8 @@ module Aws::MediaTailor
87
87
  # }
88
88
  #
89
89
  # @!attribute [rw] message_type
90
- # The SCTE-35 ad insertion type. Accepted value: SPLICE\_INSERT.
90
+ # The SCTE-35 ad insertion type. Accepted value: `SPLICE_INSERT`,
91
+ # `TIME_SIGNAL`.
91
92
  # @return [String]
92
93
  #
93
94
  # @!attribute [rw] offset_millis
@@ -101,8 +102,8 @@ module Aws::MediaTailor
101
102
  # @return [Types::SlateSource]
102
103
  #
103
104
  # @!attribute [rw] splice_insert_message
104
- # This defines the SCTE-35 splice\_insert() message inserted around
105
- # the ad. For information about using splice\_insert(), see the
105
+ # This defines the SCTE-35 `splice_insert()` message inserted around
106
+ # the ad. For information about using `splice_insert()`, see the
106
107
  # SCTE-35 specficiaiton, section 9.7.3.1.
107
108
  # @return [Types::SpliceInsertMessage]
108
109
  #
@@ -117,13 +118,14 @@ module Aws::MediaTailor
117
118
  include Aws::Structure
118
119
  end
119
120
 
120
- # For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN,
121
- # EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin
122
- # manifest to the MediaTailor personalized manifest.
121
+ # For HLS, when set to `true`, MediaTailor passes through
122
+ # `EXT-X-CUE-IN`, `EXT-X-CUE-OUT`, and `EXT-X-SPLICEPOINT-SCTE35` ad
123
+ # markers from the origin manifest to the MediaTailor personalized
124
+ # manifest.
123
125
  #
124
- # No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT
125
- # has a value of 60, but no ads are filled for that ad break,
126
- # MediaTailor will not set the value to 0.
126
+ # No logic is applied to these ad markers. For example, if
127
+ # `EXT-X-CUE-OUT` has a value of `60`, but no ads are filled for that ad
128
+ # break, MediaTailor will not set the value to `0`.
127
129
  #
128
130
  # @note When making an API call, you may pass AdMarkerPassthrough
129
131
  # data as a hash:
@@ -147,7 +149,7 @@ module Aws::MediaTailor
147
149
  # Alert configuration parameters.
148
150
  #
149
151
  # @!attribute [rw] alert_code
150
- # The code for the alert. For example, NOT\_PROCESSED.
152
+ # The code for the alert. For example, `NOT_PROCESSED`.
151
153
  # @return [String]
152
154
  #
153
155
  # @!attribute [rw] alert_message
@@ -183,20 +185,20 @@ module Aws::MediaTailor
183
185
  # meets the criteria defined by the dynamic variables. This gives you
184
186
  # granular control over which ad break to place the prefetched ads into.
185
187
  #
186
- # As an example, let's say that you set DynamicVariable to
187
- # scte.event\_id and Operator to EQUALS, and your playback configuration
188
- # has an ADS URL of
189
- # https://my.ads.server.com/path?&podId=\[scte.avail\_num\]&event=\[scte.event\_id\]&duration=\[session.avail\_duration\_secs\].
188
+ # As an example, let's say that you set `DynamicVariable` to
189
+ # `scte.event_id` and `Operator` to `EQUALS`, and your playback
190
+ # configuration has an ADS URL of
191
+ # `https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]`.
190
192
  # And the prefetch request to the ADS contains these values
191
- # https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30.
193
+ # `https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30`.
192
194
  # MediaTailor will only insert the prefetched ads into the ad break if
193
- # has a SCTE marker with an event id of my-awesome-event, since it must
194
- # match the event id that MediaTailor uses to query the ADS.
195
+ # has a SCTE marker with an event id of `my-awesome-event`, since it
196
+ # must match the event id that MediaTailor uses to query the ADS.
195
197
  #
196
- # You can specify up to five AvailMatchingCriteria. If you specify
197
- # multiple AvailMatchingCriteria, MediaTailor combines them to match
198
- # using a logical AND. You can model logical OR combinations by creating
199
- # multiple prefetch schedules.
198
+ # You can specify up to five `AvailMatchingCriteria`. If you specify
199
+ # multiple `AvailMatchingCriteria`, MediaTailor combines them to match
200
+ # using a logical `AND`. You can model logical `OR` combinations by
201
+ # creating multiple prefetch schedules.
200
202
  #
201
203
  # @note When making an API call, you may pass AvailMatchingCriteria
202
204
  # data as a hash:
@@ -221,7 +223,7 @@ module Aws::MediaTailor
221
223
  # @return [String]
222
224
  #
223
225
  # @!attribute [rw] operator
224
- # For the DynamicVariable specified in AvailMatchingCriteria, the
226
+ # For the `DynamicVariable` specified in `AvailMatchingCriteria`, the
225
227
  # Operator that is used for the comparison.
226
228
  # @return [String]
227
229
  #
@@ -252,7 +254,7 @@ module Aws::MediaTailor
252
254
  # @!attribute [rw] mode
253
255
  # Sets the ad suppression mode. By default, ad suppression is off and
254
256
  # all ad breaks are filled with ads or slate. When Mode is set to
255
- # BEHIND\_LIVE\_EDGE, ad suppression is active and MediaTailor won't
257
+ # `BEHIND_LIVE_EDGE`, ad suppression is active and MediaTailor won't
256
258
  # fill ad breaks on or behind the ad suppression Value time in the
257
259
  # manifest lookback window.
258
260
  # @return [String]
@@ -281,8 +283,6 @@ module Aws::MediaTailor
281
283
  # A request contains unexpected data.
282
284
  #
283
285
  # @!attribute [rw] message
284
- # Constructs a new BadRequestException with the specified error
285
- # message.
286
286
  # @return [String]
287
287
  #
288
288
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/BadRequestException AWS API Documentation
@@ -342,8 +342,8 @@ module Aws::MediaTailor
342
342
  # By default, AWS Elemental MediaTailor uses Amazon CloudFront with
343
343
  # default cache settings as its CDN for ad segments. To set up an
344
344
  # alternate CDN, create a rule in your CDN for the origin
345
- # ads.mediatailor.<region>.amazonaws.com. Then specify the
346
- # rule's name in this AdSegmentUrlPrefix. When AWS Elemental
345
+ # ads.mediatailor.*<region>*.amazonaws.com. Then specify the
346
+ # rule's name in this `AdSegmentUrlPrefix`. When AWS Elemental
347
347
  # MediaTailor serves a manifest, it reports your CDN as the source for
348
348
  # ad segments.
349
349
  # @return [String]
@@ -353,7 +353,7 @@ module Aws::MediaTailor
353
353
  # content requests don’t always have to go to the origin server.
354
354
  # First, create a rule in your CDN for the content segment origin
355
355
  # server. Then specify the rule's name in this
356
- # ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a
356
+ # `ContentSegmentUrlPrefix`. When AWS Elemental MediaTailor serves a
357
357
  # manifest, it reports your CDN as the source for content segments.
358
358
  # @return [String]
359
359
  #
@@ -366,7 +366,13 @@ module Aws::MediaTailor
366
366
  include Aws::Structure
367
367
  end
368
368
 
369
- # The configuration parameters for a channel.
369
+ # The configuration parameters for a channel. For information about
370
+ # MediaTailor channels, see [Working with channels][1] in the
371
+ # *MediaTailor User Guide*.
372
+ #
373
+ #
374
+ #
375
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
370
376
  #
371
377
  # @!attribute [rw] arn
372
378
  # The ARN of the channel.
@@ -386,9 +392,9 @@ module Aws::MediaTailor
386
392
  #
387
393
  # @!attribute [rw] filler_slate
388
394
  # The slate used to fill gaps between programs in the schedule. You
389
- # must configure filler slate if your channel uses the LINEAR
390
- # PlaybackMode. MediaTailor doesn't support filler slate for channels
391
- # using the LOOP PlaybackMode.
395
+ # must configure filler slate if your channel uses the `LINEAR`
396
+ # `PlaybackMode`. MediaTailor doesn't support filler slate for
397
+ # channels using the `LOOP` `PlaybackMode`.
392
398
  # @return [Types::SlateSource]
393
399
  #
394
400
  # @!attribute [rw] last_modified_time
@@ -402,15 +408,22 @@ module Aws::MediaTailor
402
408
  # @!attribute [rw] playback_mode
403
409
  # The type of playback mode for this channel.
404
410
  #
405
- # LINEAR - Programs play back-to-back only once.
411
+ # `LINEAR` - Programs play back-to-back only once.
406
412
  #
407
- # LOOP - Programs play back-to-back in an endless loop. When the last
408
- # program in the schedule plays, playback loops back to the first
413
+ # `LOOP` - Programs play back-to-back in an endless loop. When the
414
+ # last program in the schedule plays, playback loops back to the first
409
415
  # program in the schedule.
410
416
  # @return [String]
411
417
  #
412
418
  # @!attribute [rw] tags
413
- # The tags to assign to the channel.
419
+ # The tags to assign to the channel. Tags are key-value pairs that you
420
+ # can associate with Amazon resources to help with organization,
421
+ # access control, and cost tracking. For more information, see
422
+ # [Tagging AWS Elemental MediaTailor Resources][1].
423
+ #
424
+ #
425
+ #
426
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
414
427
  # @return [Hash<String,String>]
415
428
  #
416
429
  # @!attribute [rw] tier
@@ -435,8 +448,8 @@ module Aws::MediaTailor
435
448
  include Aws::Structure
436
449
  end
437
450
 
438
- # Configures Amazon CloudWatch log settings for an existing MediaTailor
439
- # playback configuration.
451
+ # Configures Amazon CloudWatch log settings for a playback
452
+ # configuration.
440
453
  #
441
454
  # @note When making an API call, you may pass ConfigureLogsForPlaybackConfigurationRequest
442
455
  # data as a hash:
@@ -449,13 +462,13 @@ module Aws::MediaTailor
449
462
  # @!attribute [rw] percent_enabled
450
463
  # The percentage of session logs that MediaTailor sends to your
451
464
  # Cloudwatch Logs account. For example, if your playback configuration
452
- # has 1000 sessions and percentEnabled is set to 60, MediaTailor sends
453
- # logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides
454
- # at random which of the playback configuration sessions to send logs
455
- # for. If you want to view logs for a specific session, you can use
456
- # the [debug log mode][1].
465
+ # has 1000 sessions and percentEnabled is set to `60`, MediaTailor
466
+ # sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor
467
+ # decides at random which of the playback configuration sessions to
468
+ # send logs for. If you want to view logs for a specific session, you
469
+ # can use the [debug log mode][1].
457
470
  #
458
- # Valid values: 0 - 100
471
+ # Valid values: `0` - `100`
459
472
  #
460
473
  #
461
474
  #
@@ -475,8 +488,6 @@ module Aws::MediaTailor
475
488
  include Aws::Structure
476
489
  end
477
490
 
478
- # Amazon CloudWatch log settings for a playback configuration.
479
- #
480
491
  # @!attribute [rw] percent_enabled
481
492
  # The percentage of session logs that MediaTailor sends to your
482
493
  # Cloudwatch Logs account.
@@ -495,8 +506,6 @@ module Aws::MediaTailor
495
506
  include Aws::Structure
496
507
  end
497
508
 
498
- # The configuration for this channel.
499
- #
500
509
  # @note When making an API call, you may pass CreateChannelRequest
501
510
  # data as a hash:
502
511
  #
@@ -529,13 +538,14 @@ module Aws::MediaTailor
529
538
  # }
530
539
  #
531
540
  # @!attribute [rw] channel_name
541
+ # The name of the channel.
532
542
  # @return [String]
533
543
  #
534
544
  # @!attribute [rw] filler_slate
535
545
  # The slate used to fill gaps between programs in the schedule. You
536
- # must configure filler slate if your channel uses the LINEAR
537
- # PlaybackMode. MediaTailor doesn't support filler slate for channels
538
- # using the LOOP PlaybackMode.
546
+ # must configure filler slate if your channel uses the `LINEAR`
547
+ # `PlaybackMode`. MediaTailor doesn't support filler slate for
548
+ # channels using the `LOOP` `PlaybackMode`.
539
549
  # @return [Types::SlateSource]
540
550
  #
541
551
  # @!attribute [rw] outputs
@@ -545,16 +555,23 @@ module Aws::MediaTailor
545
555
  # @!attribute [rw] playback_mode
546
556
  # The type of playback mode to use for this channel.
547
557
  #
548
- # LINEAR - The programs in the schedule play once back-to-back in the
549
- # schedule.
558
+ # `LINEAR` - The programs in the schedule play once back-to-back in
559
+ # the schedule.
550
560
  #
551
- # LOOP - The programs in the schedule play back-to-back in an endless
552
- # loop. When the last program in the schedule stops playing, playback
553
- # loops back to the first program in the schedule.
561
+ # `LOOP` - The programs in the schedule play back-to-back in an
562
+ # endless loop. When the last program in the schedule stops playing,
563
+ # playback loops back to the first program in the schedule.
554
564
  # @return [String]
555
565
  #
556
566
  # @!attribute [rw] tags
557
- # The tags to assign to the channel.
567
+ # The tags to assign to the channel. Tags are key-value pairs that you
568
+ # can associate with Amazon resources to help with organization,
569
+ # access control, and cost tracking. For more information, see
570
+ # [Tagging AWS Elemental MediaTailor Resources][1].
571
+ #
572
+ #
573
+ #
574
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
558
575
  # @return [Hash<String,String>]
559
576
  #
560
577
  # @!attribute [rw] tier
@@ -575,34 +592,51 @@ module Aws::MediaTailor
575
592
  end
576
593
 
577
594
  # @!attribute [rw] arn
595
+ # The Amazon Resource Name (ARN) to assign to the channel.
578
596
  # @return [String]
579
597
  #
580
598
  # @!attribute [rw] channel_name
599
+ # The name to assign to the channel.
581
600
  # @return [String]
582
601
  #
583
602
  # @!attribute [rw] channel_state
603
+ # Indicates whether the channel is in a running state or not.
584
604
  # @return [String]
585
605
  #
586
606
  # @!attribute [rw] creation_time
607
+ # The timestamp of when the channel was created.
587
608
  # @return [Time]
588
609
  #
589
610
  # @!attribute [rw] filler_slate
590
- # Slate VOD source configuration.
611
+ # Contains information about the slate used to fill gaps between
612
+ # programs in the schedule.
591
613
  # @return [Types::SlateSource]
592
614
  #
593
615
  # @!attribute [rw] last_modified_time
616
+ # The timestamp of when the channel was last modified.
594
617
  # @return [Time]
595
618
  #
596
619
  # @!attribute [rw] outputs
620
+ # The output properties to assign to the channel.
597
621
  # @return [Array<Types::ResponseOutputItem>]
598
622
  #
599
623
  # @!attribute [rw] playback_mode
624
+ # The playback mode to assign to the channel.
600
625
  # @return [String]
601
626
  #
602
627
  # @!attribute [rw] tags
628
+ # The tags to assign to the channel. Tags are key-value pairs that you
629
+ # can associate with Amazon resources to help with organization,
630
+ # access control, and cost tracking. For more information, see
631
+ # [Tagging AWS Elemental MediaTailor Resources][1].
632
+ #
633
+ #
634
+ #
635
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
603
636
  # @return [Hash<String,String>]
604
637
  #
605
638
  # @!attribute [rw] tier
639
+ # The tier of the channel.
606
640
  # @return [String]
607
641
  #
608
642
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateChannelResponse AWS API Documentation
@@ -622,8 +656,6 @@ module Aws::MediaTailor
622
656
  include Aws::Structure
623
657
  end
624
658
 
625
- # The live source configuration parameters.
626
- #
627
659
  # @note When making an API call, you may pass CreateLiveSourceRequest
628
660
  # data as a hash:
629
661
  #
@@ -648,13 +680,22 @@ module Aws::MediaTailor
648
680
  # @return [Array<Types::HttpPackageConfiguration>]
649
681
  #
650
682
  # @!attribute [rw] live_source_name
683
+ # The name of the live source.
651
684
  # @return [String]
652
685
  #
653
686
  # @!attribute [rw] source_location_name
687
+ # The name of the source location.
654
688
  # @return [String]
655
689
  #
656
690
  # @!attribute [rw] tags
657
- # The tags to assign to the live source.
691
+ # The tags to assign to the live source. Tags are key-value pairs that
692
+ # you can associate with Amazon resources to help with organization,
693
+ # access control, and cost tracking. For more information, see
694
+ # [Tagging AWS Elemental MediaTailor Resources][1].
695
+ #
696
+ #
697
+ #
698
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
658
699
  # @return [Hash<String,String>]
659
700
  #
660
701
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateLiveSourceRequest AWS API Documentation
@@ -669,25 +710,39 @@ module Aws::MediaTailor
669
710
  end
670
711
 
671
712
  # @!attribute [rw] arn
713
+ # The ARN to assign to the live source.
672
714
  # @return [String]
673
715
  #
674
716
  # @!attribute [rw] creation_time
717
+ # The time the live source was created.
675
718
  # @return [Time]
676
719
  #
677
720
  # @!attribute [rw] http_package_configurations
678
- # The VOD source's HTTP package configuration settings.
721
+ # A list of HTTP package configuration parameters for this live
722
+ # source.
679
723
  # @return [Array<Types::HttpPackageConfiguration>]
680
724
  #
681
725
  # @!attribute [rw] last_modified_time
726
+ # The time the live source was last modified.
682
727
  # @return [Time]
683
728
  #
684
729
  # @!attribute [rw] live_source_name
730
+ # The name to assign to the live source.
685
731
  # @return [String]
686
732
  #
687
733
  # @!attribute [rw] source_location_name
734
+ # The name to assign to the source location of the live source.
688
735
  # @return [String]
689
736
  #
690
737
  # @!attribute [rw] tags
738
+ # The tags to assign to the live source. Tags are key-value pairs that
739
+ # you can associate with Amazon resources to help with organization,
740
+ # access control, and cost tracking. For more information, see
741
+ # [Tagging AWS Elemental MediaTailor Resources][1].
742
+ #
743
+ #
744
+ #
745
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
691
746
  # @return [Hash<String,String>]
692
747
  #
693
748
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateLiveSourceResponse AWS API Documentation
@@ -704,9 +759,6 @@ module Aws::MediaTailor
704
759
  include Aws::Structure
705
760
  end
706
761
 
707
- # A complex type that contains configuration settings for retrieval,
708
- # consumption, and an optional stream ID.
709
- #
710
762
  # @note When making an API call, you may pass CreatePrefetchScheduleRequest
711
763
  # data as a hash:
712
764
  #
@@ -742,9 +794,11 @@ module Aws::MediaTailor
742
794
  # @return [Types::PrefetchConsumption]
743
795
  #
744
796
  # @!attribute [rw] name
797
+ # The name to assign to the schedule request.
745
798
  # @return [String]
746
799
  #
747
800
  # @!attribute [rw] playback_configuration_name
801
+ # The name to assign to the playback configuration.
748
802
  # @return [String]
749
803
  #
750
804
  # @!attribute [rw] retrieval
@@ -756,10 +810,10 @@ module Aws::MediaTailor
756
810
  # @!attribute [rw] stream_id
757
811
  # An optional stream identifier that MediaTailor uses to prefetch ads
758
812
  # for multiple streams that use the same playback configuration. If
759
- # StreamId is specified, MediaTailor returns all of the prefetch
760
- # schedules with an exact match on StreamId. If not specified,
813
+ # `StreamId` is specified, MediaTailor returns all of the prefetch
814
+ # schedules with an exact match on `StreamId`. If not specified,
761
815
  # MediaTailor returns all of the prefetch schedules for the playback
762
- # configuration, regardless of StreamId.
816
+ # configuration, regardless of `StreamId`.
763
817
  # @return [String]
764
818
  #
765
819
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreatePrefetchScheduleRequest AWS API Documentation
@@ -775,26 +829,38 @@ module Aws::MediaTailor
775
829
  end
776
830
 
777
831
  # @!attribute [rw] arn
832
+ # The ARN to assign to the prefetch schedule.
778
833
  # @return [String]
779
834
  #
780
835
  # @!attribute [rw] consumption
781
- # A complex type that contains settings that determine how and when
782
- # that MediaTailor places prefetched ads into upcoming ad breaks.
836
+ # The configuration settings for MediaTailor's *consumption* of the
837
+ # prefetched ads from the ad decision server. Each consumption
838
+ # configuration contains an end time and an optional start time that
839
+ # define the *consumption window*. Prefetch schedules automatically
840
+ # expire no earlier than seven days after the end time.
783
841
  # @return [Types::PrefetchConsumption]
784
842
  #
785
843
  # @!attribute [rw] name
844
+ # The name to assign to the prefetch schedule.
786
845
  # @return [String]
787
846
  #
788
847
  # @!attribute [rw] playback_configuration_name
848
+ # The name to assign to the playback configuration.
789
849
  # @return [String]
790
850
  #
791
851
  # @!attribute [rw] retrieval
792
- # A complex type that contains settings governing when MediaTailor
793
- # prefetches ads, and which dynamic variables that MediaTailor
794
- # includes in the request to the ad decision server.
852
+ # The configuration settings for retrieval of prefetched ads from the
853
+ # ad decision server. Only one set of prefetched ads will be retrieved
854
+ # and subsequently consumed for each ad break.
795
855
  # @return [Types::PrefetchRetrieval]
796
856
  #
797
857
  # @!attribute [rw] stream_id
858
+ # An optional stream identifier that MediaTailor uses to prefetch ads
859
+ # for multiple streams that use the same playback configuration. If
860
+ # `StreamId` is specified, MediaTailor returns all of the prefetch
861
+ # schedules with an exact match on `StreamId`. If not specified,
862
+ # MediaTailor returns all of the prefetch schedules for the playback
863
+ # configuration, regardless of `StreamId`.
798
864
  # @return [String]
799
865
  #
800
866
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreatePrefetchScheduleResponse AWS API Documentation
@@ -810,8 +876,6 @@ module Aws::MediaTailor
810
876
  include Aws::Structure
811
877
  end
812
878
 
813
- # Program configuration parameters.
814
- #
815
879
  # @note When making an API call, you may pass CreateProgramRequest
816
880
  # data as a hash:
817
881
  #
@@ -853,6 +917,7 @@ module Aws::MediaTailor
853
917
  # @return [Array<Types::AdBreak>]
854
918
  #
855
919
  # @!attribute [rw] channel_name
920
+ # The name of the channel for this Program.
856
921
  # @return [String]
857
922
  #
858
923
  # @!attribute [rw] live_source_name
@@ -860,6 +925,7 @@ module Aws::MediaTailor
860
925
  # @return [String]
861
926
  #
862
927
  # @!attribute [rw] program_name
928
+ # The name of the Program.
863
929
  # @return [String]
864
930
  #
865
931
  # @!attribute [rw] schedule_configuration
@@ -889,30 +955,39 @@ module Aws::MediaTailor
889
955
  end
890
956
 
891
957
  # @!attribute [rw] ad_breaks
958
+ # The ad break configuration settings.
892
959
  # @return [Array<Types::AdBreak>]
893
960
  #
894
961
  # @!attribute [rw] arn
962
+ # The ARN to assign to the program.
895
963
  # @return [String]
896
964
  #
897
965
  # @!attribute [rw] channel_name
966
+ # The name to assign to the channel for this program.
898
967
  # @return [String]
899
968
  #
900
969
  # @!attribute [rw] creation_time
970
+ # The time the program was created.
901
971
  # @return [Time]
902
972
  #
903
973
  # @!attribute [rw] live_source_name
974
+ # The name of the LiveSource for this Program.
904
975
  # @return [String]
905
976
  #
906
977
  # @!attribute [rw] program_name
978
+ # The name to assign to this program.
907
979
  # @return [String]
908
980
  #
909
981
  # @!attribute [rw] scheduled_start_time
982
+ # The scheduled start time for this Program.
910
983
  # @return [Time]
911
984
  #
912
985
  # @!attribute [rw] source_location_name
986
+ # The name to assign to the source location for this program.
913
987
  # @return [String]
914
988
  #
915
989
  # @!attribute [rw] vod_source_name
990
+ # The name that's used to refer to a VOD source.
916
991
  # @return [String]
917
992
  #
918
993
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateProgramResponse AWS API Documentation
@@ -931,8 +1006,6 @@ module Aws::MediaTailor
931
1006
  include Aws::Structure
932
1007
  end
933
1008
 
934
- # Source location configuration parameters.
935
- #
936
1009
  # @note When making an API call, you may pass CreateSourceLocationRequest
937
1010
  # data as a hash:
938
1011
  #
@@ -982,10 +1055,18 @@ module Aws::MediaTailor
982
1055
  # @return [Array<Types::SegmentDeliveryConfiguration>]
983
1056
  #
984
1057
  # @!attribute [rw] source_location_name
1058
+ # The name associated with the source location.
985
1059
  # @return [String]
986
1060
  #
987
1061
  # @!attribute [rw] tags
988
- # The tags to assign to the source location.
1062
+ # The tags to assign to the source location. Tags are key-value pairs
1063
+ # that you can associate with Amazon resources to help with
1064
+ # organization, access control, and cost tracking. For more
1065
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
1066
+ #
1067
+ #
1068
+ #
1069
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
989
1070
  # @return [Hash<String,String>]
990
1071
  #
991
1072
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateSourceLocationRequest AWS API Documentation
@@ -1002,39 +1083,53 @@ module Aws::MediaTailor
1002
1083
  end
1003
1084
 
1004
1085
  # @!attribute [rw] access_configuration
1005
- # Access configuration parameters.
1086
+ # Access configuration parameters. Configures the type of
1087
+ # authentication used to access content from your source location.
1006
1088
  # @return [Types::AccessConfiguration]
1007
1089
  #
1008
1090
  # @!attribute [rw] arn
1091
+ # The ARN to assign to the source location.
1009
1092
  # @return [String]
1010
1093
  #
1011
1094
  # @!attribute [rw] creation_time
1095
+ # The time the source location was created.
1012
1096
  # @return [Time]
1013
1097
  #
1014
1098
  # @!attribute [rw] default_segment_delivery_configuration
1015
- # The optional configuration for a server that serves segments. Use
1016
- # this if you want the segment delivery server to be different from
1017
- # the source location server. For example, you can configure your
1018
- # source location server to be an origination server, such as
1019
- # MediaPackage, and the segment delivery server to be a content
1020
- # delivery network (CDN), such as CloudFront. If you don't specify a
1021
- # segment delivery server, then the source location server is used.
1099
+ # The optional configuration for the server that serves segments.
1022
1100
  # @return [Types::DefaultSegmentDeliveryConfiguration]
1023
1101
  #
1024
1102
  # @!attribute [rw] http_configuration
1025
- # The HTTP configuration for the source location.
1103
+ # The source's HTTP package configurations.
1026
1104
  # @return [Types::HttpConfiguration]
1027
1105
  #
1028
1106
  # @!attribute [rw] last_modified_time
1107
+ # The time the source location was last modified.
1029
1108
  # @return [Time]
1030
1109
  #
1031
1110
  # @!attribute [rw] segment_delivery_configurations
1111
+ # The segment delivery configurations for the source location. For
1112
+ # information about MediaTailor configurations, see [Working with
1113
+ # configurations in AWS Elemental MediaTailor][1].
1114
+ #
1115
+ #
1116
+ #
1117
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
1032
1118
  # @return [Array<Types::SegmentDeliveryConfiguration>]
1033
1119
  #
1034
1120
  # @!attribute [rw] source_location_name
1121
+ # The name to assign to the source location.
1035
1122
  # @return [String]
1036
1123
  #
1037
1124
  # @!attribute [rw] tags
1125
+ # The tags to assign to the source location. Tags are key-value pairs
1126
+ # that you can associate with Amazon resources to help with
1127
+ # organization, access control, and cost tracking. For more
1128
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
1129
+ #
1130
+ #
1131
+ #
1132
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1038
1133
  # @return [Hash<String,String>]
1039
1134
  #
1040
1135
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateSourceLocationResponse AWS API Documentation
@@ -1053,8 +1148,6 @@ module Aws::MediaTailor
1053
1148
  include Aws::Structure
1054
1149
  end
1055
1150
 
1056
- # The VOD source configuration parameters.
1057
- #
1058
1151
  # @note When making an API call, you may pass CreateVodSourceRequest
1059
1152
  # data as a hash:
1060
1153
  #
@@ -1078,13 +1171,22 @@ module Aws::MediaTailor
1078
1171
  # @return [Array<Types::HttpPackageConfiguration>]
1079
1172
  #
1080
1173
  # @!attribute [rw] source_location_name
1174
+ # The name of the source location for this VOD source.
1081
1175
  # @return [String]
1082
1176
  #
1083
1177
  # @!attribute [rw] tags
1084
- # The tags to assign to the VOD source.
1178
+ # The tags to assign to the VOD source. Tags are key-value pairs that
1179
+ # you can associate with Amazon resources to help with organization,
1180
+ # access control, and cost tracking. For more information, see
1181
+ # [Tagging AWS Elemental MediaTailor Resources][1].
1182
+ #
1183
+ #
1184
+ #
1185
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1085
1186
  # @return [Hash<String,String>]
1086
1187
  #
1087
1188
  # @!attribute [rw] vod_source_name
1189
+ # The name associated with the VOD source.&gt;
1088
1190
  # @return [String]
1089
1191
  #
1090
1192
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateVodSourceRequest AWS API Documentation
@@ -1099,25 +1201,38 @@ module Aws::MediaTailor
1099
1201
  end
1100
1202
 
1101
1203
  # @!attribute [rw] arn
1204
+ # The ARN to assign to this VOD source.
1102
1205
  # @return [String]
1103
1206
  #
1104
1207
  # @!attribute [rw] creation_time
1208
+ # The time the VOD source was created.
1105
1209
  # @return [Time]
1106
1210
  #
1107
1211
  # @!attribute [rw] http_package_configurations
1108
- # The VOD source's HTTP package configuration settings.
1212
+ # A list of HTTP package configuration parameters for this VOD source.
1109
1213
  # @return [Array<Types::HttpPackageConfiguration>]
1110
1214
  #
1111
1215
  # @!attribute [rw] last_modified_time
1216
+ # The time the VOD source was last modified.
1112
1217
  # @return [Time]
1113
1218
  #
1114
1219
  # @!attribute [rw] source_location_name
1220
+ # The name to assign to the source location for this VOD source.
1115
1221
  # @return [String]
1116
1222
  #
1117
1223
  # @!attribute [rw] tags
1224
+ # The tags to assign to the VOD source. Tags are key-value pairs that
1225
+ # you can associate with Amazon resources to help with organization,
1226
+ # access control, and cost tracking. For more information, see
1227
+ # [Tagging AWS Elemental MediaTailor Resources][1].
1228
+ #
1229
+ #
1230
+ #
1231
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1118
1232
  # @return [Hash<String,String>]
1119
1233
  #
1120
1234
  # @!attribute [rw] vod_source_name
1235
+ # The name to assign to the VOD source.
1121
1236
  # @return [String]
1122
1237
  #
1123
1238
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateVodSourceResponse AWS API Documentation
@@ -1149,18 +1264,18 @@ module Aws::MediaTailor
1149
1264
  # don't support sticky redirects. Disable this if you have CDN
1150
1265
  # routing rules set up for accessing MediaTailor manifests, and you
1151
1266
  # are either using client-side reporting or your players support
1152
- # sticky HTTP redirects. Valid values are DISABLED and EMT\_DEFAULT.
1153
- # The EMT\_DEFAULT setting enables the inclusion of the tag and is the
1154
- # default value.
1267
+ # sticky HTTP redirects. Valid values are `DISABLED` and
1268
+ # `EMT_DEFAULT`. The `EMT_DEFAULT` setting enables the inclusion of
1269
+ # the tag and is the default value.
1155
1270
  # @return [String]
1156
1271
  #
1157
1272
  # @!attribute [rw] origin_manifest_type
1158
1273
  # The setting that controls whether MediaTailor handles manifests from
1159
1274
  # the origin server as multi-period manifests or single-period
1160
1275
  # manifests. If your origin server produces single-period manifests,
1161
- # set this to SINGLE\_PERIOD. The default setting is MULTI\_PERIOD.
1276
+ # set this to `SINGLE_PERIOD`. The default setting is `MULTI_PERIOD`.
1162
1277
  # For multi-period manifests, omit this setting or set it to
1163
- # MULTI\_PERIOD.
1278
+ # `MULTI_PERIOD`.
1164
1279
  # @return [String]
1165
1280
  #
1166
1281
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DashConfiguration AWS API Documentation
@@ -1190,18 +1305,18 @@ module Aws::MediaTailor
1190
1305
  # don't support sticky redirects. Disable this if you have CDN
1191
1306
  # routing rules set up for accessing MediaTailor manifests, and you
1192
1307
  # are either using client-side reporting or your players support
1193
- # sticky HTTP redirects. Valid values are DISABLED and EMT\_DEFAULT.
1194
- # The EMT\_DEFAULT setting enables the inclusion of the tag and is the
1195
- # default value.
1308
+ # sticky HTTP redirects. Valid values are `DISABLED` and
1309
+ # `EMT_DEFAULT`. The `EMT_DEFAULT` setting enables the inclusion of
1310
+ # the tag and is the default value.
1196
1311
  # @return [String]
1197
1312
  #
1198
1313
  # @!attribute [rw] origin_manifest_type
1199
1314
  # The setting that controls whether MediaTailor handles manifests from
1200
1315
  # the origin server as multi-period manifests or single-period
1201
1316
  # manifests. If your origin server produces single-period manifests,
1202
- # set this to SINGLE\_PERIOD. The default setting is MULTI\_PERIOD.
1317
+ # set this to `SINGLE_PERIOD`. The default setting is `MULTI_PERIOD`.
1203
1318
  # For multi-period manifests, omit this setting or set it to
1204
- # MULTI\_PERIOD.
1319
+ # `MULTI_PERIOD`.
1205
1320
  # @return [String]
1206
1321
  #
1207
1322
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DashConfigurationForPut AWS API Documentation
@@ -1226,26 +1341,26 @@ module Aws::MediaTailor
1226
1341
  # }
1227
1342
  #
1228
1343
  # @!attribute [rw] manifest_window_seconds
1229
- # The total duration (in seconds) of each manifest. Minimum value: 30
1230
- # seconds. Maximum value: 3600 seconds.
1344
+ # The total duration (in seconds) of each manifest. Minimum value:
1345
+ # `30` seconds. Maximum value: `3600` seconds.
1231
1346
  # @return [Integer]
1232
1347
  #
1233
1348
  # @!attribute [rw] min_buffer_time_seconds
1234
1349
  # Minimum amount of content (measured in seconds) that a player must
1235
- # keep available in the buffer. Minimum value: 2 seconds. Maximum
1236
- # value: 60 seconds.
1350
+ # keep available in the buffer. Minimum value: `2` seconds. Maximum
1351
+ # value: `60` seconds.
1237
1352
  # @return [Integer]
1238
1353
  #
1239
1354
  # @!attribute [rw] min_update_period_seconds
1240
1355
  # Minimum amount of time (in seconds) that the player should wait
1241
- # before requesting updates to the manifest. Minimum value: 2 seconds.
1242
- # Maximum value: 60 seconds.
1356
+ # before requesting updates to the manifest. Minimum value: `2`
1357
+ # seconds. Maximum value: `60` seconds.
1243
1358
  # @return [Integer]
1244
1359
  #
1245
1360
  # @!attribute [rw] suggested_presentation_delay_seconds
1246
1361
  # Amount of time (in seconds) that the player should be from the live
1247
- # point at the end of the manifest. Minimum value: 2 seconds. Maximum
1248
- # value: 60 seconds.
1362
+ # point at the end of the manifest. Minimum value: `2` seconds.
1363
+ # Maximum value: `60` seconds.
1249
1364
  # @return [Integer]
1250
1365
  #
1251
1366
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DashPlaylistSettings AWS API Documentation
@@ -1287,8 +1402,6 @@ module Aws::MediaTailor
1287
1402
  include Aws::Structure
1288
1403
  end
1289
1404
 
1290
- # This response includes only the "type" : "object" property.
1291
- #
1292
1405
  # @note When making an API call, you may pass DeleteChannelPolicyRequest
1293
1406
  # data as a hash:
1294
1407
  #
@@ -1297,6 +1410,7 @@ module Aws::MediaTailor
1297
1410
  # }
1298
1411
  #
1299
1412
  # @!attribute [rw] channel_name
1413
+ # The name of the channel associated with this channel policy.
1300
1414
  # @return [String]
1301
1415
  #
1302
1416
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelPolicyRequest AWS API Documentation
@@ -1307,8 +1421,6 @@ module Aws::MediaTailor
1307
1421
  include Aws::Structure
1308
1422
  end
1309
1423
 
1310
- # This response includes only the "type" : "object" property.
1311
- #
1312
1424
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelPolicyResponse AWS API Documentation
1313
1425
  #
1314
1426
  class DeleteChannelPolicyResponse < Aws::EmptyStructure; end
@@ -1321,6 +1433,7 @@ module Aws::MediaTailor
1321
1433
  # }
1322
1434
  #
1323
1435
  # @!attribute [rw] channel_name
1436
+ # The name of the channel.
1324
1437
  # @return [String]
1325
1438
  #
1326
1439
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelRequest AWS API Documentation
@@ -1331,8 +1444,6 @@ module Aws::MediaTailor
1331
1444
  include Aws::Structure
1332
1445
  end
1333
1446
 
1334
- # This response includes only the "type" : "object" property.
1335
- #
1336
1447
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelResponse AWS API Documentation
1337
1448
  #
1338
1449
  class DeleteChannelResponse < Aws::EmptyStructure; end
@@ -1346,9 +1457,11 @@ module Aws::MediaTailor
1346
1457
  # }
1347
1458
  #
1348
1459
  # @!attribute [rw] live_source_name
1460
+ # The name of the live source.
1349
1461
  # @return [String]
1350
1462
  #
1351
1463
  # @!attribute [rw] source_location_name
1464
+ # The name of the source location associated with this Live Source.
1352
1465
  # @return [String]
1353
1466
  #
1354
1467
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteLiveSourceRequest AWS API Documentation
@@ -1360,8 +1473,6 @@ module Aws::MediaTailor
1360
1473
  include Aws::Structure
1361
1474
  end
1362
1475
 
1363
- # This response includes only the "type" : "object" property.
1364
- #
1365
1476
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteLiveSourceResponse AWS API Documentation
1366
1477
  #
1367
1478
  class DeleteLiveSourceResponse < Aws::EmptyStructure; end
@@ -1374,6 +1485,7 @@ module Aws::MediaTailor
1374
1485
  # }
1375
1486
  #
1376
1487
  # @!attribute [rw] name
1488
+ # The name of the playback configuration.
1377
1489
  # @return [String]
1378
1490
  #
1379
1491
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePlaybackConfigurationRequest AWS API Documentation
@@ -1397,9 +1509,12 @@ module Aws::MediaTailor
1397
1509
  # }
1398
1510
  #
1399
1511
  # @!attribute [rw] name
1512
+ # The name of the prefetch schedule. If the action is successful, the
1513
+ # service sends back an HTTP 204 response with an empty HTTP body.
1400
1514
  # @return [String]
1401
1515
  #
1402
1516
  # @!attribute [rw] playback_configuration_name
1517
+ # The name of the playback configuration for this prefetch schedule.
1403
1518
  # @return [String]
1404
1519
  #
1405
1520
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePrefetchScheduleRequest AWS API Documentation
@@ -1411,9 +1526,6 @@ module Aws::MediaTailor
1411
1526
  include Aws::Structure
1412
1527
  end
1413
1528
 
1414
- # If the action is successful, the service sends back an HTTP 204
1415
- # response with an empty HTTP body.
1416
- #
1417
1529
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePrefetchScheduleResponse AWS API Documentation
1418
1530
  #
1419
1531
  class DeletePrefetchScheduleResponse < Aws::EmptyStructure; end
@@ -1427,9 +1539,11 @@ module Aws::MediaTailor
1427
1539
  # }
1428
1540
  #
1429
1541
  # @!attribute [rw] channel_name
1542
+ # The name of the channel.
1430
1543
  # @return [String]
1431
1544
  #
1432
1545
  # @!attribute [rw] program_name
1546
+ # The name of the program.
1433
1547
  # @return [String]
1434
1548
  #
1435
1549
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteProgramRequest AWS API Documentation
@@ -1441,8 +1555,6 @@ module Aws::MediaTailor
1441
1555
  include Aws::Structure
1442
1556
  end
1443
1557
 
1444
- # This response includes only the "type" : "object" property.
1445
- #
1446
1558
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteProgramResponse AWS API Documentation
1447
1559
  #
1448
1560
  class DeleteProgramResponse < Aws::EmptyStructure; end
@@ -1455,6 +1567,7 @@ module Aws::MediaTailor
1455
1567
  # }
1456
1568
  #
1457
1569
  # @!attribute [rw] source_location_name
1570
+ # The name of the source location.
1458
1571
  # @return [String]
1459
1572
  #
1460
1573
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteSourceLocationRequest AWS API Documentation
@@ -1465,8 +1578,6 @@ module Aws::MediaTailor
1465
1578
  include Aws::Structure
1466
1579
  end
1467
1580
 
1468
- # This response includes only the "type" : "object" property.
1469
- #
1470
1581
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteSourceLocationResponse AWS API Documentation
1471
1582
  #
1472
1583
  class DeleteSourceLocationResponse < Aws::EmptyStructure; end
@@ -1480,9 +1591,11 @@ module Aws::MediaTailor
1480
1591
  # }
1481
1592
  #
1482
1593
  # @!attribute [rw] source_location_name
1594
+ # The name of the source location associated with this VOD Source.
1483
1595
  # @return [String]
1484
1596
  #
1485
1597
  # @!attribute [rw] vod_source_name
1598
+ # The name of the VOD source.
1486
1599
  # @return [String]
1487
1600
  #
1488
1601
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteVodSourceRequest AWS API Documentation
@@ -1494,8 +1607,6 @@ module Aws::MediaTailor
1494
1607
  include Aws::Structure
1495
1608
  end
1496
1609
 
1497
- # This response includes only the "type" : "object" property.
1498
- #
1499
1610
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteVodSourceResponse AWS API Documentation
1500
1611
  #
1501
1612
  class DeleteVodSourceResponse < Aws::EmptyStructure; end
@@ -1508,6 +1619,7 @@ module Aws::MediaTailor
1508
1619
  # }
1509
1620
  #
1510
1621
  # @!attribute [rw] channel_name
1622
+ # The name of the channel.
1511
1623
  # @return [String]
1512
1624
  #
1513
1625
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeChannelRequest AWS API Documentation
@@ -1518,8 +1630,6 @@ module Aws::MediaTailor
1518
1630
  include Aws::Structure
1519
1631
  end
1520
1632
 
1521
- # Returns a channel's properties.
1522
- #
1523
1633
  # @!attribute [rw] arn
1524
1634
  # The ARN of the channel.
1525
1635
  # @return [String]
@@ -1554,7 +1664,14 @@ module Aws::MediaTailor
1554
1664
  # @return [String]
1555
1665
  #
1556
1666
  # @!attribute [rw] tags
1557
- # The tags assigned to the channel.
1667
+ # The tags assigned to the channel. Tags are key-value pairs that you
1668
+ # can associate with Amazon resources to help with organization,
1669
+ # access control, and cost tracking. For more information, see
1670
+ # [Tagging AWS Elemental MediaTailor Resources][1].
1671
+ #
1672
+ #
1673
+ #
1674
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1558
1675
  # @return [Hash<String,String>]
1559
1676
  #
1560
1677
  # @!attribute [rw] tier
@@ -1587,9 +1704,11 @@ module Aws::MediaTailor
1587
1704
  # }
1588
1705
  #
1589
1706
  # @!attribute [rw] live_source_name
1707
+ # The name of the live source.
1590
1708
  # @return [String]
1591
1709
  #
1592
1710
  # @!attribute [rw] source_location_name
1711
+ # The name of the source location associated with this Live Source.
1593
1712
  # @return [String]
1594
1713
  #
1595
1714
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeLiveSourceRequest AWS API Documentation
@@ -1601,8 +1720,6 @@ module Aws::MediaTailor
1601
1720
  include Aws::Structure
1602
1721
  end
1603
1722
 
1604
- # This response includes only the "type" : "object" property.
1605
- #
1606
1723
  # @!attribute [rw] arn
1607
1724
  # The ARN of the live source.
1608
1725
  # @return [String]
@@ -1624,11 +1741,18 @@ module Aws::MediaTailor
1624
1741
  # @return [String]
1625
1742
  #
1626
1743
  # @!attribute [rw] source_location_name
1627
- # The name of the source location associated with the VOD source.
1744
+ # The name of the source location associated with the live source.
1628
1745
  # @return [String]
1629
1746
  #
1630
1747
  # @!attribute [rw] tags
1631
- # The tags assigned to the live source.
1748
+ # The tags assigned to the live source. Tags are key-value pairs that
1749
+ # you can associate with Amazon resources to help with organization,
1750
+ # access control, and cost tracking. For more information, see
1751
+ # [Tagging AWS Elemental MediaTailor Resources][1].
1752
+ #
1753
+ #
1754
+ #
1755
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1632
1756
  # @return [Hash<String,String>]
1633
1757
  #
1634
1758
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeLiveSourceResponse AWS API Documentation
@@ -1654,9 +1778,11 @@ module Aws::MediaTailor
1654
1778
  # }
1655
1779
  #
1656
1780
  # @!attribute [rw] channel_name
1781
+ # The name of the channel associated with this Program.
1657
1782
  # @return [String]
1658
1783
  #
1659
1784
  # @!attribute [rw] program_name
1785
+ # The name of the program.
1660
1786
  # @return [String]
1661
1787
  #
1662
1788
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeProgramRequest AWS API Documentation
@@ -1668,8 +1794,6 @@ module Aws::MediaTailor
1668
1794
  include Aws::Structure
1669
1795
  end
1670
1796
 
1671
- # This program's configuration parameters.
1672
- #
1673
1797
  # @!attribute [rw] ad_breaks
1674
1798
  # The ad break configuration settings.
1675
1799
  # @return [Array<Types::AdBreak>]
@@ -1733,6 +1857,7 @@ module Aws::MediaTailor
1733
1857
  # }
1734
1858
  #
1735
1859
  # @!attribute [rw] source_location_name
1860
+ # The name of the source location.
1736
1861
  # @return [String]
1737
1862
  #
1738
1863
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeSourceLocationRequest AWS API Documentation
@@ -1743,8 +1868,6 @@ module Aws::MediaTailor
1743
1868
  include Aws::Structure
1744
1869
  end
1745
1870
 
1746
- # This response includes only the "type" : "object" property.
1747
- #
1748
1871
  # @!attribute [rw] access_configuration
1749
1872
  # The access configuration for the source location.
1750
1873
  # @return [Types::AccessConfiguration]
@@ -1780,7 +1903,14 @@ module Aws::MediaTailor
1780
1903
  # @return [String]
1781
1904
  #
1782
1905
  # @!attribute [rw] tags
1783
- # The tags assigned to the source location.
1906
+ # The tags assigned to the source location. Tags are key-value pairs
1907
+ # that you can associate with Amazon resources to help with
1908
+ # organization, access control, and cost tracking. For more
1909
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
1910
+ #
1911
+ #
1912
+ #
1913
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1784
1914
  # @return [Hash<String,String>]
1785
1915
  #
1786
1916
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeSourceLocationResponse AWS API Documentation
@@ -1808,9 +1938,11 @@ module Aws::MediaTailor
1808
1938
  # }
1809
1939
  #
1810
1940
  # @!attribute [rw] source_location_name
1941
+ # The name of the source location associated with this VOD Source.
1811
1942
  # @return [String]
1812
1943
  #
1813
1944
  # @!attribute [rw] vod_source_name
1945
+ # The name of the VOD Source.
1814
1946
  # @return [String]
1815
1947
  #
1816
1948
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeVodSourceRequest AWS API Documentation
@@ -1822,8 +1954,6 @@ module Aws::MediaTailor
1822
1954
  include Aws::Structure
1823
1955
  end
1824
1956
 
1825
- # This response includes only the "type" : "object" property.
1826
- #
1827
1957
  # @!attribute [rw] arn
1828
1958
  # The ARN of the VOD source.
1829
1959
  # @return [String]
@@ -1845,7 +1975,14 @@ module Aws::MediaTailor
1845
1975
  # @return [String]
1846
1976
  #
1847
1977
  # @!attribute [rw] tags
1848
- # The tags assigned to the VOD source.
1978
+ # The tags assigned to the VOD source. Tags are key-value pairs that
1979
+ # you can associate with Amazon resources to help with organization,
1980
+ # access control, and cost tracking. For more information, see
1981
+ # [Tagging AWS Elemental MediaTailor Resources][1].
1982
+ #
1983
+ #
1984
+ #
1985
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1849
1986
  # @return [Hash<String,String>]
1850
1987
  #
1851
1988
  # @!attribute [rw] vod_source_name
@@ -1874,6 +2011,7 @@ module Aws::MediaTailor
1874
2011
  # }
1875
2012
  #
1876
2013
  # @!attribute [rw] channel_name
2014
+ # The name of the channel associated with this Channel Policy.
1877
2015
  # @return [String]
1878
2016
  #
1879
2017
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelPolicyRequest AWS API Documentation
@@ -1884,10 +2022,9 @@ module Aws::MediaTailor
1884
2022
  include Aws::Structure
1885
2023
  end
1886
2024
 
1887
- # Returns the channel's IAM policy.
1888
- #
1889
2025
  # @!attribute [rw] policy
1890
- # The IAM policy for the channel.
2026
+ # The IAM policy for the channel. IAM policies are used to control
2027
+ # access to your channel.
1891
2028
  # @return [String]
1892
2029
  #
1893
2030
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelPolicyResponse AWS API Documentation
@@ -1909,15 +2046,33 @@ module Aws::MediaTailor
1909
2046
  # }
1910
2047
  #
1911
2048
  # @!attribute [rw] channel_name
2049
+ # The name of the channel associated with this Channel Schedule.
1912
2050
  # @return [String]
1913
2051
  #
1914
2052
  # @!attribute [rw] duration_minutes
2053
+ # The duration in minutes of the channel schedule.
1915
2054
  # @return [String]
1916
2055
  #
1917
2056
  # @!attribute [rw] max_results
2057
+ # The maximum number of channel schedules that you want MediaTailor to
2058
+ # return in response to the current request. If there are more than
2059
+ # `MaxResults` channel schedules, use the value of `NextToken` in the
2060
+ # response to get the next page of results.
1918
2061
  # @return [Integer]
1919
2062
  #
1920
2063
  # @!attribute [rw] next_token
2064
+ # (Optional) If the playback configuration has more than `MaxResults`
2065
+ # channel schedules, use `NextToken` to get the second and subsequent
2066
+ # pages of results.
2067
+ #
2068
+ # For the first `GetChannelScheduleRequest` request, omit this value.
2069
+ #
2070
+ # For the second and subsequent requests, get the value of `NextToken`
2071
+ # from the previous response and specify that value for `NextToken` in
2072
+ # the request.
2073
+ #
2074
+ # If the previous response didn't include a `NextToken` element,
2075
+ # there are no more channel schedules to get.
1921
2076
  # @return [String]
1922
2077
  #
1923
2078
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelScheduleRequest AWS API Documentation
@@ -1931,15 +2086,14 @@ module Aws::MediaTailor
1931
2086
  include Aws::Structure
1932
2087
  end
1933
2088
 
1934
- # Returns the schedule entries for the channel.
1935
- #
1936
2089
  # @!attribute [rw] items
1937
2090
  # A list of schedule entries for the channel.
1938
2091
  # @return [Array<Types::ScheduleEntry>]
1939
2092
  #
1940
2093
  # @!attribute [rw] next_token
1941
- # Pagination token from the GET list request. Use the token to fetch
1942
- # the next page of results.
2094
+ # Pagination token returned by the list request when results exceed
2095
+ # the maximum allowed. Use the token to fetch the next page of
2096
+ # results.
1943
2097
  # @return [String]
1944
2098
  #
1945
2099
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelScheduleResponse AWS API Documentation
@@ -1959,6 +2113,7 @@ module Aws::MediaTailor
1959
2113
  # }
1960
2114
  #
1961
2115
  # @!attribute [rw] name
2116
+ # The identifier for the playback configuration.
1962
2117
  # @return [String]
1963
2118
  #
1964
2119
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPlaybackConfigurationRequest AWS API Documentation
@@ -1969,8 +2124,6 @@ module Aws::MediaTailor
1969
2124
  include Aws::Structure
1970
2125
  end
1971
2126
 
1972
- # Returns the playback configuration for the specified name.
1973
- #
1974
2127
  # @!attribute [rw] ad_decision_server_url
1975
2128
  # The URL for the ad decision server (ADS). This includes the
1976
2129
  # specification of static parameters and placeholders for dynamic
@@ -2082,7 +2235,14 @@ module Aws::MediaTailor
2082
2235
  # @return [String]
2083
2236
  #
2084
2237
  # @!attribute [rw] tags
2085
- # The tags assigned to the playback configuration.
2238
+ # The tags assigned to the playback configuration. Tags are key-value
2239
+ # pairs that you can associate with Amazon resources to help with
2240
+ # organization, access control, and cost tracking. For more
2241
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
2242
+ #
2243
+ #
2244
+ #
2245
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
2086
2246
  # @return [Hash<String,String>]
2087
2247
  #
2088
2248
  # @!attribute [rw] transcode_profile_name
@@ -2132,9 +2292,16 @@ module Aws::MediaTailor
2132
2292
  # }
2133
2293
  #
2134
2294
  # @!attribute [rw] name
2295
+ # The name of the prefetch schedule. The name must be unique among all
2296
+ # prefetch schedules that are associated with the specified playback
2297
+ # configuration.
2135
2298
  # @return [String]
2136
2299
  #
2137
2300
  # @!attribute [rw] playback_configuration_name
2301
+ # Returns information about the prefetch schedule for a specific
2302
+ # playback configuration. If you call `GetPrefetchSchedule` on an
2303
+ # expired prefetch schedule, MediaTailor returns an HTTP 404 status
2304
+ # code.
2138
2305
  # @return [String]
2139
2306
  #
2140
2307
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPrefetchScheduleRequest AWS API Documentation
@@ -2147,26 +2314,37 @@ module Aws::MediaTailor
2147
2314
  end
2148
2315
 
2149
2316
  # @!attribute [rw] arn
2317
+ # The Amazon Resource Name (ARN) of the prefetch schedule.
2150
2318
  # @return [String]
2151
2319
  #
2152
2320
  # @!attribute [rw] consumption
2153
- # A complex type that contains settings that determine how and when
2154
- # that MediaTailor places prefetched ads into upcoming ad breaks.
2321
+ # Consumption settings determine how, and when, MediaTailor places the
2322
+ # prefetched ads into ad breaks. Ad consumption occurs within a span
2323
+ # of time that you define, called a *consumption window*. You can
2324
+ # designate which ad breaks that MediaTailor fills with prefetch ads
2325
+ # by setting avail matching criteria.
2155
2326
  # @return [Types::PrefetchConsumption]
2156
2327
  #
2157
2328
  # @!attribute [rw] name
2329
+ # The name of the prefetch schedule. The name must be unique among all
2330
+ # prefetch schedules that are associated with the specified playback
2331
+ # configuration.
2158
2332
  # @return [String]
2159
2333
  #
2160
2334
  # @!attribute [rw] playback_configuration_name
2335
+ # The name of the playback configuration to create the prefetch
2336
+ # schedule for.
2161
2337
  # @return [String]
2162
2338
  #
2163
2339
  # @!attribute [rw] retrieval
2164
- # A complex type that contains settings governing when MediaTailor
2165
- # prefetches ads, and which dynamic variables that MediaTailor
2166
- # includes in the request to the ad decision server.
2340
+ # A complex type that contains settings for prefetch retrieval from
2341
+ # the ad decision server (ADS).
2167
2342
  # @return [Types::PrefetchRetrieval]
2168
2343
  #
2169
2344
  # @!attribute [rw] stream_id
2345
+ # An optional stream identifier that you can specify in order to
2346
+ # prefetch for multiple streams that use the same playback
2347
+ # configuration.
2170
2348
  # @return [String]
2171
2349
  #
2172
2350
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPrefetchScheduleResponse AWS API Documentation
@@ -2207,8 +2385,8 @@ module Aws::MediaTailor
2207
2385
  # }
2208
2386
  #
2209
2387
  # @!attribute [rw] manifest_window_seconds
2210
- # The total duration (in seconds) of each manifest. Minimum value: 30
2211
- # seconds. Maximum value: 3600 seconds.
2388
+ # The total duration (in seconds) of each manifest. Minimum value:
2389
+ # `30` seconds. Maximum value: `3600` seconds.
2212
2390
  # @return [Integer]
2213
2391
  #
2214
2392
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/HlsPlaylistSettings AWS API Documentation
@@ -2255,17 +2433,18 @@ module Aws::MediaTailor
2255
2433
  #
2256
2434
  # @!attribute [rw] path
2257
2435
  # The relative path to the URL for this VOD source. This is combined
2258
- # with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
2436
+ # with `SourceLocation::HttpConfiguration::BaseUrl` to form a valid
2437
+ # URL.
2259
2438
  # @return [String]
2260
2439
  #
2261
2440
  # @!attribute [rw] source_group
2262
2441
  # The name of the source group. This has to match one of the
2263
- # Channel::Outputs::SourceGroup.
2442
+ # `Channel::Outputs::SourceGroup`.
2264
2443
  # @return [String]
2265
2444
  #
2266
2445
  # @!attribute [rw] type
2267
2446
  # The streaming protocol for this package configuration. Supported
2268
- # values are HLS and DASH.
2447
+ # values are `HLS` and `DASH`.
2269
2448
  # @return [String]
2270
2449
  #
2271
2450
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/HttpPackageConfiguration AWS API Documentation
@@ -2288,12 +2467,20 @@ module Aws::MediaTailor
2288
2467
  # }
2289
2468
  #
2290
2469
  # @!attribute [rw] max_results
2470
+ # The maximum number of alerts that you want MediaTailor to return in
2471
+ # response to the current request. If there are more than `MaxResults`
2472
+ # alerts, use the value of `NextToken` in the response to get the next
2473
+ # page of results.
2291
2474
  # @return [Integer]
2292
2475
  #
2293
2476
  # @!attribute [rw] next_token
2477
+ # Pagination token returned by the list request when results exceed
2478
+ # the maximum allowed. Use the token to fetch the next page of
2479
+ # results.
2294
2480
  # @return [String]
2295
2481
  #
2296
2482
  # @!attribute [rw] resource_arn
2483
+ # The Amazon Resource Name (ARN) of the resource.
2297
2484
  # @return [String]
2298
2485
  #
2299
2486
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListAlertsRequest AWS API Documentation
@@ -2306,15 +2493,14 @@ module Aws::MediaTailor
2306
2493
  include Aws::Structure
2307
2494
  end
2308
2495
 
2309
- # Lists the alerts for a given resource.
2310
- #
2311
2496
  # @!attribute [rw] items
2312
2497
  # A list of alerts that are associated with this resource.
2313
2498
  # @return [Array<Types::Alert>]
2314
2499
  #
2315
2500
  # @!attribute [rw] next_token
2316
- # Pagination token from the list request. Use the token to fetch the
2317
- # next page of results.
2501
+ # Pagination token returned by the list request when results exceed
2502
+ # the maximum allowed. Use the token to fetch the next page of
2503
+ # results.
2318
2504
  # @return [String]
2319
2505
  #
2320
2506
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListAlertsResponse AWS API Documentation
@@ -2335,9 +2521,16 @@ module Aws::MediaTailor
2335
2521
  # }
2336
2522
  #
2337
2523
  # @!attribute [rw] max_results
2524
+ # The maximum number of channels that you want MediaTailor to return
2525
+ # in response to the current request. If there are more than
2526
+ # `MaxResults` channels, use the value of `NextToken` in the response
2527
+ # to get the next page of results.
2338
2528
  # @return [Integer]
2339
2529
  #
2340
2530
  # @!attribute [rw] next_token
2531
+ # Pagination token returned by the list request when results exceed
2532
+ # the maximum allowed. Use the token to fetch the next page of
2533
+ # results.
2341
2534
  # @return [String]
2342
2535
  #
2343
2536
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListChannelsRequest AWS API Documentation
@@ -2349,8 +2542,6 @@ module Aws::MediaTailor
2349
2542
  include Aws::Structure
2350
2543
  end
2351
2544
 
2352
- # Returns a list of channels.
2353
- #
2354
2545
  # @!attribute [rw] items
2355
2546
  # A list of channels that are associated with this account.
2356
2547
  # @return [Array<Types::Channel>]
@@ -2380,12 +2571,21 @@ module Aws::MediaTailor
2380
2571
  # }
2381
2572
  #
2382
2573
  # @!attribute [rw] max_results
2574
+ # The maximum number of live sources that you want MediaTailor to
2575
+ # return in response to the current request. If there are more than
2576
+ # `MaxResults` live sources, use the value of `NextToken` in the
2577
+ # response to get the next page of results.
2383
2578
  # @return [Integer]
2384
2579
  #
2385
2580
  # @!attribute [rw] next_token
2581
+ # Pagination token returned by the list request when results exceed
2582
+ # the maximum allowed. Use the token to fetch the next page of
2583
+ # results.
2386
2584
  # @return [String]
2387
2585
  #
2388
2586
  # @!attribute [rw] source_location_name
2587
+ # The name of the source location associated with this Live Sources
2588
+ # list.
2389
2589
  # @return [String]
2390
2590
  #
2391
2591
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListLiveSourcesRequest AWS API Documentation
@@ -2398,15 +2598,14 @@ module Aws::MediaTailor
2398
2598
  include Aws::Structure
2399
2599
  end
2400
2600
 
2401
- # A list of your live sources.
2402
- #
2403
2601
  # @!attribute [rw] items
2404
2602
  # Lists the live sources.
2405
2603
  # @return [Array<Types::LiveSource>]
2406
2604
  #
2407
2605
  # @!attribute [rw] next_token
2408
- # Pagination token from the list request. Use the token to fetch the
2409
- # next page of results.
2606
+ # Pagination token returned by the list request when results exceed
2607
+ # the maximum allowed. Use the token to fetch the next page of
2608
+ # results.
2410
2609
  # @return [String]
2411
2610
  #
2412
2611
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListLiveSourcesResponse AWS API Documentation
@@ -2427,9 +2626,16 @@ module Aws::MediaTailor
2427
2626
  # }
2428
2627
  #
2429
2628
  # @!attribute [rw] max_results
2629
+ # The maximum number of playback configurations that you want
2630
+ # MediaTailor to return in response to the current request. If there
2631
+ # are more than `MaxResults` playback configurations, use the value of
2632
+ # `NextToken` in the response to get the next page of results.
2430
2633
  # @return [Integer]
2431
2634
  #
2432
2635
  # @!attribute [rw] next_token
2636
+ # Pagination token returned by the list request when results exceed
2637
+ # the maximum allowed. Use the token to fetch the next page of
2638
+ # results.
2433
2639
  # @return [String]
2434
2640
  #
2435
2641
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListPlaybackConfigurationsRequest AWS API Documentation
@@ -2441,8 +2647,6 @@ module Aws::MediaTailor
2441
2647
  include Aws::Structure
2442
2648
  end
2443
2649
 
2444
- # Returns a list of playback configurations.
2445
- #
2446
2650
  # @!attribute [rw] items
2447
2651
  # Array of playback configurations. This might be all the available
2448
2652
  # configurations or a subset, depending on the settings that you
@@ -2464,9 +2668,6 @@ module Aws::MediaTailor
2464
2668
  include Aws::Structure
2465
2669
  end
2466
2670
 
2467
- # Retrieves the prefetch schedule(s) for a specific playback
2468
- # configuration.
2469
- #
2470
2671
  # @note When making an API call, you may pass ListPrefetchSchedulesRequest
2471
2672
  # data as a hash:
2472
2673
  #
@@ -2479,27 +2680,30 @@ module Aws::MediaTailor
2479
2680
  #
2480
2681
  # @!attribute [rw] max_results
2481
2682
  # The maximum number of prefetch schedules that you want MediaTailor
2482
- # to return in response to the current request. If the playback
2483
- # configuration has more than MaxResults prefetch schedules, use the
2484
- # value of NextToken in the response to get the next page of results.
2683
+ # to return in response to the current request. If there are more than
2684
+ # `MaxResults` prefetch schedules, use the value of `NextToken` in the
2685
+ # response to get the next page of results.
2485
2686
  # @return [Integer]
2486
2687
  #
2487
2688
  # @!attribute [rw] next_token
2488
- # (Optional) If the playback configuration has more than MaxResults
2489
- # prefetch schedules, use NextToken to get the second and subsequent
2689
+ # (Optional) If the playback configuration has more than `MaxResults`
2690
+ # prefetch schedules, use `NextToken` to get the second and subsequent
2490
2691
  # pages of results.
2491
2692
  #
2492
- # For the first ListPrefetchSchedulesRequest request, omit this value.
2693
+ # For the first `ListPrefetchSchedulesRequest` request, omit this
2694
+ # value.
2493
2695
  #
2494
- # For the second and subsequent requests, get the value of NextToken
2495
- # from the previous response and specify that value for NextToken in
2696
+ # For the second and subsequent requests, get the value of `NextToken`
2697
+ # from the previous response and specify that value for `NextToken` in
2496
2698
  # the request.
2497
2699
  #
2498
- # If the previous response didn't include a NextToken element, there
2499
- # are no more prefetch schedules to get.
2700
+ # If the previous response didn't include a `NextToken` element,
2701
+ # there are no more prefetch schedules to get.
2500
2702
  # @return [String]
2501
2703
  #
2502
2704
  # @!attribute [rw] playback_configuration_name
2705
+ # Retrieves the prefetch schedule(s) for a specific playback
2706
+ # configuration.
2503
2707
  # @return [String]
2504
2708
  #
2505
2709
  # @!attribute [rw] stream_id
@@ -2518,16 +2722,15 @@ module Aws::MediaTailor
2518
2722
  include Aws::Structure
2519
2723
  end
2520
2724
 
2521
- # The list of prefetch schedules.
2522
- #
2523
2725
  # @!attribute [rw] items
2524
- # Lists the prefetch schedules. An empty Items list doesn't mean
2726
+ # Lists the prefetch schedules. An empty `Items` list doesn't mean
2525
2727
  # there aren't more items to fetch, just that that page was empty.
2526
2728
  # @return [Array<Types::PrefetchSchedule>]
2527
2729
  #
2528
2730
  # @!attribute [rw] next_token
2529
- # The value that you will use forNextToken in the next
2530
- # ListPrefetchSchedulesRequest request.
2731
+ # Pagination token returned by the list request when results exceed
2732
+ # the maximum allowed. Use the token to fetch the next page of
2733
+ # results.
2531
2734
  # @return [String]
2532
2735
  #
2533
2736
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListPrefetchSchedulesResponse AWS API Documentation
@@ -2548,9 +2751,16 @@ module Aws::MediaTailor
2548
2751
  # }
2549
2752
  #
2550
2753
  # @!attribute [rw] max_results
2754
+ # The maximum number of source locations that you want MediaTailor to
2755
+ # return in response to the current request. If there are more than
2756
+ # `MaxResults` source locations, use the value of `NextToken` in the
2757
+ # response to get the next page of results.
2551
2758
  # @return [Integer]
2552
2759
  #
2553
2760
  # @!attribute [rw] next_token
2761
+ # Pagination token returned by the list request when results exceed
2762
+ # the maximum allowed. Use the token to fetch the next page of
2763
+ # results.
2554
2764
  # @return [String]
2555
2765
  #
2556
2766
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListSourceLocationsRequest AWS API Documentation
@@ -2562,15 +2772,14 @@ module Aws::MediaTailor
2562
2772
  include Aws::Structure
2563
2773
  end
2564
2774
 
2565
- # Lists the source locations.
2566
- #
2567
2775
  # @!attribute [rw] items
2568
2776
  # A list of source locations.
2569
2777
  # @return [Array<Types::SourceLocation>]
2570
2778
  #
2571
2779
  # @!attribute [rw] next_token
2572
- # Pagination token from the list request. Use the token to fetch the
2573
- # next page of results.
2780
+ # Pagination token returned by the list request when results exceed
2781
+ # the maximum allowed. Use the token to fetch the next page of
2782
+ # results.
2574
2783
  # @return [String]
2575
2784
  #
2576
2785
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListSourceLocationsResponse AWS API Documentation
@@ -2590,6 +2799,7 @@ module Aws::MediaTailor
2590
2799
  # }
2591
2800
  #
2592
2801
  # @!attribute [rw] resource_arn
2802
+ # The Amazon Resource Name (ARN) associated with this resource.
2593
2803
  # @return [String]
2594
2804
  #
2595
2805
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListTagsForResourceRequest AWS API Documentation
@@ -2601,6 +2811,14 @@ module Aws::MediaTailor
2601
2811
  end
2602
2812
 
2603
2813
  # @!attribute [rw] tags
2814
+ # The tags associated with this resource. Tags are key-value pairs
2815
+ # that you can associate with Amazon resources to help with
2816
+ # organization, access control, and cost tracking. For more
2817
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
2818
+ #
2819
+ #
2820
+ #
2821
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
2604
2822
  # @return [Hash<String,String>]
2605
2823
  #
2606
2824
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListTagsForResourceResponse AWS API Documentation
@@ -2621,12 +2839,21 @@ module Aws::MediaTailor
2621
2839
  # }
2622
2840
  #
2623
2841
  # @!attribute [rw] max_results
2842
+ # The maximum number of VOD sources that you want MediaTailor to
2843
+ # return in response to the current request. If there are more than
2844
+ # `MaxResults` VOD sources, use the value of `NextToken` in the
2845
+ # response to get the next page of results.
2624
2846
  # @return [Integer]
2625
2847
  #
2626
2848
  # @!attribute [rw] next_token
2849
+ # Pagination token returned by the list request when results exceed
2850
+ # the maximum allowed. Use the token to fetch the next page of
2851
+ # results.
2627
2852
  # @return [String]
2628
2853
  #
2629
2854
  # @!attribute [rw] source_location_name
2855
+ # The name of the source location associated with this VOD Source
2856
+ # list.
2630
2857
  # @return [String]
2631
2858
  #
2632
2859
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListVodSourcesRequest AWS API Documentation
@@ -2639,15 +2866,14 @@ module Aws::MediaTailor
2639
2866
  include Aws::Structure
2640
2867
  end
2641
2868
 
2642
- # A list of VOD sources.
2643
- #
2644
2869
  # @!attribute [rw] items
2645
2870
  # Lists the VOD sources.
2646
2871
  # @return [Array<Types::VodSource>]
2647
2872
  #
2648
2873
  # @!attribute [rw] next_token
2649
- # Pagination token from the list request. Use the token to fetch the
2650
- # next page of results.
2874
+ # Pagination token returned by the list request when results exceed
2875
+ # the maximum allowed. Use the token to fetch the next page of
2876
+ # results.
2651
2877
  # @return [String]
2652
2878
  #
2653
2879
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListVodSourcesResponse AWS API Documentation
@@ -2721,7 +2947,14 @@ module Aws::MediaTailor
2721
2947
  # @return [String]
2722
2948
  #
2723
2949
  # @!attribute [rw] tags
2724
- # The tags assigned to the live source.
2950
+ # The tags assigned to the live source. Tags are key-value pairs that
2951
+ # you can associate with Amazon resources to help with organization,
2952
+ # access control, and cost tracking. For more information, see
2953
+ # [Tagging AWS Elemental MediaTailor Resources][1].
2954
+ #
2955
+ #
2956
+ #
2957
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
2725
2958
  # @return [Hash<String,String>]
2726
2959
  #
2727
2960
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/LiveSource AWS API Documentation
@@ -2743,13 +2976,13 @@ module Aws::MediaTailor
2743
2976
  # @!attribute [rw] percent_enabled
2744
2977
  # The percentage of session logs that MediaTailor sends to your
2745
2978
  # Cloudwatch Logs account. For example, if your playback configuration
2746
- # has 1000 sessions and percentEnabled is set to 60, MediaTailor sends
2747
- # logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides
2748
- # at random which of the playback configuration sessions to send logs
2749
- # for. If you want to view logs for a specific session, you can use
2750
- # the [debug log mode][1].
2979
+ # has 1000 sessions and `percentEnabled` is set to `60`, MediaTailor
2980
+ # sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor
2981
+ # decides at random which of the playback configuration sessions to
2982
+ # send logs for. If you want to view logs for a specific session, you
2983
+ # can use the [debug log mode][1].
2751
2984
  #
2752
- # Valid values: 0 - 100
2985
+ # Valid values: `0` - `100`
2753
2986
  #
2754
2987
  #
2755
2988
  #
@@ -2778,13 +3011,14 @@ module Aws::MediaTailor
2778
3011
  # }
2779
3012
  #
2780
3013
  # @!attribute [rw] ad_marker_passthrough
2781
- # For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN,
2782
- # EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the
2783
- # origin manifest to the MediaTailor personalized manifest.
3014
+ # For HLS, when set to `true`, MediaTailor passes through
3015
+ # `EXT-X-CUE-IN`, `EXT-X-CUE-OUT`, and `EXT-X-SPLICEPOINT-SCTE35` ad
3016
+ # markers from the origin manifest to the MediaTailor personalized
3017
+ # manifest.
2784
3018
  #
2785
3019
  # No logic is applied to these ad markers. For example, if
2786
- # EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad
2787
- # break, MediaTailor will not set the value to 0.
3020
+ # `EXT-X-CUE-OUT` has a value of `60`, but no ads are filled for that
3021
+ # ad break, MediaTailor will not set the value to `0`.
2788
3022
  # @return [Types::AdMarkerPassthrough]
2789
3023
  #
2790
3024
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ManifestProcessingRules AWS API Documentation
@@ -2795,7 +3029,7 @@ module Aws::MediaTailor
2795
3029
  include Aws::Structure
2796
3030
  end
2797
3031
 
2798
- # Creates a playback configuration. For information about MediaTailor
3032
+ # A playback configuration. For information about MediaTailor
2799
3033
  # configurations, see [Working with configurations in AWS Elemental
2800
3034
  # MediaTailor][1].
2801
3035
  #
@@ -2914,7 +3148,14 @@ module Aws::MediaTailor
2914
3148
  # @return [String]
2915
3149
  #
2916
3150
  # @!attribute [rw] tags
2917
- # The tags to assign to the playback configuration.
3151
+ # The tags to assign to the playback configuration. Tags are key-value
3152
+ # pairs that you can associate with Amazon resources to help with
3153
+ # organization, access control, and cost tracking. For more
3154
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
3155
+ #
3156
+ #
3157
+ #
3158
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
2918
3159
  # @return [Hash<String,String>]
2919
3160
  #
2920
3161
  # @!attribute [rw] transcode_profile_name
@@ -2975,7 +3216,7 @@ module Aws::MediaTailor
2975
3216
  # @!attribute [rw] avail_matching_criteria
2976
3217
  # If you only want MediaTailor to insert prefetched ads into avails
2977
3218
  # (ad breaks) that match specific dynamic variables, such as
2978
- # scte.event\_id, set the avail matching criteria.
3219
+ # `scte.event_id`, set the avail matching criteria.
2979
3220
  # @return [Array<Types::AvailMatchingCriteria>]
2980
3221
  #
2981
3222
  # @!attribute [rw] end_time
@@ -2983,12 +3224,12 @@ module Aws::MediaTailor
2983
3224
  # use in an ad break. MediaTailor automatically deletes prefetch
2984
3225
  # schedules no less than seven days after the end time. If you'd like
2985
3226
  # to manually delete the prefetch schedule, you can call
2986
- # DeletePrefetchSchedule.
3227
+ # `DeletePrefetchSchedule`.
2987
3228
  # @return [Time]
2988
3229
  #
2989
3230
  # @!attribute [rw] start_time
2990
3231
  # The time when prefetched ads are considered for use in an ad break.
2991
- # If you don't specify StartTime, the prefetched ads are available
3232
+ # If you don't specify `StartTime`, the prefetched ads are available
2992
3233
  # after MediaTailor retrives them from the ad decision server.
2993
3234
  # @return [Time]
2994
3235
  #
@@ -3021,9 +3262,9 @@ module Aws::MediaTailor
3021
3262
  # The dynamic variables to use for substitution during prefetch
3022
3263
  # requests to the ad decision server (ADS).
3023
3264
  #
3024
- # You intially configure [dynamic variables][1] for the ADS URL when
3265
+ # You initially configure [dynamic variables][1] for the ADS URL when
3025
3266
  # you set up your playback configuration. When you specify
3026
- # DynamicVariables for prefetch retrieval, MediaTailor includes the
3267
+ # `DynamicVariables` for prefetch retrieval, MediaTailor includes the
3027
3268
  # dynamic variables in the request to the ADS.
3028
3269
  #
3029
3270
  #
@@ -3054,7 +3295,14 @@ module Aws::MediaTailor
3054
3295
  include Aws::Structure
3055
3296
  end
3056
3297
 
3057
- # A complex type that contains prefetch schedule information.
3298
+ # A prefetch schedule allows you to tell MediaTailor to fetch and
3299
+ # prepare certain ads before an ad break happens. For more information
3300
+ # about ad prefetching, see [Using ad prefetching][1] in the
3301
+ # *MediaTailor User Guide*.
3302
+ #
3303
+ #
3304
+ #
3305
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
3058
3306
  #
3059
3307
  # @!attribute [rw] arn
3060
3308
  # The Amazon Resource Name (ARN) of the prefetch schedule.
@@ -3103,8 +3351,6 @@ module Aws::MediaTailor
3103
3351
  include Aws::Structure
3104
3352
  end
3105
3353
 
3106
- # Adds an IAM policy for the channel.
3107
- #
3108
3354
  # @note When making an API call, you may pass PutChannelPolicyRequest
3109
3355
  # data as a hash:
3110
3356
  #
@@ -3114,6 +3360,7 @@ module Aws::MediaTailor
3114
3360
  # }
3115
3361
  #
3116
3362
  # @!attribute [rw] channel_name
3363
+ # The channel name associated with this Channel Policy.
3117
3364
  # @return [String]
3118
3365
  #
3119
3366
  # @!attribute [rw] policy
@@ -3129,14 +3376,10 @@ module Aws::MediaTailor
3129
3376
  include Aws::Structure
3130
3377
  end
3131
3378
 
3132
- # This response includes only the "type" : "object" property.
3133
- #
3134
3379
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PutChannelPolicyResponse AWS API Documentation
3135
3380
  #
3136
3381
  class PutChannelPolicyResponse < Aws::EmptyStructure; end
3137
3382
 
3138
- # The configuration for creating a playback configuration.
3139
- #
3140
3383
  # @note When making an API call, you may pass PutPlaybackConfigurationRequest
3141
3384
  # data as a hash:
3142
3385
  #
@@ -3172,7 +3415,7 @@ module Aws::MediaTailor
3172
3415
  # enabled: false,
3173
3416
  # },
3174
3417
  # },
3175
- # name: "__string",
3418
+ # name: "__string", # required
3176
3419
  # personalization_threshold_seconds: 1,
3177
3420
  # slate_ad_url: "__string",
3178
3421
  # tags: {
@@ -3271,7 +3514,14 @@ module Aws::MediaTailor
3271
3514
  # @return [String]
3272
3515
  #
3273
3516
  # @!attribute [rw] tags
3274
- # The tags to assign to the playback configuration.
3517
+ # The tags to assign to the playback configuration. Tags are key-value
3518
+ # pairs that you can associate with Amazon resources to help with
3519
+ # organization, access control, and cost tracking. For more
3520
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
3521
+ #
3522
+ #
3523
+ #
3524
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
3275
3525
  # @return [Hash<String,String>]
3276
3526
  #
3277
3527
  # @!attribute [rw] transcode_profile_name
@@ -3308,6 +3558,12 @@ module Aws::MediaTailor
3308
3558
  end
3309
3559
 
3310
3560
  # @!attribute [rw] ad_decision_server_url
3561
+ # The URL for the ad decision server (ADS). This includes the
3562
+ # specification of static parameters and placeholders for dynamic
3563
+ # parameters. AWS Elemental MediaTailor substitutes player-specific
3564
+ # and session-specific parameters as needed when calling the ADS.
3565
+ # Alternately, for testing you can provide a static VAST URL. The
3566
+ # maximum length is 25,000 characters.
3311
3567
  # @return [String]
3312
3568
  #
3313
3569
  # @!attribute [rw] avail_suppression
@@ -3336,7 +3592,13 @@ module Aws::MediaTailor
3336
3592
  # @return [Types::CdnConfiguration]
3337
3593
  #
3338
3594
  # @!attribute [rw] configuration_aliases
3339
- # The predefined aliases for dynamic variables.
3595
+ # The player parameters and aliases used as dynamic variables during
3596
+ # session initialization. For more information, see [Domain
3597
+ # Variables][1].
3598
+ #
3599
+ #
3600
+ #
3601
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html
3340
3602
  # @return [Hash<String,Hash<String,String>>]
3341
3603
  #
3342
3604
  # @!attribute [rw] dash_configuration
@@ -3352,7 +3614,7 @@ module Aws::MediaTailor
3352
3614
  # @return [Types::LivePreRollConfiguration]
3353
3615
  #
3354
3616
  # @!attribute [rw] log_configuration
3355
- # Returns Amazon CloudWatch log settings for a playback configuration.
3617
+ # The Amazon CloudWatch log settings for a playback configuration.
3356
3618
  # @return [Types::LogConfiguration]
3357
3619
  #
3358
3620
  # @!attribute [rw] manifest_processing_rules
@@ -3362,30 +3624,71 @@ module Aws::MediaTailor
3362
3624
  # @return [Types::ManifestProcessingRules]
3363
3625
  #
3364
3626
  # @!attribute [rw] name
3627
+ # The identifier for the playback configuration.
3365
3628
  # @return [String]
3366
3629
  #
3367
3630
  # @!attribute [rw] personalization_threshold_seconds
3631
+ # Defines the maximum duration of underfilled ad time (in seconds)
3632
+ # allowed in an ad break. If the duration of underfilled ad time
3633
+ # exceeds the personalization threshold, then the personalization of
3634
+ # the ad break is abandoned and the underlying content is shown. This
3635
+ # feature applies to *ad replacement* in live and VOD streams, rather
3636
+ # than ad insertion, because it relies on an underlying content
3637
+ # stream. For more information about ad break behavior, including ad
3638
+ # replacement and insertion, see [Ad Behavior in AWS Elemental
3639
+ # MediaTailor][1].
3640
+ #
3641
+ #
3642
+ #
3643
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
3368
3644
  # @return [Integer]
3369
3645
  #
3370
3646
  # @!attribute [rw] playback_configuration_arn
3647
+ # The Amazon Resource Name (ARN) associated with the playback
3648
+ # configuration.
3371
3649
  # @return [String]
3372
3650
  #
3373
3651
  # @!attribute [rw] playback_endpoint_prefix
3652
+ # The playback endpoint prefix associated with the playback
3653
+ # configuration.
3374
3654
  # @return [String]
3375
3655
  #
3376
3656
  # @!attribute [rw] session_initialization_endpoint_prefix
3657
+ # The session initialization endpoint prefix associated with the
3658
+ # playback configuration.
3377
3659
  # @return [String]
3378
3660
  #
3379
3661
  # @!attribute [rw] slate_ad_url
3662
+ # The URL for a high-quality video asset to transcode and use to fill
3663
+ # in time that's not used by ads. AWS Elemental MediaTailor shows the
3664
+ # slate to fill in gaps in media content. Configuring the slate is
3665
+ # optional for non-VPAID configurations. For VPAID, the slate is
3666
+ # required because MediaTailor provides it in the slots that are
3667
+ # designated for dynamic ad content. The slate must be a high-quality
3668
+ # asset that contains both audio and video.
3380
3669
  # @return [String]
3381
3670
  #
3382
3671
  # @!attribute [rw] tags
3672
+ # The tags to assign to the playback configuration. Tags are key-value
3673
+ # pairs that you can associate with Amazon resources to help with
3674
+ # organization, access control, and cost tracking. For more
3675
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
3676
+ #
3677
+ #
3678
+ #
3679
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
3383
3680
  # @return [Hash<String,String>]
3384
3681
  #
3385
3682
  # @!attribute [rw] transcode_profile_name
3683
+ # The name that is used to associate this playback configuration with
3684
+ # a custom transcode profile. This overrides the dynamic transcoding
3685
+ # defaults of MediaTailor. Use this only if you have already set up
3686
+ # custom profiles with the help of AWS Support.
3386
3687
  # @return [String]
3387
3688
  #
3388
3689
  # @!attribute [rw] video_content_source_url
3690
+ # The URL prefix for the parent manifest for the stream, minus the
3691
+ # asset ID. The maximum length is 512 characters.
3389
3692
  # @return [String]
3390
3693
  #
3391
3694
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PutPlaybackConfigurationResponse AWS API Documentation
@@ -3443,12 +3746,12 @@ module Aws::MediaTailor
3443
3746
  #
3444
3747
  # @!attribute [rw] manifest_name
3445
3748
  # The name of the manifest for the channel. The name appears in the
3446
- # PlaybackUrl.
3749
+ # `PlaybackUrl`.
3447
3750
  # @return [String]
3448
3751
  #
3449
3752
  # @!attribute [rw] source_group
3450
- # A string used to match which HttpPackageConfiguration is used for
3451
- # each VodSource.
3753
+ # A string used to match which `HttpPackageConfiguration` is used for
3754
+ # each `VodSource`.
3452
3755
  # @return [String]
3453
3756
  #
3454
3757
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/RequestOutputItem AWS API Documentation
@@ -3462,7 +3765,7 @@ module Aws::MediaTailor
3462
3765
  include Aws::Structure
3463
3766
  end
3464
3767
 
3465
- # This response includes only the "property" : "type" property.
3768
+ # The output item response.
3466
3769
  #
3467
3770
  # @!attribute [rw] dash_playlist_settings
3468
3771
  # DASH manifest configuration settings.
@@ -3588,8 +3891,6 @@ module Aws::MediaTailor
3588
3891
  #
3589
3892
  # @!attribute [rw] schedule_entry_type
3590
3893
  # The type of schedule entry.
3591
- #
3592
- # Valid values: PROGRAM or FILLER\_SLATE.
3593
3894
  # @return [String]
3594
3895
  #
3595
3896
  # @!attribute [rw] source_location_name
@@ -3664,11 +3965,7 @@ module Aws::MediaTailor
3664
3965
  include Aws::Structure
3665
3966
  end
3666
3967
 
3667
- # The base URL of the host or path of the segment delivery server that
3668
- # you're using to serve segments. This is typically a content delivery
3669
- # network (CDN). The URL can be absolute or relative. To use an absolute
3670
- # URL include the protocol, such as https://example.com/some/path. To
3671
- # use a relative URL specify the relative path, such as /some/path*.
3968
+ # The segment delivery configuration settings.
3672
3969
  #
3673
3970
  # @note When making an API call, you may pass SegmentDeliveryConfiguration
3674
3971
  # data as a hash:
@@ -3683,8 +3980,8 @@ module Aws::MediaTailor
3683
3980
  # you're using to serve segments. This is typically a content
3684
3981
  # delivery network (CDN). The URL can be absolute or relative. To use
3685
3982
  # an absolute URL include the protocol, such as
3686
- # https://example.com/some/path. To use a relative URL specify the
3687
- # relative path, such as /some/path*.
3983
+ # `https://example.com/some/path`. To use a relative URL specify the
3984
+ # relative path, such as `/some/path*`.
3688
3985
  # @return [String]
3689
3986
  #
3690
3987
  # @!attribute [rw] name
@@ -3730,7 +4027,13 @@ module Aws::MediaTailor
3730
4027
  include Aws::Structure
3731
4028
  end
3732
4029
 
3733
- # This response includes only the "type" : "object" property.
4030
+ # A source location is a container for sources. For more information
4031
+ # about source locations, see [Working with source locations][1] in the
4032
+ # *MediaTailor User Guide*.
4033
+ #
4034
+ #
4035
+ #
4036
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
3734
4037
  #
3735
4038
  # @!attribute [rw] access_configuration
3736
4039
  # The access configuration for the source location.
@@ -3766,7 +4069,14 @@ module Aws::MediaTailor
3766
4069
  # @return [String]
3767
4070
  #
3768
4071
  # @!attribute [rw] tags
3769
- # The tags assigned to the source location.
4072
+ # The tags assigned to the source location. Tags are key-value pairs
4073
+ # that you can associate with Amazon resources to help with
4074
+ # organization, access control, and cost tracking. For more
4075
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
4076
+ #
4077
+ #
4078
+ #
4079
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
3770
4080
  # @return [Hash<String,String>]
3771
4081
  #
3772
4082
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/SourceLocation AWS API Documentation
@@ -3798,27 +4108,27 @@ module Aws::MediaTailor
3798
4108
  # }
3799
4109
  #
3800
4110
  # @!attribute [rw] avail_num
3801
- # This is written to splice\_insert.avail\_num, as defined in section
3802
- # 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values
3803
- # must be between 0 and 256, inclusive.
4111
+ # This is written to `splice_insert.avail_num`, as defined in section
4112
+ # 9.7.3.1 of the SCTE-35 specification. The default value is `0`.
4113
+ # Values must be between `0` and `256`, inclusive.
3804
4114
  # @return [Integer]
3805
4115
  #
3806
4116
  # @!attribute [rw] avails_expected
3807
- # This is written to splice\_insert.avails\_expected, as defined in
4117
+ # This is written to `splice_insert.avails_expected`, as defined in
3808
4118
  # section 9.7.3.1 of the SCTE-35 specification. The default value is
3809
- # 0. Values must be between 0 and 256, inclusive.
4119
+ # `0`. Values must be between `0` and `256`, inclusive.
3810
4120
  # @return [Integer]
3811
4121
  #
3812
4122
  # @!attribute [rw] splice_event_id
3813
- # This is written to splice\_insert.splice\_event\_id, as defined in
4123
+ # This is written to `splice_insert.splice_event_id`, as defined in
3814
4124
  # section 9.7.3.1 of the SCTE-35 specification. The default value is
3815
- # 1.
4125
+ # `1`.
3816
4126
  # @return [Integer]
3817
4127
  #
3818
4128
  # @!attribute [rw] unique_program_id
3819
- # This is written to splice\_insert.unique\_program\_id, as defined in
4129
+ # This is written to `splice_insert.unique_program_id`, as defined in
3820
4130
  # section 9.7.3.1 of the SCTE-35 specification. The default value is
3821
- # 0. Values must be between 0 and 256, inclusive.
4131
+ # `0`. Values must be between `0` and `256`, inclusive.
3822
4132
  # @return [Integer]
3823
4133
  #
3824
4134
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/SpliceInsertMessage AWS API Documentation
@@ -3840,6 +4150,7 @@ module Aws::MediaTailor
3840
4150
  # }
3841
4151
  #
3842
4152
  # @!attribute [rw] channel_name
4153
+ # The name of the channel.
3843
4154
  # @return [String]
3844
4155
  #
3845
4156
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/StartChannelRequest AWS API Documentation
@@ -3862,6 +4173,7 @@ module Aws::MediaTailor
3862
4173
  # }
3863
4174
  #
3864
4175
  # @!attribute [rw] channel_name
4176
+ # The name of the channel.
3865
4177
  # @return [String]
3866
4178
  #
3867
4179
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/StopChannelRequest AWS API Documentation
@@ -3887,9 +4199,18 @@ module Aws::MediaTailor
3887
4199
  # }
3888
4200
  #
3889
4201
  # @!attribute [rw] resource_arn
4202
+ # The Amazon Resource Name (ARN) associated with the resource.
3890
4203
  # @return [String]
3891
4204
  #
3892
4205
  # @!attribute [rw] tags
4206
+ # The tags to assign to the resource. Tags are key-value pairs that
4207
+ # you can associate with Amazon resources to help with organization,
4208
+ # access control, and cost tracking. For more information, see
4209
+ # [Tagging AWS Elemental MediaTailor Resources][1].
4210
+ #
4211
+ #
4212
+ #
4213
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
3893
4214
  # @return [Hash<String,String>]
3894
4215
  #
3895
4216
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/TagResourceRequest AWS API Documentation
@@ -3920,12 +4241,12 @@ module Aws::MediaTailor
3920
4241
  #
3921
4242
  # @!attribute [rw] relative_position
3922
4243
  # The position where this program will be inserted relative to the
3923
- # RelativePosition.
4244
+ # `RelativePosition`.
3924
4245
  # @return [String]
3925
4246
  #
3926
4247
  # @!attribute [rw] relative_program
3927
4248
  # The name of the program that this program will be inserted next to,
3928
- # as defined by RelativePosition.
4249
+ # as defined by `RelativePosition`.
3929
4250
  # @return [String]
3930
4251
  #
3931
4252
  # @!attribute [rw] scheduled_start_time_millis
@@ -3935,22 +4256,23 @@ module Aws::MediaTailor
3935
4256
  #
3936
4257
  # @!attribute [rw] type
3937
4258
  # Defines when the program plays in the schedule. You can set the
3938
- # value to ABSOLUTE or RELATIVE.
4259
+ # value to `ABSOLUTE` or `RELATIVE`.
3939
4260
  #
3940
- # ABSOLUTE - The program plays at a specific wall clock time. This
3941
- # setting can only be used for channels using the LINEAR PlaybackMode.
4261
+ # `ABSOLUTE` - The program plays at a specific wall clock time. This
4262
+ # setting can only be used for channels using the `LINEAR`
4263
+ # `PlaybackMode`.
3942
4264
  #
3943
- # Note the following considerations when using ABSOLUTE transitions:
4265
+ # Note the following considerations when using `ABSOLUTE` transitions:
3944
4266
  #
3945
4267
  # If the preceding program in the schedule has a duration that extends
3946
4268
  # past the wall clock time, MediaTailor truncates the preceding
3947
4269
  # program on a common segment boundary.
3948
4270
  #
3949
- # If there are gaps in playback, MediaTailor plays the FillerSlate you
3950
- # configured for your linear channel.
4271
+ # If there are gaps in playback, MediaTailor plays the `FillerSlate`
4272
+ # you configured for your linear channel.
3951
4273
  #
3952
- # RELATIVE - The program is inserted into the schedule either before
3953
- # or after a program that you specify via RelativePosition.
4274
+ # `RELATIVE` - The program is inserted into the schedule either before
4275
+ # or after a program that you specify via `RelativePosition`.
3954
4276
  # @return [String]
3955
4277
  #
3956
4278
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/Transition AWS API Documentation
@@ -3974,9 +4296,11 @@ module Aws::MediaTailor
3974
4296
  # }
3975
4297
  #
3976
4298
  # @!attribute [rw] resource_arn
4299
+ # The Amazon Resource Name (ARN) of the resource to untag.
3977
4300
  # @return [String]
3978
4301
  #
3979
4302
  # @!attribute [rw] tag_keys
4303
+ # The tag keys associated with the resource.
3980
4304
  # @return [Array<String>]
3981
4305
  #
3982
4306
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UntagResourceRequest AWS API Documentation
@@ -3988,8 +4312,6 @@ module Aws::MediaTailor
3988
4312
  include Aws::Structure
3989
4313
  end
3990
4314
 
3991
- # Updates a channel's Outputs.
3992
- #
3993
4315
  # @note When making an API call, you may pass UpdateChannelRequest
3994
4316
  # data as a hash:
3995
4317
  #
@@ -4017,13 +4339,14 @@ module Aws::MediaTailor
4017
4339
  # }
4018
4340
  #
4019
4341
  # @!attribute [rw] channel_name
4342
+ # The name of the channel.
4020
4343
  # @return [String]
4021
4344
  #
4022
4345
  # @!attribute [rw] filler_slate
4023
4346
  # The slate used to fill gaps between programs in the schedule. You
4024
- # must configure filler slate if your channel uses the LINEAR
4025
- # PlaybackMode. MediaTailor doesn't support filler slate for channels
4026
- # using the LOOP PlaybackMode.
4347
+ # must configure filler slate if your channel uses the `LINEAR`
4348
+ # `PlaybackMode`. MediaTailor doesn't support filler slate for
4349
+ # channels using the `LOOP` `PlaybackMode`.
4027
4350
  # @return [Types::SlateSource]
4028
4351
  #
4029
4352
  # @!attribute [rw] outputs
@@ -4041,34 +4364,59 @@ module Aws::MediaTailor
4041
4364
  end
4042
4365
 
4043
4366
  # @!attribute [rw] arn
4367
+ # The Amazon Resource Name (ARN) associated with the channel.
4044
4368
  # @return [String]
4045
4369
  #
4046
4370
  # @!attribute [rw] channel_name
4371
+ # The name of the channel.
4047
4372
  # @return [String]
4048
4373
  #
4049
4374
  # @!attribute [rw] channel_state
4375
+ # Returns the state whether the channel is running or not.
4050
4376
  # @return [String]
4051
4377
  #
4052
4378
  # @!attribute [rw] creation_time
4379
+ # The timestamp of when the channel was created.
4053
4380
  # @return [Time]
4054
4381
  #
4055
4382
  # @!attribute [rw] filler_slate
4056
- # Slate VOD source configuration.
4383
+ # The slate used to fill gaps between programs in the schedule. You
4384
+ # must configure filler slate if your channel uses the `LINEAR`
4385
+ # `PlaybackMode`. MediaTailor doesn't support filler slate for
4386
+ # channels using the `LOOP` `PlaybackMode`.
4057
4387
  # @return [Types::SlateSource]
4058
4388
  #
4059
4389
  # @!attribute [rw] last_modified_time
4390
+ # The timestamp that indicates when the channel was last modified.
4060
4391
  # @return [Time]
4061
4392
  #
4062
4393
  # @!attribute [rw] outputs
4394
+ # The channel's output properties.
4063
4395
  # @return [Array<Types::ResponseOutputItem>]
4064
4396
  #
4065
4397
  # @!attribute [rw] playback_mode
4398
+ # The type of playback mode for this channel.
4399
+ #
4400
+ # `LINEAR` - Programs play back-to-back only once.
4401
+ #
4402
+ # `LOOP` - Programs play back-to-back in an endless loop. When the
4403
+ # last program in the schedule plays, playback loops back to the first
4404
+ # program in the schedule.
4066
4405
  # @return [String]
4067
4406
  #
4068
4407
  # @!attribute [rw] tags
4408
+ # The tags to assign to the channel. Tags are key-value pairs that you
4409
+ # can associate with Amazon resources to help with organization,
4410
+ # access control, and cost tracking. For more information, see
4411
+ # [Tagging AWS Elemental MediaTailor Resources][1].
4412
+ #
4413
+ #
4414
+ #
4415
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
4069
4416
  # @return [Hash<String,String>]
4070
4417
  #
4071
4418
  # @!attribute [rw] tier
4419
+ # The tier associated with this Channel.
4072
4420
  # @return [String]
4073
4421
  #
4074
4422
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateChannelResponse AWS API Documentation
@@ -4088,8 +4436,6 @@ module Aws::MediaTailor
4088
4436
  include Aws::Structure
4089
4437
  end
4090
4438
 
4091
- # Updates a live source's configuration.
4092
- #
4093
4439
  # @note When making an API call, you may pass UpdateLiveSourceRequest
4094
4440
  # data as a hash:
4095
4441
  #
@@ -4111,9 +4457,11 @@ module Aws::MediaTailor
4111
4457
  # @return [Array<Types::HttpPackageConfiguration>]
4112
4458
  #
4113
4459
  # @!attribute [rw] live_source_name
4460
+ # The name of the live source.
4114
4461
  # @return [String]
4115
4462
  #
4116
4463
  # @!attribute [rw] source_location_name
4464
+ # The name of the source location associated with this Live Source.
4117
4465
  # @return [String]
4118
4466
  #
4119
4467
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateLiveSourceRequest AWS API Documentation
@@ -4127,25 +4475,39 @@ module Aws::MediaTailor
4127
4475
  end
4128
4476
 
4129
4477
  # @!attribute [rw] arn
4478
+ # The Amazon Resource Name (ARN) associated with this live source.
4130
4479
  # @return [String]
4131
4480
  #
4132
4481
  # @!attribute [rw] creation_time
4482
+ # The timestamp that indicates when the live source was created.
4133
4483
  # @return [Time]
4134
4484
  #
4135
4485
  # @!attribute [rw] http_package_configurations
4136
- # The VOD source's HTTP package configuration settings.
4486
+ # A list of HTTP package configurations for the live source on this
4487
+ # account.
4137
4488
  # @return [Array<Types::HttpPackageConfiguration>]
4138
4489
  #
4139
4490
  # @!attribute [rw] last_modified_time
4491
+ # The timestamp that indicates when the live source was last modified.
4140
4492
  # @return [Time]
4141
4493
  #
4142
4494
  # @!attribute [rw] live_source_name
4495
+ # The name of the live source.
4143
4496
  # @return [String]
4144
4497
  #
4145
4498
  # @!attribute [rw] source_location_name
4499
+ # The name of the source location associated with the live source.
4146
4500
  # @return [String]
4147
4501
  #
4148
4502
  # @!attribute [rw] tags
4503
+ # The tags to assign to the live source. Tags are key-value pairs that
4504
+ # you can associate with Amazon resources to help with organization,
4505
+ # access control, and cost tracking. For more information, see
4506
+ # [Tagging AWS Elemental MediaTailor Resources][1].
4507
+ #
4508
+ #
4509
+ #
4510
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
4149
4511
  # @return [Hash<String,String>]
4150
4512
  #
4151
4513
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateLiveSourceResponse AWS API Documentation
@@ -4162,8 +4524,6 @@ module Aws::MediaTailor
4162
4524
  include Aws::Structure
4163
4525
  end
4164
4526
 
4165
- # Source location configuration parameters.
4166
- #
4167
4527
  # @note When making an API call, you may pass UpdateSourceLocationRequest
4168
4528
  # data as a hash:
4169
4529
  #
@@ -4210,6 +4570,7 @@ module Aws::MediaTailor
4210
4570
  # @return [Array<Types::SegmentDeliveryConfiguration>]
4211
4571
  #
4212
4572
  # @!attribute [rw] source_location_name
4573
+ # The name of the source location.
4213
4574
  # @return [String]
4214
4575
  #
4215
4576
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateSourceLocationRequest AWS API Documentation
@@ -4225,23 +4586,20 @@ module Aws::MediaTailor
4225
4586
  end
4226
4587
 
4227
4588
  # @!attribute [rw] access_configuration
4228
- # Access configuration parameters.
4589
+ # Access configuration parameters. Configures the type of
4590
+ # authentication used to access content from your source location.
4229
4591
  # @return [Types::AccessConfiguration]
4230
4592
  #
4231
4593
  # @!attribute [rw] arn
4594
+ # The Amazon Resource Name (ARN) associated with the source location.
4232
4595
  # @return [String]
4233
4596
  #
4234
4597
  # @!attribute [rw] creation_time
4598
+ # The timestamp that indicates when the source location was created.
4235
4599
  # @return [Time]
4236
4600
  #
4237
4601
  # @!attribute [rw] default_segment_delivery_configuration
4238
- # The optional configuration for a server that serves segments. Use
4239
- # this if you want the segment delivery server to be different from
4240
- # the source location server. For example, you can configure your
4241
- # source location server to be an origination server, such as
4242
- # MediaPackage, and the segment delivery server to be a content
4243
- # delivery network (CDN), such as CloudFront. If you don't specify a
4244
- # segment delivery server, then the source location server is used.
4602
+ # The optional configuration for the host server that serves segments.
4245
4603
  # @return [Types::DefaultSegmentDeliveryConfiguration]
4246
4604
  #
4247
4605
  # @!attribute [rw] http_configuration
@@ -4249,15 +4607,33 @@ module Aws::MediaTailor
4249
4607
  # @return [Types::HttpConfiguration]
4250
4608
  #
4251
4609
  # @!attribute [rw] last_modified_time
4610
+ # The timestamp that indicates when the source location was last
4611
+ # modified.
4252
4612
  # @return [Time]
4253
4613
  #
4254
4614
  # @!attribute [rw] segment_delivery_configurations
4615
+ # The segment delivery configurations for the source location. For
4616
+ # information about MediaTailor configurations, see [Working with
4617
+ # configurations in AWS Elemental MediaTailor][1].
4618
+ #
4619
+ #
4620
+ #
4621
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
4255
4622
  # @return [Array<Types::SegmentDeliveryConfiguration>]
4256
4623
  #
4257
4624
  # @!attribute [rw] source_location_name
4625
+ # The name of the source location.
4258
4626
  # @return [String]
4259
4627
  #
4260
4628
  # @!attribute [rw] tags
4629
+ # The tags to assign to the source location. Tags are key-value pairs
4630
+ # that you can associate with Amazon resources to help with
4631
+ # organization, access control, and cost tracking. For more
4632
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
4633
+ #
4634
+ #
4635
+ #
4636
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
4261
4637
  # @return [Hash<String,String>]
4262
4638
  #
4263
4639
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateSourceLocationResponse AWS API Documentation
@@ -4276,8 +4652,6 @@ module Aws::MediaTailor
4276
4652
  include Aws::Structure
4277
4653
  end
4278
4654
 
4279
- # Updates a VOD source's configuration.
4280
- #
4281
4655
  # @note When making an API call, you may pass UpdateVodSourceRequest
4282
4656
  # data as a hash:
4283
4657
  #
@@ -4299,9 +4673,11 @@ module Aws::MediaTailor
4299
4673
  # @return [Array<Types::HttpPackageConfiguration>]
4300
4674
  #
4301
4675
  # @!attribute [rw] source_location_name
4676
+ # The name of the source location associated with this VOD Source.
4302
4677
  # @return [String]
4303
4678
  #
4304
4679
  # @!attribute [rw] vod_source_name
4680
+ # The name of the VOD source.
4305
4681
  # @return [String]
4306
4682
  #
4307
4683
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateVodSourceRequest AWS API Documentation
@@ -4315,25 +4691,39 @@ module Aws::MediaTailor
4315
4691
  end
4316
4692
 
4317
4693
  # @!attribute [rw] arn
4694
+ # The Amazon Resource Name (ARN) associated with the VOD source.
4318
4695
  # @return [String]
4319
4696
  #
4320
4697
  # @!attribute [rw] creation_time
4698
+ # The timestamp that indicates when the VOD source was created.
4321
4699
  # @return [Time]
4322
4700
  #
4323
4701
  # @!attribute [rw] http_package_configurations
4324
- # The VOD source's HTTP package configuration settings.
4702
+ # A list of HTTP package configurations for the VOD source on this
4703
+ # account.
4325
4704
  # @return [Array<Types::HttpPackageConfiguration>]
4326
4705
  #
4327
4706
  # @!attribute [rw] last_modified_time
4707
+ # The timestamp that indicates when the VOD source was last modified.
4328
4708
  # @return [Time]
4329
4709
  #
4330
4710
  # @!attribute [rw] source_location_name
4711
+ # The name of the source location associated with the VOD source.
4331
4712
  # @return [String]
4332
4713
  #
4333
4714
  # @!attribute [rw] tags
4715
+ # The tags to assign to the VOD source. Tags are key-value pairs that
4716
+ # you can associate with Amazon resources to help with organization,
4717
+ # access control, and cost tracking. For more information, see
4718
+ # [Tagging AWS Elemental MediaTailor Resources][1].
4719
+ #
4720
+ #
4721
+ #
4722
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
4334
4723
  # @return [Hash<String,String>]
4335
4724
  #
4336
4725
  # @!attribute [rw] vod_source_name
4726
+ # The name of the VOD source.
4337
4727
  # @return [String]
4338
4728
  #
4339
4729
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateVodSourceResponse AWS API Documentation
@@ -4374,7 +4764,14 @@ module Aws::MediaTailor
4374
4764
  # @return [String]
4375
4765
  #
4376
4766
  # @!attribute [rw] tags
4377
- # The tags assigned to the VOD source.
4767
+ # The tags assigned to the VOD source. Tags are key-value pairs that
4768
+ # you can associate with Amazon resources to help with organization,
4769
+ # access control, and cost tracking. For more information, see
4770
+ # [Tagging AWS Elemental MediaTailor Resources][1].
4771
+ #
4772
+ #
4773
+ #
4774
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
4378
4775
  # @return [Hash<String,String>]
4379
4776
  #
4380
4777
  # @!attribute [rw] vod_source_name