aws-sdk-mediatailor 1.55.0 → 1.57.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
@@ -72,7 +72,7 @@ module Aws::MediaTailor
72
72
  # data as a hash:
73
73
  #
74
74
  # {
75
- # message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT
75
+ # message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT, TIME_SIGNAL
76
76
  # offset_millis: 1,
77
77
  # slate: {
78
78
  # source_location_name: "__string",
@@ -84,10 +84,25 @@ module Aws::MediaTailor
84
84
  # splice_event_id: 1,
85
85
  # unique_program_id: 1,
86
86
  # },
87
+ # time_signal_message: {
88
+ # segmentation_descriptors: [
89
+ # {
90
+ # segment_num: 1,
91
+ # segmentation_event_id: 1,
92
+ # segmentation_type_id: 1,
93
+ # segmentation_upid: "String",
94
+ # segmentation_upid_type: 1,
95
+ # segments_expected: 1,
96
+ # sub_segment_num: 1,
97
+ # sub_segments_expected: 1,
98
+ # },
99
+ # ],
100
+ # },
87
101
  # }
88
102
  #
89
103
  # @!attribute [rw] message_type
90
- # The SCTE-35 ad insertion type. Accepted value: SPLICE\_INSERT.
104
+ # The SCTE-35 ad insertion type. Accepted value: `SPLICE_INSERT`,
105
+ # `TIME_SIGNAL`.
91
106
  # @return [String]
92
107
  #
93
108
  # @!attribute [rw] offset_millis
@@ -101,29 +116,42 @@ module Aws::MediaTailor
101
116
  # @return [Types::SlateSource]
102
117
  #
103
118
  # @!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
119
+ # This defines the SCTE-35 `splice_insert()` message inserted around
120
+ # the ad. For information about using `splice_insert()`, see the
106
121
  # SCTE-35 specficiaiton, section 9.7.3.1.
107
122
  # @return [Types::SpliceInsertMessage]
108
123
  #
124
+ # @!attribute [rw] time_signal_message
125
+ # Defines the SCTE-35 `time_signal` message inserted around the ad.
126
+ #
127
+ # Programs on a channel's schedule can be configured with one or more
128
+ # ad breaks. You can attach a `splice_insert` SCTE-35 message to the
129
+ # ad break. This message provides basic metadata about the ad break.
130
+ #
131
+ # See section 9.7.4 of the 2022 SCTE-35 specification for more
132
+ # information.
133
+ # @return [Types::TimeSignalMessage]
134
+ #
109
135
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/AdBreak AWS API Documentation
110
136
  #
111
137
  class AdBreak < Struct.new(
112
138
  :message_type,
113
139
  :offset_millis,
114
140
  :slate,
115
- :splice_insert_message)
141
+ :splice_insert_message,
142
+ :time_signal_message)
116
143
  SENSITIVE = []
117
144
  include Aws::Structure
118
145
  end
119
146
 
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.
147
+ # For HLS, when set to `true`, MediaTailor passes through
148
+ # `EXT-X-CUE-IN`, `EXT-X-CUE-OUT`, and `EXT-X-SPLICEPOINT-SCTE35` ad
149
+ # markers from the origin manifest to the MediaTailor personalized
150
+ # manifest.
123
151
  #
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.
152
+ # No logic is applied to these ad markers. For example, if
153
+ # `EXT-X-CUE-OUT` has a value of `60`, but no ads are filled for that ad
154
+ # break, MediaTailor will not set the value to `0`.
127
155
  #
128
156
  # @note When making an API call, you may pass AdMarkerPassthrough
129
157
  # data as a hash:
@@ -147,7 +175,7 @@ module Aws::MediaTailor
147
175
  # Alert configuration parameters.
148
176
  #
149
177
  # @!attribute [rw] alert_code
150
- # The code for the alert. For example, NOT\_PROCESSED.
178
+ # The code for the alert. For example, `NOT_PROCESSED`.
151
179
  # @return [String]
152
180
  #
153
181
  # @!attribute [rw] alert_message
@@ -183,20 +211,20 @@ module Aws::MediaTailor
183
211
  # meets the criteria defined by the dynamic variables. This gives you
184
212
  # granular control over which ad break to place the prefetched ads into.
185
213
  #
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?&amp;podId=\[scte.avail\_num\]&amp;event=\[scte.event\_id\]&amp;duration=\[session.avail\_duration\_secs\].
214
+ # As an example, let's say that you set `DynamicVariable` to
215
+ # `scte.event_id` and `Operator` to `EQUALS`, and your playback
216
+ # configuration has an ADS URL of
217
+ # `https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]`.
190
218
  # And the prefetch request to the ADS contains these values
191
- # https://my.ads.server.com/path?&amp;podId=3&amp;event=my-awesome-event&amp;duration=30.
219
+ # `https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30`.
192
220
  # 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.
221
+ # has a SCTE marker with an event id of `my-awesome-event`, since it
222
+ # must match the event id that MediaTailor uses to query the ADS.
195
223
  #
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.
224
+ # You can specify up to five `AvailMatchingCriteria`. If you specify
225
+ # multiple `AvailMatchingCriteria`, MediaTailor combines them to match
226
+ # using a logical `AND`. You can model logical `OR` combinations by
227
+ # creating multiple prefetch schedules.
200
228
  #
201
229
  # @note When making an API call, you may pass AvailMatchingCriteria
202
230
  # data as a hash:
@@ -221,7 +249,7 @@ module Aws::MediaTailor
221
249
  # @return [String]
222
250
  #
223
251
  # @!attribute [rw] operator
224
- # For the DynamicVariable specified in AvailMatchingCriteria, the
252
+ # For the `DynamicVariable` specified in `AvailMatchingCriteria`, the
225
253
  # Operator that is used for the comparison.
226
254
  # @return [String]
227
255
  #
@@ -252,7 +280,7 @@ module Aws::MediaTailor
252
280
  # @!attribute [rw] mode
253
281
  # Sets the ad suppression mode. By default, ad suppression is off and
254
282
  # 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
283
+ # `BEHIND_LIVE_EDGE`, ad suppression is active and MediaTailor won't
256
284
  # fill ad breaks on or behind the ad suppression Value time in the
257
285
  # manifest lookback window.
258
286
  # @return [String]
@@ -281,8 +309,6 @@ module Aws::MediaTailor
281
309
  # A request contains unexpected data.
282
310
  #
283
311
  # @!attribute [rw] message
284
- # Constructs a new BadRequestException with the specified error
285
- # message.
286
312
  # @return [String]
287
313
  #
288
314
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/BadRequestException AWS API Documentation
@@ -342,8 +368,8 @@ module Aws::MediaTailor
342
368
  # By default, AWS Elemental MediaTailor uses Amazon CloudFront with
343
369
  # default cache settings as its CDN for ad segments. To set up an
344
370
  # alternate CDN, create a rule in your CDN for the origin
345
- # ads.mediatailor.&amp;lt;region>.amazonaws.com. Then specify the
346
- # rule's name in this AdSegmentUrlPrefix. When AWS Elemental
371
+ # ads.mediatailor.*&lt;region&gt;*.amazonaws.com. Then specify the
372
+ # rule's name in this `AdSegmentUrlPrefix`. When AWS Elemental
347
373
  # MediaTailor serves a manifest, it reports your CDN as the source for
348
374
  # ad segments.
349
375
  # @return [String]
@@ -353,7 +379,7 @@ module Aws::MediaTailor
353
379
  # content requests don’t always have to go to the origin server.
354
380
  # First, create a rule in your CDN for the content segment origin
355
381
  # server. Then specify the rule's name in this
356
- # ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a
382
+ # `ContentSegmentUrlPrefix`. When AWS Elemental MediaTailor serves a
357
383
  # manifest, it reports your CDN as the source for content segments.
358
384
  # @return [String]
359
385
  #
@@ -366,7 +392,13 @@ module Aws::MediaTailor
366
392
  include Aws::Structure
367
393
  end
368
394
 
369
- # The configuration parameters for a channel.
395
+ # The configuration parameters for a channel. For information about
396
+ # MediaTailor channels, see [Working with channels][1] in the
397
+ # *MediaTailor User Guide*.
398
+ #
399
+ #
400
+ #
401
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html
370
402
  #
371
403
  # @!attribute [rw] arn
372
404
  # The ARN of the channel.
@@ -386,9 +418,9 @@ module Aws::MediaTailor
386
418
  #
387
419
  # @!attribute [rw] filler_slate
388
420
  # 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.
421
+ # must configure filler slate if your channel uses the `LINEAR`
422
+ # `PlaybackMode`. MediaTailor doesn't support filler slate for
423
+ # channels using the `LOOP` `PlaybackMode`.
392
424
  # @return [Types::SlateSource]
393
425
  #
394
426
  # @!attribute [rw] last_modified_time
@@ -402,15 +434,22 @@ module Aws::MediaTailor
402
434
  # @!attribute [rw] playback_mode
403
435
  # The type of playback mode for this channel.
404
436
  #
405
- # LINEAR - Programs play back-to-back only once.
437
+ # `LINEAR` - Programs play back-to-back only once.
406
438
  #
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
439
+ # `LOOP` - Programs play back-to-back in an endless loop. When the
440
+ # last program in the schedule plays, playback loops back to the first
409
441
  # program in the schedule.
410
442
  # @return [String]
411
443
  #
412
444
  # @!attribute [rw] tags
413
- # The tags to assign to the channel.
445
+ # The tags to assign to the channel. Tags are key-value pairs that you
446
+ # can associate with Amazon resources to help with organization,
447
+ # access control, and cost tracking. For more information, see
448
+ # [Tagging AWS Elemental MediaTailor Resources][1].
449
+ #
450
+ #
451
+ #
452
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
414
453
  # @return [Hash<String,String>]
415
454
  #
416
455
  # @!attribute [rw] tier
@@ -435,8 +474,8 @@ module Aws::MediaTailor
435
474
  include Aws::Structure
436
475
  end
437
476
 
438
- # Configures Amazon CloudWatch log settings for an existing MediaTailor
439
- # playback configuration.
477
+ # Configures Amazon CloudWatch log settings for a playback
478
+ # configuration.
440
479
  #
441
480
  # @note When making an API call, you may pass ConfigureLogsForPlaybackConfigurationRequest
442
481
  # data as a hash:
@@ -449,13 +488,13 @@ module Aws::MediaTailor
449
488
  # @!attribute [rw] percent_enabled
450
489
  # The percentage of session logs that MediaTailor sends to your
451
490
  # 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].
491
+ # has 1000 sessions and percentEnabled is set to `60`, MediaTailor
492
+ # sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor
493
+ # decides at random which of the playback configuration sessions to
494
+ # send logs for. If you want to view logs for a specific session, you
495
+ # can use the [debug log mode][1].
457
496
  #
458
- # Valid values: 0 - 100
497
+ # Valid values: `0` - `100`
459
498
  #
460
499
  #
461
500
  #
@@ -475,8 +514,6 @@ module Aws::MediaTailor
475
514
  include Aws::Structure
476
515
  end
477
516
 
478
- # Amazon CloudWatch log settings for a playback configuration.
479
- #
480
517
  # @!attribute [rw] percent_enabled
481
518
  # The percentage of session logs that MediaTailor sends to your
482
519
  # Cloudwatch Logs account.
@@ -495,8 +532,6 @@ module Aws::MediaTailor
495
532
  include Aws::Structure
496
533
  end
497
534
 
498
- # The configuration for this channel.
499
- #
500
535
  # @note When making an API call, you may pass CreateChannelRequest
501
536
  # data as a hash:
502
537
  #
@@ -529,13 +564,14 @@ module Aws::MediaTailor
529
564
  # }
530
565
  #
531
566
  # @!attribute [rw] channel_name
567
+ # The name of the channel.
532
568
  # @return [String]
533
569
  #
534
570
  # @!attribute [rw] filler_slate
535
571
  # 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.
572
+ # must configure filler slate if your channel uses the `LINEAR`
573
+ # `PlaybackMode`. MediaTailor doesn't support filler slate for
574
+ # channels using the `LOOP` `PlaybackMode`.
539
575
  # @return [Types::SlateSource]
540
576
  #
541
577
  # @!attribute [rw] outputs
@@ -545,16 +581,23 @@ module Aws::MediaTailor
545
581
  # @!attribute [rw] playback_mode
546
582
  # The type of playback mode to use for this channel.
547
583
  #
548
- # LINEAR - The programs in the schedule play once back-to-back in the
549
- # schedule.
584
+ # `LINEAR` - The programs in the schedule play once back-to-back in
585
+ # the schedule.
550
586
  #
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.
587
+ # `LOOP` - The programs in the schedule play back-to-back in an
588
+ # endless loop. When the last program in the schedule stops playing,
589
+ # playback loops back to the first program in the schedule.
554
590
  # @return [String]
555
591
  #
556
592
  # @!attribute [rw] tags
557
- # The tags to assign to the channel.
593
+ # The tags to assign to the channel. Tags are key-value pairs that you
594
+ # can associate with Amazon resources to help with organization,
595
+ # access control, and cost tracking. For more information, see
596
+ # [Tagging AWS Elemental MediaTailor Resources][1].
597
+ #
598
+ #
599
+ #
600
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
558
601
  # @return [Hash<String,String>]
559
602
  #
560
603
  # @!attribute [rw] tier
@@ -575,34 +618,51 @@ module Aws::MediaTailor
575
618
  end
576
619
 
577
620
  # @!attribute [rw] arn
621
+ # The Amazon Resource Name (ARN) to assign to the channel.
578
622
  # @return [String]
579
623
  #
580
624
  # @!attribute [rw] channel_name
625
+ # The name to assign to the channel.
581
626
  # @return [String]
582
627
  #
583
628
  # @!attribute [rw] channel_state
629
+ # Indicates whether the channel is in a running state or not.
584
630
  # @return [String]
585
631
  #
586
632
  # @!attribute [rw] creation_time
633
+ # The timestamp of when the channel was created.
587
634
  # @return [Time]
588
635
  #
589
636
  # @!attribute [rw] filler_slate
590
- # Slate VOD source configuration.
637
+ # Contains information about the slate used to fill gaps between
638
+ # programs in the schedule.
591
639
  # @return [Types::SlateSource]
592
640
  #
