@aws-sdk/client-mediatailor 3.806.0 → 3.810.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -2
- package/dist-types/MediaTailor.d.ts +1 -2
- package/dist-types/MediaTailorClient.d.ts +1 -2
- package/dist-types/commands/GetPlaybackConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/ListPlaybackConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/PutPlaybackConfigurationCommand.d.ts +1 -1
- package/dist-types/index.d.ts +1 -2
- package/dist-types/models/models_0.d.ts +37 -134
- package/dist-types/ts3.4/models/models_0.d.ts +1 -1
- package/package.json +17 -17
package/README.md
CHANGED
|
@@ -6,8 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript MediaTailor Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<p>Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/">AWS Elemental MediaTailor User Guide</a>.</p>
|
|
10
|
-
<p>Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).</p>
|
|
9
|
+
<p>Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/">AWS Elemental MediaTailor User Guide</a>.</p> <p>Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).</p>
|
|
11
10
|
|
|
12
11
|
## Installing
|
|
13
12
|
|
|
@@ -314,8 +314,7 @@ export interface MediaTailor {
|
|
|
314
314
|
updateVodSource(args: UpdateVodSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateVodSourceCommandOutput) => void): void;
|
|
315
315
|
}
|
|
316
316
|
/**
|
|
317
|
-
* <p>Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/">AWS Elemental MediaTailor User Guide</a>.</p>
|
|
318
|
-
* <p>Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).</p>
|
|
317
|
+
* <p>Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/">AWS Elemental MediaTailor User Guide</a>.</p> <p>Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).</p>
|
|
319
318
|
* @public
|
|
320
319
|
*/
|
|
321
320
|
export declare class MediaTailor extends MediaTailorClient implements MediaTailor {
|
|
@@ -213,8 +213,7 @@ export type MediaTailorClientResolvedConfigType = __SmithyResolvedConfiguration<
|
|
|
213
213
|
export interface MediaTailorClientResolvedConfig extends MediaTailorClientResolvedConfigType {
|
|
214
214
|
}
|
|
215
215
|
/**
|
|
216
|
-
* <p>Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/">AWS Elemental MediaTailor User Guide</a>.</p>
|
|
217
|
-
* <p>Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).</p>
|
|
216
|
+
* <p>Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/">AWS Elemental MediaTailor User Guide</a>.</p> <p>Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).</p>
|
|
218
217
|
* @public
|
|
219
218
|
*/
|
|
220
219
|
export declare class MediaTailorClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, MediaTailorClientResolvedConfig> {
|
|
@@ -74,7 +74,7 @@ declare const GetPlaybackConfigurationCommand_base: {
|
|
|
74
74
|
* // },
|
|
75
75
|
* // LogConfiguration: { // LogConfiguration
|
|
76
76
|
* // PercentEnabled: Number("int"), // required
|
|
77
|
-
* // EnabledLoggingStrategies: [ // __listOfLoggingStrategies
|
|
77
|
+
* // EnabledLoggingStrategies: [ // __listOfLoggingStrategies // required
|
|
78
78
|
* // "VENDED_LOGS" || "LEGACY_CLOUDWATCH",
|
|
79
79
|
* // ],
|
|
80
80
|
* // AdsInteractionLog: { // AdsInteractionLog
|
|
@@ -77,7 +77,7 @@ declare const ListPlaybackConfigurationsCommand_base: {
|
|
|
77
77
|
* // },
|
|
78
78
|
* // LogConfiguration: { // LogConfiguration
|
|
79
79
|
* // PercentEnabled: Number("int"), // required
|
|
80
|
-
* // EnabledLoggingStrategies: [ // __listOfLoggingStrategies
|
|
80
|
+
* // EnabledLoggingStrategies: [ // __listOfLoggingStrategies // required
|
|
81
81
|
* // "VENDED_LOGS" || "LEGACY_CLOUDWATCH",
|
|
82
82
|
* // ],
|
|
83
83
|
* // AdsInteractionLog: { // AdsInteractionLog
|
|
@@ -117,7 +117,7 @@ declare const PutPlaybackConfigurationCommand_base: {
|
|
|
117
117
|
* // },
|
|
118
118
|
* // LogConfiguration: { // LogConfiguration
|
|
119
119
|
* // PercentEnabled: Number("int"), // required
|
|
120
|
-
* // EnabledLoggingStrategies: [ // __listOfLoggingStrategies
|
|
120
|
+
* // EnabledLoggingStrategies: [ // __listOfLoggingStrategies // required
|
|
121
121
|
* // "VENDED_LOGS" || "LEGACY_CLOUDWATCH",
|
|
122
122
|
* // ],
|
|
123
123
|
* // AdsInteractionLog: { // AdsInteractionLog
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/">AWS Elemental MediaTailor User Guide</a>.</p>
|
|
3
|
-
* <p>Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).</p>
|
|
2
|
+
* <p>Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/">AWS Elemental MediaTailor User Guide</a>.</p> <p>Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).</p>
|
|
4
3
|
*
|
|
5
4
|
* @packageDocumentation
|
|
6
5
|
*/
|
|
@@ -133,10 +133,7 @@ export interface SpliceInsertMessage {
|
|
|
133
133
|
UniqueProgramId?: number | undefined;
|
|
134
134
|
}
|
|
135
135
|
/**
|
|
136
|
-
* <p>The <code>segmentation_descriptor</code> message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the <code>EXT-X-DATERANGE</code> or <code>EventStream</code> ad marker's SCTE-35 data.</p>
|
|
137
|
-
* <p>
|
|
138
|
-
* <code>segmentation_descriptor</code> messages must be sent with the <code>time_signal</code> message type.</p>
|
|
139
|
-
* <p>See the <code>segmentation_descriptor()</code> table of the 2022 SCTE-35 specification for more information.</p>
|
|
136
|
+
* <p>The <code>segmentation_descriptor</code> message can contain advanced metadata fields, like content identifiers, to convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as part of the <code>EXT-X-DATERANGE</code> or <code>EventStream</code> ad marker's SCTE-35 data.</p> <p> <code>segmentation_descriptor</code> messages must be sent with the <code>time_signal</code> message type.</p> <p>See the <code>segmentation_descriptor()</code> table of the 2022 SCTE-35 specification for more information.</p>
|
|
140
137
|
* @public
|
|
141
138
|
*/
|
|
142
139
|
export interface SegmentationDescriptor {
|
|
@@ -182,9 +179,7 @@ export interface SegmentationDescriptor {
|
|
|
182
179
|
SubSegmentsExpected?: number | undefined;
|
|
183
180
|
}
|
|
184
181
|
/**
|
|
185
|
-
* <p>The SCTE-35 <code>time_signal</code> message can be sent with one or more <code>segmentation_descriptor</code> messages. A <code>time_signal</code> message can be sent only if a single <code>segmentation_descriptor</code> message is sent.</p>
|
|
186
|
-
* <p>The <code>time_signal</code> message contains only the <code>splice_time</code> field which is constructed using a given presentation timestamp. When sending a <code>time_signal</code> message, the <code>splice_command_type</code> field in the <code>splice_info_section</code> message is set to 6 (0x06).</p>
|
|
187
|
-
* <p>See the <code>time_signal()</code> table of the 2022 SCTE-35 specification for more information.</p>
|
|
182
|
+
* <p>The SCTE-35 <code>time_signal</code> message can be sent with one or more <code>segmentation_descriptor</code> messages. A <code>time_signal</code> message can be sent only if a single <code>segmentation_descriptor</code> message is sent.</p> <p>The <code>time_signal</code> message contains only the <code>splice_time</code> field which is constructed using a given presentation timestamp. When sending a <code>time_signal</code> message, the <code>splice_command_type</code> field in the <code>splice_info_section</code> message is set to 6 (0x06).</p> <p>See the <code>time_signal()</code> table of the 2022 SCTE-35 specification for more information.</p>
|
|
188
183
|
* @public
|
|
189
184
|
*/
|
|
190
185
|
export interface TimeSignalMessage {
|
|
@@ -220,9 +215,7 @@ export interface AdBreak {
|
|
|
220
215
|
*/
|
|
221
216
|
SpliceInsertMessage?: SpliceInsertMessage | undefined;
|
|
222
217
|
/**
|
|
223
|
-
* <p>Defines the SCTE-35 <code>time_signal</code> message inserted around the ad.</p>
|
|
224
|
-
* <p>Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a <code>splice_insert</code> SCTE-35 message to the ad break. This message provides basic metadata about the ad break.</p>
|
|
225
|
-
* <p>See section 9.7.4 of the 2022 SCTE-35 specification for more information.</p>
|
|
218
|
+
* <p>Defines the SCTE-35 <code>time_signal</code> message inserted around the ad.</p> <p>Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a <code>splice_insert</code> SCTE-35 message to the ad break. This message provides basic metadata about the ad break.</p> <p>See section 9.7.4 of the 2022 SCTE-35 specification for more information.</p>
|
|
226
219
|
* @public
|
|
227
220
|
*/
|
|
228
221
|
TimeSignalMessage?: TimeSignalMessage | undefined;
|
|
@@ -366,15 +359,12 @@ export declare const Operator: {
|
|
|
366
359
|
*/
|
|
367
360
|
export type Operator = (typeof Operator)[keyof typeof Operator];
|
|
368
361
|
/**
|
|
369
|
-
* <p>MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.</p>
|
|
370
|
-
* <p>As an example, let's say that you set <code>DynamicVariable</code> to <code>scte.event_id</code> and <code>Operator</code> to <code>EQUALS</code>, and your playback configuration has an ADS URL of <code>https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]</code>. And the prefetch request to the ADS contains these values <code>https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30</code>. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of <code>my-awesome-event</code>, since it must match the event id that MediaTailor uses to query the ADS.</p>
|
|
371
|
-
* <p>You can specify up to five <code>AvailMatchingCriteria</code>. If you specify multiple <code>AvailMatchingCriteria</code>, MediaTailor combines them to match using a logical <code>AND</code>. You can model logical <code>OR</code> combinations by creating multiple prefetch schedules.</p>
|
|
362
|
+
* <p>MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.</p> <p>As an example, let's say that you set <code>DynamicVariable</code> to <code>scte.event_id</code> and <code>Operator</code> to <code>EQUALS</code>, and your playback configuration has an ADS URL of <code>https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]</code>. And the prefetch request to the ADS contains these values <code>https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30</code>. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of <code>my-awesome-event</code>, since it must match the event id that MediaTailor uses to query the ADS.</p> <p>You can specify up to five <code>AvailMatchingCriteria</code>. If you specify multiple <code>AvailMatchingCriteria</code>, MediaTailor combines them to match using a logical <code>AND</code>. You can model logical <code>OR</code> combinations by creating multiple prefetch schedules.</p>
|
|
372
363
|
* @public
|
|
373
364
|
*/
|
|
374
365
|
export interface AvailMatchingCriteria {
|
|
375
366
|
/**
|
|
376
|
-
* <p>The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html">Using dynamic ad variables</a> in the <i>MediaTailor User Guide</i>.</p>
|
|
377
|
-
* <p>You can include up to 100 dynamic variables.</p>
|
|
367
|
+
* <p>The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html">Using dynamic ad variables</a> in the <i>MediaTailor User Guide</i>.</p> <p>You can include up to 100 dynamic variables.</p>
|
|
378
368
|
* @public
|
|
379
369
|
*/
|
|
380
370
|
DynamicVariable: string | undefined;
|
|
@@ -517,9 +507,7 @@ export interface Channel {
|
|
|
517
507
|
*/
|
|
518
508
|
CreationTime?: Date | undefined;
|
|
519
509
|
/**
|
|
520
|
-
* <p>The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the <code>LINEAR</code>
|
|
521
|
-
* <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
|
|
522
|
-
* <code>PlaybackMode</code>.</p>
|
|
510
|
+
* <p>The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the <code>LINEAR</code> <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code> <code>PlaybackMode</code>.</p>
|
|
523
511
|
* @public
|
|
524
512
|
*/
|
|
525
513
|
FillerSlate?: SlateSource | undefined;
|
|
@@ -534,11 +522,7 @@ export interface Channel {
|
|
|
534
522
|
*/
|
|
535
523
|
Outputs: ResponseOutputItem[] | undefined;
|
|
536
524
|
/**
|
|
537
|
-
* <p>The type of playback mode for this channel.</p>
|
|
538
|
-
* <p>
|
|
539
|
-
* <code>LINEAR</code> - Programs play back-to-back only once.</p>
|
|
540
|
-
* <p>
|
|
541
|
-
* <code>LOOP</code> - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.</p>
|
|
525
|
+
* <p>The type of playback mode for this channel.</p> <p> <code>LINEAR</code> - Programs play back-to-back only once.</p> <p> <code>LOOP</code> - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.</p>
|
|
542
526
|
* @public
|
|
543
527
|
*/
|
|
544
528
|
PlaybackMode: string | undefined;
|
|
@@ -667,10 +651,7 @@ export type StreamingMediaFileConditioning = (typeof StreamingMediaFileCondition
|
|
|
667
651
|
*/
|
|
668
652
|
export interface AdConditioningConfiguration {
|
|
669
653
|
/**
|
|
670
|
-
* <p>For ads that have media files with streaming delivery and supported file extensions, indicates what transcoding action MediaTailor takes when it first receives these ads from the ADS.
|
|
671
|
-
* <code>TRANSCODE</code> indicates that MediaTailor must transcode the ads.
|
|
672
|
-
* <code>NONE</code> indicates that you have already transcoded the ads outside of MediaTailor and don't need them transcoded as part of the ad insertion workflow.
|
|
673
|
-
* For more information about ad conditioning see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/precondition-ads.html">Using preconditioned ads</a> in the Elemental MediaTailor user guide.</p>
|
|
654
|
+
* <p>For ads that have media files with streaming delivery and supported file extensions, indicates what transcoding action MediaTailor takes when it first receives these ads from the ADS. <code>TRANSCODE</code> indicates that MediaTailor must transcode the ads. <code>NONE</code> indicates that you have already transcoded the ads outside of MediaTailor and don't need them transcoded as part of the ad insertion workflow. For more information about ad conditioning see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/precondition-ads.html">Using preconditioned ads</a> in the Elemental MediaTailor user guide.</p>
|
|
674
655
|
* @public
|
|
675
656
|
*/
|
|
676
657
|
StreamingMediaFileConditioning: StreamingMediaFileConditioning | undefined;
|
|
@@ -826,9 +807,7 @@ export interface LivePreRollConfiguration {
|
|
|
826
807
|
MaxDurationSeconds?: number | undefined;
|
|
827
808
|
}
|
|
828
809
|
/**
|
|
829
|
-
* <p>Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).</p>
|
|
830
|
-
* <p>For more information about ADS logs, inlcuding descriptions of the event types, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ads-log-format.html">MediaTailor ADS logs description and event types</a>
|
|
831
|
-
* in Elemental MediaTailor User Guide.</p>
|
|
810
|
+
* <p>Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).</p> <p>For more information about ADS logs, inlcuding descriptions of the event types, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ads-log-format.html">MediaTailor ADS logs description and event types</a> in Elemental MediaTailor User Guide.</p>
|
|
832
811
|
* @public
|
|
833
812
|
*/
|
|
834
813
|
export interface AdsInteractionLog {
|
|
@@ -886,9 +865,7 @@ export declare const ManifestServiceExcludeEventType: {
|
|
|
886
865
|
*/
|
|
887
866
|
export type ManifestServiceExcludeEventType = (typeof ManifestServiceExcludeEventType)[keyof typeof ManifestServiceExcludeEventType];
|
|
888
867
|
/**
|
|
889
|
-
* <p>Settings for customizing what events are included in logs for interactions with the origin server.</p>
|
|
890
|
-
* <p>For more information about manifest service logs, including descriptions of the event types, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/log-types.html">MediaTailor manifest logs description and event types</a>
|
|
891
|
-
* in Elemental MediaTailor User Guide.</p>
|
|
868
|
+
* <p>Settings for customizing what events are included in logs for interactions with the origin server.</p> <p>For more information about manifest service logs, including descriptions of the event types, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/log-types.html">MediaTailor manifest logs description and event types</a> in Elemental MediaTailor User Guide.</p>
|
|
892
869
|
* @public
|
|
893
870
|
*/
|
|
894
871
|
export interface ManifestServiceInteractionLog {
|
|
@@ -904,9 +881,7 @@ export interface ManifestServiceInteractionLog {
|
|
|
904
881
|
*/
|
|
905
882
|
export interface LogConfiguration {
|
|
906
883
|
/**
|
|
907
|
-
* <p>The percentage of session logs that MediaTailor sends to your configured log destination. For example, if your playback configuration has 1000 sessions and <code>percentEnabled</code> is set to <code>60</code>, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html">debug log mode</a>.</p>
|
|
908
|
-
* <p>Valid values: <code>0</code> - <code>100</code>
|
|
909
|
-
* </p>
|
|
884
|
+
* <p>The percentage of session logs that MediaTailor sends to your configured log destination. For example, if your playback configuration has 1000 sessions and <code>percentEnabled</code> is set to <code>60</code>, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html">debug log mode</a>.</p> <p>Valid values: <code>0</code> - <code>100</code> </p>
|
|
910
885
|
* @public
|
|
911
886
|
*/
|
|
912
887
|
PercentEnabled: number | undefined;
|
|
@@ -914,7 +889,7 @@ export interface LogConfiguration {
|
|
|
914
889
|
* <p>The method used for collecting logs from AWS Elemental MediaTailor. <code>LEGACY_CLOUDWATCH</code> indicates that MediaTailor is sending logs directly to Amazon CloudWatch Logs. <code>VENDED_LOGS</code> indicates that MediaTailor is sending logs to CloudWatch, which then vends the logs to your destination of choice. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream. </p>
|
|
915
890
|
* @public
|
|
916
891
|
*/
|
|
917
|
-
EnabledLoggingStrategies
|
|
892
|
+
EnabledLoggingStrategies: LoggingStrategy[] | undefined;
|
|
918
893
|
/**
|
|
919
894
|
* <p>Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).</p>
|
|
920
895
|
* @public
|
|
@@ -927,8 +902,7 @@ export interface LogConfiguration {
|
|
|
927
902
|
ManifestServiceInteractionLog?: ManifestServiceInteractionLog | undefined;
|
|
928
903
|
}
|
|
929
904
|
/**
|
|
930
|
-
* <p>For HLS, when set to <code>true</code>, MediaTailor passes through <code>EXT-X-CUE-IN</code>, <code>EXT-X-CUE-OUT</code>, and <code>EXT-X-SPLICEPOINT-SCTE35</code> ad markers from the origin manifest to the MediaTailor personalized manifest.</p>
|
|
931
|
-
* <p>No logic is applied to these ad markers. For example, if <code>EXT-X-CUE-OUT</code> has a value of <code>60</code>, but no ads are filled for that ad break, MediaTailor will not set the value to <code>0</code>.</p>
|
|
905
|
+
* <p>For HLS, when set to <code>true</code>, MediaTailor passes through <code>EXT-X-CUE-IN</code>, <code>EXT-X-CUE-OUT</code>, and <code>EXT-X-SPLICEPOINT-SCTE35</code> ad markers from the origin manifest to the MediaTailor personalized manifest.</p> <p>No logic is applied to these ad markers. For example, if <code>EXT-X-CUE-OUT</code> has a value of <code>60</code>, but no ads are filled for that ad break, MediaTailor will not set the value to <code>0</code>.</p>
|
|
932
906
|
* @public
|
|
933
907
|
*/
|
|
934
908
|
export interface AdMarkerPassthrough {
|
|
@@ -944,8 +918,7 @@ export interface AdMarkerPassthrough {
|
|
|
944
918
|
*/
|
|
945
919
|
export interface ManifestProcessingRules {
|
|
946
920
|
/**
|
|
947
|
-
* <p>For HLS, when set to <code>true</code>, MediaTailor passes through <code>EXT-X-CUE-IN</code>, <code>EXT-X-CUE-OUT</code>, and <code>EXT-X-SPLICEPOINT-SCTE35</code> ad markers from the origin manifest to the MediaTailor personalized manifest.</p>
|
|
948
|
-
* <p>No logic is applied to these ad markers. For example, if <code>EXT-X-CUE-OUT</code> has a value of <code>60</code>, but no ads are filled for that ad break, MediaTailor will not set the value to <code>0</code>.</p>
|
|
921
|
+
* <p>For HLS, when set to <code>true</code>, MediaTailor passes through <code>EXT-X-CUE-IN</code>, <code>EXT-X-CUE-OUT</code>, and <code>EXT-X-SPLICEPOINT-SCTE35</code> ad markers from the origin manifest to the MediaTailor personalized manifest.</p> <p>No logic is applied to these ad markers. For example, if <code>EXT-X-CUE-OUT</code> has a value of <code>60</code>, but no ads are filled for that ad break, MediaTailor will not set the value to <code>0</code>.</p>
|
|
949
922
|
* @public
|
|
950
923
|
*/
|
|
951
924
|
AdMarkerPassthrough?: AdMarkerPassthrough | undefined;
|
|
@@ -1121,8 +1094,7 @@ export declare const TrafficShapingType: {
|
|
|
1121
1094
|
*/
|
|
1122
1095
|
export type TrafficShapingType = (typeof TrafficShapingType)[keyof typeof TrafficShapingType];
|
|
1123
1096
|
/**
|
|
1124
|
-
* <p>With recurring prefetch, MediaTailor automatically prefetches ads for every avail that occurs during the retrieval window. The following
|
|
1125
|
-
* configurations describe the MediaTailor behavior when prefetching ads for a live event.</p>
|
|
1097
|
+
* <p>With recurring prefetch, MediaTailor automatically prefetches ads for every avail that occurs during the retrieval window. The following configurations describe the MediaTailor behavior when prefetching ads for a live event.</p>
|
|
1126
1098
|
* @public
|
|
1127
1099
|
*/
|
|
1128
1100
|
export interface RecurringRetrieval {
|
|
@@ -1179,8 +1151,7 @@ export interface RecurringPrefetchConfiguration {
|
|
|
1179
1151
|
*/
|
|
1180
1152
|
export interface PrefetchRetrieval {
|
|
1181
1153
|
/**
|
|
1182
|
-
* <p>The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).</p>
|
|
1183
|
-
* <p>You initially configure <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html">dynamic variables</a> for the ADS URL when you set up your playback configuration. When you specify <code>DynamicVariables</code> for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.</p>
|
|
1154
|
+
* <p>The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).</p> <p>You initially configure <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html">dynamic variables</a> for the ADS URL when you set up your playback configuration. When you specify <code>DynamicVariables</code> for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.</p>
|
|
1184
1155
|
* @public
|
|
1185
1156
|
*/
|
|
1186
1157
|
DynamicVariables?: Record<string, string> | undefined;
|
|
@@ -1248,9 +1219,7 @@ export interface PrefetchSchedule {
|
|
|
1248
1219
|
*/
|
|
1249
1220
|
Retrieval?: PrefetchRetrieval | undefined;
|
|
1250
1221
|
/**
|
|
1251
|
-
* <p>The frequency that MediaTailor creates prefetch schedules. <code>SINGLE</code> indicates that this schedule applies to one ad break. <code>RECURRING</code> indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.</p>
|
|
1252
|
-
* <p>For more information about the prefetch types and when you might use each, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html">Prefetching ads in Elemental MediaTailor.</a>
|
|
1253
|
-
* </p>
|
|
1222
|
+
* <p>The frequency that MediaTailor creates prefetch schedules. <code>SINGLE</code> indicates that this schedule applies to one ad break. <code>RECURRING</code> indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.</p> <p>For more information about the prefetch types and when you might use each, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html">Prefetching ads in Elemental MediaTailor.</a> </p>
|
|
1254
1223
|
* @public
|
|
1255
1224
|
*/
|
|
1256
1225
|
ScheduleType?: PrefetchScheduleType | undefined;
|
|
@@ -1421,23 +1390,7 @@ export interface SecretsManagerAccessTokenConfiguration {
|
|
|
1421
1390
|
*/
|
|
1422
1391
|
export interface AccessConfiguration {
|
|
1423
1392
|
/**
|
|
1424
|
-
* <p>The type of authentication used to access content from <code>HttpConfiguration::BaseUrl</code> on your source location.</p>
|
|
1425
|
-
* <p>
|
|
1426
|
-
* <code>S3_SIGV4</code> - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.</p>
|
|
1427
|
-
* <p>Before you can use <code>S3_SIGV4</code>, you must meet these requirements:</p>
|
|
1428
|
-
* <p>• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.</p>
|
|
1429
|
-
* <p>• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.</p>
|
|
1430
|
-
* <p>• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.</p>
|
|
1431
|
-
* <p>
|
|
1432
|
-
* <code>AUTODETECT_SIGV4</code> - AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored.</p>
|
|
1433
|
-
* <p>Before you can use <code>AUTODETECT_SIGV4</code> with a MediaPackage Version 2 endpoint, you must meet these requirements:</p>
|
|
1434
|
-
* <p>• You must grant MediaTailor access to your MediaPackage endpoint by granting <code>mediatailor.amazonaws.com</code> principal access in an Origin Access policy on the endpoint.</p>
|
|
1435
|
-
* <p>• Your MediaTailor source location base URL must be a MediaPackage V2 endpoint.</p>
|
|
1436
|
-
* <p>• The caller of the API must have <code>mediapackagev2:GetObject</code> IAM permissions to read all top level manifests referenced by the MediaTailor source packaging configurations.</p>
|
|
1437
|
-
* <p>Before you can use <code>AUTODETECT_SIGV4</code> with an Amazon S3 bucket, you must meet these requirements:</p>
|
|
1438
|
-
* <p>• You must grant MediaTailor access to your S3 bucket by granting <code>mediatailor.amazonaws.com</code> principal access in IAM. For more information about configuring access in IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management</a> in the <i>IAM User Guide.</i>.</p>
|
|
1439
|
-
* <p>• The <code>mediatailor.amazonaws.com</code> service principal must have permissions to read all top-level manifests referenced by the <code>VodSource</code> packaging configurations.</p>
|
|
1440
|
-
* <p>• The caller of the API must have <code>s3:GetObject</code> IAM permissions to read all top level manifests referenced by your MediaTailor <code>VodSource</code> packaging configurations.</p>
|
|
1393
|
+
* <p>The type of authentication used to access content from <code>HttpConfiguration::BaseUrl</code> on your source location.</p> <p> <code>S3_SIGV4</code> - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.</p> <p>Before you can use <code>S3_SIGV4</code>, you must meet these requirements:</p> <p>• You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.</p> <p>• The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.</p> <p>• The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.</p> <p> <code>AUTODETECT_SIGV4</code> - AWS Signature Version 4 authentication for a set of supported services: MediaPackage Version 2 and Amazon S3 hosted virtual-style access. If your source location base URL is a MediaPackage Version 2 endpoint or an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the resource where your source content is stored.</p> <p>Before you can use <code>AUTODETECT_SIGV4</code> with a MediaPackage Version 2 endpoint, you must meet these requirements:</p> <p>• You must grant MediaTailor access to your MediaPackage endpoint by granting <code>mediatailor.amazonaws.com</code> principal access in an Origin Access policy on the endpoint.</p> <p>• Your MediaTailor source location base URL must be a MediaPackage V2 endpoint.</p> <p>• The caller of the API must have <code>mediapackagev2:GetObject</code> IAM permissions to read all top level manifests referenced by the MediaTailor source packaging configurations.</p> <p>Before you can use <code>AUTODETECT_SIGV4</code> with an Amazon S3 bucket, you must meet these requirements:</p> <p>• You must grant MediaTailor access to your S3 bucket by granting <code>mediatailor.amazonaws.com</code> principal access in IAM. For more information about configuring access in IAM, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html">Access management</a> in the <i>IAM User Guide.</i>.</p> <p>• The <code>mediatailor.amazonaws.com</code> service principal must have permissions to read all top-level manifests referenced by the <code>VodSource</code> packaging configurations.</p> <p>• The caller of the API must have <code>s3:GetObject</code> IAM permissions to read all top level manifests referenced by your MediaTailor <code>VodSource</code> packaging configurations.</p>
|
|
1441
1394
|
* @public
|
|
1442
1395
|
*/
|
|
1443
1396
|
AccessType?: AccessType | undefined;
|
|
@@ -1721,17 +1674,12 @@ export declare const Tier: {
|
|
|
1721
1674
|
*/
|
|
1722
1675
|
export type Tier = (typeof Tier)[keyof typeof Tier];
|
|
1723
1676
|
/**
|
|
1724
|
-
* <p>
|
|
1725
|
-
* The configuration for time-shifted viewing.
|
|
1726
|
-
* </p>
|
|
1677
|
+
* <p> The configuration for time-shifted viewing. </p>
|
|
1727
1678
|
* @public
|
|
1728
1679
|
*/
|
|
1729
1680
|
export interface TimeShiftConfiguration {
|
|
1730
1681
|
/**
|
|
1731
|
-
* <p>
|
|
1732
|
-
* The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds,
|
|
1733
|
-
* and the maximum allowed maximum time delay is 21600 seconds (6 hours).
|
|
1734
|
-
* </p>
|
|
1682
|
+
* <p> The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds, and the maximum allowed maximum time delay is 21600 seconds (6 hours). </p>
|
|
1735
1683
|
* @public
|
|
1736
1684
|
*/
|
|
1737
1685
|
MaxTimeDelaySeconds: number | undefined;
|
|
@@ -1746,9 +1694,7 @@ export interface CreateChannelRequest {
|
|
|
1746
1694
|
*/
|
|
1747
1695
|
ChannelName: string | undefined;
|
|
1748
1696
|
/**
|
|
1749
|
-
* <p>The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the <code>LINEAR</code>
|
|
1750
|
-
* <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
|
|
1751
|
-
* <code>PlaybackMode</code>.</p>
|
|
1697
|
+
* <p>The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the <code>LINEAR</code> <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code> <code>PlaybackMode</code>.</p>
|
|
1752
1698
|
* @public
|
|
1753
1699
|
*/
|
|
1754
1700
|
FillerSlate?: SlateSource | undefined;
|
|
@@ -1758,11 +1704,7 @@ export interface CreateChannelRequest {
|
|
|
1758
1704
|
*/
|
|
1759
1705
|
Outputs: RequestOutputItem[] | undefined;
|
|
1760
1706
|
/**
|
|
1761
|
-
* <p>The type of playback mode to use for this channel.</p>
|
|
1762
|
-
* <p>
|
|
1763
|
-
* <code>LINEAR</code> - The programs in the schedule play once back-to-back in the schedule.</p>
|
|
1764
|
-
* <p>
|
|
1765
|
-
* <code>LOOP</code> - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.</p>
|
|
1707
|
+
* <p>The type of playback mode to use for this channel.</p> <p> <code>LINEAR</code> - The programs in the schedule play once back-to-back in the schedule.</p> <p> <code>LOOP</code> - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.</p>
|
|
1766
1708
|
* @public
|
|
1767
1709
|
*/
|
|
1768
1710
|
PlaybackMode: PlaybackMode | undefined;
|
|
@@ -1777,9 +1719,7 @@ export interface CreateChannelRequest {
|
|
|
1777
1719
|
*/
|
|
1778
1720
|
Tier?: Tier | undefined;
|
|
1779
1721
|
/**
|
|
1780
|
-
* <p>
|
|
1781
|
-
* The time-shifted viewing configuration you want to associate to the channel.
|
|
1782
|
-
* </p>
|
|
1722
|
+
* <p> The time-shifted viewing configuration you want to associate to the channel. </p>
|
|
1783
1723
|
* @public
|
|
1784
1724
|
*/
|
|
1785
1725
|
TimeShiftConfiguration?: TimeShiftConfiguration | undefined;
|
|
@@ -1856,9 +1796,7 @@ export interface CreateChannelResponse {
|
|
|
1856
1796
|
*/
|
|
1857
1797
|
Tier?: string | undefined;
|
|
1858
1798
|
/**
|
|
1859
|
-
* <p>
|
|
1860
|
-
* The time-shifted viewing configuration assigned to the channel.
|
|
1861
|
-
* </p>
|
|
1799
|
+
* <p> The time-shifted viewing configuration assigned to the channel. </p>
|
|
1862
1800
|
* @public
|
|
1863
1801
|
*/
|
|
1864
1802
|
TimeShiftConfiguration?: TimeShiftConfiguration | undefined;
|
|
@@ -1953,9 +1891,7 @@ export interface DescribeChannelResponse {
|
|
|
1953
1891
|
*/
|
|
1954
1892
|
LogConfiguration: LogConfigurationForChannel | undefined;
|
|
1955
1893
|
/**
|
|
1956
|
-
* <p>
|
|
1957
|
-
* The time-shifted viewing configuration for the channel.
|
|
1958
|
-
* </p>
|
|
1894
|
+
* <p> The time-shifted viewing configuration for the channel. </p>
|
|
1959
1895
|
* @public
|
|
1960
1896
|
*/
|
|
1961
1897
|
TimeShiftConfiguration?: TimeShiftConfiguration | undefined;
|
|
@@ -1985,10 +1921,7 @@ export interface GetChannelScheduleRequest {
|
|
|
1985
1921
|
*/
|
|
1986
1922
|
MaxResults?: number | undefined;
|
|
1987
1923
|
/**
|
|
1988
|
-
* <p>(Optional) If the playback configuration has more than <code>MaxResults</code> channel schedules, use <code>NextToken</code> to get the second and subsequent pages of results.</p>
|
|
1989
|
-
* <p>For the first <code>GetChannelScheduleRequest</code> request, omit this value.</p>
|
|
1990
|
-
* <p>For the second and subsequent requests, get the value of <code>NextToken</code> from the previous response and specify that value for <code>NextToken</code> in the request.</p>
|
|
1991
|
-
* <p>If the previous response didn't include a <code>NextToken</code> element, there are no more channel schedules to get.</p>
|
|
1924
|
+
* <p>(Optional) If the playback configuration has more than <code>MaxResults</code> channel schedules, use <code>NextToken</code> to get the second and subsequent pages of results.</p> <p>For the first <code>GetChannelScheduleRequest</code> request, omit this value.</p> <p>For the second and subsequent requests, get the value of <code>NextToken</code> from the previous response and specify that value for <code>NextToken</code> in the request.</p> <p>If the previous response didn't include a <code>NextToken</code> element, there are no more channel schedules to get.</p>
|
|
1992
1925
|
* @public
|
|
1993
1926
|
*/
|
|
1994
1927
|
NextToken?: string | undefined;
|
|
@@ -2081,15 +2014,7 @@ export interface Transition {
|
|
|
2081
2014
|
*/
|
|
2082
2015
|
ScheduledStartTimeMillis?: number | undefined;
|
|
2083
2016
|
/**
|
|
2084
|
-
* <p>Defines when the program plays in the schedule. You can set the value to <code>ABSOLUTE</code> or <code>RELATIVE</code>.</p>
|
|
2085
|
-
* <p>
|
|
2086
|
-
* <code>ABSOLUTE</code> - The program plays at a specific wall clock time. This setting can only be used for channels using the <code>LINEAR</code>
|
|
2087
|
-
* <code>PlaybackMode</code>.</p>
|
|
2088
|
-
* <p>Note the following considerations when using <code>ABSOLUTE</code> transitions:</p>
|
|
2089
|
-
* <p>If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.</p>
|
|
2090
|
-
* <p>If there are gaps in playback, MediaTailor plays the <code>FillerSlate</code> you configured for your linear channel.</p>
|
|
2091
|
-
* <p>
|
|
2092
|
-
* <code>RELATIVE</code> - The program is inserted into the schedule either before or after a program that you specify via <code>RelativePosition</code>.</p>
|
|
2017
|
+
* <p>Defines when the program plays in the schedule. You can set the value to <code>ABSOLUTE</code> or <code>RELATIVE</code>.</p> <p> <code>ABSOLUTE</code> - The program plays at a specific wall clock time. This setting can only be used for channels using the <code>LINEAR</code> <code>PlaybackMode</code>.</p> <p>Note the following considerations when using <code>ABSOLUTE</code> transitions:</p> <p>If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.</p> <p>If there are gaps in playback, MediaTailor plays the <code>FillerSlate</code> you configured for your linear channel.</p> <p> <code>RELATIVE</code> - The program is inserted into the schedule either before or after a program that you specify via <code>RelativePosition</code>.</p>
|
|
2093
2018
|
* @public
|
|
2094
2019
|
*/
|
|
2095
2020
|
Type: string | undefined;
|
|
@@ -2487,9 +2412,7 @@ export interface UpdateChannelRequest {
|
|
|
2487
2412
|
*/
|
|
2488
2413
|
ChannelName: string | undefined;
|
|
2489
2414
|
/**
|
|
2490
|
-
* <p>The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the <code>LINEAR</code>
|
|
2491
|
-
* <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
|
|
2492
|
-
* <code>PlaybackMode</code>.</p>
|
|
2415
|
+
* <p>The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the <code>LINEAR</code> <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code> <code>PlaybackMode</code>.</p>
|
|
2493
2416
|
* @public
|
|
2494
2417
|
*/
|
|
2495
2418
|
FillerSlate?: SlateSource | undefined;
|
|
@@ -2499,9 +2422,7 @@ export interface UpdateChannelRequest {
|
|
|
2499
2422
|
*/
|
|
2500
2423
|
Outputs: RequestOutputItem[] | undefined;
|
|
2501
2424
|
/**
|
|
2502
|
-
* <p>
|
|
2503
|
-
* The time-shifted viewing configuration you want to associate to the channel.
|
|
2504
|
-
* </p>
|
|
2425
|
+
* <p> The time-shifted viewing configuration you want to associate to the channel. </p>
|
|
2505
2426
|
* @public
|
|
2506
2427
|
*/
|
|
2507
2428
|
TimeShiftConfiguration?: TimeShiftConfiguration | undefined;
|
|
@@ -2536,9 +2457,7 @@ export interface UpdateChannelResponse {
|
|
|
2536
2457
|
*/
|
|
2537
2458
|
CreationTime?: Date | undefined;
|
|
2538
2459
|
/**
|
|
2539
|
-
* <p>The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the <code>LINEAR</code>
|
|
2540
|
-
* <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
|
|
2541
|
-
* <code>PlaybackMode</code>.</p>
|
|
2460
|
+
* <p>The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the <code>LINEAR</code> <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code> <code>PlaybackMode</code>.</p>
|
|
2542
2461
|
* @public
|
|
2543
2462
|
*/
|
|
2544
2463
|
FillerSlate?: SlateSource | undefined;
|
|
@@ -2553,11 +2472,7 @@ export interface UpdateChannelResponse {
|
|
|
2553
2472
|
*/
|
|
2554
2473
|
Outputs?: ResponseOutputItem[] | undefined;
|
|
2555
2474
|
/**
|
|
2556
|
-
* <p>The type of playback mode for this channel.</p>
|
|
2557
|
-
* <p>
|
|
2558
|
-
* <code>LINEAR</code> - Programs play back-to-back only once.</p>
|
|
2559
|
-
* <p>
|
|
2560
|
-
* <code>LOOP</code> - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.</p>
|
|
2475
|
+
* <p>The type of playback mode for this channel.</p> <p> <code>LINEAR</code> - Programs play back-to-back only once.</p> <p> <code>LOOP</code> - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.</p>
|
|
2561
2476
|
* @public
|
|
2562
2477
|
*/
|
|
2563
2478
|
PlaybackMode?: string | undefined;
|
|
@@ -2572,9 +2487,7 @@ export interface UpdateChannelResponse {
|
|
|
2572
2487
|
*/
|
|
2573
2488
|
Tier?: string | undefined;
|
|
2574
2489
|
/**
|
|
2575
|
-
* <p>
|
|
2576
|
-
* The time-shifted viewing configuration for the channel.
|
|
2577
|
-
* </p>
|
|
2490
|
+
* <p> The time-shifted viewing configuration for the channel. </p>
|
|
2578
2491
|
* @public
|
|
2579
2492
|
*/
|
|
2580
2493
|
TimeShiftConfiguration?: TimeShiftConfiguration | undefined;
|
|
@@ -2590,9 +2503,7 @@ export interface UpdateChannelResponse {
|
|
|
2590
2503
|
*/
|
|
2591
2504
|
export interface ConfigureLogsForPlaybackConfigurationRequest {
|
|
2592
2505
|
/**
|
|
2593
|
-
* <p>The percentage of session logs that MediaTailor sends to your CloudWatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to <code>60</code>, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html">debug log mode</a>.</p>
|
|
2594
|
-
* <p>Valid values: <code>0</code> - <code>100</code>
|
|
2595
|
-
* </p>
|
|
2506
|
+
* <p>The percentage of session logs that MediaTailor sends to your CloudWatch Logs account. For example, if your playback configuration has 1000 sessions and percentEnabled is set to <code>60</code>, MediaTailor sends logs for 600 of the sessions to CloudWatch Logs. MediaTailor decides at random which of the playback configuration sessions to send logs for. If you want to view logs for a specific session, you can use the <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/debug-log-mode.html">debug log mode</a>.</p> <p>Valid values: <code>0</code> - <code>100</code> </p>
|
|
2596
2507
|
* @public
|
|
2597
2508
|
*/
|
|
2598
2509
|
PercentEnabled: number | undefined;
|
|
@@ -2602,9 +2513,7 @@ export interface ConfigureLogsForPlaybackConfigurationRequest {
|
|
|
2602
2513
|
*/
|
|
2603
2514
|
PlaybackConfigurationName: string | undefined;
|
|
2604
2515
|
/**
|
|
2605
|
-
* <p>The method used for collecting logs from AWS Elemental MediaTailor. To configure MediaTailor to send logs directly to Amazon CloudWatch Logs, choose <code>LEGACY_CLOUDWATCH</code>. To configure MediaTailor to
|
|
2606
|
-
* send logs to CloudWatch, which then vends the logs to your destination of choice, choose <code>VENDED_LOGS</code>. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.</p>
|
|
2607
|
-
* <p>To use vended logs, you must configure the delivery destination in Amazon CloudWatch, as described in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html#AWS-vended-logs-permissions-V2">Enable logging from AWS services, Logging that requires additional permissions [V2]</a>.</p>
|
|
2516
|
+
* <p>The method used for collecting logs from AWS Elemental MediaTailor. To configure MediaTailor to send logs directly to Amazon CloudWatch Logs, choose <code>LEGACY_CLOUDWATCH</code>. To configure MediaTailor to send logs to CloudWatch, which then vends the logs to your destination of choice, choose <code>VENDED_LOGS</code>. Supported destinations are CloudWatch Logs log group, Amazon S3 bucket, and Amazon Data Firehose stream.</p> <p>To use vended logs, you must configure the delivery destination in Amazon CloudWatch, as described in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html#AWS-vended-logs-permissions-V2">Enable logging from AWS services, Logging that requires additional permissions [V2]</a>.</p>
|
|
2608
2517
|
* @public
|
|
2609
2518
|
*/
|
|
2610
2519
|
EnabledLoggingStrategies?: LoggingStrategy[] | undefined;
|
|
@@ -2744,9 +2653,7 @@ export interface CreatePrefetchScheduleRequest {
|
|
|
2744
2653
|
*/
|
|
2745
2654
|
RecurringPrefetchConfiguration?: RecurringPrefetchConfiguration | undefined;
|
|
2746
2655
|
/**
|
|
2747
|
-
* <p>The frequency that MediaTailor creates prefetch schedules. <code>SINGLE</code> indicates that this schedule applies to one ad break. <code>RECURRING</code> indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.</p>
|
|
2748
|
-
* <p>For more information about the prefetch types and when you might use each, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html">Prefetching ads in Elemental MediaTailor.</a>
|
|
2749
|
-
* </p>
|
|
2656
|
+
* <p>The frequency that MediaTailor creates prefetch schedules. <code>SINGLE</code> indicates that this schedule applies to one ad break. <code>RECURRING</code> indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.</p> <p>For more information about the prefetch types and when you might use each, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html">Prefetching ads in Elemental MediaTailor.</a> </p>
|
|
2750
2657
|
* @public
|
|
2751
2658
|
*/
|
|
2752
2659
|
ScheduleType?: PrefetchScheduleType | undefined;
|
|
@@ -3535,10 +3442,7 @@ export interface ListPrefetchSchedulesRequest {
|
|
|
3535
3442
|
*/
|
|
3536
3443
|
MaxResults?: number | undefined;
|
|
3537
3444
|
/**
|
|
3538
|
-
* <p>(Optional) If the playback configuration has more than <code>MaxResults</code> prefetch schedules, use <code>NextToken</code> to get the second and subsequent pages of results.</p>
|
|
3539
|
-
* <p> For the first <code>ListPrefetchSchedulesRequest</code> request, omit this value.</p>
|
|
3540
|
-
* <p> For the second and subsequent requests, get the value of <code>NextToken</code> from the previous response and specify that value for <code>NextToken</code> in the request.</p>
|
|
3541
|
-
* <p> If the previous response didn't include a <code>NextToken</code> element, there are no more prefetch schedules to get.</p>
|
|
3445
|
+
* <p>(Optional) If the playback configuration has more than <code>MaxResults</code> prefetch schedules, use <code>NextToken</code> to get the second and subsequent pages of results.</p> <p> For the first <code>ListPrefetchSchedulesRequest</code> request, omit this value.</p> <p> For the second and subsequent requests, get the value of <code>NextToken</code> from the previous response and specify that value for <code>NextToken</code> in the request.</p> <p> If the previous response didn't include a <code>NextToken</code> element, there are no more prefetch schedules to get.</p>
|
|
3542
3446
|
* @public
|
|
3543
3447
|
*/
|
|
3544
3448
|
NextToken?: string | undefined;
|
|
@@ -3548,8 +3452,7 @@ export interface ListPrefetchSchedulesRequest {
|
|
|
3548
3452
|
*/
|
|
3549
3453
|
PlaybackConfigurationName: string | undefined;
|
|
3550
3454
|
/**
|
|
3551
|
-
* <p>The type of prefetch schedules that you want to list. <code>SINGLE</code> indicates that you want to list the configured single prefetch schedules. <code>RECURRING</code>
|
|
3552
|
-
* indicates that you want to list the configured recurring prefetch schedules. <code>ALL</code> indicates that you want to list all configured prefetch schedules.</p>
|
|
3455
|
+
* <p>The type of prefetch schedules that you want to list. <code>SINGLE</code> indicates that you want to list the configured single prefetch schedules. <code>RECURRING</code> indicates that you want to list the configured recurring prefetch schedules. <code>ALL</code> indicates that you want to list all configured prefetch schedules.</p>
|
|
3553
3456
|
* @public
|
|
3554
3457
|
*/
|
|
3555
3458
|
ScheduleType?: ListPrefetchScheduleType | undefined;
|
|
@@ -298,7 +298,7 @@ export interface ManifestServiceInteractionLog {
|
|
|
298
298
|
}
|
|
299
299
|
export interface LogConfiguration {
|
|
300
300
|
PercentEnabled: number | undefined;
|
|
301
|
-
EnabledLoggingStrategies
|
|
301
|
+
EnabledLoggingStrategies: LoggingStrategy[] | undefined;
|
|
302
302
|
AdsInteractionLog?: AdsInteractionLog | undefined;
|
|
303
303
|
ManifestServiceInteractionLog?: ManifestServiceInteractionLog | undefined;
|
|
304
304
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-mediatailor",
|
|
3
3
|
"description": "AWS SDK for JavaScript Mediatailor Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.810.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-mediatailor",
|
|
@@ -20,39 +20,39 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/core": "3.
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
23
|
+
"@aws-sdk/core": "3.810.0",
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.810.0",
|
|
25
25
|
"@aws-sdk/middleware-host-header": "3.804.0",
|
|
26
26
|
"@aws-sdk/middleware-logger": "3.804.0",
|
|
27
27
|
"@aws-sdk/middleware-recursion-detection": "3.804.0",
|
|
28
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
29
|
-
"@aws-sdk/region-config-resolver": "3.
|
|
28
|
+
"@aws-sdk/middleware-user-agent": "3.810.0",
|
|
29
|
+
"@aws-sdk/region-config-resolver": "3.808.0",
|
|
30
30
|
"@aws-sdk/types": "3.804.0",
|
|
31
|
-
"@aws-sdk/util-endpoints": "3.
|
|
31
|
+
"@aws-sdk/util-endpoints": "3.808.0",
|
|
32
32
|
"@aws-sdk/util-user-agent-browser": "3.804.0",
|
|
33
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
34
|
-
"@smithy/config-resolver": "^4.1.
|
|
35
|
-
"@smithy/core": "^3.3.
|
|
33
|
+
"@aws-sdk/util-user-agent-node": "3.810.0",
|
|
34
|
+
"@smithy/config-resolver": "^4.1.2",
|
|
35
|
+
"@smithy/core": "^3.3.3",
|
|
36
36
|
"@smithy/fetch-http-handler": "^5.0.2",
|
|
37
37
|
"@smithy/hash-node": "^4.0.2",
|
|
38
38
|
"@smithy/invalid-dependency": "^4.0.2",
|
|
39
39
|
"@smithy/middleware-content-length": "^4.0.2",
|
|
40
|
-
"@smithy/middleware-endpoint": "^4.1.
|
|
41
|
-
"@smithy/middleware-retry": "^4.1.
|
|
42
|
-
"@smithy/middleware-serde": "^4.0.
|
|
40
|
+
"@smithy/middleware-endpoint": "^4.1.6",
|
|
41
|
+
"@smithy/middleware-retry": "^4.1.7",
|
|
42
|
+
"@smithy/middleware-serde": "^4.0.5",
|
|
43
43
|
"@smithy/middleware-stack": "^4.0.2",
|
|
44
|
-
"@smithy/node-config-provider": "^4.1.
|
|
44
|
+
"@smithy/node-config-provider": "^4.1.1",
|
|
45
45
|
"@smithy/node-http-handler": "^4.0.4",
|
|
46
46
|
"@smithy/protocol-http": "^5.1.0",
|
|
47
|
-
"@smithy/smithy-client": "^4.2.
|
|
47
|
+
"@smithy/smithy-client": "^4.2.6",
|
|
48
48
|
"@smithy/types": "^4.2.0",
|
|
49
49
|
"@smithy/url-parser": "^4.0.2",
|
|
50
50
|
"@smithy/util-base64": "^4.0.0",
|
|
51
51
|
"@smithy/util-body-length-browser": "^4.0.0",
|
|
52
52
|
"@smithy/util-body-length-node": "^4.0.0",
|
|
53
|
-
"@smithy/util-defaults-mode-browser": "^4.0.
|
|
54
|
-
"@smithy/util-defaults-mode-node": "^4.0.
|
|
55
|
-
"@smithy/util-endpoints": "^3.0.
|
|
53
|
+
"@smithy/util-defaults-mode-browser": "^4.0.14",
|
|
54
|
+
"@smithy/util-defaults-mode-node": "^4.0.14",
|
|
55
|
+
"@smithy/util-endpoints": "^3.0.4",
|
|
56
56
|
"@smithy/util-middleware": "^4.0.2",
|
|
57
57
|
"@smithy/util-retry": "^4.0.3",
|
|
58
58
|
"@smithy/util-utf8": "^4.0.0",
|