593
641
  # @!attribute [rw] last_modified_time
642
+ # The timestamp of when the channel was last modified.
594
643
  # @return [Time]
595
644
  #
596
645
  # @!attribute [rw] outputs
646
+ # The output properties to assign to the channel.
597
647
  # @return [Array<Types::ResponseOutputItem>]
598
648
  #
599
649
  # @!attribute [rw] playback_mode
650
+ # The playback mode to assign to the channel.
600
651
  # @return [String]
601
652
  #
602
653
  # @!attribute [rw] tags
654
+ # The tags to assign to the channel. Tags are key-value pairs that you
655
+ # can associate with Amazon resources to help with organization,
656
+ # access control, and cost tracking. For more information, see
657
+ # [Tagging AWS Elemental MediaTailor Resources][1].
658
+ #
659
+ #
660
+ #
661
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
603
662
  # @return [Hash<String,String>]
604
663
  #
605
664
  # @!attribute [rw] tier
665
+ # The tier of the channel.
606
666
  # @return [String]
607
667
  #
608
668
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateChannelResponse AWS API Documentation
@@ -622,8 +682,6 @@ module Aws::MediaTailor
622
682
  include Aws::Structure
623
683
  end
624
684
 
625
- # The live source configuration parameters.
626
- #
627
685
  # @note When making an API call, you may pass CreateLiveSourceRequest
628
686
  # data as a hash:
629
687
  #
@@ -648,13 +706,22 @@ module Aws::MediaTailor
648
706
  # @return [Array<Types::HttpPackageConfiguration>]
649
707
  #
650
708
  # @!attribute [rw] live_source_name
709
+ # The name of the live source.
651
710
  # @return [String]
652
711
  #
653
712
  # @!attribute [rw] source_location_name
713
+ # The name of the source location.
654
714
  # @return [String]
655
715
  #
656
716
  # @!attribute [rw] tags
657
- # The tags to assign to the live source.
717
+ # The tags to assign to the live source. Tags are key-value pairs that
718
+ # you can associate with Amazon resources to help with organization,
719
+ # access control, and cost tracking. For more information, see
720
+ # [Tagging AWS Elemental MediaTailor Resources][1].
721
+ #
722
+ #
723
+ #
724
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
658
725
  # @return [Hash<String,String>]
659
726
  #
660
727
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateLiveSourceRequest AWS API Documentation
@@ -669,25 +736,39 @@ module Aws::MediaTailor
669
736
  end
670
737
 
671
738
  # @!attribute [rw] arn
739
+ # The ARN to assign to the live source.
672
740
  # @return [String]
673
741
  #
674
742
  # @!attribute [rw] creation_time
743
+ # The time the live source was created.
675
744
  # @return [Time]
676
745
  #
677
746
  # @!attribute [rw] http_package_configurations
678
- # The VOD source's HTTP package configuration settings.
747
+ # A list of HTTP package configuration parameters for this live
748
+ # source.
679
749
  # @return [Array<Types::HttpPackageConfiguration>]
680
750
  #
681
751
  # @!attribute [rw] last_modified_time
752
+ # The time the live source was last modified.
682
753
  # @return [Time]
683
754
  #
684
755
  # @!attribute [rw] live_source_name
756
+ # The name to assign to the live source.
685
757
  # @return [String]
686
758
  #
687
759
  # @!attribute [rw] source_location_name
760
+ # The name to assign to the source location of the live source.
688
761
  # @return [String]
689
762
  #
690
763
  # @!attribute [rw] tags
764
+ # The tags to assign to the live source. Tags are key-value pairs that
765
+ # you can associate with Amazon resources to help with organization,
766
+ # access control, and cost tracking. For more information, see
767
+ # [Tagging AWS Elemental MediaTailor Resources][1].
768
+ #
769
+ #
770
+ #
771
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
691
772
  # @return [Hash<String,String>]
692
773
  #
693
774
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateLiveSourceResponse AWS API Documentation
@@ -704,9 +785,6 @@ module Aws::MediaTailor
704
785
  include Aws::Structure
705
786
  end
706
787
 
707
- # A complex type that contains configuration settings for retrieval,
708
- # consumption, and an optional stream ID.
709
- #
710
788
  # @note When making an API call, you may pass CreatePrefetchScheduleRequest
711
789
  # data as a hash:
712
790
  #
@@ -742,9 +820,11 @@ module Aws::MediaTailor
742
820
  # @return [Types::PrefetchConsumption]
743
821
  #
744
822
  # @!attribute [rw] name
823
+ # The name to assign to the schedule request.
745
824
  # @return [String]
746
825
  #
747
826
  # @!attribute [rw] playback_configuration_name
827
+ # The name to assign to the playback configuration.
748
828
  # @return [String]
749
829
  #
750
830
  # @!attribute [rw] retrieval
@@ -756,10 +836,10 @@ module Aws::MediaTailor
756
836
  # @!attribute [rw] stream_id
757
837
  # An optional stream identifier that MediaTailor uses to prefetch ads
758
838
  # 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,
839
+ # `StreamId` is specified, MediaTailor returns all of the prefetch
840
+ # schedules with an exact match on `StreamId`. If not specified,
761
841
  # MediaTailor returns all of the prefetch schedules for the playback
762
- # configuration, regardless of StreamId.
842
+ # configuration, regardless of `StreamId`.
763
843
  # @return [String]
764
844
  #
765
845
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreatePrefetchScheduleRequest AWS API Documentation
@@ -775,26 +855,38 @@ module Aws::MediaTailor
775
855
  end
776
856
 
777
857
  # @!attribute [rw] arn
858
+ # The ARN to assign to the prefetch schedule.
778
859
  # @return [String]
779
860
  #
780
861
  # @!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.
862
+ # The configuration settings for MediaTailor's *consumption* of the
863
+ # prefetched ads from the ad decision server. Each consumption
864
+ # configuration contains an end time and an optional start time that
865
+ # define the *consumption window*. Prefetch schedules automatically
866
+ # expire no earlier than seven days after the end time.
783
867
  # @return [Types::PrefetchConsumption]
784
868
  #
785
869
  # @!attribute [rw] name
870
+ # The name to assign to the prefetch schedule.
786
871
  # @return [String]
787
872
  #
788
873
  # @!attribute [rw] playback_configuration_name
874
+ # The name to assign to the playback configuration.
789
875
  # @return [String]
790
876
  #
791
877
  # @!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.
878
+ # The configuration settings for retrieval of prefetched ads from the
879
+ # ad decision server. Only one set of prefetched ads will be retrieved
880
+ # and subsequently consumed for each ad break.
795
881
  # @return [Types::PrefetchRetrieval]
796
882
  #
797
883
  # @!attribute [rw] stream_id
884
+ # An optional stream identifier that MediaTailor uses to prefetch ads
885
+ # for multiple streams that use the same playback configuration. If
886
+ # `StreamId` is specified, MediaTailor returns all of the prefetch
887
+ # schedules with an exact match on `StreamId`. If not specified,
888
+ # MediaTailor returns all of the prefetch schedules for the playback
889
+ # configuration, regardless of `StreamId`.
798
890
  # @return [String]
799
891
  #
800
892
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreatePrefetchScheduleResponse AWS API Documentation
@@ -810,15 +902,13 @@ module Aws::MediaTailor
810
902
  include Aws::Structure
811
903
  end
812
904
 
813
- # Program configuration parameters.
814
- #
815
905
  # @note When making an API call, you may pass CreateProgramRequest
816
906
  # data as a hash:
817
907
  #
818
908
  # {
819
909
  # ad_breaks: [
820
910
  # {
821
- # message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT
911
+ # message_type: "SPLICE_INSERT", # accepts SPLICE_INSERT, TIME_SIGNAL
822
912
  # offset_millis: 1,
823
913
  # slate: {
824
914
  # source_location_name: "__string",
@@ -830,6 +920,20 @@ module Aws::MediaTailor
830
920
  # splice_event_id: 1,
831
921
  # unique_program_id: 1,
832
922
  # },
923
+ # time_signal_message: {
924
+ # segmentation_descriptors: [
925
+ # {
926
+ # segment_num: 1,
927
+ # segmentation_event_id: 1,
928
+ # segmentation_type_id: 1,
929
+ # segmentation_upid: "String",
930
+ # segmentation_upid_type: 1,
931
+ # segments_expected: 1,
932
+ # sub_segment_num: 1,
933
+ # sub_segments_expected: 1,
934
+ # },
935
+ # ],
936
+ # },
833
937
  # },
834
938
  # ],
835
939
  # channel_name: "__string", # required
@@ -853,6 +957,7 @@ module Aws::MediaTailor
853
957
  # @return [Array<Types::AdBreak>]
854
958
  #
855
959
  # @!attribute [rw] channel_name
960
+ # The name of the channel for this Program.
856
961
  # @return [String]
857
962
  #
858
963
  # @!attribute [rw] live_source_name
@@ -860,6 +965,7 @@ module Aws::MediaTailor
860
965
  # @return [String]
861
966
  #
862
967
  # @!attribute [rw] program_name
968
+ # The name of the Program.
863
969
  # @return [String]
864
970
  #
865
971
  # @!attribute [rw] schedule_configuration
@@ -889,30 +995,39 @@ module Aws::MediaTailor
889
995
  end
890
996
 
891
997
  # @!attribute [rw] ad_breaks
998
+ # The ad break configuration settings.
892
999
  # @return [Array<Types::AdBreak>]
893
1000
  #
894
1001
  # @!attribute [rw] arn
1002
+ # The ARN to assign to the program.
895
1003
  # @return [String]
896
1004
  #
897
1005
  # @!attribute [rw] channel_name
1006
+ # The name to assign to the channel for this program.
898
1007
  # @return [String]
899
1008
  #
900
1009
  # @!attribute [rw] creation_time
1010
+ # The time the program was created.
901
1011
  # @return [Time]
902
1012
  #
903
1013
  # @!attribute [rw] live_source_name
1014
+ # The name of the LiveSource for this Program.
904
1015
  # @return [String]
905
1016
  #
906
1017
  # @!attribute [rw] program_name
1018
+ # The name to assign to this program.
907
1019
  # @return [String]
908
1020
  #
909
1021
  # @!attribute [rw] scheduled_start_time
1022
+ # The scheduled start time for this Program.
910
1023
  # @return [Time]
911
1024
  #
912
1025
  # @!attribute [rw] source_location_name
1026
+ # The name to assign to the source location for this program.
913
1027
  # @return [String]
914
1028
  #
915
1029
  # @!attribute [rw] vod_source_name
1030
+ # The name that's used to refer to a VOD source.
916
1031
  # @return [String]
917
1032
  #
918
1033
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateProgramResponse AWS API Documentation
@@ -931,8 +1046,6 @@ module Aws::MediaTailor
931
1046
  include Aws::Structure
932
1047
  end
933
1048
 
934
- # Source location configuration parameters.
935
- #
936
1049
  # @note When making an API call, you may pass CreateSourceLocationRequest
937
1050
  # data as a hash:
938
1051
  #
@@ -982,10 +1095,18 @@ module Aws::MediaTailor
982
1095
  # @return [Array<Types::SegmentDeliveryConfiguration>]
983
1096
  #
984
1097
  # @!attribute [rw] source_location_name
1098
+ # The name associated with the source location.
985
1099
  # @return [String]
986
1100
  #
987
1101
  # @!attribute [rw] tags
988
- # The tags to assign to the source location.
1102
+ # The tags to assign to the source location. Tags are key-value pairs
1103
+ # that you can associate with Amazon resources to help with
1104
+ # organization, access control, and cost tracking. For more
1105
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
1106
+ #
1107
+ #
1108
+ #
1109
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
989
1110
  # @return [Hash<String,String>]
990
1111
  #
991
1112
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateSourceLocationRequest AWS API Documentation
@@ -1002,39 +1123,53 @@ module Aws::MediaTailor
1002
1123
  end
1003
1124
 
1004
1125
  # @!attribute [rw] access_configuration
1005
- # Access configuration parameters.
1126
+ # Access configuration parameters. Configures the type of
1127
+ # authentication used to access content from your source location.
1006
1128
  # @return [Types::AccessConfiguration]
1007
1129
  #
1008
1130
  # @!attribute [rw] arn
1131
+ # The ARN to assign to the source location.
1009
1132
  # @return [String]
1010
1133
  #
1011
1134
  # @!attribute [rw] creation_time
1135
+ # The time the source location was created.
1012
1136
  # @return [Time]
1013
1137
  #
1014
1138
  # @!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.
1139
+ # The optional configuration for the server that serves segments.
1022
1140
  # @return [Types::DefaultSegmentDeliveryConfiguration]
1023
1141
  #
1024
1142
  # @!attribute [rw] http_configuration
1025
- # The HTTP configuration for the source location.
1143
+ # The source's HTTP package configurations.
1026
1144
  # @return [Types::HttpConfiguration]
1027
1145
  #
1028
1146
  # @!attribute [rw] last_modified_time
1147
+ # The time the source location was last modified.
1029
1148
  # @return [Time]
1030
1149
  #
1031
1150
  # @!attribute [rw] segment_delivery_configurations
1151
+ # The segment delivery configurations for the source location. For
1152
+ # information about MediaTailor configurations, see [Working with
1153
+ # configurations in AWS Elemental MediaTailor][1].
1154
+ #
1155
+ #
1156
+ #
1157
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
1032
1158
  # @return [Array<Types::SegmentDeliveryConfiguration>]
1033
1159
  #
1034
1160
  # @!attribute [rw] source_location_name
1161
+ # The name to assign to the source location.
1035
1162
  # @return [String]
1036
1163
  #
1037
1164
  # @!attribute [rw] tags
1165
+ # The tags to assign to the source location. Tags are key-value pairs
1166
+ # that you can associate with Amazon resources to help with
1167
+ # organization, access control, and cost tracking. For more
1168
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
1169
+ #
1170
+ #
1171
+ #
1172
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1038
1173
  # @return [Hash<String,String>]
1039
1174
  #
1040
1175
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateSourceLocationResponse AWS API Documentation
@@ -1053,8 +1188,6 @@ module Aws::MediaTailor
1053
1188
  include Aws::Structure
1054
1189
  end
1055
1190
 
1056
- # The VOD source configuration parameters.
1057
- #
1058
1191
  # @note When making an API call, you may pass CreateVodSourceRequest
1059
1192
  # data as a hash:
1060
1193
  #
@@ -1078,13 +1211,22 @@ module Aws::MediaTailor
1078
1211
  # @return [Array<Types::HttpPackageConfiguration>]
1079
1212
  #
1080
1213
  # @!attribute [rw] source_location_name
1214
+ # The name of the source location for this VOD source.
1081
1215
  # @return [String]
1082
1216
  #
1083
1217
  # @!attribute [rw] tags
1084
- # The tags to assign to the VOD source.
1218
+ # The tags to assign to the VOD source. Tags are key-value pairs that
1219
+ # you can associate with Amazon resources to help with organization,
1220
+ # access control, and cost tracking. For more information, see
1221
+ # [Tagging AWS Elemental MediaTailor Resources][1].
1222
+ #
1223
+ #
1224
+ #
1225
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1085
1226
  # @return [Hash<String,String>]
1086
1227
  #
1087
1228
  # @!attribute [rw] vod_source_name
1229
+ # The name associated with the VOD source.&gt;
1088
1230
  # @return [String]
1089
1231
  #
1090
1232
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateVodSourceRequest AWS API Documentation
@@ -1099,25 +1241,38 @@ module Aws::MediaTailor
1099
1241
  end
1100
1242
 
1101
1243
  # @!attribute [rw] arn
1244
+ # The ARN to assign to this VOD source.
1102
1245
  # @return [String]
1103
1246
  #
1104
1247
  # @!attribute [rw] creation_time
1248
+ # The time the VOD source was created.
1105
1249
  # @return [Time]
1106
1250
  #
1107
1251
  # @!attribute [rw] http_package_configurations
1108
- # The VOD source's HTTP package configuration settings.
1252
+ # A list of HTTP package configuration parameters for this VOD source.
1109
1253
  # @return [Array<Types::HttpPackageConfiguration>]
1110
1254
  #
1111
1255
  # @!attribute [rw] last_modified_time
1256
+ # The time the VOD source was last modified.
1112
1257
  # @return [Time]
1113
1258
  #
1114
1259
  # @!attribute [rw] source_location_name
1260
+ # The name to assign to the source location for this VOD source.
1115
1261
  # @return [String]
1116
1262
  #
1117
1263
  # @!attribute [rw] tags
1264
+ # The tags to assign to the VOD source. Tags are key-value pairs that
1265
+ # you can associate with Amazon resources to help with organization,
1266
+ # access control, and cost tracking. For more information, see
1267
+ # [Tagging AWS Elemental MediaTailor Resources][1].
1268
+ #
1269
+ #
1270
+ #
1271
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1118
1272
  # @return [Hash<String,String>]
1119
1273
  #
1120
1274
  # @!attribute [rw] vod_source_name
1275
+ # The name to assign to the VOD source.
1121
1276
  # @return [String]
1122
1277
  #
1123
1278
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/CreateVodSourceResponse AWS API Documentation
@@ -1149,18 +1304,18 @@ module Aws::MediaTailor
1149
1304
  # don't support sticky redirects. Disable this if you have CDN
1150
1305
  # routing rules set up for accessing MediaTailor manifests, and you
1151
1306
  # 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.
1307
+ # sticky HTTP redirects. Valid values are `DISABLED` and
1308
+ # `EMT_DEFAULT`. The `EMT_DEFAULT` setting enables the inclusion of
1309
+ # the tag and is the default value.
1155
1310
  # @return [String]
1156
1311
  #
1157
1312
  # @!attribute [rw] origin_manifest_type
1158
1313
  # The setting that controls whether MediaTailor handles manifests from
1159
1314
  # the origin server as multi-period manifests or single-period
1160
1315
  # manifests. If your origin server produces single-period manifests,
1161
- # set this to SINGLE\_PERIOD. The default setting is MULTI\_PERIOD.
1316
+ # set this to `SINGLE_PERIOD`. The default setting is `MULTI_PERIOD`.
1162
1317
  # For multi-period manifests, omit this setting or set it to
1163
- # MULTI\_PERIOD.
1318
+ # `MULTI_PERIOD`.
1164
1319
  # @return [String]
1165
1320
  #
1166
1321
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DashConfiguration AWS API Documentation
@@ -1190,18 +1345,18 @@ module Aws::MediaTailor
1190
1345
  # don't support sticky redirects. Disable this if you have CDN
1191
1346
  # routing rules set up for accessing MediaTailor manifests, and you
1192
1347
  # 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.
1348
+ # sticky HTTP redirects. Valid values are `DISABLED` and
1349
+ # `EMT_DEFAULT`. The `EMT_DEFAULT` setting enables the inclusion of
1350
+ # the tag and is the default value.
1196
1351
  # @return [String]
1197
1352
  #
1198
1353
  # @!attribute [rw] origin_manifest_type
1199
1354
  # The setting that controls whether MediaTailor handles manifests from
1200
1355
  # the origin server as multi-period manifests or single-period
1201
1356
  # manifests. If your origin server produces single-period manifests,
1202
- # set this to SINGLE\_PERIOD. The default setting is MULTI\_PERIOD.
1357
+ # set this to `SINGLE_PERIOD`. The default setting is `MULTI_PERIOD`.
1203
1358
  # For multi-period manifests, omit this setting or set it to
1204
- # MULTI\_PERIOD.
1359
+ # `MULTI_PERIOD`.
1205
1360
  # @return [String]
1206
1361
  #
1207
1362
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DashConfigurationForPut AWS API Documentation
@@ -1226,26 +1381,26 @@ module Aws::MediaTailor
1226
1381
  # }
1227
1382
  #
1228
1383
  # @!attribute [rw] manifest_window_seconds
1229
- # The total duration (in seconds) of each manifest. Minimum value: 30
1230
- # seconds. Maximum value: 3600 seconds.
1384
+ # The total duration (in seconds) of each manifest. Minimum value:
1385
+ # `30` seconds. Maximum value: `3600` seconds.
1231
1386
  # @return [Integer]
1232
1387
  #
1233
1388
  # @!attribute [rw] min_buffer_time_seconds
1234
1389
  # 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.
1390
+ # keep available in the buffer. Minimum value: `2` seconds. Maximum
1391
+ # value: `60` seconds.
1237
1392
  # @return [Integer]
1238
1393
  #
1239
1394
  # @!attribute [rw] min_update_period_seconds
1240
1395
  # 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.
1396
+ # before requesting updates to the manifest. Minimum value: `2`
1397
+ # seconds. Maximum value: `60` seconds.
1243
1398
  # @return [Integer]
1244
1399
  #
1245
1400
  # @!attribute [rw] suggested_presentation_delay_seconds
1246
1401
  # 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.
1402
+ # point at the end of the manifest. Minimum value: `2` seconds.
1403
+ # Maximum value: `60` seconds.
1249
1404
  # @return [Integer]
1250
1405
  #
1251
1406
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DashPlaylistSettings AWS API Documentation
@@ -1287,8 +1442,6 @@ module Aws::MediaTailor
1287
1442
  include Aws::Structure
1288
1443
  end
1289
1444
 
1290
- # This response includes only the "type" : "object" property.
1291
- #
1292
1445
  # @note When making an API call, you may pass DeleteChannelPolicyRequest
1293
1446
  # data as a hash:
1294
1447
  #
@@ -1297,6 +1450,7 @@ module Aws::MediaTailor
1297
1450
  # }
1298
1451
  #
1299
1452
  # @!attribute [rw] channel_name
1453
+ # The name of the channel associated with this channel policy.
1300
1454
  # @return [String]
1301
1455
  #
1302
1456
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelPolicyRequest AWS API Documentation
@@ -1307,8 +1461,6 @@ module Aws::MediaTailor
1307
1461
  include Aws::Structure
1308
1462
  end
1309
1463
 
1310
- # This response includes only the "type" : "object" property.
1311
- #
1312
1464
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelPolicyResponse AWS API Documentation
1313
1465
  #
1314
1466
  class DeleteChannelPolicyResponse < Aws::EmptyStructure; end
@@ -1321,6 +1473,7 @@ module Aws::MediaTailor
1321
1473
  # }
1322
1474
  #
1323
1475
  # @!attribute [rw] channel_name
1476
+ # The name of the channel.
1324
1477
  # @return [String]
1325
1478
  #
1326
1479
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelRequest AWS API Documentation
@@ -1331,8 +1484,6 @@ module Aws::MediaTailor
1331
1484
  include Aws::Structure
1332
1485
  end
1333
1486
 
1334
- # This response includes only the "type" : "object" property.
1335
- #
1336
1487
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteChannelResponse AWS API Documentation
1337
1488
  #
1338
1489
  class DeleteChannelResponse < Aws::EmptyStructure; end
@@ -1346,9 +1497,11 @@ module Aws::MediaTailor
1346
1497
  # }
1347
1498
  #
1348
1499
  # @!attribute [rw] live_source_name
1500
+ # The name of the live source.
1349
1501
  # @return [String]
1350
1502
  #
1351
1503
  # @!attribute [rw] source_location_name
1504
+ # The name of the source location associated with this Live Source.
1352
1505
  # @return [String]
1353
1506
  #
1354
1507
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteLiveSourceRequest AWS API Documentation
@@ -1360,8 +1513,6 @@ module Aws::MediaTailor
1360
1513
  include Aws::Structure
1361
1514
  end
1362
1515
 
1363
- # This response includes only the "type" : "object" property.
1364
- #
1365
1516
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteLiveSourceResponse AWS API Documentation
1366
1517
  #
1367
1518
  class DeleteLiveSourceResponse < Aws::EmptyStructure; end
@@ -1374,6 +1525,7 @@ module Aws::MediaTailor
1374
1525
  # }
1375
1526
  #
1376
1527
  # @!attribute [rw] name
1528
+ # The name of the playback configuration.
1377
1529
  # @return [String]
1378
1530
  #
1379
1531
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePlaybackConfigurationRequest AWS API Documentation
@@ -1397,9 +1549,12 @@ module Aws::MediaTailor
1397
1549
  # }
1398
1550
  #
1399
1551
  # @!attribute [rw] name
1552
+ # The name of the prefetch schedule. If the action is successful, the
1553
+ # service sends back an HTTP 204 response with an empty HTTP body.
1400
1554
  # @return [String]
1401
1555
  #
1402
1556
  # @!attribute [rw] playback_configuration_name
1557
+ # The name of the playback configuration for this prefetch schedule.
1403
1558
  # @return [String]
1404
1559
  #
1405
1560
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePrefetchScheduleRequest AWS API Documentation
@@ -1411,9 +1566,6 @@ module Aws::MediaTailor
1411
1566
  include Aws::Structure
1412
1567
  end
1413
1568
 
1414
- # If the action is successful, the service sends back an HTTP 204
1415
- # response with an empty HTTP body.
1416
- #
1417
1569
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeletePrefetchScheduleResponse AWS API Documentation
1418
1570
  #
1419
1571
  class DeletePrefetchScheduleResponse < Aws::EmptyStructure; end
@@ -1427,9 +1579,11 @@ module Aws::MediaTailor
1427
1579
  # }
1428
1580
  #
1429
1581
  # @!attribute [rw] channel_name
1582
+ # The name of the channel.
1430
1583
  # @return [String]
1431
1584
  #
1432
1585
  # @!attribute [rw] program_name
1586
+ # The name of the program.
1433
1587
  # @return [String]
1434
1588
  #
1435
1589
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteProgramRequest AWS API Documentation
@@ -1441,8 +1595,6 @@ module Aws::MediaTailor
1441
1595
  include Aws::Structure
1442
1596
  end
1443
1597
 
1444
- # This response includes only the "type" : "object" property.
1445
- #
1446
1598
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteProgramResponse AWS API Documentation
1447
1599
  #
1448
1600
  class DeleteProgramResponse < Aws::EmptyStructure; end
@@ -1455,6 +1607,7 @@ module Aws::MediaTailor
1455
1607
  # }
1456
1608
  #
1457
1609
  # @!attribute [rw] source_location_name
1610
+ # The name of the source location.
1458
1611
  # @return [String]
1459
1612
  #
1460
1613
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteSourceLocationRequest AWS API Documentation
@@ -1465,8 +1618,6 @@ module Aws::MediaTailor
1465
1618
  include Aws::Structure
1466
1619
  end
1467
1620
 
1468
- # This response includes only the "type" : "object" property.
1469
- #
1470
1621
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteSourceLocationResponse AWS API Documentation
1471
1622
  #
1472
1623
  class DeleteSourceLocationResponse < Aws::EmptyStructure; end
@@ -1480,9 +1631,11 @@ module Aws::MediaTailor
1480
1631
  # }
1481
1632
  #
1482
1633
  # @!attribute [rw] source_location_name
1634
+ # The name of the source location associated with this VOD Source.
1483
1635
  # @return [String]
1484
1636
  #
1485
1637
  # @!attribute [rw] vod_source_name
1638
+ # The name of the VOD source.
1486
1639
  # @return [String]
1487
1640
  #
1488
1641
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteVodSourceRequest AWS API Documentation
@@ -1494,8 +1647,6 @@ module Aws::MediaTailor
1494
1647
  include Aws::Structure
1495
1648
  end
1496
1649
 
1497
- # This response includes only the "type" : "object" property.
1498
- #
1499
1650
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DeleteVodSourceResponse AWS API Documentation
1500
1651
  #
1501
1652
  class DeleteVodSourceResponse < Aws::EmptyStructure; end
@@ -1508,6 +1659,7 @@ module Aws::MediaTailor
1508
1659
  # }
1509
1660
  #
1510
1661
  # @!attribute [rw] channel_name
1662
+ # The name of the channel.
1511
1663
  # @return [String]
1512
1664
  #
1513
1665
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeChannelRequest AWS API Documentation
@@ -1518,8 +1670,6 @@ module Aws::MediaTailor
1518
1670
  include Aws::Structure
1519
1671
  end
1520
1672
 
1521
- # Returns a channel's properties.
1522
- #
1523
1673
  # @!attribute [rw] arn
1524
1674
  # The ARN of the channel.
1525
1675
  # @return [String]
@@ -1554,7 +1704,14 @@ module Aws::MediaTailor
1554
1704
  # @return [String]
1555
1705
  #
1556
1706
  # @!attribute [rw] tags
1557
- # The tags assigned to the channel.
1707
+ # The tags assigned to the channel. Tags are key-value pairs that you
1708
+ # can associate with Amazon resources to help with organization,
1709
+ # access control, and cost tracking. For more information, see
1710
+ # [Tagging AWS Elemental MediaTailor Resources][1].
1711
+ #
1712
+ #
1713
+ #
1714
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1558
1715
  # @return [Hash<String,String>]
1559
1716
  #
1560
1717
  # @!attribute [rw] tier
@@ -1587,9 +1744,11 @@ module Aws::MediaTailor
1587
1744
  # }
1588
1745
  #
1589
1746
  # @!attribute [rw] live_source_name
1747
+ # The name of the live source.
1590
1748
  # @return [String]
1591
1749
  #
1592
1750
  # @!attribute [rw] source_location_name
1751
+ # The name of the source location associated with this Live Source.
1593
1752
  # @return [String]
1594
1753
  #
1595
1754
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeLiveSourceRequest AWS API Documentation
@@ -1601,8 +1760,6 @@ module Aws::MediaTailor
1601
1760
  include Aws::Structure
1602
1761
  end
1603
1762
 
1604
- # This response includes only the "type" : "object" property.
1605
- #
1606
1763
  # @!attribute [rw] arn
1607
1764
  # The ARN of the live source.
1608
1765
  # @return [String]
@@ -1624,11 +1781,18 @@ module Aws::MediaTailor
1624
1781
  # @return [String]
1625
1782
  #
1626
1783
  # @!attribute [rw] source_location_name
1627
- # The name of the source location associated with the VOD source.
1784
+ # The name of the source location associated with the live source.
1628
1785
  # @return [String]
1629
1786
  #
1630
1787
  # @!attribute [rw] tags
1631
- # The tags assigned to the live source.
1788
+ # The tags assigned to the live source. Tags are key-value pairs that
1789
+ # you can associate with Amazon resources to help with organization,
1790
+ # access control, and cost tracking. For more information, see
1791
+ # [Tagging AWS Elemental MediaTailor Resources][1].
1792
+ #
1793
+ #
1794
+ #
1795
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1632
1796
  # @return [Hash<String,String>]
1633
1797
  #
1634
1798
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeLiveSourceResponse AWS API Documentation
@@ -1654,9 +1818,11 @@ module Aws::MediaTailor
1654
1818
  # }
1655
1819
  #
1656
1820
  # @!attribute [rw] channel_name
1821
+ # The name of the channel associated with this Program.
1657
1822
  # @return [String]
1658
1823
  #
1659
1824
  # @!attribute [rw] program_name
1825
+ # The name of the program.
1660
1826
  # @return [String]
1661
1827
  #
1662
1828
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeProgramRequest AWS API Documentation
@@ -1668,8 +1834,6 @@ module Aws::MediaTailor
1668
1834
  include Aws::Structure
1669
1835
  end
1670
1836
 
1671
- # This program's configuration parameters.
1672
- #
1673
1837
  # @!attribute [rw] ad_breaks
1674
1838
  # The ad break configuration settings.
1675
1839
  # @return [Array<Types::AdBreak>]
@@ -1733,6 +1897,7 @@ module Aws::MediaTailor
1733
1897
  # }
1734
1898
  #
1735
1899
  # @!attribute [rw] source_location_name
1900
+ # The name of the source location.
1736
1901
  # @return [String]
1737
1902
  #
1738
1903
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeSourceLocationRequest AWS API Documentation
@@ -1743,8 +1908,6 @@ module Aws::MediaTailor
1743
1908
  include Aws::Structure
1744
1909
  end
1745
1910
 
1746
- # This response includes only the "type" : "object" property.
1747
- #
1748
1911
  # @!attribute [rw] access_configuration
1749
1912
  # The access configuration for the source location.
1750
1913
  # @return [Types::AccessConfiguration]
@@ -1780,7 +1943,14 @@ module Aws::MediaTailor
1780
1943
  # @return [String]
1781
1944
  #
1782
1945
  # @!attribute [rw] tags
1783
- # The tags assigned to the source location.
1946
+ # The tags assigned to the source location. Tags are key-value pairs
1947
+ # that you can associate with Amazon resources to help with
1948
+ # organization, access control, and cost tracking. For more
1949
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
1950
+ #
1951
+ #
1952
+ #
1953
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1784
1954
  # @return [Hash<String,String>]
1785
1955
  #
1786
1956
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeSourceLocationResponse AWS API Documentation
@@ -1808,9 +1978,11 @@ module Aws::MediaTailor
1808
1978
  # }
1809
1979
  #
1810
1980
  # @!attribute [rw] source_location_name
1981
+ # The name of the source location associated with this VOD Source.
1811
1982
  # @return [String]
1812
1983
  #
1813
1984
  # @!attribute [rw] vod_source_name
1985
+ # The name of the VOD Source.
1814
1986
  # @return [String]
1815
1987
  #
1816
1988
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/DescribeVodSourceRequest AWS API Documentation
@@ -1822,8 +1994,6 @@ module Aws::MediaTailor
1822
1994
  include Aws::Structure
1823
1995
  end
1824
1996
 
1825
- # This response includes only the "type" : "object" property.
1826
- #
1827
1997
  # @!attribute [rw] arn
1828
1998
  # The ARN of the VOD source.
1829
1999
  # @return [String]
@@ -1845,7 +2015,14 @@ module Aws::MediaTailor
1845
2015
  # @return [String]
1846
2016
  #
1847
2017
  # @!attribute [rw] tags
1848
- # The tags assigned to the VOD source.
2018
+ # The tags assigned to the VOD source. Tags are key-value pairs that
2019
+ # you can associate with Amazon resources to help with organization,
2020
+ # access control, and cost tracking. For more information, see
2021
+ # [Tagging AWS Elemental MediaTailor Resources][1].
2022
+ #
2023
+ #
2024
+ #
2025
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
1849
2026
  # @return [Hash<String,String>]
1850
2027
  #
1851
2028
  # @!attribute [rw] vod_source_name
@@ -1874,6 +2051,7 @@ module Aws::MediaTailor
1874
2051
  # }
1875
2052
  #
1876
2053
  # @!attribute [rw] channel_name
2054
+ # The name of the channel associated with this Channel Policy.
1877
2055
  # @return [String]
1878
2056
  #
1879
2057
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelPolicyRequest AWS API Documentation
@@ -1884,10 +2062,9 @@ module Aws::MediaTailor
1884
2062
  include Aws::Structure
1885
2063
  end
1886
2064
 
1887
- # Returns the channel's IAM policy.
1888
- #
1889
2065
  # @!attribute [rw] policy
1890
- # The IAM policy for the channel.
2066
+ # The IAM policy for the channel. IAM policies are used to control
2067
+ # access to your channel.
1891
2068
  # @return [String]
1892
2069
  #
1893
2070
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelPolicyResponse AWS API Documentation
@@ -1909,15 +2086,33 @@ module Aws::MediaTailor
1909
2086
  # }
1910
2087
  #
1911
2088
  # @!attribute [rw] channel_name
2089
+ # The name of the channel associated with this Channel Schedule.
1912
2090
  # @return [String]
1913
2091
  #
1914
2092
  # @!attribute [rw] duration_minutes
2093
+ # The duration in minutes of the channel schedule.
1915
2094
  # @return [String]
1916
2095
  #
1917
2096
  # @!attribute [rw] max_results
2097
+ # The maximum number of channel schedules that you want MediaTailor to
2098
+ # return in response to the current request. If there are more than
2099
+ # `MaxResults` channel schedules, use the value of `NextToken` in the
2100
+ # response to get the next page of results.
1918
2101
  # @return [Integer]
1919
2102
  #
1920
2103
  # @!attribute [rw] next_token
2104
+ # (Optional) If the playback configuration has more than `MaxResults`
2105
+ # channel schedules, use `NextToken` to get the second and subsequent
2106
+ # pages of results.
2107
+ #
2108
+ # For the first `GetChannelScheduleRequest` request, omit this value.
2109
+ #
2110
+ # For the second and subsequent requests, get the value of `NextToken`
2111
+ # from the previous response and specify that value for `NextToken` in
2112
+ # the request.
2113
+ #
2114
+ # If the previous response didn't include a `NextToken` element,
2115
+ # there are no more channel schedules to get.
1921
2116
  # @return [String]
1922
2117
  #
1923
2118
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelScheduleRequest AWS API Documentation
@@ -1931,15 +2126,14 @@ module Aws::MediaTailor
1931
2126
  include Aws::Structure
1932
2127
  end
1933
2128
 
1934
- # Returns the schedule entries for the channel.
1935
- #
1936
2129
  # @!attribute [rw] items
1937
2130
  # A list of schedule entries for the channel.
1938
2131
  # @return [Array<Types::ScheduleEntry>]
1939
2132
  #
1940
2133
  # @!attribute [rw] next_token
1941
- # Pagination token from the GET list request. Use the token to fetch
1942
- # the next page of results.
2134
+ # Pagination token returned by the list request when results exceed
2135
+ # the maximum allowed. Use the token to fetch the next page of
2136
+ # results.
1943
2137
  # @return [String]
1944
2138
  #
1945
2139
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetChannelScheduleResponse AWS API Documentation
@@ -1959,6 +2153,7 @@ module Aws::MediaTailor
1959
2153
  # }
1960
2154
  #
1961
2155
  # @!attribute [rw] name
2156
+ # The identifier for the playback configuration.
1962
2157
  # @return [String]
1963
2158
  #
1964
2159
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPlaybackConfigurationRequest AWS API Documentation
@@ -1969,8 +2164,6 @@ module Aws::MediaTailor
1969
2164
  include Aws::Structure
1970
2165
  end
1971
2166
 
1972
- # Returns the playback configuration for the specified name.
1973
- #
1974
2167
  # @!attribute [rw] ad_decision_server_url
1975
2168
  # The URL for the ad decision server (ADS). This includes the
1976
2169
  # specification of static parameters and placeholders for dynamic
@@ -2082,7 +2275,14 @@ module Aws::MediaTailor
2082
2275
  # @return [String]
2083
2276
  #
2084
2277
  # @!attribute [rw] tags
2085
- # The tags assigned to the playback configuration.
2278
+ # The tags assigned to the playback configuration. Tags are key-value
2279
+ # pairs that you can associate with Amazon resources to help with
2280
+ # organization, access control, and cost tracking. For more
2281
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
2282
+ #
2283
+ #
2284
+ #
2285
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
2086
2286
  # @return [Hash<String,String>]
2087
2287
  #
2088
2288
  # @!attribute [rw] transcode_profile_name
@@ -2132,9 +2332,16 @@ module Aws::MediaTailor
2132
2332
  # }
2133
2333
  #
2134
2334
  # @!attribute [rw] name
2335
+ # The name of the prefetch schedule. The name must be unique among all
2336
+ # prefetch schedules that are associated with the specified playback
2337
+ # configuration.
2135
2338
  # @return [String]
2136
2339
  #
2137
2340
  # @!attribute [rw] playback_configuration_name
2341
+ # Returns information about the prefetch schedule for a specific
2342
+ # playback configuration. If you call `GetPrefetchSchedule` on an
2343
+ # expired prefetch schedule, MediaTailor returns an HTTP 404 status
2344
+ # code.
2138
2345
  # @return [String]
2139
2346
  #
2140
2347
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPrefetchScheduleRequest AWS API Documentation
@@ -2147,26 +2354,37 @@ module Aws::MediaTailor
2147
2354
  end
2148
2355
 
2149
2356
  # @!attribute [rw] arn
2357
+ # The Amazon Resource Name (ARN) of the prefetch schedule.
2150
2358
  # @return [String]
2151
2359
  #
2152
2360
  # @!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.
2361
+ # Consumption settings determine how, and when, MediaTailor places the
2362
+ # prefetched ads into ad breaks. Ad consumption occurs within a span
2363
+ # of time that you define, called a *consumption window*. You can
2364
+ # designate which ad breaks that MediaTailor fills with prefetch ads
2365
+ # by setting avail matching criteria.
2155
2366
  # @return [Types::PrefetchConsumption]
2156
2367
  #
2157
2368
  # @!attribute [rw] name
2369
+ # The name of the prefetch schedule. The name must be unique among all
2370
+ # prefetch schedules that are associated with the specified playback
2371
+ # configuration.
2158
2372
  # @return [String]
2159
2373
  #
2160
2374
  # @!attribute [rw] playback_configuration_name
2375
+ # The name of the playback configuration to create the prefetch
2376
+ # schedule for.
2161
2377
  # @return [String]
2162
2378
  #
2163
2379
  # @!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.
2380
+ # A complex type that contains settings for prefetch retrieval from
2381
+ # the ad decision server (ADS).
2167
2382
  # @return [Types::PrefetchRetrieval]
2168
2383
  #
2169
2384
  # @!attribute [rw] stream_id
2385
+ # An optional stream identifier that you can specify in order to
2386
+ # prefetch for multiple streams that use the same playback
2387
+ # configuration.
2170
2388
  # @return [String]
2171
2389
  #
2172
2390
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/GetPrefetchScheduleResponse AWS API Documentation
@@ -2207,8 +2425,8 @@ module Aws::MediaTailor
2207
2425
  # }
2208
2426
  #
2209
2427
  # @!attribute [rw] manifest_window_seconds
2210
- # The total duration (in seconds) of each manifest. Minimum value: 30
2211
- # seconds. Maximum value: 3600 seconds.
2428
+ # The total duration (in seconds) of each manifest. Minimum value:
2429
+ # `30` seconds. Maximum value: `3600` seconds.
2212
2430
  # @return [Integer]
2213
2431
  #
2214
2432
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/HlsPlaylistSettings AWS API Documentation
@@ -2255,17 +2473,18 @@ module Aws::MediaTailor
2255
2473
  #
2256
2474
  # @!attribute [rw] path
2257
2475
  # The relative path to the URL for this VOD source. This is combined
2258
- # with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.
2476
+ # with `SourceLocation::HttpConfiguration::BaseUrl` to form a valid
2477
+ # URL.
2259
2478
  # @return [String]
2260
2479
  #
2261
2480
  # @!attribute [rw] source_group
2262
2481
  # The name of the source group. This has to match one of the
2263
- # Channel::Outputs::SourceGroup.
2482
+ # `Channel::Outputs::SourceGroup`.
2264
2483
  # @return [String]
2265
2484
  #
2266
2485
  # @!attribute [rw] type
2267
2486
  # The streaming protocol for this package configuration. Supported
2268
- # values are HLS and DASH.
2487
+ # values are `HLS` and `DASH`.
2269
2488
  # @return [String]
2270
2489
  #
2271
2490
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/HttpPackageConfiguration AWS API Documentation
@@ -2288,12 +2507,20 @@ module Aws::MediaTailor
2288
2507
  # }
2289
2508
  #
2290
2509
  # @!attribute [rw] max_results
2510
+ # The maximum number of alerts that you want MediaTailor to return in
2511
+ # response to the current request. If there are more than `MaxResults`
2512
+ # alerts, use the value of `NextToken` in the response to get the next
2513
+ # page of results.
2291
2514
  # @return [Integer]
2292
2515
  #
2293
2516
  # @!attribute [rw] next_token
2517
+ # Pagination token returned by the list request when results exceed
2518
+ # the maximum allowed. Use the token to fetch the next page of
2519
+ # results.
2294
2520
  # @return [String]
2295
2521
  #
2296
2522
  # @!attribute [rw] resource_arn
2523
+ # The Amazon Resource Name (ARN) of the resource.
2297
2524
  # @return [String]
2298
2525
  #
2299
2526
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListAlertsRequest AWS API Documentation
@@ -2306,15 +2533,14 @@ module Aws::MediaTailor
2306
2533
  include Aws::Structure
2307
2534
  end
2308
2535
 
2309
- # Lists the alerts for a given resource.
2310
- #
2311
2536
  # @!attribute [rw] items
2312
2537
  # A list of alerts that are associated with this resource.
2313
2538
  # @return [Array<Types::Alert>]
2314
2539
  #
2315
2540
  # @!attribute [rw] next_token
2316
- # Pagination token from the list request. Use the token to fetch the
2317
- # next page of results.
2541
+ # Pagination token returned by the list request when results exceed
2542
+ # the maximum allowed. Use the token to fetch the next page of
2543
+ # results.
2318
2544
  # @return [String]
2319
2545
  #
2320
2546
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListAlertsResponse AWS API Documentation
@@ -2335,9 +2561,16 @@ module Aws::MediaTailor
2335
2561
  # }
2336
2562
  #
2337
2563
  # @!attribute [rw] max_results
2564
+ # The maximum number of channels that you want MediaTailor to return
2565
+ # in response to the current request. If there are more than
2566
+ # `MaxResults` channels, use the value of `NextToken` in the response
2567
+ # to get the next page of results.
2338
2568
  # @return [Integer]
2339
2569
  #
2340
2570
  # @!attribute [rw] next_token
2571
+ # Pagination token returned by the list request when results exceed
2572
+ # the maximum allowed. Use the token to fetch the next page of
2573
+ # results.
2341
2574
  # @return [String]
2342
2575
  #
2343
2576
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListChannelsRequest AWS API Documentation
@@ -2349,8 +2582,6 @@ module Aws::MediaTailor
2349
2582
  include Aws::Structure
2350
2583
  end
2351
2584
 
2352
- # Returns a list of channels.
2353
- #
2354
2585
  # @!attribute [rw] items
2355
2586
  # A list of channels that are associated with this account.
2356
2587
  # @return [Array<Types::Channel>]
@@ -2380,12 +2611,21 @@ module Aws::MediaTailor
2380
2611
  # }
2381
2612
  #
2382
2613
  # @!attribute [rw] max_results
2614
+ # The maximum number of live sources that you want MediaTailor to
2615
+ # return in response to the current request. If there are more than
2616
+ # `MaxResults` live sources, use the value of `NextToken` in the
2617
+ # response to get the next page of results.
2383
2618
  # @return [Integer]
2384
2619
  #
2385
2620
  # @!attribute [rw] next_token
2621
+ # Pagination token returned by the list request when results exceed
2622
+ # the maximum allowed. Use the token to fetch the next page of
2623
+ # results.
2386
2624
  # @return [String]
2387
2625
  #
2388
2626
  # @!attribute [rw] source_location_name
2627
+ # The name of the source location associated with this Live Sources
2628
+ # list.
2389
2629
  # @return [String]
2390
2630
  #
2391
2631
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListLiveSourcesRequest AWS API Documentation
@@ -2398,15 +2638,14 @@ module Aws::MediaTailor
2398
2638
  include Aws::Structure
2399
2639
  end
2400
2640
 
2401
- # A list of your live sources.
2402
- #
2403
2641
  # @!attribute [rw] items
2404
2642
  # Lists the live sources.
2405
2643
  # @return [Array<Types::LiveSource>]
2406
2644
  #
2407
2645
  # @!attribute [rw] next_token
2408
- # Pagination token from the list request. Use the token to fetch the
2409
- # next page of results.
2646
+ # Pagination token returned by the list request when results exceed
2647
+ # the maximum allowed. Use the token to fetch the next page of
2648
+ # results.
2410
2649
  # @return [String]
2411
2650
  #
2412
2651
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListLiveSourcesResponse AWS API Documentation
@@ -2427,9 +2666,16 @@ module Aws::MediaTailor
2427
2666
  # }
2428
2667
  #
2429
2668
  # @!attribute [rw] max_results
2669
+ # The maximum number of playback configurations that you want
2670
+ # MediaTailor to return in response to the current request. If there
2671
+ # are more than `MaxResults` playback configurations, use the value of
2672
+ # `NextToken` in the response to get the next page of results.
2430
2673
  # @return [Integer]
2431
2674
  #
2432
2675
  # @!attribute [rw] next_token
2676
+ # Pagination token returned by the list request when results exceed
2677
+ # the maximum allowed. Use the token to fetch the next page of
2678
+ # results.
2433
2679
  # @return [String]
2434
2680
  #
2435
2681
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListPlaybackConfigurationsRequest AWS API Documentation
@@ -2441,8 +2687,6 @@ module Aws::MediaTailor
2441
2687
  include Aws::Structure
2442
2688
  end
2443
2689
 
2444
- # Returns a list of playback configurations.
2445
- #
2446
2690
  # @!attribute [rw] items
2447
2691
  # Array of playback configurations. This might be all the available
2448
2692
  # configurations or a subset, depending on the settings that you
@@ -2464,9 +2708,6 @@ module Aws::MediaTailor
2464
2708
  include Aws::Structure
2465
2709
  end
2466
2710
 
2467
- # Retrieves the prefetch schedule(s) for a specific playback
2468
- # configuration.
2469
- #
2470
2711
  # @note When making an API call, you may pass ListPrefetchSchedulesRequest
2471
2712
  # data as a hash:
2472
2713
  #
@@ -2479,27 +2720,30 @@ module Aws::MediaTailor
2479
2720
  #
2480
2721
  # @!attribute [rw] max_results
2481
2722
  # 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.
2723
+ # to return in response to the current request. If there are more than
2724
+ # `MaxResults` prefetch schedules, use the value of `NextToken` in the
2725
+ # response to get the next page of results.
2485
2726
  # @return [Integer]
2486
2727
  #
2487
2728
  # @!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
2729
+ # (Optional) If the playback configuration has more than `MaxResults`
2730
+ # prefetch schedules, use `NextToken` to get the second and subsequent
2490
2731
  # pages of results.
2491
2732
  #
2492
- # For the first ListPrefetchSchedulesRequest request, omit this value.
2733
+ # For the first `ListPrefetchSchedulesRequest` request, omit this
2734
+ # value.
2493
2735
  #
2494
- # For the second and subsequent requests, get the value of NextToken
2495
- # from the previous response and specify that value for NextToken in
2736
+ # For the second and subsequent requests, get the value of `NextToken`
2737
+ # from the previous response and specify that value for `NextToken` in
2496
2738
  # the request.
2497
2739
  #
2498
- # If the previous response didn't include a NextToken element, there
2499
- # are no more prefetch schedules to get.
2740
+ # If the previous response didn't include a `NextToken` element,
2741
+ # there are no more prefetch schedules to get.
2500
2742
  # @return [String]
2501
2743
  #
2502
2744
  # @!attribute [rw] playback_configuration_name
2745
+ # Retrieves the prefetch schedule(s) for a specific playback
2746
+ # configuration.
2503
2747
  # @return [String]
2504
2748
  #
2505
2749
  # @!attribute [rw] stream_id
@@ -2518,16 +2762,15 @@ module Aws::MediaTailor
2518
2762
  include Aws::Structure
2519
2763
  end
2520
2764
 
2521
- # The list of prefetch schedules.
2522
- #
2523
2765
  # @!attribute [rw] items
2524
- # Lists the prefetch schedules. An empty Items list doesn't mean
2766
+ # Lists the prefetch schedules. An empty `Items` list doesn't mean
2525
2767
  # there aren't more items to fetch, just that that page was empty.
2526
2768
  # @return [Array<Types::PrefetchSchedule>]
2527
2769
  #
2528
2770
  # @!attribute [rw] next_token
2529
- # The value that you will use forNextToken in the next
2530
- # ListPrefetchSchedulesRequest request.
2771
+ # Pagination token returned by the list request when results exceed
2772
+ # the maximum allowed. Use the token to fetch the next page of
2773
+ # results.
2531
2774
  # @return [String]
2532
2775
  #
2533
2776
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListPrefetchSchedulesResponse AWS API Documentation
@@ -2548,9 +2791,16 @@ module Aws::MediaTailor
2548
2791
  # }
2549
2792
  #
2550
2793
  # @!attribute [rw] max_results
2794
+ # The maximum number of source locations that you want MediaTailor to
2795
+ # return in response to the current request. If there are more than
2796
+ # `MaxResults` source locations, use the value of `NextToken` in the
2797
+ # response to get the next page of results.
2551
2798
  # @return [Integer]
2552
2799
  #
2553
2800
  # @!attribute [rw] next_token
2801
+ # Pagination token returned by the list request when results exceed
2802
+ # the maximum allowed. Use the token to fetch the next page of
2803
+ # results.
2554
2804
  # @return [String]
2555
2805
  #
2556
2806
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListSourceLocationsRequest AWS API Documentation
@@ -2562,15 +2812,14 @@ module Aws::MediaTailor
2562
2812
  include Aws::Structure
2563
2813
  end
2564
2814
 
2565
- # Lists the source locations.
2566
- #
2567
2815
  # @!attribute [rw] items
2568
2816
  # A list of source locations.
2569
2817
  # @return [Array<Types::SourceLocation>]
2570
2818
  #
2571
2819
  # @!attribute [rw] next_token
2572
- # Pagination token from the list request. Use the token to fetch the
2573
- # next page of results.
2820
+ # Pagination token returned by the list request when results exceed
2821
+ # the maximum allowed. Use the token to fetch the next page of
2822
+ # results.
2574
2823
  # @return [String]
2575
2824
  #
2576
2825
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListSourceLocationsResponse AWS API Documentation
@@ -2590,6 +2839,7 @@ module Aws::MediaTailor
2590
2839
  # }
2591
2840
  #
2592
2841
  # @!attribute [rw] resource_arn
2842
+ # The Amazon Resource Name (ARN) associated with this resource.
2593
2843
  # @return [String]
2594
2844
  #
2595
2845
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListTagsForResourceRequest AWS API Documentation
@@ -2601,6 +2851,14 @@ module Aws::MediaTailor
2601
2851
  end
2602
2852
 
2603
2853
  # @!attribute [rw] tags
2854
+ # The tags associated with this resource. Tags are key-value pairs
2855
+ # that you can associate with Amazon resources to help with
2856
+ # organization, access control, and cost tracking. For more
2857
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
2858
+ #
2859
+ #
2860
+ #
2861
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
2604
2862
  # @return [Hash<String,String>]
2605
2863
  #
2606
2864
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListTagsForResourceResponse AWS API Documentation
@@ -2621,12 +2879,21 @@ module Aws::MediaTailor
2621
2879
  # }
2622
2880
  #
2623
2881
  # @!attribute [rw] max_results
2882
+ # The maximum number of VOD sources that you want MediaTailor to
2883
+ # return in response to the current request. If there are more than
2884
+ # `MaxResults` VOD sources, use the value of `NextToken` in the
2885
+ # response to get the next page of results.
2624
2886
  # @return [Integer]
2625
2887
  #
2626
2888
  # @!attribute [rw] next_token
2889
+ # Pagination token returned by the list request when results exceed
2890
+ # the maximum allowed. Use the token to fetch the next page of
2891
+ # results.
2627
2892
  # @return [String]
2628
2893
  #
2629
2894
  # @!attribute [rw] source_location_name
2895
+ # The name of the source location associated with this VOD Source
2896
+ # list.
2630
2897
  # @return [String]
2631
2898
  #
2632
2899
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListVodSourcesRequest AWS API Documentation
@@ -2639,15 +2906,14 @@ module Aws::MediaTailor
2639
2906
  include Aws::Structure
2640
2907
  end
2641
2908
 
2642
- # A list of VOD sources.
2643
- #
2644
2909
  # @!attribute [rw] items
2645
2910
  # Lists the VOD sources.
2646
2911
  # @return [Array<Types::VodSource>]
2647
2912
  #
2648
2913
  # @!attribute [rw] next_token
2649
- # Pagination token from the list request. Use the token to fetch the
2650
- # next page of results.
2914
+ # Pagination token returned by the list request when results exceed
2915
+ # the maximum allowed. Use the token to fetch the next page of
2916
+ # results.
2651
2917
  # @return [String]
2652
2918
  #
2653
2919
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ListVodSourcesResponse AWS API Documentation
@@ -2721,7 +2987,14 @@ module Aws::MediaTailor
2721
2987
  # @return [String]
2722
2988
  #
2723
2989
  # @!attribute [rw] tags
2724
- # The tags assigned to the live source.
2990
+ # The tags assigned to the live source. Tags are key-value pairs that
2991
+ # you can associate with Amazon resources to help with organization,
2992
+ # access control, and cost tracking. For more information, see
2993
+ # [Tagging AWS Elemental MediaTailor Resources][1].
2994
+ #
2995
+ #
2996
+ #
2997
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
2725
2998
  # @return [Hash<String,String>]
2726
2999
  #
2727
3000
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/LiveSource AWS API Documentation
@@ -2743,13 +3016,13 @@ module Aws::MediaTailor
2743
3016
  # @!attribute [rw] percent_enabled
2744
3017
  # The percentage of session logs that MediaTailor sends to your
2745
3018
  # 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].
3019
+ # has 1000 sessions and `percentEnabled` is set to `60`, MediaTailor
3020
+ # sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor
3021
+ # decides at random which of the playback configuration sessions to
3022
+ # send logs for. If you want to view logs for a specific session, you
3023
+ # can use the [debug log mode][1].
2751
3024
  #
2752
- # Valid values: 0 - 100
3025
+ # Valid values: `0` - `100`
2753
3026
  #
2754
3027
  #
2755
3028
  #
@@ -2778,13 +3051,14 @@ module Aws::MediaTailor
2778
3051
  # }
2779
3052
  #
2780
3053
  # @!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.
3054
+ # For HLS, when set to `true`, MediaTailor passes through
3055
+ # `EXT-X-CUE-IN`, `EXT-X-CUE-OUT`, and `EXT-X-SPLICEPOINT-SCTE35` ad
3056
+ # markers from the origin manifest to the MediaTailor personalized
3057
+ # manifest.
2784
3058
  #
2785
3059
  # 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.
3060
+ # `EXT-X-CUE-OUT` has a value of `60`, but no ads are filled for that
3061
+ # ad break, MediaTailor will not set the value to `0`.
2788
3062
  # @return [Types::AdMarkerPassthrough]
2789
3063
  #
2790
3064
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/ManifestProcessingRules AWS API Documentation
@@ -2795,7 +3069,7 @@ module Aws::MediaTailor
2795
3069
  include Aws::Structure
2796
3070
  end
2797
3071
 
2798
- # Creates a playback configuration. For information about MediaTailor
3072
+ # A playback configuration. For information about MediaTailor
2799
3073
  # configurations, see [Working with configurations in AWS Elemental
2800
3074
  # MediaTailor][1].
2801
3075
  #
@@ -2914,7 +3188,14 @@ module Aws::MediaTailor
2914
3188
  # @return [String]
2915
3189
  #
2916
3190
  # @!attribute [rw] tags
2917
- # The tags to assign to the playback configuration.
3191
+ # The tags to assign to the playback configuration. Tags are key-value
3192
+ # pairs that you can associate with Amazon resources to help with
3193
+ # organization, access control, and cost tracking. For more
3194
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
3195
+ #
3196
+ #
3197
+ #
3198
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
2918
3199
  # @return [Hash<String,String>]
2919
3200
  #
2920
3201
  # @!attribute [rw] transcode_profile_name
@@ -2975,7 +3256,7 @@ module Aws::MediaTailor
2975
3256
  # @!attribute [rw] avail_matching_criteria
2976
3257
  # If you only want MediaTailor to insert prefetched ads into avails
2977
3258
  # (ad breaks) that match specific dynamic variables, such as
2978
- # scte.event\_id, set the avail matching criteria.
3259
+ # `scte.event_id`, set the avail matching criteria.
2979
3260
  # @return [Array<Types::AvailMatchingCriteria>]
2980
3261
  #
2981
3262
  # @!attribute [rw] end_time
@@ -2983,12 +3264,12 @@ module Aws::MediaTailor
2983
3264
  # use in an ad break. MediaTailor automatically deletes prefetch
2984
3265
  # schedules no less than seven days after the end time. If you'd like
2985
3266
  # to manually delete the prefetch schedule, you can call
2986
- # DeletePrefetchSchedule.
3267
+ # `DeletePrefetchSchedule`.
2987
3268
  # @return [Time]
2988
3269
  #
2989
3270
  # @!attribute [rw] start_time
2990
3271
  # 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
3272
+ # If you don't specify `StartTime`, the prefetched ads are available
2992
3273
  # after MediaTailor retrives them from the ad decision server.
2993
3274
  # @return [Time]
2994
3275
  #
@@ -3021,9 +3302,9 @@ module Aws::MediaTailor
3021
3302
  # The dynamic variables to use for substitution during prefetch
3022
3303
  # requests to the ad decision server (ADS).
3023
3304
  #
3024
- # You intially configure [dynamic variables][1] for the ADS URL when
3305
+ # You initially configure [dynamic variables][1] for the ADS URL when
3025
3306
  # you set up your playback configuration. When you specify
3026
- # DynamicVariables for prefetch retrieval, MediaTailor includes the
3307
+ # `DynamicVariables` for prefetch retrieval, MediaTailor includes the
3027
3308
  # dynamic variables in the request to the ADS.
3028
3309
  #
3029
3310
  #
@@ -3054,7 +3335,14 @@ module Aws::MediaTailor
3054
3335
  include Aws::Structure
3055
3336
  end
3056
3337
 
3057
- # A complex type that contains prefetch schedule information.
3338
+ # A prefetch schedule allows you to tell MediaTailor to fetch and
3339
+ # prepare certain ads before an ad break happens. For more information
3340
+ # about ad prefetching, see [Using ad prefetching][1] in the
3341
+ # *MediaTailor User Guide*.
3342
+ #
3343
+ #
3344
+ #
3345
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html
3058
3346
  #
3059
3347
  # @!attribute [rw] arn
3060
3348
  # The Amazon Resource Name (ARN) of the prefetch schedule.
@@ -3103,8 +3391,6 @@ module Aws::MediaTailor
3103
3391
  include Aws::Structure
3104
3392
  end
3105
3393
 
3106
- # Adds an IAM policy for the channel.
3107
- #
3108
3394
  # @note When making an API call, you may pass PutChannelPolicyRequest
3109
3395
  # data as a hash:
3110
3396
  #
@@ -3114,6 +3400,7 @@ module Aws::MediaTailor
3114
3400
  # }
3115
3401
  #
3116
3402
  # @!attribute [rw] channel_name
3403
+ # The channel name associated with this Channel Policy.
3117
3404
  # @return [String]
3118
3405
  #
3119
3406
  # @!attribute [rw] policy
@@ -3129,14 +3416,10 @@ module Aws::MediaTailor
3129
3416
  include Aws::Structure
3130
3417
  end
3131
3418
 
3132
- # This response includes only the "type" : "object" property.
3133
- #
3134
3419
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PutChannelPolicyResponse AWS API Documentation
3135
3420
  #
3136
3421
  class PutChannelPolicyResponse < Aws::EmptyStructure; end
3137
3422
 
3138
- # The configuration for creating a playback configuration.
3139
- #
3140
3423
  # @note When making an API call, you may pass PutPlaybackConfigurationRequest
3141
3424
  # data as a hash:
3142
3425
  #
@@ -3172,7 +3455,7 @@ module Aws::MediaTailor
3172
3455
  # enabled: false,
3173
3456
  # },
3174
3457
  # },
3175
- # name: "__string",
3458
+ # name: "__string", # required
3176
3459
  # personalization_threshold_seconds: 1,
3177
3460
  # slate_ad_url: "__string",
3178
3461
  # tags: {
@@ -3271,7 +3554,14 @@ module Aws::MediaTailor
3271
3554
  # @return [String]
3272
3555
  #
3273
3556
  # @!attribute [rw] tags
3274
- # The tags to assign to the playback configuration.
3557
+ # The tags to assign to the playback configuration. Tags are key-value
3558
+ # pairs that you can associate with Amazon resources to help with
3559
+ # organization, access control, and cost tracking. For more
3560
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
3561
+ #
3562
+ #
3563
+ #
3564
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
3275
3565
  # @return [Hash<String,String>]
3276
3566
  #
3277
3567
  # @!attribute [rw] transcode_profile_name
@@ -3308,6 +3598,12 @@ module Aws::MediaTailor
3308
3598
  end
3309
3599
 
3310
3600
  # @!attribute [rw] ad_decision_server_url
3601
+ # The URL for the ad decision server (ADS). This includes the
3602
+ # specification of static parameters and placeholders for dynamic
3603
+ # parameters. AWS Elemental MediaTailor substitutes player-specific
3604
+ # and session-specific parameters as needed when calling the ADS.
3605
+ # Alternately, for testing you can provide a static VAST URL. The
3606
+ # maximum length is 25,000 characters.
3311
3607
  # @return [String]
3312
3608
  #
3313
3609
  # @!attribute [rw] avail_suppression
@@ -3336,7 +3632,13 @@ module Aws::MediaTailor
3336
3632
  # @return [Types::CdnConfiguration]
3337
3633
  #
3338
3634
  # @!attribute [rw] configuration_aliases
3339
- # The predefined aliases for dynamic variables.
3635
+ # The player parameters and aliases used as dynamic variables during
3636
+ # session initialization. For more information, see [Domain
3637
+ # Variables][1].
3638
+ #
3639
+ #
3640
+ #
3641
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html
3340
3642
  # @return [Hash<String,Hash<String,String>>]
3341
3643
  #
3342
3644
  # @!attribute [rw] dash_configuration
@@ -3352,7 +3654,7 @@ module Aws::MediaTailor
3352
3654
  # @return [Types::LivePreRollConfiguration]
3353
3655
  #
3354
3656
  # @!attribute [rw] log_configuration
3355
- # Returns Amazon CloudWatch log settings for a playback configuration.
3657
+ # The Amazon CloudWatch log settings for a playback configuration.
3356
3658
  # @return [Types::LogConfiguration]
3357
3659
  #
3358
3660
  # @!attribute [rw] manifest_processing_rules
@@ -3362,30 +3664,71 @@ module Aws::MediaTailor
3362
3664
  # @return [Types::ManifestProcessingRules]
3363
3665
  #
3364
3666
  # @!attribute [rw] name
3667
+ # The identifier for the playback configuration.
3365
3668
  # @return [String]
3366
3669
  #
3367
3670
  # @!attribute [rw] personalization_threshold_seconds
3671
+ # Defines the maximum duration of underfilled ad time (in seconds)
3672
+ # allowed in an ad break. If the duration of underfilled ad time
3673
+ # exceeds the personalization threshold, then the personalization of
3674
+ # the ad break is abandoned and the underlying content is shown. This
3675
+ # feature applies to *ad replacement* in live and VOD streams, rather
3676
+ # than ad insertion, because it relies on an underlying content
3677
+ # stream. For more information about ad break behavior, including ad
3678
+ # replacement and insertion, see [Ad Behavior in AWS Elemental
3679
+ # MediaTailor][1].
3680
+ #
3681
+ #
3682
+ #
3683
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html
3368
3684
  # @return [Integer]
3369
3685
  #
3370
3686
  # @!attribute [rw] playback_configuration_arn
3687
+ # The Amazon Resource Name (ARN) associated with the playback
3688
+ # configuration.
3371
3689
  # @return [String]
3372
3690
  #
3373
3691
  # @!attribute [rw] playback_endpoint_prefix
3692
+ # The playback endpoint prefix associated with the playback
3693
+ # configuration.
3374
3694
  # @return [String]
3375
3695
  #
3376
3696
  # @!attribute [rw] session_initialization_endpoint_prefix
3697
+ # The session initialization endpoint prefix associated with the
3698
+ # playback configuration.
3377
3699
  # @return [String]
3378
3700
  #
3379
3701
  # @!attribute [rw] slate_ad_url
3702
+ # The URL for a high-quality video asset to transcode and use to fill
3703
+ # in time that's not used by ads. AWS Elemental MediaTailor shows the
3704
+ # slate to fill in gaps in media content. Configuring the slate is
3705
+ # optional for non-VPAID configurations. For VPAID, the slate is
3706
+ # required because MediaTailor provides it in the slots that are
3707
+ # designated for dynamic ad content. The slate must be a high-quality
3708
+ # asset that contains both audio and video.
3380
3709
  # @return [String]
3381
3710
  #
3382
3711
  # @!attribute [rw] tags
3712
+ # The tags to assign to the playback configuration. Tags are key-value
3713
+ # pairs that you can associate with Amazon resources to help with
3714
+ # organization, access control, and cost tracking. For more
3715
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
3716
+ #
3717
+ #
3718
+ #
3719
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
3383
3720
  # @return [Hash<String,String>]
3384
3721
  #
3385
3722
  # @!attribute [rw] transcode_profile_name
3723
+ # The name that is used to associate this playback configuration with
3724
+ # a custom transcode profile. This overrides the dynamic transcoding
3725
+ # defaults of MediaTailor. Use this only if you have already set up
3726
+ # custom profiles with the help of AWS Support.
3386
3727
  # @return [String]
3387
3728
  #
3388
3729
  # @!attribute [rw] video_content_source_url
3730
+ # The URL prefix for the parent manifest for the stream, minus the
3731
+ # asset ID. The maximum length is 512 characters.
3389
3732
  # @return [String]
3390
3733
  #
3391
3734
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/PutPlaybackConfigurationResponse AWS API Documentation
@@ -3443,12 +3786,12 @@ module Aws::MediaTailor
3443
3786
  #
3444
3787
  # @!attribute [rw] manifest_name
3445
3788
  # The name of the manifest for the channel. The name appears in the
3446
- # PlaybackUrl.
3789
+ # `PlaybackUrl`.
3447
3790
  # @return [String]
3448
3791
  #
3449
3792
  # @!attribute [rw] source_group
3450
- # A string used to match which HttpPackageConfiguration is used for
3451
- # each VodSource.
3793
+ # A string used to match which `HttpPackageConfiguration` is used for
3794
+ # each `VodSource`.
3452
3795
  # @return [String]
3453
3796
  #
3454
3797
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/RequestOutputItem AWS API Documentation
@@ -3462,7 +3805,7 @@ module Aws::MediaTailor
3462
3805
  include Aws::Structure
3463
3806
  end
3464
3807
 
3465
- # This response includes only the "property" : "type" property.
3808
+ # The output item response.
3466
3809
  #
3467
3810
  # @!attribute [rw] dash_playlist_settings
3468
3811
  # DASH manifest configuration settings.
@@ -3588,8 +3931,6 @@ module Aws::MediaTailor
3588
3931
  #
3589
3932
  # @!attribute [rw] schedule_entry_type
3590
3933
  # The type of schedule entry.
3591
- #
3592
- # Valid values: PROGRAM or FILLER\_SLATE.
3593
3934
  # @return [String]
3594
3935
  #
3595
3936
  # @!attribute [rw] source_location_name
@@ -3664,11 +4005,7 @@ module Aws::MediaTailor
3664
4005
  include Aws::Structure
3665
4006
  end
3666
4007
 
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*.
4008
+ # The segment delivery configuration settings.
3672
4009
  #
3673
4010
  # @note When making an API call, you may pass SegmentDeliveryConfiguration
3674
4011
  # data as a hash:
@@ -3683,8 +4020,8 @@ module Aws::MediaTailor
3683
4020
  # you're using to serve segments. This is typically a content
3684
4021
  # delivery network (CDN). The URL can be absolute or relative. To use
3685
4022
  # 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*.
4023
+ # `https://example.com/some/path`. To use a relative URL specify the
4024
+ # relative path, such as `/some/path*`.
3688
4025
  # @return [String]
3689
4026
  #
3690
4027
  # @!attribute [rw] name
@@ -3701,6 +4038,104 @@ module Aws::MediaTailor
3701
4038
  include Aws::Structure
3702
4039
  end
3703
4040
 
4041
+ # The `segmentation_descriptor` message can contain advanced metadata
4042
+ # fields, like content identifiers, to convey a wide range of
4043
+ # information about the ad break. MediaTailor writes the ad metadata in
4044
+ # the egress manifest as part of the `EXT-X-DATERANGE` or `EventStream`
4045
+ # ad marker's SCTE-35 data.
4046
+ #
4047
+ # `segmentation_descriptor` messages must be sent with the `time_signal`
4048
+ # message type.
4049
+ #
4050
+ # See the `segmentation_descriptor()` table of the 2022 SCTE-35
4051
+ # specification for more information.
4052
+ #
4053
+ # @note When making an API call, you may pass SegmentationDescriptor
4054
+ # data as a hash:
4055
+ #
4056
+ # {
4057
+ # segment_num: 1,
4058
+ # segmentation_event_id: 1,
4059
+ # segmentation_type_id: 1,
4060
+ # segmentation_upid: "String",
4061
+ # segmentation_upid_type: 1,
4062
+ # segments_expected: 1,
4063
+ # sub_segment_num: 1,
4064
+ # sub_segments_expected: 1,
4065
+ # }
4066
+ #
4067
+ # @!attribute [rw] segment_num
4068
+ # The segment number to assign to the
4069
+ # `segmentation_descriptor.segment_num` message, as defined in section
4070
+ # 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0
4071
+ # and 256, inclusive. The default value is 0.
4072
+ # @return [Integer]
4073
+ #
4074
+ # @!attribute [rw] segmentation_event_id
4075
+ # The Event Identifier to assign to the
4076
+ # `segmentation_descriptor.segmentation_event_id` message, as defined
4077
+ # in section 10.3.3.1 of the 2022 SCTE-35 specification. The default
4078
+ # value is 1.
4079
+ # @return [Integer]
4080
+ #
4081
+ # @!attribute [rw] segmentation_type_id
4082
+ # The Type Identifier to assign to the
4083
+ # `segmentation_descriptor.segmentation_type_id` message, as defined
4084
+ # in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must
4085
+ # be between 0 and 256, inclusive. The default value is 48.
4086
+ # @return [Integer]
4087
+ #
4088
+ # @!attribute [rw] segmentation_upid
4089
+ # The Upid to assign to the
4090
+ # `segmentation_descriptor.segmentation_upid` message, as defined in
4091
+ # section 10.3.3.1 of the 2022 SCTE-35 specification. The value must
4092
+ # be a hexadecimal string containing only the characters 0 though 9
4093
+ # and A through F. The default value is "" (an empty string).
4094
+ # @return [String]
4095
+ #
4096
+ # @!attribute [rw] segmentation_upid_type
4097
+ # The Upid Type to assign to the
4098
+ # `segmentation_descriptor.segmentation_upid_type` message, as defined
4099
+ # in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must
4100
+ # be between 0 and 256, inclusive. The default value is 14.
4101
+ # @return [Integer]
4102
+ #
4103
+ # @!attribute [rw] segments_expected
4104
+ # The number of segments expected, which is assigned to the
4105
+ # `segmentation_descriptor.segments_expectedS` message, as defined in
4106
+ # section 10.3.3.1 of the 2022 SCTE-35 specification Values must be
4107
+ # between 0 and 256, inclusive. The default value is 0.
4108
+ # @return [Integer]
4109
+ #
4110
+ # @!attribute [rw] sub_segment_num
4111
+ # The sub-segment number to assign to the
4112
+ # `segmentation_descriptor.sub_segment_num` message, as defined in
4113
+ # section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be
4114
+ # between 0 and 256, inclusive. The defualt value is null.
4115
+ # @return [Integer]
4116
+ #
4117
+ # @!attribute [rw] sub_segments_expected
4118
+ # The number of sub-segments expected, which is assigned to the
4119
+ # `segmentation_descriptor.sub_segments_expected` message, as defined
4120
+ # in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must
4121
+ # be between 0 and 256, inclusive. The default value is null.
4122
+ # @return [Integer]
4123
+ #
4124
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/SegmentationDescriptor AWS API Documentation
4125
+ #
4126
+ class SegmentationDescriptor < Struct.new(
4127
+ :segment_num,
4128
+ :segmentation_event_id,
4129
+ :segmentation_type_id,
4130
+ :segmentation_upid,
4131
+ :segmentation_upid_type,
4132
+ :segments_expected,
4133
+ :sub_segment_num,
4134
+ :sub_segments_expected)
4135
+ SENSITIVE = []
4136
+ include Aws::Structure
4137
+ end
4138
+
3704
4139
  # Slate VOD source configuration.
3705
4140
  #
3706
4141
  # @note When making an API call, you may pass SlateSource
@@ -3730,7 +4165,13 @@ module Aws::MediaTailor
3730
4165
  include Aws::Structure
3731
4166
  end
3732
4167
 
3733
- # This response includes only the "type" : "object" property.
4168
+ # A source location is a container for sources. For more information
4169
+ # about source locations, see [Working with source locations][1] in the
4170
+ # *MediaTailor User Guide*.
4171
+ #
4172
+ #
4173
+ #
4174
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html
3734
4175
  #
3735
4176
  # @!attribute [rw] access_configuration
3736
4177
  # The access configuration for the source location.
@@ -3766,7 +4207,14 @@ module Aws::MediaTailor
3766
4207
  # @return [String]
3767
4208
  #
3768
4209
  # @!attribute [rw] tags
3769
- # The tags assigned to the source location.
4210
+ # The tags assigned to the source location. Tags are key-value pairs
4211
+ # that you can associate with Amazon resources to help with
4212
+ # organization, access control, and cost tracking. For more
4213
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
4214
+ #
4215
+ #
4216
+ #
4217
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
3770
4218
  # @return [Hash<String,String>]
3771
4219
  #
3772
4220
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/SourceLocation AWS API Documentation
@@ -3798,27 +4246,27 @@ module Aws::MediaTailor
3798
4246
  # }
3799
4247
  #
3800
4248
  # @!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.
4249
+ # This is written to `splice_insert.avail_num`, as defined in section
4250
+ # 9.7.3.1 of the SCTE-35 specification. The default value is `0`.
4251
+ # Values must be between `0` and `256`, inclusive.
3804
4252
  # @return [Integer]
3805
4253
  #
3806
4254
  # @!attribute [rw] avails_expected
3807
- # This is written to splice\_insert.avails\_expected, as defined in
4255
+ # This is written to `splice_insert.avails_expected`, as defined in
3808
4256
  # section 9.7.3.1 of the SCTE-35 specification. The default value is
3809
- # 0. Values must be between 0 and 256, inclusive.
4257
+ # `0`. Values must be between `0` and `256`, inclusive.
3810
4258
  # @return [Integer]
3811
4259
  #
3812
4260
  # @!attribute [rw] splice_event_id
3813
- # This is written to splice\_insert.splice\_event\_id, as defined in
4261
+ # This is written to `splice_insert.splice_event_id`, as defined in
3814
4262
  # section 9.7.3.1 of the SCTE-35 specification. The default value is
3815
- # 1.
4263
+ # `1`.
3816
4264
  # @return [Integer]
3817
4265
  #
3818
4266
  # @!attribute [rw] unique_program_id
3819
- # This is written to splice\_insert.unique\_program\_id, as defined in
4267
+ # This is written to `splice_insert.unique_program_id`, as defined in
3820
4268
  # section 9.7.3.1 of the SCTE-35 specification. The default value is
3821
- # 0. Values must be between 0 and 256, inclusive.
4269
+ # `0`. Values must be between `0` and `256`, inclusive.
3822
4270
  # @return [Integer]
3823
4271
  #
3824
4272
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/SpliceInsertMessage AWS API Documentation
@@ -3840,6 +4288,7 @@ module Aws::MediaTailor
3840
4288
  # }
3841
4289
  #
3842
4290
  # @!attribute [rw] channel_name
4291
+ # The name of the channel.
3843
4292
  # @return [String]
3844
4293
  #
3845
4294
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/StartChannelRequest AWS API Documentation
@@ -3862,6 +4311,7 @@ module Aws::MediaTailor
3862
4311
  # }
3863
4312
  #
3864
4313
  # @!attribute [rw] channel_name
4314
+ # The name of the channel.
3865
4315
  # @return [String]
3866
4316
  #
3867
4317
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/StopChannelRequest AWS API Documentation
@@ -3887,9 +4337,18 @@ module Aws::MediaTailor
3887
4337
  # }
3888
4338
  #
3889
4339
  # @!attribute [rw] resource_arn
4340
+ # The Amazon Resource Name (ARN) associated with the resource.
3890
4341
  # @return [String]
3891
4342
  #
3892
4343
  # @!attribute [rw] tags
4344
+ # The tags to assign to the resource. Tags are key-value pairs that
4345
+ # you can associate with Amazon resources to help with organization,
4346
+ # access control, and cost tracking. For more information, see
4347
+ # [Tagging AWS Elemental MediaTailor Resources][1].
4348
+ #
4349
+ #
4350
+ #
4351
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
3893
4352
  # @return [Hash<String,String>]
3894
4353
  #
3895
4354
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/TagResourceRequest AWS API Documentation
@@ -3901,6 +4360,49 @@ module Aws::MediaTailor
3901
4360
  include Aws::Structure
3902
4361
  end
3903
4362
 
4363
+ # The SCTE-35 `time_signal` message can be sent with one or more
4364
+ # `segmentation_descriptor` messages. A `time_signal` message can be
4365
+ # sent only if a single `segmentation_descriptor` message is sent.
4366
+ #
4367
+ # The `time_signal` message contains only the `splice_time` field which
4368
+ # is constructed using a given presentation timestamp. When sending a
4369
+ # `time_signal` message, the `splice_command_type` field in the
4370
+ # `splice_info_section` message is set to 6 (0x06).
4371
+ #
4372
+ # See the `time_signal()` table of the 2022 SCTE-35 specification for
4373
+ # more information.
4374
+ #
4375
+ # @note When making an API call, you may pass TimeSignalMessage
4376
+ # data as a hash:
4377
+ #
4378
+ # {
4379
+ # segmentation_descriptors: [
4380
+ # {
4381
+ # segment_num: 1,
4382
+ # segmentation_event_id: 1,
4383
+ # segmentation_type_id: 1,
4384
+ # segmentation_upid: "String",
4385
+ # segmentation_upid_type: 1,
4386
+ # segments_expected: 1,
4387
+ # sub_segment_num: 1,
4388
+ # sub_segments_expected: 1,
4389
+ # },
4390
+ # ],
4391
+ # }
4392
+ #
4393
+ # @!attribute [rw] segmentation_descriptors
4394
+ # The configurations for the SCTE-35 `segmentation_descriptor`
4395
+ # message(s) sent with the `time_signal` message.
4396
+ # @return [Array<Types::SegmentationDescriptor>]
4397
+ #
4398
+ # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/TimeSignalMessage AWS API Documentation
4399
+ #
4400
+ class TimeSignalMessage < Struct.new(
4401
+ :segmentation_descriptors)
4402
+ SENSITIVE = []
4403
+ include Aws::Structure
4404
+ end
4405
+
3904
4406
  # Program transition configuration.
3905
4407
  #
3906
4408
  # @note When making an API call, you may pass Transition
@@ -3920,12 +4422,12 @@ module Aws::MediaTailor
3920
4422
  #
3921
4423
  # @!attribute [rw] relative_position
3922
4424
  # The position where this program will be inserted relative to the
3923
- # RelativePosition.
4425
+ # `RelativePosition`.
3924
4426
  # @return [String]
3925
4427
  #
3926
4428
  # @!attribute [rw] relative_program
3927
4429
  # The name of the program that this program will be inserted next to,
3928
- # as defined by RelativePosition.
4430
+ # as defined by `RelativePosition`.
3929
4431
  # @return [String]
3930
4432
  #
3931
4433
  # @!attribute [rw] scheduled_start_time_millis
@@ -3935,22 +4437,23 @@ module Aws::MediaTailor
3935
4437
  #
3936
4438
  # @!attribute [rw] type
3937
4439
  # Defines when the program plays in the schedule. You can set the
3938
- # value to ABSOLUTE or RELATIVE.
4440
+ # value to `ABSOLUTE` or `RELATIVE`.
3939
4441
  #
3940
- # ABSOLUTE - The program plays at a specific wall clock time. This
3941
- # setting can only be used for channels using the LINEAR PlaybackMode.
4442
+ # `ABSOLUTE` - The program plays at a specific wall clock time. This
4443
+ # setting can only be used for channels using the `LINEAR`
4444
+ # `PlaybackMode`.
3942
4445
  #
3943
- # Note the following considerations when using ABSOLUTE transitions:
4446
+ # Note the following considerations when using `ABSOLUTE` transitions:
3944
4447
  #
3945
4448
  # If the preceding program in the schedule has a duration that extends
3946
4449
  # past the wall clock time, MediaTailor truncates the preceding
3947
4450
  # program on a common segment boundary.
3948
4451
  #
3949
- # If there are gaps in playback, MediaTailor plays the FillerSlate you
3950
- # configured for your linear channel.
4452
+ # If there are gaps in playback, MediaTailor plays the `FillerSlate`
4453
+ # you configured for your linear channel.
3951
4454
  #
3952
- # RELATIVE - The program is inserted into the schedule either before
3953
- # or after a program that you specify via RelativePosition.
4455
+ # `RELATIVE` - The program is inserted into the schedule either before
4456
+ # or after a program that you specify via `RelativePosition`.
3954
4457
  # @return [String]
3955
4458
  #
3956
4459
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/Transition AWS API Documentation
@@ -3974,9 +4477,11 @@ module Aws::MediaTailor
3974
4477
  # }
3975
4478
  #
3976
4479
  # @!attribute [rw] resource_arn
4480
+ # The Amazon Resource Name (ARN) of the resource to untag.
3977
4481
  # @return [String]
3978
4482
  #
3979
4483
  # @!attribute [rw] tag_keys
4484
+ # The tag keys associated with the resource.
3980
4485
  # @return [Array<String>]
3981
4486
  #
3982
4487
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UntagResourceRequest AWS API Documentation
@@ -3988,8 +4493,6 @@ module Aws::MediaTailor
3988
4493
  include Aws::Structure
3989
4494
  end
3990
4495
 
3991
- # Updates a channel's Outputs.
3992
- #
3993
4496
  # @note When making an API call, you may pass UpdateChannelRequest
3994
4497
  # data as a hash:
3995
4498
  #
@@ -4017,13 +4520,14 @@ module Aws::MediaTailor
4017
4520
  # }
4018
4521
  #
4019
4522
  # @!attribute [rw] channel_name
4523
+ # The name of the channel.
4020
4524
  # @return [String]
4021
4525
  #
4022
4526
  # @!attribute [rw] filler_slate
4023
4527
  # 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.
4528
+ # must configure filler slate if your channel uses the `LINEAR`
4529
+ # `PlaybackMode`. MediaTailor doesn't support filler slate for
4530
+ # channels using the `LOOP` `PlaybackMode`.
4027
4531
  # @return [Types::SlateSource]
4028
4532
  #
4029
4533
  # @!attribute [rw] outputs
@@ -4041,34 +4545,59 @@ module Aws::MediaTailor
4041
4545
  end
4042
4546
 
4043
4547
  # @!attribute [rw] arn
4548
+ # The Amazon Resource Name (ARN) associated with the channel.
4044
4549
  # @return [String]
4045
4550
  #
4046
4551
  # @!attribute [rw] channel_name
4552
+ # The name of the channel.
4047
4553
  # @return [String]
4048
4554
  #
4049
4555
  # @!attribute [rw] channel_state
4556
+ # Returns the state whether the channel is running or not.
4050
4557
  # @return [String]
4051
4558
  #
4052
4559
  # @!attribute [rw] creation_time
4560
+ # The timestamp of when the channel was created.
4053
4561
  # @return [Time]
4054
4562
  #
4055
4563
  # @!attribute [rw] filler_slate
4056
- # Slate VOD source configuration.
4564
+ # The slate used to fill gaps between programs in the schedule. You
4565
+ # must configure filler slate if your channel uses the `LINEAR`
4566
+ # `PlaybackMode`. MediaTailor doesn't support filler slate for
4567
+ # channels using the `LOOP` `PlaybackMode`.
4057
4568
  # @return [Types::SlateSource]
4058
4569
  #
4059
4570
  # @!attribute [rw] last_modified_time
4571
+ # The timestamp that indicates when the channel was last modified.
4060
4572
  # @return [Time]
4061
4573
  #
4062
4574
  # @!attribute [rw] outputs
4575
+ # The channel's output properties.
4063
4576
  # @return [Array<Types::ResponseOutputItem>]
4064
4577
  #
4065
4578
  # @!attribute [rw] playback_mode
4579
+ # The type of playback mode for this channel.
4580
+ #
4581
+ # `LINEAR` - Programs play back-to-back only once.
4582
+ #
4583
+ # `LOOP` - Programs play back-to-back in an endless loop. When the
4584
+ # last program in the schedule plays, playback loops back to the first
4585
+ # program in the schedule.
4066
4586
  # @return [String]
4067
4587
  #
4068
4588
  # @!attribute [rw] tags
4589
+ # The tags to assign to the channel. Tags are key-value pairs that you
4590
+ # can associate with Amazon resources to help with organization,
4591
+ # access control, and cost tracking. For more information, see
4592
+ # [Tagging AWS Elemental MediaTailor Resources][1].
4593
+ #
4594
+ #
4595
+ #
4596
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
4069
4597
  # @return [Hash<String,String>]
4070
4598
  #
4071
4599
  # @!attribute [rw] tier
4600
+ # The tier associated with this Channel.
4072
4601
  # @return [String]
4073
4602
  #
4074
4603
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateChannelResponse AWS API Documentation
@@ -4088,8 +4617,6 @@ module Aws::MediaTailor
4088
4617
  include Aws::Structure
4089
4618
  end
4090
4619
 
4091
- # Updates a live source's configuration.
4092
- #
4093
4620
  # @note When making an API call, you may pass UpdateLiveSourceRequest
4094
4621
  # data as a hash:
4095
4622
  #
@@ -4111,9 +4638,11 @@ module Aws::MediaTailor
4111
4638
  # @return [Array<Types::HttpPackageConfiguration>]
4112
4639
  #
4113
4640
  # @!attribute [rw] live_source_name
4641
+ # The name of the live source.
4114
4642
  # @return [String]
4115
4643
  #
4116
4644
  # @!attribute [rw] source_location_name
4645
+ # The name of the source location associated with this Live Source.
4117
4646
  # @return [String]
4118
4647
  #
4119
4648
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateLiveSourceRequest AWS API Documentation
@@ -4127,25 +4656,39 @@ module Aws::MediaTailor
4127
4656
  end
4128
4657
 
4129
4658
  # @!attribute [rw] arn
4659
+ # The Amazon Resource Name (ARN) associated with this live source.
4130
4660
  # @return [String]
4131
4661
  #
4132
4662
  # @!attribute [rw] creation_time
4663
+ # The timestamp that indicates when the live source was created.
4133
4664
  # @return [Time]
4134
4665
  #
4135
4666
  # @!attribute [rw] http_package_configurations
4136
- # The VOD source's HTTP package configuration settings.
4667
+ # A list of HTTP package configurations for the live source on this
4668
+ # account.
4137
4669
  # @return [Array<Types::HttpPackageConfiguration>]
4138
4670
  #
4139
4671
  # @!attribute [rw] last_modified_time
4672
+ # The timestamp that indicates when the live source was last modified.
4140
4673
  # @return [Time]
4141
4674
  #
4142
4675
  # @!attribute [rw] live_source_name
4676
+ # The name of the live source.
4143
4677
  # @return [String]
4144
4678
  #
4145
4679
  # @!attribute [rw] source_location_name
4680
+ # The name of the source location associated with the live source.
4146
4681
  # @return [String]
4147
4682
  #
4148
4683
  # @!attribute [rw] tags
4684
+ # The tags to assign to the live source. Tags are key-value pairs that
4685
+ # you can associate with Amazon resources to help with organization,
4686
+ # access control, and cost tracking. For more information, see
4687
+ # [Tagging AWS Elemental MediaTailor Resources][1].
4688
+ #
4689
+ #
4690
+ #
4691
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
4149
4692
  # @return [Hash<String,String>]
4150
4693
  #
4151
4694
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateLiveSourceResponse AWS API Documentation
@@ -4162,8 +4705,6 @@ module Aws::MediaTailor
4162
4705
  include Aws::Structure
4163
4706
  end
4164
4707
 
4165
- # Source location configuration parameters.
4166
- #
4167
4708
  # @note When making an API call, you may pass UpdateSourceLocationRequest
4168
4709
  # data as a hash:
4169
4710
  #
@@ -4210,6 +4751,7 @@ module Aws::MediaTailor
4210
4751
  # @return [Array<Types::SegmentDeliveryConfiguration>]
4211
4752
  #
4212
4753
  # @!attribute [rw] source_location_name
4754
+ # The name of the source location.
4213
4755
  # @return [String]
4214
4756
  #
4215
4757
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateSourceLocationRequest AWS API Documentation
@@ -4225,23 +4767,20 @@ module Aws::MediaTailor
4225
4767
  end
4226
4768
 
4227
4769
  # @!attribute [rw] access_configuration
4228
- # Access configuration parameters.
4770
+ # Access configuration parameters. Configures the type of
4771
+ # authentication used to access content from your source location.
4229
4772
  # @return [Types::AccessConfiguration]
4230
4773
  #
4231
4774
  # @!attribute [rw] arn
4775
+ # The Amazon Resource Name (ARN) associated with the source location.
4232
4776
  # @return [String]
4233
4777
  #
4234
4778
  # @!attribute [rw] creation_time
4779
+ # The timestamp that indicates when the source location was created.
4235
4780
  # @return [Time]
4236
4781
  #
4237
4782
  # @!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.
4783
+ # The optional configuration for the host server that serves segments.
4245
4784
  # @return [Types::DefaultSegmentDeliveryConfiguration]
4246
4785
  #
4247
4786
  # @!attribute [rw] http_configuration
@@ -4249,15 +4788,33 @@ module Aws::MediaTailor
4249
4788
  # @return [Types::HttpConfiguration]
4250
4789
  #
4251
4790
  # @!attribute [rw] last_modified_time
4791
+ # The timestamp that indicates when the source location was last
4792
+ # modified.
4252
4793
  # @return [Time]
4253
4794
  #
4254
4795
  # @!attribute [rw] segment_delivery_configurations
4796
+ # The segment delivery configurations for the source location. For
4797
+ # information about MediaTailor configurations, see [Working with
4798
+ # configurations in AWS Elemental MediaTailor][1].
4799
+ #
4800
+ #
4801
+ #
4802
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html
4255
4803
  # @return [Array<Types::SegmentDeliveryConfiguration>]
4256
4804
  #
4257
4805
  # @!attribute [rw] source_location_name
4806
+ # The name of the source location.
4258
4807
  # @return [String]
4259
4808
  #
4260
4809
  # @!attribute [rw] tags
4810
+ # The tags to assign to the source location. Tags are key-value pairs
4811
+ # that you can associate with Amazon resources to help with
4812
+ # organization, access control, and cost tracking. For more
4813
+ # information, see [Tagging AWS Elemental MediaTailor Resources][1].
4814
+ #
4815
+ #
4816
+ #
4817
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
4261
4818
  # @return [Hash<String,String>]
4262
4819
  #
4263
4820
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateSourceLocationResponse AWS API Documentation
@@ -4276,8 +4833,6 @@ module Aws::MediaTailor
4276
4833
  include Aws::Structure
4277
4834
  end
4278
4835
 
4279
- # Updates a VOD source's configuration.
4280
- #
4281
4836
  # @note When making an API call, you may pass UpdateVodSourceRequest
4282
4837
  # data as a hash:
4283
4838
  #
@@ -4299,9 +4854,11 @@ module Aws::MediaTailor
4299
4854
  # @return [Array<Types::HttpPackageConfiguration>]
4300
4855
  #
4301
4856
  # @!attribute [rw] source_location_name
4857
+ # The name of the source location associated with this VOD Source.
4302
4858
  # @return [String]
4303
4859
  #
4304
4860
  # @!attribute [rw] vod_source_name
4861
+ # The name of the VOD source.
4305
4862
  # @return [String]
4306
4863
  #
4307
4864
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateVodSourceRequest AWS API Documentation
@@ -4315,25 +4872,39 @@ module Aws::MediaTailor
4315
4872
  end
4316
4873
 
4317
4874
  # @!attribute [rw] arn
4875
+ # The Amazon Resource Name (ARN) associated with the VOD source.
4318
4876
  # @return [String]
4319
4877
  #
4320
4878
  # @!attribute [rw] creation_time
4879
+ # The timestamp that indicates when the VOD source was created.
4321
4880
  # @return [Time]
4322
4881
  #
4323
4882
  # @!attribute [rw] http_package_configurations
4324
- # The VOD source's HTTP package configuration settings.
4883
+ # A list of HTTP package configurations for the VOD source on this
4884
+ # account.
4325
4885
  # @return [Array<Types::HttpPackageConfiguration>]
4326
4886
  #
4327
4887
  # @!attribute [rw] last_modified_time
4888
+ # The timestamp that indicates when the VOD source was last modified.
4328
4889
  # @return [Time]
4329
4890
  #
4330
4891
  # @!attribute [rw] source_location_name
4892
+ # The name of the source location associated with the VOD source.
4331
4893
  # @return [String]
4332
4894
  #
4333
4895
  # @!attribute [rw] tags
4896
+ # The tags to assign to the VOD source. Tags are key-value pairs that
4897
+ # you can associate with Amazon resources to help with organization,
4898
+ # access control, and cost tracking. For more information, see
4899
+ # [Tagging AWS Elemental MediaTailor Resources][1].
4900
+ #
4901
+ #
4902
+ #
4903
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
4334
4904
  # @return [Hash<String,String>]
4335
4905
  #
4336
4906
  # @!attribute [rw] vod_source_name
4907
+ # The name of the VOD source.
4337
4908
  # @return [String]
4338
4909
  #
4339
4910
  # @see http://docs.aws.amazon.com/goto/WebAPI/mediatailor-2018-04-23/UpdateVodSourceResponse AWS API Documentation
@@ -4374,7 +4945,14 @@ module Aws::MediaTailor
4374
4945
  # @return [String]
4375
4946
  #
4376
4947
  # @!attribute [rw] tags
4377
- # The tags assigned to the VOD source.
4948
+ # The tags assigned to the VOD source. Tags are key-value pairs that
4949
+ # you can associate with Amazon resources to help with organization,
4950
+ # access control, and cost tracking. For more information, see
4951
+ # [Tagging AWS Elemental MediaTailor Resources][1].
4952
+ #
4953
+ #
4954
+ #
4955
+ # [1]: https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html
4378
4956
  # @return [Hash<String,String>]
4379
4957
  #
4380
4958
  # @!attribute [rw] vod_source_name