@aws-sdk/client-mediatailor 3.533.0 → 3.536.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/dist-cjs/index.js +17 -1
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +15 -0
- package/dist-types/MediaTailor.d.ts +4 -1
- package/dist-types/MediaTailorClient.d.ts +1 -1
- package/dist-types/commands/ConfigureLogsForChannelCommand.d.ts +2 -1
- package/dist-types/commands/ConfigureLogsForPlaybackConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/CreateChannelCommand.d.ts +8 -1
- package/dist-types/commands/CreateLiveSourceCommand.d.ts +2 -1
- package/dist-types/commands/CreatePrefetchScheduleCommand.d.ts +2 -1
- package/dist-types/commands/CreateProgramCommand.d.ts +114 -3
- package/dist-types/commands/CreateSourceLocationCommand.d.ts +2 -1
- package/dist-types/commands/CreateVodSourceCommand.d.ts +2 -1
- package/dist-types/commands/DeleteChannelCommand.d.ts +2 -1
- package/dist-types/commands/DeleteChannelPolicyCommand.d.ts +2 -1
- package/dist-types/commands/DeleteLiveSourceCommand.d.ts +2 -1
- package/dist-types/commands/DeletePlaybackConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/DeletePrefetchScheduleCommand.d.ts +2 -1
- package/dist-types/commands/DeleteProgramCommand.d.ts +2 -1
- package/dist-types/commands/DeleteSourceLocationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteVodSourceCommand.d.ts +2 -1
- package/dist-types/commands/DescribeChannelCommand.d.ts +5 -1
- package/dist-types/commands/DescribeLiveSourceCommand.d.ts +2 -1
- package/dist-types/commands/DescribeProgramCommand.d.ts +58 -2
- package/dist-types/commands/DescribeSourceLocationCommand.d.ts +2 -1
- package/dist-types/commands/DescribeVodSourceCommand.d.ts +2 -1
- package/dist-types/commands/GetChannelPolicyCommand.d.ts +2 -1
- package/dist-types/commands/GetChannelScheduleCommand.d.ts +7 -2
- package/dist-types/commands/GetPlaybackConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetPrefetchScheduleCommand.d.ts +2 -1
- package/dist-types/commands/ListAlertsCommand.d.ts +2 -1
- package/dist-types/commands/ListChannelsCommand.d.ts +5 -1
- package/dist-types/commands/ListLiveSourcesCommand.d.ts +2 -1
- package/dist-types/commands/ListPlaybackConfigurationsCommand.d.ts +2 -1
- package/dist-types/commands/ListPrefetchSchedulesCommand.d.ts +2 -1
- package/dist-types/commands/ListSourceLocationsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/ListVodSourcesCommand.d.ts +2 -1
- package/dist-types/commands/PutChannelPolicyCommand.d.ts +2 -1
- package/dist-types/commands/PutPlaybackConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/StartChannelCommand.d.ts +2 -1
- package/dist-types/commands/StopChannelCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateChannelCommand.d.ts +8 -1
- package/dist-types/commands/UpdateLiveSourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateProgramCommand.d.ts +114 -3
- package/dist-types/commands/UpdateSourceLocationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateVodSourceCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +691 -563
- package/dist-types/ts3.4/MediaTailor.d.ts +3 -0
- package/dist-types/ts3.4/commands/ConfigureLogsForChannelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ConfigureLogsForPlaybackConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateChannelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateLiveSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreatePrefetchScheduleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateProgramCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSourceLocationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateVodSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteChannelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteChannelPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteLiveSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeletePlaybackConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeletePrefetchScheduleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteProgramCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteSourceLocationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteVodSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeChannelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeLiveSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeProgramCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeSourceLocationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeVodSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetChannelPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetChannelScheduleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetPlaybackConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetPrefetchScheduleCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAlertsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListChannelsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListLiveSourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPlaybackConfigurationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListPrefetchSchedulesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSourceLocationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListVodSourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutChannelPolicyCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutPlaybackConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartChannelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StopChannelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateChannelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateLiveSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateProgramCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateSourceLocationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateVodSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/models/models_0.d.ts +31 -3
- package/package.json +40 -40
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { MediaTailorServiceException as __BaseException } from "./MediaTailorServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>For <code>SCTE35_ENHANCED</code> output, defines a key and corresponding value. MediaTailor generates these pairs within the <code>EXT-X-ASSET</code>tag.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export interface KeyValuePair {
|
|
8
8
|
/**
|
|
9
|
-
* @public
|
|
10
9
|
* <p>For <code>SCTE35_ENHANCED</code> output, defines a key. MediaTailor takes this key, and its associated value, and generates the key/value pair within the <code>EXT-X-ASSET</code>tag. If you specify a key, you must also specify a corresponding value.</p>
|
|
10
|
+
* @public
|
|
11
11
|
*/
|
|
12
12
|
Key: string | undefined;
|
|
13
13
|
/**
|
|
14
|
-
* @public
|
|
15
14
|
* <p>For <code>SCTE35_ENHANCED</code> output, defines a value. MediaTailor; takes this value, and its associated key, and generates the key/value pair within the <code>EXT-X-ASSET</code>tag. If you specify a value, you must also specify a corresponding key.</p>
|
|
15
|
+
* @public
|
|
16
16
|
*/
|
|
17
17
|
Value: string | undefined;
|
|
18
18
|
}
|
|
@@ -29,144 +29,144 @@ export declare const MessageType: {
|
|
|
29
29
|
*/
|
|
30
30
|
export type MessageType = (typeof MessageType)[keyof typeof MessageType];
|
|
31
31
|
/**
|
|
32
|
-
* @public
|
|
33
32
|
* <p>Slate VOD source configuration.</p>
|
|
33
|
+
* @public
|
|
34
34
|
*/
|
|
35
35
|
export interface SlateSource {
|
|
36
36
|
/**
|
|
37
|
-
* @public
|
|
38
37
|
* <p>The name of the source location where the slate VOD source is stored.</p>
|
|
38
|
+
* @public
|
|
39
39
|
*/
|
|
40
40
|
SourceLocationName?: string;
|
|
41
41
|
/**
|
|
42
|
-
* @public
|
|
43
42
|
* <p>The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.</p>
|
|
43
|
+
* @public
|
|
44
44
|
*/
|
|
45
45
|
VodSourceName?: string;
|
|
46
46
|
}
|
|
47
47
|
/**
|
|
48
|
-
* @public
|
|
49
48
|
* <p>Splice insert message configuration.</p>
|
|
49
|
+
* @public
|
|
50
50
|
*/
|
|
51
51
|
export interface SpliceInsertMessage {
|
|
52
52
|
/**
|
|
53
|
-
* @public
|
|
54
53
|
* <p>This is written to <code>splice_insert.avail_num</code>, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is <code>0</code>. Values must be between <code>0</code> and <code>256</code>, inclusive.</p>
|
|
54
|
+
* @public
|
|
55
55
|
*/
|
|
56
56
|
AvailNum?: number;
|
|
57
57
|
/**
|
|
58
|
-
* @public
|
|
59
58
|
* <p>This is written to <code>splice_insert.avails_expected</code>, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is <code>0</code>. Values must be between <code>0</code> and <code>256</code>, inclusive.</p>
|
|
59
|
+
* @public
|
|
60
60
|
*/
|
|
61
61
|
AvailsExpected?: number;
|
|
62
62
|
/**
|
|
63
|
-
* @public
|
|
64
63
|
* <p>This is written to <code>splice_insert.splice_event_id</code>, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is <code>1</code>.</p>
|
|
64
|
+
* @public
|
|
65
65
|
*/
|
|
66
66
|
SpliceEventId?: number;
|
|
67
67
|
/**
|
|
68
|
-
* @public
|
|
69
68
|
* <p>This is written to <code>splice_insert.unique_program_id</code>, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is <code>0</code>. Values must be between <code>0</code> and <code>256</code>, inclusive.</p>
|
|
69
|
+
* @public
|
|
70
70
|
*/
|
|
71
71
|
UniqueProgramId?: number;
|
|
72
72
|
}
|
|
73
73
|
/**
|
|
74
|
-
* @public
|
|
75
74
|
* <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>
|
|
76
75
|
* <p>
|
|
77
76
|
* <code>segmentation_descriptor</code> messages must be sent with the <code>time_signal</code> message type.</p>
|
|
78
77
|
* <p>See the <code>segmentation_descriptor()</code> table of the 2022 SCTE-35 specification for more information.</p>
|
|
78
|
+
* @public
|
|
79
79
|
*/
|
|
80
80
|
export interface SegmentationDescriptor {
|
|
81
81
|
/**
|
|
82
|
-
* @public
|
|
83
82
|
* <p>The Event Identifier to assign to the <code>segmentation_descriptor.segmentation_event_id</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.</p>
|
|
83
|
+
* @public
|
|
84
84
|
*/
|
|
85
85
|
SegmentationEventId?: number;
|
|
86
86
|
/**
|
|
87
|
-
* @public
|
|
88
87
|
* <p>The Upid Type to assign to the <code>segmentation_descriptor.segmentation_upid_type</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 14.</p>
|
|
88
|
+
* @public
|
|
89
89
|
*/
|
|
90
90
|
SegmentationUpidType?: number;
|
|
91
91
|
/**
|
|
92
|
-
* @public
|
|
93
92
|
* <p>The Upid to assign to the <code>segmentation_descriptor.segmentation_upid</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters 0 though 9 and A through F. The default value is "" (an empty string).</p>
|
|
93
|
+
* @public
|
|
94
94
|
*/
|
|
95
95
|
SegmentationUpid?: string;
|
|
96
96
|
/**
|
|
97
|
-
* @public
|
|
98
97
|
* <p>The Type Identifier to assign to the <code>segmentation_descriptor.segmentation_type_id</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is 48.</p>
|
|
98
|
+
* @public
|
|
99
99
|
*/
|
|
100
100
|
SegmentationTypeId?: number;
|
|
101
101
|
/**
|
|
102
|
-
* @public
|
|
103
102
|
* <p>The segment number to assign to the <code>segmentation_descriptor.segment_num</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.</p>
|
|
103
|
+
* @public
|
|
104
104
|
*/
|
|
105
105
|
SegmentNum?: number;
|
|
106
106
|
/**
|
|
107
|
-
* @public
|
|
108
107
|
* <p>The number of segments expected, which is assigned to the <code>segmentation_descriptor.segments_expectedS</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.</p>
|
|
108
|
+
* @public
|
|
109
109
|
*/
|
|
110
110
|
SegmentsExpected?: number;
|
|
111
111
|
/**
|
|
112
|
-
* @public
|
|
113
112
|
* <p>The sub-segment number to assign to the <code>segmentation_descriptor.sub_segment_num</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt value is null.</p>
|
|
113
|
+
* @public
|
|
114
114
|
*/
|
|
115
115
|
SubSegmentNum?: number;
|
|
116
116
|
/**
|
|
117
|
-
* @public
|
|
118
117
|
* <p>The number of sub-segments expected, which is assigned to the <code>segmentation_descriptor.sub_segments_expected</code> message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.</p>
|
|
118
|
+
* @public
|
|
119
119
|
*/
|
|
120
120
|
SubSegmentsExpected?: number;
|
|
121
121
|
}
|
|
122
122
|
/**
|
|
123
|
-
* @public
|
|
124
123
|
* <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>
|
|
125
124
|
* <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>
|
|
126
125
|
* <p>See the <code>time_signal()</code> table of the 2022 SCTE-35 specification for more information.</p>
|
|
126
|
+
* @public
|
|
127
127
|
*/
|
|
128
128
|
export interface TimeSignalMessage {
|
|
129
129
|
/**
|
|
130
|
-
* @public
|
|
131
130
|
* <p>The configurations for the SCTE-35 <code>segmentation_descriptor</code> message(s) sent with the <code>time_signal</code> message.</p>
|
|
131
|
+
* @public
|
|
132
132
|
*/
|
|
133
133
|
SegmentationDescriptors?: SegmentationDescriptor[];
|
|
134
134
|
}
|
|
135
135
|
/**
|
|
136
|
-
* @public
|
|
137
136
|
* <p>Ad break configuration parameters.</p>
|
|
137
|
+
* @public
|
|
138
138
|
*/
|
|
139
139
|
export interface AdBreak {
|
|
140
140
|
/**
|
|
141
|
-
* @public
|
|
142
141
|
* <p>The SCTE-35 ad insertion type. Accepted value: <code>SPLICE_INSERT</code>, <code>TIME_SIGNAL</code>.</p>
|
|
142
|
+
* @public
|
|
143
143
|
*/
|
|
144
144
|
MessageType?: MessageType;
|
|
145
145
|
/**
|
|
146
|
-
* @public
|
|
147
146
|
* <p>How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.</p>
|
|
147
|
+
* @public
|
|
148
148
|
*/
|
|
149
149
|
OffsetMillis: number | undefined;
|
|
150
150
|
/**
|
|
151
|
-
* @public
|
|
152
151
|
* <p>Ad break slate configuration.</p>
|
|
152
|
+
* @public
|
|
153
153
|
*/
|
|
154
154
|
Slate?: SlateSource;
|
|
155
155
|
/**
|
|
156
|
-
* @public
|
|
157
156
|
* <p>This defines the SCTE-35 <code>splice_insert()</code> message inserted around the ad. For information about using <code>splice_insert()</code>, see the SCTE-35 specficiaiton, section 9.7.3.1.</p>
|
|
157
|
+
* @public
|
|
158
158
|
*/
|
|
159
159
|
SpliceInsertMessage?: SpliceInsertMessage;
|
|
160
160
|
/**
|
|
161
|
-
* @public
|
|
162
161
|
* <p>Defines the SCTE-35 <code>time_signal</code> message inserted around the ad.</p>
|
|
163
162
|
* <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>
|
|
164
163
|
* <p>See section 9.7.4 of the 2022 SCTE-35 specification for more information.</p>
|
|
164
|
+
* @public
|
|
165
165
|
*/
|
|
166
166
|
TimeSignalMessage?: TimeSignalMessage;
|
|
167
167
|
/**
|
|
168
|
-
* @public
|
|
169
168
|
* <p>Defines a list of key/value pairs that MediaTailor generates within the <code>EXT-X-ASSET</code>tag for <code>SCTE35_ENHANCED</code> output.</p>
|
|
169
|
+
* @public
|
|
170
170
|
*/
|
|
171
171
|
AdBreakMetadata?: KeyValuePair[];
|
|
172
172
|
}
|
|
@@ -184,41 +184,114 @@ export declare const AlertCategory: {
|
|
|
184
184
|
*/
|
|
185
185
|
export type AlertCategory = (typeof AlertCategory)[keyof typeof AlertCategory];
|
|
186
186
|
/**
|
|
187
|
-
* @public
|
|
188
187
|
* <p>Alert configuration parameters.</p>
|
|
188
|
+
* @public
|
|
189
189
|
*/
|
|
190
190
|
export interface Alert {
|
|
191
191
|
/**
|
|
192
|
-
* @public
|
|
193
192
|
* <p>The code for the alert. For example, <code>NOT_PROCESSED</code>.</p>
|
|
193
|
+
* @public
|
|
194
194
|
*/
|
|
195
195
|
AlertCode: string | undefined;
|
|
196
196
|
/**
|
|
197
|
-
* @public
|
|
198
197
|
* <p>If an alert is generated for a resource, an explanation of the reason for the alert.</p>
|
|
198
|
+
* @public
|
|
199
199
|
*/
|
|
200
200
|
AlertMessage: string | undefined;
|
|
201
201
|
/**
|
|
202
|
-
* @public
|
|
203
202
|
* <p>The timestamp when the alert was last modified.</p>
|
|
203
|
+
* @public
|
|
204
204
|
*/
|
|
205
205
|
LastModifiedTime: Date | undefined;
|
|
206
206
|
/**
|
|
207
|
-
* @public
|
|
208
207
|
* <p>The Amazon Resource Names (ARNs) related to this alert.</p>
|
|
208
|
+
* @public
|
|
209
209
|
*/
|
|
210
210
|
RelatedResourceArns: string[] | undefined;
|
|
211
211
|
/**
|
|
212
|
-
* @public
|
|
213
212
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
213
|
+
* @public
|
|
214
214
|
*/
|
|
215
215
|
ResourceArn: string | undefined;
|
|
216
216
|
/**
|
|
217
|
-
* @public
|
|
218
217
|
* <p>The category that MediaTailor assigns to the alert.</p>
|
|
218
|
+
* @public
|
|
219
219
|
*/
|
|
220
220
|
Category?: AlertCategory;
|
|
221
221
|
}
|
|
222
|
+
/**
|
|
223
|
+
* <p>Clip range configuration for the VOD source associated with the program.</p>
|
|
224
|
+
* @public
|
|
225
|
+
*/
|
|
226
|
+
export interface ClipRange {
|
|
227
|
+
/**
|
|
228
|
+
* <p>The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.</p>
|
|
229
|
+
* @public
|
|
230
|
+
*/
|
|
231
|
+
EndOffsetMillis?: number;
|
|
232
|
+
/**
|
|
233
|
+
* <p>The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.</p>
|
|
234
|
+
* @public
|
|
235
|
+
*/
|
|
236
|
+
StartOffsetMillis?: number;
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* <p>A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.</p>
|
|
240
|
+
* @public
|
|
241
|
+
*/
|
|
242
|
+
export interface AlternateMedia {
|
|
243
|
+
/**
|
|
244
|
+
* <p>The name of the source location for alternateMedia.</p>
|
|
245
|
+
* @public
|
|
246
|
+
*/
|
|
247
|
+
SourceLocationName?: string;
|
|
248
|
+
/**
|
|
249
|
+
* <p>The name of the live source for alternateMedia.</p>
|
|
250
|
+
* @public
|
|
251
|
+
*/
|
|
252
|
+
LiveSourceName?: string;
|
|
253
|
+
/**
|
|
254
|
+
* <p>The name of the VOD source for alternateMedia.</p>
|
|
255
|
+
* @public
|
|
256
|
+
*/
|
|
257
|
+
VodSourceName?: string;
|
|
258
|
+
/**
|
|
259
|
+
* <p>Clip range configuration for the VOD source associated with the program.</p>
|
|
260
|
+
* @public
|
|
261
|
+
*/
|
|
262
|
+
ClipRange?: ClipRange;
|
|
263
|
+
/**
|
|
264
|
+
* <p>The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.</p>
|
|
265
|
+
* @public
|
|
266
|
+
*/
|
|
267
|
+
ScheduledStartTimeMillis?: number;
|
|
268
|
+
/**
|
|
269
|
+
* <p>Ad break configuration parameters defined in AlternateMedia.</p>
|
|
270
|
+
* @public
|
|
271
|
+
*/
|
|
272
|
+
AdBreaks?: AdBreak[];
|
|
273
|
+
/**
|
|
274
|
+
* <p>The duration of the alternateMedia in milliseconds.</p>
|
|
275
|
+
* @public
|
|
276
|
+
*/
|
|
277
|
+
DurationMillis?: number;
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* <p>An AudienceMedia object contains an Audience and a list of AlternateMedia.</p>
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
export interface AudienceMedia {
|
|
284
|
+
/**
|
|
285
|
+
* <p>The Audience defined in AudienceMedia.</p>
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
Audience?: string;
|
|
289
|
+
/**
|
|
290
|
+
* <p>The list of AlternateMedia defined in AudienceMedia.</p>
|
|
291
|
+
* @public
|
|
292
|
+
*/
|
|
293
|
+
AlternateMedia?: AlternateMedia[];
|
|
294
|
+
}
|
|
222
295
|
/**
|
|
223
296
|
* @public
|
|
224
297
|
* @enum
|
|
@@ -231,21 +304,21 @@ export declare const Operator: {
|
|
|
231
304
|
*/
|
|
232
305
|
export type Operator = (typeof Operator)[keyof typeof Operator];
|
|
233
306
|
/**
|
|
234
|
-
* @public
|
|
235
307
|
* <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>
|
|
236
308
|
* <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>
|
|
237
309
|
* <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>
|
|
310
|
+
* @public
|
|
238
311
|
*/
|
|
239
312
|
export interface AvailMatchingCriteria {
|
|
240
313
|
/**
|
|
241
|
-
* @public
|
|
242
314
|
* <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>
|
|
243
315
|
* <p>You can include up to 100 dynamic variables.</p>
|
|
316
|
+
* @public
|
|
244
317
|
*/
|
|
245
318
|
DynamicVariable: string | undefined;
|
|
246
319
|
/**
|
|
247
|
-
* @public
|
|
248
320
|
* <p>For the <code>DynamicVariable</code> specified in <code>AvailMatchingCriteria</code>, the Operator that is used for the comparison.</p>
|
|
321
|
+
* @public
|
|
249
322
|
*/
|
|
250
323
|
Operator: Operator | undefined;
|
|
251
324
|
}
|
|
@@ -261,39 +334,39 @@ export declare const LogType: {
|
|
|
261
334
|
*/
|
|
262
335
|
export type LogType = (typeof LogType)[keyof typeof LogType];
|
|
263
336
|
/**
|
|
264
|
-
* @public
|
|
265
337
|
* <p>The log configuration for the channel.</p>
|
|
338
|
+
* @public
|
|
266
339
|
*/
|
|
267
340
|
export interface LogConfigurationForChannel {
|
|
268
341
|
/**
|
|
269
|
-
* @public
|
|
270
342
|
* <p>The log types.</p>
|
|
343
|
+
* @public
|
|
271
344
|
*/
|
|
272
345
|
LogTypes?: LogType[];
|
|
273
346
|
}
|
|
274
347
|
/**
|
|
275
|
-
* @public
|
|
276
348
|
* <p>Dash manifest configuration parameters.</p>
|
|
349
|
+
* @public
|
|
277
350
|
*/
|
|
278
351
|
export interface DashPlaylistSettings {
|
|
279
352
|
/**
|
|
280
|
-
* @public
|
|
281
353
|
* <p>The total duration (in seconds) of each manifest. Minimum value: <code>30</code> seconds. Maximum value: <code>3600</code> seconds.</p>
|
|
354
|
+
* @public
|
|
282
355
|
*/
|
|
283
356
|
ManifestWindowSeconds?: number;
|
|
284
357
|
/**
|
|
285
|
-
* @public
|
|
286
358
|
* <p>Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: <code>2</code> seconds. Maximum value: <code>60</code> seconds.</p>
|
|
359
|
+
* @public
|
|
287
360
|
*/
|
|
288
361
|
MinBufferTimeSeconds?: number;
|
|
289
362
|
/**
|
|
290
|
-
* @public
|
|
291
363
|
* <p>Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: <code>2</code> seconds. Maximum value: <code>60</code> seconds.</p>
|
|
364
|
+
* @public
|
|
292
365
|
*/
|
|
293
366
|
MinUpdatePeriodSeconds?: number;
|
|
294
367
|
/**
|
|
295
|
-
* @public
|
|
296
368
|
* <p>Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: <code>2</code> seconds. Maximum value: <code>60</code> seconds.</p>
|
|
369
|
+
* @public
|
|
297
370
|
*/
|
|
298
371
|
SuggestedPresentationDelaySeconds?: number;
|
|
299
372
|
}
|
|
@@ -310,118 +383,123 @@ export declare const AdMarkupType: {
|
|
|
310
383
|
*/
|
|
311
384
|
export type AdMarkupType = (typeof AdMarkupType)[keyof typeof AdMarkupType];
|
|
312
385
|
/**
|
|
313
|
-
* @public
|
|
314
386
|
* <p>HLS playlist configuration parameters.</p>
|
|
387
|
+
* @public
|
|
315
388
|
*/
|
|
316
389
|
export interface HlsPlaylistSettings {
|
|
317
390
|
/**
|
|
318
|
-
* @public
|
|
319
391
|
* <p>The total duration (in seconds) of each manifest. Minimum value: <code>30</code> seconds. Maximum value: <code>3600</code> seconds.</p>
|
|
392
|
+
* @public
|
|
320
393
|
*/
|
|
321
394
|
ManifestWindowSeconds?: number;
|
|
322
395
|
/**
|
|
323
|
-
* @public
|
|
324
396
|
* <p>Determines the type of SCTE 35 tags to use in ad markup. Specify <code>DATERANGE</code> to use <code>DATERANGE</code> tags (for live or VOD content). Specify <code>SCTE35_ENHANCED</code> to use <code>EXT-X-CUE-OUT</code> and <code>EXT-X-CUE-IN</code> tags (for VOD content only).</p>
|
|
397
|
+
* @public
|
|
325
398
|
*/
|
|
326
399
|
AdMarkupType?: AdMarkupType[];
|
|
327
400
|
}
|
|
328
401
|
/**
|
|
329
|
-
* @public
|
|
330
402
|
* <p>The output item response.</p>
|
|
403
|
+
* @public
|
|
331
404
|
*/
|
|
332
405
|
export interface ResponseOutputItem {
|
|
333
406
|
/**
|
|
334
|
-
* @public
|
|
335
407
|
* <p>DASH manifest configuration settings.</p>
|
|
408
|
+
* @public
|
|
336
409
|
*/
|
|
337
410
|
DashPlaylistSettings?: DashPlaylistSettings;
|
|
338
411
|
/**
|
|
339
|
-
* @public
|
|
340
412
|
* <p>HLS manifest configuration settings.</p>
|
|
413
|
+
* @public
|
|
341
414
|
*/
|
|
342
415
|
HlsPlaylistSettings?: HlsPlaylistSettings;
|
|
343
416
|
/**
|
|
344
|
-
* @public
|
|
345
417
|
* <p>The name of the manifest for the channel that will appear in the channel output's playback URL.</p>
|
|
418
|
+
* @public
|
|
346
419
|
*/
|
|
347
420
|
ManifestName: string | undefined;
|
|
348
421
|
/**
|
|
349
|
-
* @public
|
|
350
422
|
* <p>The URL used for playback by content players.</p>
|
|
423
|
+
* @public
|
|
351
424
|
*/
|
|
352
425
|
PlaybackUrl: string | undefined;
|
|
353
426
|
/**
|
|
354
|
-
* @public
|
|
355
427
|
* <p>A string used to associate a package configuration source group with a channel output.</p>
|
|
428
|
+
* @public
|
|
356
429
|
*/
|
|
357
430
|
SourceGroup: string | undefined;
|
|
358
431
|
}
|
|
359
432
|
/**
|
|
360
|
-
* @public
|
|
361
433
|
* <p>The configuration parameters for a channel. For information about MediaTailor channels, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-channels.html">Working with channels</a> in the <i>MediaTailor User Guide</i>.</p>
|
|
434
|
+
* @public
|
|
362
435
|
*/
|
|
363
436
|
export interface Channel {
|
|
364
437
|
/**
|
|
365
|
-
* @public
|
|
366
438
|
* <p>The ARN of the channel.</p>
|
|
439
|
+
* @public
|
|
367
440
|
*/
|
|
368
441
|
Arn: string | undefined;
|
|
369
442
|
/**
|
|
370
|
-
* @public
|
|
371
443
|
* <p>The name of the channel.</p>
|
|
444
|
+
* @public
|
|
372
445
|
*/
|
|
373
446
|
ChannelName: string | undefined;
|
|
374
447
|
/**
|
|
375
|
-
* @public
|
|
376
448
|
* <p>Returns the state whether the channel is running or not.</p>
|
|
449
|
+
* @public
|
|
377
450
|
*/
|
|
378
451
|
ChannelState: string | undefined;
|
|
379
452
|
/**
|
|
380
|
-
* @public
|
|
381
453
|
* <p>The timestamp of when the channel was created.</p>
|
|
454
|
+
* @public
|
|
382
455
|
*/
|
|
383
456
|
CreationTime?: Date;
|
|
384
457
|
/**
|
|
385
|
-
* @public
|
|
386
458
|
* <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>
|
|
387
459
|
* <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
|
|
388
460
|
* <code>PlaybackMode</code>.</p>
|
|
461
|
+
* @public
|
|
389
462
|
*/
|
|
390
463
|
FillerSlate?: SlateSource;
|
|
391
464
|
/**
|
|
392
|
-
* @public
|
|
393
465
|
* <p>The timestamp of when the channel was last modified.</p>
|
|
466
|
+
* @public
|
|
394
467
|
*/
|
|
395
468
|
LastModifiedTime?: Date;
|
|
396
469
|
/**
|
|
397
|
-
* @public
|
|
398
470
|
* <p>The channel's output properties.</p>
|
|
471
|
+
* @public
|
|
399
472
|
*/
|
|
400
473
|
Outputs: ResponseOutputItem[] | undefined;
|
|
401
474
|
/**
|
|
402
|
-
* @public
|
|
403
475
|
* <p>The type of playback mode for this channel.</p>
|
|
404
476
|
* <p>
|
|
405
477
|
* <code>LINEAR</code> - Programs play back-to-back only once.</p>
|
|
406
478
|
* <p>
|
|
407
479
|
* <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>
|
|
480
|
+
* @public
|
|
408
481
|
*/
|
|
409
482
|
PlaybackMode: string | undefined;
|
|
410
483
|
/**
|
|
411
|
-
* @public
|
|
412
484
|
* <p>The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
485
|
+
* @public
|
|
413
486
|
*/
|
|
414
487
|
Tags?: Record<string, string>;
|
|
415
488
|
/**
|
|
416
|
-
* @public
|
|
417
489
|
* <p>The tier for this channel. STANDARD tier channels can contain live programs.</p>
|
|
490
|
+
* @public
|
|
418
491
|
*/
|
|
419
492
|
Tier: string | undefined;
|
|
420
493
|
/**
|
|
421
|
-
* @public
|
|
422
494
|
* <p>The log configuration.</p>
|
|
495
|
+
* @public
|
|
423
496
|
*/
|
|
424
497
|
LogConfiguration: LogConfigurationForChannel | undefined;
|
|
498
|
+
/**
|
|
499
|
+
* <p>The list of audiences defined in channel.</p>
|
|
500
|
+
* @public
|
|
501
|
+
*/
|
|
502
|
+
Audiences?: string[];
|
|
425
503
|
}
|
|
426
504
|
/**
|
|
427
505
|
* @public
|
|
@@ -436,64 +514,64 @@ export declare const Type: {
|
|
|
436
514
|
*/
|
|
437
515
|
export type Type = (typeof Type)[keyof typeof Type];
|
|
438
516
|
/**
|
|
439
|
-
* @public
|
|
440
517
|
* <p>The HTTP package configuration properties for the requested VOD source.</p>
|
|
518
|
+
* @public
|
|
441
519
|
*/
|
|
442
520
|
export interface HttpPackageConfiguration {
|
|
443
521
|
/**
|
|
444
|
-
* @public
|
|
445
522
|
* <p>The relative path to the URL for this VOD source. This is combined with <code>SourceLocation::HttpConfiguration::BaseUrl</code> to form a valid URL.</p>
|
|
523
|
+
* @public
|
|
446
524
|
*/
|
|
447
525
|
Path: string | undefined;
|
|
448
526
|
/**
|
|
449
|
-
* @public
|
|
450
527
|
* <p>The name of the source group. This has to match one of the <code>Channel::Outputs::SourceGroup</code>.</p>
|
|
528
|
+
* @public
|
|
451
529
|
*/
|
|
452
530
|
SourceGroup: string | undefined;
|
|
453
531
|
/**
|
|
454
|
-
* @public
|
|
455
532
|
* <p>The streaming protocol for this package configuration. Supported values are <code>HLS</code> and <code>DASH</code>.</p>
|
|
533
|
+
* @public
|
|
456
534
|
*/
|
|
457
535
|
Type: Type | undefined;
|
|
458
536
|
}
|
|
459
537
|
/**
|
|
460
|
-
* @public
|
|
461
538
|
* <p>Live source configuration parameters.</p>
|
|
539
|
+
* @public
|
|
462
540
|
*/
|
|
463
541
|
export interface LiveSource {
|
|
464
542
|
/**
|
|
465
|
-
* @public
|
|
466
543
|
* <p>The ARN for the live source.</p>
|
|
544
|
+
* @public
|
|
467
545
|
*/
|
|
468
546
|
Arn: string | undefined;
|
|
469
547
|
/**
|
|
470
|
-
* @public
|
|
471
548
|
* <p>The timestamp that indicates when the live source was created.</p>
|
|
549
|
+
* @public
|
|
472
550
|
*/
|
|
473
551
|
CreationTime?: Date;
|
|
474
552
|
/**
|
|
475
|
-
* @public
|
|
476
553
|
* <p>The HTTP package configurations for the live source.</p>
|
|
554
|
+
* @public
|
|
477
555
|
*/
|
|
478
556
|
HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
|
|
479
557
|
/**
|
|
480
|
-
* @public
|
|
481
558
|
* <p>The timestamp that indicates when the live source was last modified.</p>
|
|
559
|
+
* @public
|
|
482
560
|
*/
|
|
483
561
|
LastModifiedTime?: Date;
|
|
484
562
|
/**
|
|
485
|
-
* @public
|
|
486
563
|
* <p>The name that's used to refer to a live source.</p>
|
|
564
|
+
* @public
|
|
487
565
|
*/
|
|
488
566
|
LiveSourceName: string | undefined;
|
|
489
567
|
/**
|
|
490
|
-
* @public
|
|
491
568
|
* <p>The name of the source location.</p>
|
|
569
|
+
* @public
|
|
492
570
|
*/
|
|
493
571
|
SourceLocationName: string | undefined;
|
|
494
572
|
/**
|
|
495
|
-
* @public
|
|
496
573
|
* <p>The tags assigned to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
574
|
+
* @public
|
|
497
575
|
*/
|
|
498
576
|
Tags?: Record<string, string>;
|
|
499
577
|
}
|
|
@@ -523,55 +601,55 @@ export declare const Mode: {
|
|
|
523
601
|
*/
|
|
524
602
|
export type Mode = (typeof Mode)[keyof typeof Mode];
|
|
525
603
|
/**
|
|
526
|
-
* @public
|
|
527
604
|
* <p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Suppression</a>.</p>
|
|
605
|
+
* @public
|
|
528
606
|
*/
|
|
529
607
|
export interface AvailSuppression {
|
|
530
608
|
/**
|
|
531
|
-
* @public
|
|
532
609
|
* <p>Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to <code>BEHIND_LIVE_EDGE</code>, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to <code>AFTER_LIVE_EDGE</code>, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.</p>
|
|
610
|
+
* @public
|
|
533
611
|
*/
|
|
534
612
|
Mode?: Mode;
|
|
535
613
|
/**
|
|
536
|
-
* @public
|
|
537
614
|
* <p>A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.</p>
|
|
615
|
+
* @public
|
|
538
616
|
*/
|
|
539
617
|
Value?: string;
|
|
540
618
|
/**
|
|
541
|
-
* @public
|
|
542
619
|
* <p>Defines the policy to apply to the avail suppression mode. <code>BEHIND_LIVE_EDGE</code> will always use the full avail suppression policy. <code>AFTER_LIVE_EDGE</code> mode can be used to invoke partial ad break fills when a session starts mid-break.</p>
|
|
620
|
+
* @public
|
|
543
621
|
*/
|
|
544
622
|
FillPolicy?: FillPolicy;
|
|
545
623
|
}
|
|
546
624
|
/**
|
|
547
|
-
* @public
|
|
548
625
|
* <p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html">Bumpers</a>.</p>
|
|
626
|
+
* @public
|
|
549
627
|
*/
|
|
550
628
|
export interface Bumper {
|
|
551
629
|
/**
|
|
552
|
-
* @public
|
|
553
630
|
* <p>The URL for the end bumper asset.</p>
|
|
631
|
+
* @public
|
|
554
632
|
*/
|
|
555
633
|
EndUrl?: string;
|
|
556
634
|
/**
|
|
557
|
-
* @public
|
|
558
635
|
* <p>The URL for the start bumper asset.</p>
|
|
636
|
+
* @public
|
|
559
637
|
*/
|
|
560
638
|
StartUrl?: string;
|
|
561
639
|
}
|
|
562
640
|
/**
|
|
563
|
-
* @public
|
|
564
641
|
* <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
|
|
642
|
+
* @public
|
|
565
643
|
*/
|
|
566
644
|
export interface CdnConfiguration {
|
|
567
645
|
/**
|
|
568
|
-
* @public
|
|
569
646
|
* <p>A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.<i><region></i>.amazonaws.com. Then specify the rule's name in this <code>AdSegmentUrlPrefix</code>. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.</p>
|
|
647
|
+
* @public
|
|
570
648
|
*/
|
|
571
649
|
AdSegmentUrlPrefix?: string;
|
|
572
650
|
/**
|
|
573
|
-
* @public
|
|
574
651
|
* <p>A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this <code>ContentSegmentUrlPrefix</code>. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.</p>
|
|
652
|
+
* @public
|
|
575
653
|
*/
|
|
576
654
|
ContentSegmentUrlPrefix?: string;
|
|
577
655
|
}
|
|
@@ -588,293 +666,293 @@ export declare const OriginManifestType: {
|
|
|
588
666
|
*/
|
|
589
667
|
export type OriginManifestType = (typeof OriginManifestType)[keyof typeof OriginManifestType];
|
|
590
668
|
/**
|
|
591
|
-
* @public
|
|
592
669
|
* <p>The configuration for DASH content.</p>
|
|
670
|
+
* @public
|
|
593
671
|
*/
|
|
594
672
|
export interface DashConfiguration {
|
|
595
673
|
/**
|
|
596
|
-
* @public
|
|
597
674
|
* <p>The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.</p>
|
|
675
|
+
* @public
|
|
598
676
|
*/
|
|
599
677
|
ManifestEndpointPrefix?: string;
|
|
600
678
|
/**
|
|
601
|
-
* @public
|
|
602
679
|
* <p>The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are <code>DISABLED</code> and <code>EMT_DEFAULT</code>. The <code>EMT_DEFAULT</code> setting enables the inclusion of the tag and is the default value.</p>
|
|
680
|
+
* @public
|
|
603
681
|
*/
|
|
604
682
|
MpdLocation?: string;
|
|
605
683
|
/**
|
|
606
|
-
* @public
|
|
607
684
|
* <p>The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to <code>SINGLE_PERIOD</code>. The default setting is <code>MULTI_PERIOD</code>. For multi-period manifests, omit this setting or set it to <code>MULTI_PERIOD</code>.</p>
|
|
685
|
+
* @public
|
|
608
686
|
*/
|
|
609
687
|
OriginManifestType?: OriginManifestType;
|
|
610
688
|
}
|
|
611
689
|
/**
|
|
612
|
-
* @public
|
|
613
690
|
* <p>The configuration for HLS content.</p>
|
|
691
|
+
* @public
|
|
614
692
|
*/
|
|
615
693
|
export interface HlsConfiguration {
|
|
616
694
|
/**
|
|
617
|
-
* @public
|
|
618
695
|
* <p>The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.</p>
|
|
696
|
+
* @public
|
|
619
697
|
*/
|
|
620
698
|
ManifestEndpointPrefix?: string;
|
|
621
699
|
}
|
|
622
700
|
/**
|
|
623
|
-
* @public
|
|
624
701
|
* <p>The configuration for pre-roll ad insertion.</p>
|
|
702
|
+
* @public
|
|
625
703
|
*/
|
|
626
704
|
export interface LivePreRollConfiguration {
|
|
627
705
|
/**
|
|
628
|
-
* @public
|
|
629
706
|
* <p>The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.</p>
|
|
707
|
+
* @public
|
|
630
708
|
*/
|
|
631
709
|
AdDecisionServerUrl?: string;
|
|
632
710
|
/**
|
|
633
|
-
* @public
|
|
634
711
|
* <p>The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.</p>
|
|
712
|
+
* @public
|
|
635
713
|
*/
|
|
636
714
|
MaxDurationSeconds?: number;
|
|
637
715
|
}
|
|
638
716
|
/**
|
|
639
|
-
* @public
|
|
640
717
|
* <p>Returns Amazon CloudWatch log settings for a playback configuration.</p>
|
|
718
|
+
* @public
|
|
641
719
|
*/
|
|
642
720
|
export interface LogConfiguration {
|
|
643
721
|
/**
|
|
644
|
-
* @public
|
|
645
722
|
* <p>The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account. 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>
|
|
646
723
|
* <p>Valid values: <code>0</code> - <code>100</code>
|
|
647
724
|
* </p>
|
|
725
|
+
* @public
|
|
648
726
|
*/
|
|
649
727
|
PercentEnabled: number | undefined;
|
|
650
728
|
}
|
|
651
729
|
/**
|
|
652
|
-
* @public
|
|
653
730
|
* <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>
|
|
654
731
|
* <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>
|
|
732
|
+
* @public
|
|
655
733
|
*/
|
|
656
734
|
export interface AdMarkerPassthrough {
|
|
657
735
|
/**
|
|
658
|
-
* @public
|
|
659
736
|
* <p>Enables ad marker passthrough for your configuration.</p>
|
|
737
|
+
* @public
|
|
660
738
|
*/
|
|
661
739
|
Enabled?: boolean;
|
|
662
740
|
}
|
|
663
741
|
/**
|
|
664
|
-
* @public
|
|
665
742
|
* <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
|
|
743
|
+
* @public
|
|
666
744
|
*/
|
|
667
745
|
export interface ManifestProcessingRules {
|
|
668
746
|
/**
|
|
669
|
-
* @public
|
|
670
747
|
* <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>
|
|
671
748
|
* <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>
|
|
749
|
+
* @public
|
|
672
750
|
*/
|
|
673
751
|
AdMarkerPassthrough?: AdMarkerPassthrough;
|
|
674
752
|
}
|
|
675
753
|
/**
|
|
676
|
-
* @public
|
|
677
754
|
* <p>A playback configuration. For information about MediaTailor configurations, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html">Working with configurations in AWS Elemental MediaTailor</a>.</p>
|
|
755
|
+
* @public
|
|
678
756
|
*/
|
|
679
757
|
export interface PlaybackConfiguration {
|
|
680
758
|
/**
|
|
681
|
-
* @public
|
|
682
759
|
* <p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.</p>
|
|
760
|
+
* @public
|
|
683
761
|
*/
|
|
684
762
|
AdDecisionServerUrl?: string;
|
|
685
763
|
/**
|
|
686
|
-
* @public
|
|
687
764
|
* <p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Suppression</a>.</p>
|
|
765
|
+
* @public
|
|
688
766
|
*/
|
|
689
767
|
AvailSuppression?: AvailSuppression;
|
|
690
768
|
/**
|
|
691
|
-
* @public
|
|
692
769
|
* <p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html">Bumpers</a>.</p>
|
|
770
|
+
* @public
|
|
693
771
|
*/
|
|
694
772
|
Bumper?: Bumper;
|
|
695
773
|
/**
|
|
696
|
-
* @public
|
|
697
774
|
* <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
|
|
775
|
+
* @public
|
|
698
776
|
*/
|
|
699
777
|
CdnConfiguration?: CdnConfiguration;
|
|
700
778
|
/**
|
|
701
|
-
* @public
|
|
702
779
|
* <p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html">Domain Variables</a>.</p>
|
|
780
|
+
* @public
|
|
703
781
|
*/
|
|
704
782
|
ConfigurationAliases?: Record<string, Record<string, string>>;
|
|
705
783
|
/**
|
|
706
|
-
* @public
|
|
707
784
|
* <p>The configuration for a DASH source.</p>
|
|
785
|
+
* @public
|
|
708
786
|
*/
|
|
709
787
|
DashConfiguration?: DashConfiguration;
|
|
710
788
|
/**
|
|
711
|
-
* @public
|
|
712
789
|
* <p>The configuration for HLS content.</p>
|
|
790
|
+
* @public
|
|
713
791
|
*/
|
|
714
792
|
HlsConfiguration?: HlsConfiguration;
|
|
715
793
|
/**
|
|
716
|
-
* @public
|
|
717
794
|
* <p>The configuration for pre-roll ad insertion.</p>
|
|
795
|
+
* @public
|
|
718
796
|
*/
|
|
719
797
|
LivePreRollConfiguration?: LivePreRollConfiguration;
|
|
720
798
|
/**
|
|
721
|
-
* @public
|
|
722
799
|
* <p>The Amazon CloudWatch log settings for a playback configuration.</p>
|
|
800
|
+
* @public
|
|
723
801
|
*/
|
|
724
802
|
LogConfiguration?: LogConfiguration;
|
|
725
803
|
/**
|
|
726
|
-
* @public
|
|
727
804
|
* <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
|
|
805
|
+
* @public
|
|
728
806
|
*/
|
|
729
807
|
ManifestProcessingRules?: ManifestProcessingRules;
|
|
730
808
|
/**
|
|
731
|
-
* @public
|
|
732
809
|
* <p>The identifier for the playback configuration.</p>
|
|
810
|
+
* @public
|
|
733
811
|
*/
|
|
734
812
|
Name?: string;
|
|
735
813
|
/**
|
|
736
|
-
* @public
|
|
737
814
|
* <p>Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to <i>ad replacement</i> in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Behavior in AWS Elemental MediaTailor</a>.</p>
|
|
815
|
+
* @public
|
|
738
816
|
*/
|
|
739
817
|
PersonalizationThresholdSeconds?: number;
|
|
740
818
|
/**
|
|
741
|
-
* @public
|
|
742
819
|
* <p>The Amazon Resource Name (ARN) for the playback configuration.</p>
|
|
820
|
+
* @public
|
|
743
821
|
*/
|
|
744
822
|
PlaybackConfigurationArn?: string;
|
|
745
823
|
/**
|
|
746
|
-
* @public
|
|
747
824
|
* <p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.</p>
|
|
825
|
+
* @public
|
|
748
826
|
*/
|
|
749
827
|
PlaybackEndpointPrefix?: string;
|
|
750
828
|
/**
|
|
751
|
-
* @public
|
|
752
829
|
* <p>The URL that the player uses to initialize a session that uses client-side reporting.</p>
|
|
830
|
+
* @public
|
|
753
831
|
*/
|
|
754
832
|
SessionInitializationEndpointPrefix?: string;
|
|
755
833
|
/**
|
|
756
|
-
* @public
|
|
757
834
|
* <p>The URL for a video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.</p>
|
|
835
|
+
* @public
|
|
758
836
|
*/
|
|
759
837
|
SlateAdUrl?: string;
|
|
760
838
|
/**
|
|
761
|
-
* @public
|
|
762
839
|
* <p>The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
840
|
+
* @public
|
|
763
841
|
*/
|
|
764
842
|
Tags?: Record<string, string>;
|
|
765
843
|
/**
|
|
766
|
-
* @public
|
|
767
844
|
* <p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>
|
|
845
|
+
* @public
|
|
768
846
|
*/
|
|
769
847
|
TranscodeProfileName?: string;
|
|
770
848
|
/**
|
|
771
|
-
* @public
|
|
772
849
|
* <p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>
|
|
850
|
+
* @public
|
|
773
851
|
*/
|
|
774
852
|
VideoContentSourceUrl?: string;
|
|
775
853
|
}
|
|
776
854
|
/**
|
|
777
|
-
* @public
|
|
778
855
|
* <p>A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.</p>
|
|
856
|
+
* @public
|
|
779
857
|
*/
|
|
780
858
|
export interface PrefetchConsumption {
|
|
781
859
|
/**
|
|
782
|
-
* @public
|
|
783
860
|
* <p>If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as <code>scte.event_id</code>, set the avail matching criteria.</p>
|
|
861
|
+
* @public
|
|
784
862
|
*/
|
|
785
863
|
AvailMatchingCriteria?: AvailMatchingCriteria[];
|
|
786
864
|
/**
|
|
787
|
-
* @public
|
|
788
865
|
* <p>The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call <code>DeletePrefetchSchedule</code>.</p>
|
|
866
|
+
* @public
|
|
789
867
|
*/
|
|
790
868
|
EndTime: Date | undefined;
|
|
791
869
|
/**
|
|
792
|
-
* @public
|
|
793
870
|
* <p>The time when prefetched ads are considered for use in an ad break. If you don't specify <code>StartTime</code>, the prefetched ads are available after MediaTailor retrives them from the ad decision server.</p>
|
|
871
|
+
* @public
|
|
794
872
|
*/
|
|
795
873
|
StartTime?: Date;
|
|
796
874
|
}
|
|
797
875
|
/**
|
|
798
|
-
* @public
|
|
799
876
|
* <p>A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.</p>
|
|
877
|
+
* @public
|
|
800
878
|
*/
|
|
801
879
|
export interface PrefetchRetrieval {
|
|
802
880
|
/**
|
|
803
|
-
* @public
|
|
804
881
|
* <p>The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).</p>
|
|
805
882
|
* <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>
|
|
883
|
+
* @public
|
|
806
884
|
*/
|
|
807
885
|
DynamicVariables?: Record<string, string>;
|
|
808
886
|
/**
|
|
809
|
-
* @public
|
|
810
887
|
* <p>The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.</p>
|
|
888
|
+
* @public
|
|
811
889
|
*/
|
|
812
890
|
EndTime: Date | undefined;
|
|
813
891
|
/**
|
|
814
|
-
* @public
|
|
815
892
|
* <p>The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.</p>
|
|
893
|
+
* @public
|
|
816
894
|
*/
|
|
817
895
|
StartTime?: Date;
|
|
818
896
|
}
|
|
819
897
|
/**
|
|
820
|
-
* @public
|
|
821
898
|
* <p>A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html">Using ad prefetching</a> in the <i>MediaTailor User Guide</i>.</p>
|
|
899
|
+
* @public
|
|
822
900
|
*/
|
|
823
901
|
export interface PrefetchSchedule {
|
|
824
902
|
/**
|
|
825
|
-
* @public
|
|
826
903
|
* <p>The Amazon Resource Name (ARN) of the prefetch schedule.</p>
|
|
904
|
+
* @public
|
|
827
905
|
*/
|
|
828
906
|
Arn: string | undefined;
|
|
829
907
|
/**
|
|
830
|
-
* @public
|
|
831
908
|
* <p>Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a <i>consumption window</i>. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.</p>
|
|
909
|
+
* @public
|
|
832
910
|
*/
|
|
833
911
|
Consumption: PrefetchConsumption | undefined;
|
|
834
912
|
/**
|
|
835
|
-
* @public
|
|
836
913
|
* <p>The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.</p>
|
|
914
|
+
* @public
|
|
837
915
|
*/
|
|
838
916
|
Name: string | undefined;
|
|
839
917
|
/**
|
|
840
|
-
* @public
|
|
841
918
|
* <p>The name of the playback configuration to create the prefetch schedule for.</p>
|
|
919
|
+
* @public
|
|
842
920
|
*/
|
|
843
921
|
PlaybackConfigurationName: string | undefined;
|
|
844
922
|
/**
|
|
845
|
-
* @public
|
|
846
923
|
* <p>A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).</p>
|
|
924
|
+
* @public
|
|
847
925
|
*/
|
|
848
926
|
Retrieval: PrefetchRetrieval | undefined;
|
|
849
927
|
/**
|
|
850
|
-
* @public
|
|
851
928
|
* <p>An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.</p>
|
|
929
|
+
* @public
|
|
852
930
|
*/
|
|
853
931
|
StreamId?: string;
|
|
854
932
|
}
|
|
855
933
|
/**
|
|
856
|
-
* @public
|
|
857
934
|
* <p>The schedule's ad break properties.</p>
|
|
935
|
+
* @public
|
|
858
936
|
*/
|
|
859
937
|
export interface ScheduleAdBreak {
|
|
860
938
|
/**
|
|
861
|
-
* @public
|
|
862
939
|
* <p>The approximate duration of the ad break, in seconds.</p>
|
|
940
|
+
* @public
|
|
863
941
|
*/
|
|
864
942
|
ApproximateDurationSeconds?: number;
|
|
865
943
|
/**
|
|
866
|
-
* @public
|
|
867
944
|
* <p>The approximate time that the ad will start playing.</p>
|
|
945
|
+
* @public
|
|
868
946
|
*/
|
|
869
947
|
ApproximateStartTime?: Date;
|
|
870
948
|
/**
|
|
871
|
-
* @public
|
|
872
949
|
* <p>The name of the source location containing the VOD source used for the ad break.</p>
|
|
950
|
+
* @public
|
|
873
951
|
*/
|
|
874
952
|
SourceLocationName?: string;
|
|
875
953
|
/**
|
|
876
|
-
* @public
|
|
877
954
|
* <p>The name of the VOD source used for the ad break.</p>
|
|
955
|
+
* @public
|
|
878
956
|
*/
|
|
879
957
|
VodSourceName?: string;
|
|
880
958
|
}
|
|
@@ -883,6 +961,7 @@ export interface ScheduleAdBreak {
|
|
|
883
961
|
* @enum
|
|
884
962
|
*/
|
|
885
963
|
export declare const ScheduleEntryType: {
|
|
964
|
+
readonly ALTERNATE_MEDIA: "ALTERNATE_MEDIA";
|
|
886
965
|
readonly FILLER_SLATE: "FILLER_SLATE";
|
|
887
966
|
readonly PROGRAM: "PROGRAM";
|
|
888
967
|
};
|
|
@@ -891,74 +970,79 @@ export declare const ScheduleEntryType: {
|
|
|
891
970
|
*/
|
|
892
971
|
export type ScheduleEntryType = (typeof ScheduleEntryType)[keyof typeof ScheduleEntryType];
|
|
893
972
|
/**
|
|
894
|
-
* @public
|
|
895
973
|
* <p>The properties for a schedule.</p>
|
|
974
|
+
* @public
|
|
896
975
|
*/
|
|
897
976
|
export interface ScheduleEntry {
|
|
898
977
|
/**
|
|
899
|
-
* @public
|
|
900
978
|
* <p>The approximate duration of this program, in seconds.</p>
|
|
979
|
+
* @public
|
|
901
980
|
*/
|
|
902
981
|
ApproximateDurationSeconds?: number;
|
|
903
982
|
/**
|
|
904
|
-
* @public
|
|
905
983
|
* <p>The approximate time that the program will start playing.</p>
|
|
984
|
+
* @public
|
|
906
985
|
*/
|
|
907
986
|
ApproximateStartTime?: Date;
|
|
908
987
|
/**
|
|
909
|
-
* @public
|
|
910
988
|
* <p>The ARN of the program.</p>
|
|
989
|
+
* @public
|
|
911
990
|
*/
|
|
912
991
|
Arn: string | undefined;
|
|
913
992
|
/**
|
|
914
|
-
* @public
|
|
915
993
|
* <p>The name of the channel that uses this schedule.</p>
|
|
994
|
+
* @public
|
|
916
995
|
*/
|
|
917
996
|
ChannelName: string | undefined;
|
|
918
997
|
/**
|
|
919
|
-
* @public
|
|
920
998
|
* <p>The name of the live source used for the program.</p>
|
|
999
|
+
* @public
|
|
921
1000
|
*/
|
|
922
1001
|
LiveSourceName?: string;
|
|
923
1002
|
/**
|
|
924
|
-
* @public
|
|
925
1003
|
* <p>The name of the program.</p>
|
|
1004
|
+
* @public
|
|
926
1005
|
*/
|
|
927
1006
|
ProgramName: string | undefined;
|
|
928
1007
|
/**
|
|
929
|
-
* @public
|
|
930
1008
|
* <p>The schedule's ad break properties.</p>
|
|
1009
|
+
* @public
|
|
931
1010
|
*/
|
|
932
1011
|
ScheduleAdBreaks?: ScheduleAdBreak[];
|
|
933
1012
|
/**
|
|
934
|
-
* @public
|
|
935
1013
|
* <p>The type of schedule entry.</p>
|
|
1014
|
+
* @public
|
|
936
1015
|
*/
|
|
937
1016
|
ScheduleEntryType?: ScheduleEntryType;
|
|
938
1017
|
/**
|
|
939
|
-
* @public
|
|
940
1018
|
* <p>The name of the source location.</p>
|
|
1019
|
+
* @public
|
|
941
1020
|
*/
|
|
942
1021
|
SourceLocationName: string | undefined;
|
|
943
1022
|
/**
|
|
944
|
-
* @public
|
|
945
1023
|
* <p>The name of the VOD source.</p>
|
|
1024
|
+
* @public
|
|
946
1025
|
*/
|
|
947
1026
|
VodSourceName?: string;
|
|
1027
|
+
/**
|
|
1028
|
+
* <p>The list of audiences defined in ScheduleEntry.</p>
|
|
1029
|
+
* @public
|
|
1030
|
+
*/
|
|
1031
|
+
Audiences?: string[];
|
|
948
1032
|
}
|
|
949
1033
|
/**
|
|
950
|
-
* @public
|
|
951
1034
|
* <p>The segment delivery configuration settings.</p>
|
|
1035
|
+
* @public
|
|
952
1036
|
*/
|
|
953
1037
|
export interface SegmentDeliveryConfiguration {
|
|
954
1038
|
/**
|
|
955
|
-
* @public
|
|
956
1039
|
* <p>The base URL of the host or path of the segment delivery server that you're using to serve segments. This is typically a content delivery network (CDN). The URL can be absolute or relative. To use an absolute URL include the protocol, such as <code>https://example.com/some/path</code>. To use a relative URL specify the relative path, such as <code>/some/path*</code>.</p>
|
|
1040
|
+
* @public
|
|
957
1041
|
*/
|
|
958
1042
|
BaseUrl?: string;
|
|
959
1043
|
/**
|
|
960
|
-
* @public
|
|
961
1044
|
* <p>A unique identifier used to distinguish between multiple segment delivery configurations in a source location.</p>
|
|
1045
|
+
* @public
|
|
962
1046
|
*/
|
|
963
1047
|
Name?: string;
|
|
964
1048
|
}
|
|
@@ -976,33 +1060,32 @@ export declare const AccessType: {
|
|
|
976
1060
|
*/
|
|
977
1061
|
export type AccessType = (typeof AccessType)[keyof typeof AccessType];
|
|
978
1062
|
/**
|
|
979
|
-
* @public
|
|
980
1063
|
* <p>AWS Secrets Manager access token configuration parameters. For information about Secrets Manager access token authentication, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-access-configuration-access-token.html">Working with AWS Secrets Manager access token authentication</a>.</p>
|
|
1064
|
+
* @public
|
|
981
1065
|
*/
|
|
982
1066
|
export interface SecretsManagerAccessTokenConfiguration {
|
|
983
1067
|
/**
|
|
984
|
-
* @public
|
|
985
1068
|
* <p>The name of the HTTP header used to supply the access token in requests to the source location.</p>
|
|
1069
|
+
* @public
|
|
986
1070
|
*/
|
|
987
1071
|
HeaderName?: string;
|
|
988
1072
|
/**
|
|
989
|
-
* @public
|
|
990
1073
|
* <p>The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.</p>
|
|
1074
|
+
* @public
|
|
991
1075
|
*/
|
|
992
1076
|
SecretArn?: string;
|
|
993
1077
|
/**
|
|
994
|
-
* @public
|
|
995
1078
|
* <p>The AWS Secrets Manager <a href="https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html#SecretsManager-CreateSecret-request-SecretString.html">SecretString</a> key associated with the access token. MediaTailor uses the key to look up SecretString key and value pair containing the access token.</p>
|
|
1079
|
+
* @public
|
|
996
1080
|
*/
|
|
997
1081
|
SecretStringKey?: string;
|
|
998
1082
|
}
|
|
999
1083
|
/**
|
|
1000
|
-
* @public
|
|
1001
1084
|
* <p>Access configuration parameters.</p>
|
|
1085
|
+
* @public
|
|
1002
1086
|
*/
|
|
1003
1087
|
export interface AccessConfiguration {
|
|
1004
1088
|
/**
|
|
1005
|
-
* @public
|
|
1006
1089
|
* <p>The type of authentication used to access content from <code>HttpConfiguration::BaseUrl</code> on your source location.</p>
|
|
1007
1090
|
* <p>
|
|
1008
1091
|
* <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>
|
|
@@ -1020,142 +1103,143 @@ export interface AccessConfiguration {
|
|
|
1020
1103
|
* <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>
|
|
1021
1104
|
* <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>
|
|
1022
1105
|
* <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>
|
|
1106
|
+
* @public
|
|
1023
1107
|
*/
|
|
1024
1108
|
AccessType?: AccessType;
|
|
1025
1109
|
/**
|
|
1026
|
-
* @public
|
|
1027
1110
|
* <p>AWS Secrets Manager access token configuration parameters.</p>
|
|
1111
|
+
* @public
|
|
1028
1112
|
*/
|
|
1029
1113
|
SecretsManagerAccessTokenConfiguration?: SecretsManagerAccessTokenConfiguration;
|
|
1030
1114
|
}
|
|
1031
1115
|
/**
|
|
1032
|
-
* @public
|
|
1033
1116
|
* <p>The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.</p>
|
|
1117
|
+
* @public
|
|
1034
1118
|
*/
|
|
1035
1119
|
export interface DefaultSegmentDeliveryConfiguration {
|
|
1036
1120
|
/**
|
|
1037
|
-
* @public
|
|
1038
1121
|
* <p>The hostname of the server that will be used to serve segments. This string must include the protocol, such as <b>https://</b>.</p>
|
|
1122
|
+
* @public
|
|
1039
1123
|
*/
|
|
1040
1124
|
BaseUrl?: string;
|
|
1041
1125
|
}
|
|
1042
1126
|
/**
|
|
1043
|
-
* @public
|
|
1044
1127
|
* <p>The HTTP configuration for the source location.</p>
|
|
1128
|
+
* @public
|
|
1045
1129
|
*/
|
|
1046
1130
|
export interface HttpConfiguration {
|
|
1047
1131
|
/**
|
|
1048
|
-
* @public
|
|
1049
1132
|
* <p>The base URL for the source location host server. This string must include the protocol, such as <b>https://</b>.</p>
|
|
1133
|
+
* @public
|
|
1050
1134
|
*/
|
|
1051
1135
|
BaseUrl: string | undefined;
|
|
1052
1136
|
}
|
|
1053
1137
|
/**
|
|
1054
|
-
* @public
|
|
1055
1138
|
* <p>A source location is a container for sources. For more information about source locations, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/channel-assembly-source-locations.html">Working with source locations</a> in the <i>MediaTailor User Guide</i>.</p>
|
|
1139
|
+
* @public
|
|
1056
1140
|
*/
|
|
1057
1141
|
export interface SourceLocation {
|
|
1058
1142
|
/**
|
|
1059
|
-
* @public
|
|
1060
1143
|
* <p>The access configuration for the source location.</p>
|
|
1144
|
+
* @public
|
|
1061
1145
|
*/
|
|
1062
1146
|
AccessConfiguration?: AccessConfiguration;
|
|
1063
1147
|
/**
|
|
1064
|
-
* @public
|
|
1065
1148
|
* <p>The ARN of the SourceLocation.</p>
|
|
1149
|
+
* @public
|
|
1066
1150
|
*/
|
|
1067
1151
|
Arn: string | undefined;
|
|
1068
1152
|
/**
|
|
1069
|
-
* @public
|
|
1070
1153
|
* <p>The timestamp that indicates when the source location was created.</p>
|
|
1154
|
+
* @public
|
|
1071
1155
|
*/
|
|
1072
1156
|
CreationTime?: Date;
|
|
1073
1157
|
/**
|
|
1074
|
-
* @public
|
|
1075
1158
|
* <p>The default segment delivery configuration.</p>
|
|
1159
|
+
* @public
|
|
1076
1160
|
*/
|
|
1077
1161
|
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
|
|
1078
1162
|
/**
|
|
1079
|
-
* @public
|
|
1080
1163
|
* <p>The HTTP configuration for the source location.</p>
|
|
1164
|
+
* @public
|
|
1081
1165
|
*/
|
|
1082
1166
|
HttpConfiguration: HttpConfiguration | undefined;
|
|
1083
1167
|
/**
|
|
1084
|
-
* @public
|
|
1085
1168
|
* <p>The timestamp that indicates when the source location was last modified.</p>
|
|
1169
|
+
* @public
|
|
1086
1170
|
*/
|
|
1087
1171
|
LastModifiedTime?: Date;
|
|
1088
1172
|
/**
|
|
1089
|
-
* @public
|
|
1090
1173
|
* <p>The segment delivery configurations for the source location.</p>
|
|
1174
|
+
* @public
|
|
1091
1175
|
*/
|
|
1092
1176
|
SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
|
|
1093
1177
|
/**
|
|
1094
|
-
* @public
|
|
1095
1178
|
* <p>The name of the source location.</p>
|
|
1179
|
+
* @public
|
|
1096
1180
|
*/
|
|
1097
1181
|
SourceLocationName: string | undefined;
|
|
1098
1182
|
/**
|
|
1099
|
-
* @public
|
|
1100
1183
|
* <p>The tags assigned to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
1184
|
+
* @public
|
|
1101
1185
|
*/
|
|
1102
1186
|
Tags?: Record<string, string>;
|
|
1103
1187
|
}
|
|
1104
1188
|
/**
|
|
1105
|
-
* @public
|
|
1106
1189
|
* <p>VOD source configuration parameters.</p>
|
|
1190
|
+
* @public
|
|
1107
1191
|
*/
|
|
1108
1192
|
export interface VodSource {
|
|
1109
1193
|
/**
|
|
1110
|
-
* @public
|
|
1111
1194
|
* <p>The ARN for the VOD source.</p>
|
|
1195
|
+
* @public
|
|
1112
1196
|
*/
|
|
1113
1197
|
Arn: string | undefined;
|
|
1114
1198
|
/**
|
|
1115
|
-
* @public
|
|
1116
1199
|
* <p>The timestamp that indicates when the VOD source was created.</p>
|
|
1200
|
+
* @public
|
|
1117
1201
|
*/
|
|
1118
1202
|
CreationTime?: Date;
|
|
1119
1203
|
/**
|
|
1120
|
-
* @public
|
|
1121
1204
|
* <p>The HTTP package configurations for the VOD source.</p>
|
|
1205
|
+
* @public
|
|
1122
1206
|
*/
|
|
1123
1207
|
HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
|
|
1124
1208
|
/**
|
|
1125
|
-
* @public
|
|
1126
1209
|
* <p>The timestamp that indicates when the VOD source was last modified.</p>
|
|
1210
|
+
* @public
|
|
1127
1211
|
*/
|
|
1128
1212
|
LastModifiedTime?: Date;
|
|
1129
1213
|
/**
|
|
1130
|
-
* @public
|
|
1131
1214
|
* <p>The name of the source location that the VOD source is associated with.</p>
|
|
1215
|
+
* @public
|
|
1132
1216
|
*/
|
|
1133
1217
|
SourceLocationName: string | undefined;
|
|
1134
1218
|
/**
|
|
1135
|
-
* @public
|
|
1136
1219
|
* <p>The tags assigned to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
1220
|
+
* @public
|
|
1137
1221
|
*/
|
|
1138
1222
|
Tags?: Record<string, string>;
|
|
1139
1223
|
/**
|
|
1140
|
-
* @public
|
|
1141
1224
|
* <p>The name of the VOD source.</p>
|
|
1225
|
+
* @public
|
|
1142
1226
|
*/
|
|
1143
1227
|
VodSourceName: string | undefined;
|
|
1144
1228
|
}
|
|
1145
1229
|
/**
|
|
1146
|
-
* @public
|
|
1147
1230
|
* <p>A location at which a zero-duration ad marker was detected in a VOD source manifest.</p>
|
|
1231
|
+
* @public
|
|
1148
1232
|
*/
|
|
1149
1233
|
export interface AdBreakOpportunity {
|
|
1150
1234
|
/**
|
|
1151
|
-
* @public
|
|
1152
1235
|
* <p>The offset in milliseconds from the start of the VOD source at which an ad marker was detected.</p>
|
|
1236
|
+
* @public
|
|
1153
1237
|
*/
|
|
1154
1238
|
OffsetMillis: number | undefined;
|
|
1155
1239
|
}
|
|
1156
1240
|
/**
|
|
1157
|
-
* @public
|
|
1158
1241
|
* <p>A request contains unexpected data.</p>
|
|
1242
|
+
* @public
|
|
1159
1243
|
*/
|
|
1160
1244
|
export declare class BadRequestException extends __BaseException {
|
|
1161
1245
|
readonly name: "BadRequestException";
|
|
@@ -1171,8 +1255,8 @@ export declare class BadRequestException extends __BaseException {
|
|
|
1171
1255
|
*/
|
|
1172
1256
|
export interface DeleteChannelPolicyRequest {
|
|
1173
1257
|
/**
|
|
1174
|
-
* @public
|
|
1175
1258
|
* <p>The name of the channel associated with this channel policy.</p>
|
|
1259
|
+
* @public
|
|
1176
1260
|
*/
|
|
1177
1261
|
ChannelName: string | undefined;
|
|
1178
1262
|
}
|
|
@@ -1186,8 +1270,8 @@ export interface DeleteChannelPolicyResponse {
|
|
|
1186
1270
|
*/
|
|
1187
1271
|
export interface GetChannelPolicyRequest {
|
|
1188
1272
|
/**
|
|
1189
|
-
* @public
|
|
1190
1273
|
* <p>The name of the channel associated with this Channel Policy.</p>
|
|
1274
|
+
* @public
|
|
1191
1275
|
*/
|
|
1192
1276
|
ChannelName: string | undefined;
|
|
1193
1277
|
}
|
|
@@ -1196,8 +1280,8 @@ export interface GetChannelPolicyRequest {
|
|
|
1196
1280
|
*/
|
|
1197
1281
|
export interface GetChannelPolicyResponse {
|
|
1198
1282
|
/**
|
|
1199
|
-
* @public
|
|
1200
1283
|
* <p>The IAM policy for the channel. IAM policies are used to control access to your channel.</p>
|
|
1284
|
+
* @public
|
|
1201
1285
|
*/
|
|
1202
1286
|
Policy?: string;
|
|
1203
1287
|
}
|
|
@@ -1206,13 +1290,13 @@ export interface GetChannelPolicyResponse {
|
|
|
1206
1290
|
*/
|
|
1207
1291
|
export interface PutChannelPolicyRequest {
|
|
1208
1292
|
/**
|
|
1209
|
-
* @public
|
|
1210
1293
|
* <p>The channel name associated with this Channel Policy.</p>
|
|
1294
|
+
* @public
|
|
1211
1295
|
*/
|
|
1212
1296
|
ChannelName: string | undefined;
|
|
1213
1297
|
/**
|
|
1214
|
-
* @public
|
|
1215
1298
|
* <p>Adds an IAM role that determines the permissions of your channel.</p>
|
|
1299
|
+
* @public
|
|
1216
1300
|
*/
|
|
1217
1301
|
Policy: string | undefined;
|
|
1218
1302
|
}
|
|
@@ -1226,13 +1310,13 @@ export interface PutChannelPolicyResponse {
|
|
|
1226
1310
|
*/
|
|
1227
1311
|
export interface ConfigureLogsForChannelRequest {
|
|
1228
1312
|
/**
|
|
1229
|
-
* @public
|
|
1230
1313
|
* <p>The name of the channel.</p>
|
|
1314
|
+
* @public
|
|
1231
1315
|
*/
|
|
1232
1316
|
ChannelName: string | undefined;
|
|
1233
1317
|
/**
|
|
1234
|
-
* @public
|
|
1235
1318
|
* <p>The types of logs to collect.</p>
|
|
1319
|
+
* @public
|
|
1236
1320
|
*/
|
|
1237
1321
|
LogTypes: LogType[] | undefined;
|
|
1238
1322
|
}
|
|
@@ -1241,39 +1325,39 @@ export interface ConfigureLogsForChannelRequest {
|
|
|
1241
1325
|
*/
|
|
1242
1326
|
export interface ConfigureLogsForChannelResponse {
|
|
1243
1327
|
/**
|
|
1244
|
-
* @public
|
|
1245
1328
|
* <p>The name of the channel.</p>
|
|
1329
|
+
* @public
|
|
1246
1330
|
*/
|
|
1247
1331
|
ChannelName?: string;
|
|
1248
1332
|
/**
|
|
1249
|
-
* @public
|
|
1250
1333
|
* <p>The types of logs collected.</p>
|
|
1334
|
+
* @public
|
|
1251
1335
|
*/
|
|
1252
1336
|
LogTypes?: LogType[];
|
|
1253
1337
|
}
|
|
1254
1338
|
/**
|
|
1255
|
-
* @public
|
|
1256
1339
|
* <p>The output configuration for this channel.</p>
|
|
1340
|
+
* @public
|
|
1257
1341
|
*/
|
|
1258
1342
|
export interface RequestOutputItem {
|
|
1259
1343
|
/**
|
|
1260
|
-
* @public
|
|
1261
1344
|
* <p>DASH manifest configuration parameters.</p>
|
|
1345
|
+
* @public
|
|
1262
1346
|
*/
|
|
1263
1347
|
DashPlaylistSettings?: DashPlaylistSettings;
|
|
1264
1348
|
/**
|
|
1265
|
-
* @public
|
|
1266
1349
|
* <p>HLS playlist configuration parameters.</p>
|
|
1350
|
+
* @public
|
|
1267
1351
|
*/
|
|
1268
1352
|
HlsPlaylistSettings?: HlsPlaylistSettings;
|
|
1269
1353
|
/**
|
|
1270
|
-
* @public
|
|
1271
1354
|
* <p>The name of the manifest for the channel. The name appears in the <code>PlaybackUrl</code>.</p>
|
|
1355
|
+
* @public
|
|
1272
1356
|
*/
|
|
1273
1357
|
ManifestName: string | undefined;
|
|
1274
1358
|
/**
|
|
1275
|
-
* @public
|
|
1276
1359
|
* <p>A string used to match which <code>HttpPackageConfiguration</code> is used for each <code>VodSource</code>.</p>
|
|
1360
|
+
* @public
|
|
1277
1361
|
*/
|
|
1278
1362
|
SourceGroup: string | undefined;
|
|
1279
1363
|
}
|
|
@@ -1302,18 +1386,18 @@ export declare const Tier: {
|
|
|
1302
1386
|
*/
|
|
1303
1387
|
export type Tier = (typeof Tier)[keyof typeof Tier];
|
|
1304
1388
|
/**
|
|
1305
|
-
* @public
|
|
1306
1389
|
* <p>
|
|
1307
1390
|
* The configuration for time-shifted viewing.
|
|
1308
1391
|
* </p>
|
|
1392
|
+
* @public
|
|
1309
1393
|
*/
|
|
1310
1394
|
export interface TimeShiftConfiguration {
|
|
1311
1395
|
/**
|
|
1312
|
-
* @public
|
|
1313
1396
|
* <p>
|
|
1314
1397
|
* The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds,
|
|
1315
1398
|
* and the maximum allowed maximum time delay is 21600 seconds (6 hours).
|
|
1316
1399
|
* </p>
|
|
1400
|
+
* @public
|
|
1317
1401
|
*/
|
|
1318
1402
|
MaxTimeDelaySeconds: number | undefined;
|
|
1319
1403
|
}
|
|
@@ -1322,48 +1406,53 @@ export interface TimeShiftConfiguration {
|
|
|
1322
1406
|
*/
|
|
1323
1407
|
export interface CreateChannelRequest {
|
|
1324
1408
|
/**
|
|
1325
|
-
* @public
|
|
1326
1409
|
* <p>The name of the channel.</p>
|
|
1410
|
+
* @public
|
|
1327
1411
|
*/
|
|
1328
1412
|
ChannelName: string | undefined;
|
|
1329
1413
|
/**
|
|
1330
|
-
* @public
|
|
1331
1414
|
* <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>
|
|
1332
1415
|
* <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
|
|
1333
1416
|
* <code>PlaybackMode</code>.</p>
|
|
1417
|
+
* @public
|
|
1334
1418
|
*/
|
|
1335
1419
|
FillerSlate?: SlateSource;
|
|
1336
1420
|
/**
|
|
1337
|
-
* @public
|
|
1338
1421
|
* <p>The channel's output properties.</p>
|
|
1422
|
+
* @public
|
|
1339
1423
|
*/
|
|
1340
1424
|
Outputs: RequestOutputItem[] | undefined;
|
|
1341
1425
|
/**
|
|
1342
|
-
* @public
|
|
1343
1426
|
* <p>The type of playback mode to use for this channel.</p>
|
|
1344
1427
|
* <p>
|
|
1345
1428
|
* <code>LINEAR</code> - The programs in the schedule play once back-to-back in the schedule.</p>
|
|
1346
1429
|
* <p>
|
|
1347
1430
|
* <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>
|
|
1431
|
+
* @public
|
|
1348
1432
|
*/
|
|
1349
1433
|
PlaybackMode: PlaybackMode | undefined;
|
|
1350
1434
|
/**
|
|
1351
|
-
* @public
|
|
1352
1435
|
* <p>The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
1436
|
+
* @public
|
|
1353
1437
|
*/
|
|
1354
1438
|
Tags?: Record<string, string>;
|
|
1355
1439
|
/**
|
|
1356
|
-
* @public
|
|
1357
1440
|
* <p>The tier of the channel.</p>
|
|
1441
|
+
* @public
|
|
1358
1442
|
*/
|
|
1359
1443
|
Tier?: Tier;
|
|
1360
1444
|
/**
|
|
1361
|
-
* @public
|
|
1362
1445
|
* <p>
|
|
1363
1446
|
* The time-shifted viewing configuration you want to associate to the channel.
|
|
1364
1447
|
* </p>
|
|
1448
|
+
* @public
|
|
1365
1449
|
*/
|
|
1366
1450
|
TimeShiftConfiguration?: TimeShiftConfiguration;
|
|
1451
|
+
/**
|
|
1452
|
+
* <p>The list of audiences defined in channel.</p>
|
|
1453
|
+
* @public
|
|
1454
|
+
*/
|
|
1455
|
+
Audiences?: string[];
|
|
1367
1456
|
}
|
|
1368
1457
|
/**
|
|
1369
1458
|
* @public
|
|
@@ -1382,70 +1471,75 @@ export type ChannelState = (typeof ChannelState)[keyof typeof ChannelState];
|
|
|
1382
1471
|
*/
|
|
1383
1472
|
export interface CreateChannelResponse {
|
|
1384
1473
|
/**
|
|
1385
|
-
* @public
|
|
1386
1474
|
* <p>The Amazon Resource Name (ARN) to assign to the channel.</p>
|
|
1475
|
+
* @public
|
|
1387
1476
|
*/
|
|
1388
1477
|
Arn?: string;
|
|
1389
1478
|
/**
|
|
1390
|
-
* @public
|
|
1391
1479
|
* <p>The name to assign to the channel.</p>
|
|
1480
|
+
* @public
|
|
1392
1481
|
*/
|
|
1393
1482
|
ChannelName?: string;
|
|
1394
1483
|
/**
|
|
1395
|
-
* @public
|
|
1396
1484
|
* <p>Indicates whether the channel is in a running state or not.</p>
|
|
1485
|
+
* @public
|
|
1397
1486
|
*/
|
|
1398
1487
|
ChannelState?: ChannelState;
|
|
1399
1488
|
/**
|
|
1400
|
-
* @public
|
|
1401
1489
|
* <p>The timestamp of when the channel was created.</p>
|
|
1490
|
+
* @public
|
|
1402
1491
|
*/
|
|
1403
1492
|
CreationTime?: Date;
|
|
1404
1493
|
/**
|
|
1405
|
-
* @public
|
|
1406
1494
|
* <p>Contains information about the slate used to fill gaps between programs in the schedule.</p>
|
|
1495
|
+
* @public
|
|
1407
1496
|
*/
|
|
1408
1497
|
FillerSlate?: SlateSource;
|
|
1409
1498
|
/**
|
|
1410
|
-
* @public
|
|
1411
1499
|
* <p>The timestamp of when the channel was last modified.</p>
|
|
1500
|
+
* @public
|
|
1412
1501
|
*/
|
|
1413
1502
|
LastModifiedTime?: Date;
|
|
1414
1503
|
/**
|
|
1415
|
-
* @public
|
|
1416
1504
|
* <p>The output properties to assign to the channel.</p>
|
|
1505
|
+
* @public
|
|
1417
1506
|
*/
|
|
1418
1507
|
Outputs?: ResponseOutputItem[];
|
|
1419
1508
|
/**
|
|
1420
|
-
* @public
|
|
1421
1509
|
* <p>The playback mode to assign to the channel.</p>
|
|
1510
|
+
* @public
|
|
1422
1511
|
*/
|
|
1423
1512
|
PlaybackMode?: string;
|
|
1424
1513
|
/**
|
|
1425
|
-
* @public
|
|
1426
1514
|
* <p>The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
1515
|
+
* @public
|
|
1427
1516
|
*/
|
|
1428
1517
|
Tags?: Record<string, string>;
|
|
1429
1518
|
/**
|
|
1430
|
-
* @public
|
|
1431
1519
|
* <p>The tier of the channel.</p>
|
|
1520
|
+
* @public
|
|
1432
1521
|
*/
|
|
1433
1522
|
Tier?: string;
|
|
1434
1523
|
/**
|
|
1435
|
-
* @public
|
|
1436
1524
|
* <p>
|
|
1437
1525
|
* The time-shifted viewing configuration assigned to the channel.
|
|
1438
1526
|
* </p>
|
|
1527
|
+
* @public
|
|
1439
1528
|
*/
|
|
1440
1529
|
TimeShiftConfiguration?: TimeShiftConfiguration;
|
|
1530
|
+
/**
|
|
1531
|
+
* <p>The list of audiences defined in channel.</p>
|
|
1532
|
+
* @public
|
|
1533
|
+
*/
|
|
1534
|
+
Audiences?: string[];
|
|
1441
1535
|
}
|
|
1442
1536
|
/**
|
|
1443
1537
|
* @public
|
|
1444
1538
|
*/
|
|
1445
1539
|
export interface DeleteChannelRequest {
|
|
1446
1540
|
/**
|
|
1447
|
-
* @public
|
|
1448
1541
|
* <p>The name of the channel.</p>
|
|
1542
|
+
* @public
|
|
1449
1543
|
*/
|
|
1450
1544
|
ChannelName: string | undefined;
|
|
1451
1545
|
}
|
|
@@ -1459,8 +1553,8 @@ export interface DeleteChannelResponse {
|
|
|
1459
1553
|
*/
|
|
1460
1554
|
export interface DescribeChannelRequest {
|
|
1461
1555
|
/**
|
|
1462
|
-
* @public
|
|
1463
1556
|
* <p>The name of the channel.</p>
|
|
1557
|
+
* @public
|
|
1464
1558
|
*/
|
|
1465
1559
|
ChannelName: string | undefined;
|
|
1466
1560
|
}
|
|
@@ -1469,108 +1563,118 @@ export interface DescribeChannelRequest {
|
|
|
1469
1563
|
*/
|
|
1470
1564
|
export interface DescribeChannelResponse {
|
|
1471
1565
|
/**
|
|
1472
|
-
* @public
|
|
1473
1566
|
* <p>The ARN of the channel.</p>
|
|
1567
|
+
* @public
|
|
1474
1568
|
*/
|
|
1475
1569
|
Arn?: string;
|
|
1476
1570
|
/**
|
|
1477
|
-
* @public
|
|
1478
1571
|
* <p>The name of the channel.</p>
|
|
1572
|
+
* @public
|
|
1479
1573
|
*/
|
|
1480
1574
|
ChannelName?: string;
|
|
1481
1575
|
/**
|
|
1482
|
-
* @public
|
|
1483
1576
|
* <p>Indicates whether the channel is in a running state or not.</p>
|
|
1577
|
+
* @public
|
|
1484
1578
|
*/
|
|
1485
1579
|
ChannelState?: ChannelState;
|
|
1486
1580
|
/**
|
|
1487
|
-
* @public
|
|
1488
1581
|
* <p>The timestamp of when the channel was created.</p>
|
|
1582
|
+
* @public
|
|
1489
1583
|
*/
|
|
1490
1584
|
CreationTime?: Date;
|
|
1491
1585
|
/**
|
|
1492
|
-
* @public
|
|
1493
1586
|
* <p>Contains information about the slate used to fill gaps between programs in the schedule.</p>
|
|
1587
|
+
* @public
|
|
1494
1588
|
*/
|
|
1495
1589
|
FillerSlate?: SlateSource;
|
|
1496
1590
|
/**
|
|
1497
|
-
* @public
|
|
1498
1591
|
* <p>The timestamp of when the channel was last modified.</p>
|
|
1592
|
+
* @public
|
|
1499
1593
|
*/
|
|
1500
1594
|
LastModifiedTime?: Date;
|
|
1501
1595
|
/**
|
|
1502
|
-
* @public
|
|
1503
1596
|
* <p>The channel's output properties.</p>
|
|
1597
|
+
* @public
|
|
1504
1598
|
*/
|
|
1505
1599
|
Outputs?: ResponseOutputItem[];
|
|
1506
1600
|
/**
|
|
1507
|
-
* @public
|
|
1508
1601
|
* <p>The channel's playback mode.</p>
|
|
1602
|
+
* @public
|
|
1509
1603
|
*/
|
|
1510
1604
|
PlaybackMode?: string;
|
|
1511
1605
|
/**
|
|
1512
|
-
* @public
|
|
1513
1606
|
* <p>The tags assigned to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
1607
|
+
* @public
|
|
1514
1608
|
*/
|
|
1515
1609
|
Tags?: Record<string, string>;
|
|
1516
1610
|
/**
|
|
1517
|
-
* @public
|
|
1518
1611
|
* <p>The channel's tier.</p>
|
|
1612
|
+
* @public
|
|
1519
1613
|
*/
|
|
1520
1614
|
Tier?: string;
|
|
1521
1615
|
/**
|
|
1522
|
-
* @public
|
|
1523
1616
|
* <p>The log configuration for the channel.</p>
|
|
1617
|
+
* @public
|
|
1524
1618
|
*/
|
|
1525
1619
|
LogConfiguration: LogConfigurationForChannel | undefined;
|
|
1526
1620
|
/**
|
|
1527
|
-
* @public
|
|
1528
1621
|
* <p>
|
|
1529
1622
|
* The time-shifted viewing configuration for the channel.
|
|
1530
1623
|
* </p>
|
|
1624
|
+
* @public
|
|
1531
1625
|
*/
|
|
1532
1626
|
TimeShiftConfiguration?: TimeShiftConfiguration;
|
|
1627
|
+
/**
|
|
1628
|
+
* <p>The list of audiences defined in channel.</p>
|
|
1629
|
+
* @public
|
|
1630
|
+
*/
|
|
1631
|
+
Audiences?: string[];
|
|
1533
1632
|
}
|
|
1534
1633
|
/**
|
|
1535
1634
|
* @public
|
|
1536
1635
|
*/
|
|
1537
1636
|
export interface GetChannelScheduleRequest {
|
|
1538
1637
|
/**
|
|
1539
|
-
* @public
|
|
1540
1638
|
* <p>The name of the channel associated with this Channel Schedule.</p>
|
|
1639
|
+
* @public
|
|
1541
1640
|
*/
|
|
1542
1641
|
ChannelName: string | undefined;
|
|
1543
1642
|
/**
|
|
1544
|
-
* @public
|
|
1545
1643
|
* <p>The duration in minutes of the channel schedule.</p>
|
|
1644
|
+
* @public
|
|
1546
1645
|
*/
|
|
1547
1646
|
DurationMinutes?: string;
|
|
1548
1647
|
/**
|
|
1549
|
-
* @public
|
|
1550
1648
|
* <p>The maximum number of channel schedules that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> channel schedules, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
|
|
1649
|
+
* @public
|
|
1551
1650
|
*/
|
|
1552
1651
|
MaxResults?: number;
|
|
1553
1652
|
/**
|
|
1554
|
-
* @public
|
|
1555
1653
|
* <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>
|
|
1556
1654
|
* <p>For the first <code>GetChannelScheduleRequest</code> request, omit this value.</p>
|
|
1557
1655
|
* <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>
|
|
1558
1656
|
* <p>If the previous response didn't include a <code>NextToken</code> element, there are no more channel schedules to get.</p>
|
|
1657
|
+
* @public
|
|
1559
1658
|
*/
|
|
1560
1659
|
NextToken?: string;
|
|
1660
|
+
/**
|
|
1661
|
+
* <p>The single audience for GetChannelScheduleRequest.</p>
|
|
1662
|
+
* @public
|
|
1663
|
+
*/
|
|
1664
|
+
Audience?: string;
|
|
1561
1665
|
}
|
|
1562
1666
|
/**
|
|
1563
1667
|
* @public
|
|
1564
1668
|
*/
|
|
1565
1669
|
export interface GetChannelScheduleResponse {
|
|
1566
1670
|
/**
|
|
1567
|
-
* @public
|
|
1568
1671
|
* <p>A list of schedule entries for the channel.</p>
|
|
1672
|
+
* @public
|
|
1569
1673
|
*/
|
|
1570
1674
|
Items?: ScheduleEntry[];
|
|
1571
1675
|
/**
|
|
1572
|
-
* @public
|
|
1573
1676
|
* <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
|
|
1677
|
+
* @public
|
|
1574
1678
|
*/
|
|
1575
1679
|
NextToken?: string;
|
|
1576
1680
|
}
|
|
@@ -1579,13 +1683,13 @@ export interface GetChannelScheduleResponse {
|
|
|
1579
1683
|
*/
|
|
1580
1684
|
export interface ListChannelsRequest {
|
|
1581
1685
|
/**
|
|
1582
|
-
* @public
|
|
1583
1686
|
* <p>The maximum number of channels that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> channels, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
|
|
1687
|
+
* @public
|
|
1584
1688
|
*/
|
|
1585
1689
|
MaxResults?: number;
|
|
1586
1690
|
/**
|
|
1587
|
-
* @public
|
|
1588
1691
|
* <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
|
|
1692
|
+
* @public
|
|
1589
1693
|
*/
|
|
1590
1694
|
NextToken?: string;
|
|
1591
1695
|
}
|
|
@@ -1594,26 +1698,15 @@ export interface ListChannelsRequest {
|
|
|
1594
1698
|
*/
|
|
1595
1699
|
export interface ListChannelsResponse {
|
|
1596
1700
|
/**
|
|
1597
|
-
* @public
|
|
1598
1701
|
* <p>A list of channels that are associated with this account.</p>
|
|
1702
|
+
* @public
|
|
1599
1703
|
*/
|
|
1600
1704
|
Items?: Channel[];
|
|
1601
1705
|
/**
|
|
1602
|
-
* @public
|
|
1603
1706
|
* <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
|
|
1604
|
-
*/
|
|
1605
|
-
NextToken?: string;
|
|
1606
|
-
}
|
|
1607
|
-
/**
|
|
1608
|
-
* @public
|
|
1609
|
-
* <p>Clip range configuration for the VOD source associated with the program.</p>
|
|
1610
|
-
*/
|
|
1611
|
-
export interface ClipRange {
|
|
1612
|
-
/**
|
|
1613
1707
|
* @public
|
|
1614
|
-
* <p>The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.</p>
|
|
1615
1708
|
*/
|
|
1616
|
-
|
|
1709
|
+
NextToken?: string;
|
|
1617
1710
|
}
|
|
1618
1711
|
/**
|
|
1619
1712
|
* @public
|
|
@@ -1628,32 +1721,31 @@ export declare const RelativePosition: {
|
|
|
1628
1721
|
*/
|
|
1629
1722
|
export type RelativePosition = (typeof RelativePosition)[keyof typeof RelativePosition];
|
|
1630
1723
|
/**
|
|
1631
|
-
* @public
|
|
1632
1724
|
* <p>Program transition configuration.</p>
|
|
1725
|
+
* @public
|
|
1633
1726
|
*/
|
|
1634
1727
|
export interface Transition {
|
|
1635
1728
|
/**
|
|
1636
|
-
* @public
|
|
1637
1729
|
* <p>The duration of the live program in seconds.</p>
|
|
1730
|
+
* @public
|
|
1638
1731
|
*/
|
|
1639
1732
|
DurationMillis?: number;
|
|
1640
1733
|
/**
|
|
1641
|
-
* @public
|
|
1642
1734
|
* <p>The position where this program will be inserted relative to the <code>RelativePosition</code>.</p>
|
|
1735
|
+
* @public
|
|
1643
1736
|
*/
|
|
1644
1737
|
RelativePosition: RelativePosition | undefined;
|
|
1645
1738
|
/**
|
|
1646
|
-
* @public
|
|
1647
1739
|
* <p>The name of the program that this program will be inserted next to, as defined by <code>RelativePosition</code>.</p>
|
|
1740
|
+
* @public
|
|
1648
1741
|
*/
|
|
1649
1742
|
RelativeProgram?: string;
|
|
1650
1743
|
/**
|
|
1651
|
-
* @public
|
|
1652
1744
|
* <p>The date and time that the program is scheduled to start, in epoch milliseconds.</p>
|
|
1745
|
+
* @public
|
|
1653
1746
|
*/
|
|
1654
1747
|
ScheduledStartTimeMillis?: number;
|
|
1655
1748
|
/**
|
|
1656
|
-
* @public
|
|
1657
1749
|
* <p>Defines when the program plays in the schedule. You can set the value to <code>ABSOLUTE</code> or <code>RELATIVE</code>.</p>
|
|
1658
1750
|
* <p>
|
|
1659
1751
|
* <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>
|
|
@@ -1663,22 +1755,23 @@ export interface Transition {
|
|
|
1663
1755
|
* <p>If there are gaps in playback, MediaTailor plays the <code>FillerSlate</code> you configured for your linear channel.</p>
|
|
1664
1756
|
* <p>
|
|
1665
1757
|
* <code>RELATIVE</code> - The program is inserted into the schedule either before or after a program that you specify via <code>RelativePosition</code>.</p>
|
|
1758
|
+
* @public
|
|
1666
1759
|
*/
|
|
1667
1760
|
Type: string | undefined;
|
|
1668
1761
|
}
|
|
1669
1762
|
/**
|
|
1670
|
-
* @public
|
|
1671
1763
|
* <p>Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.</p>
|
|
1764
|
+
* @public
|
|
1672
1765
|
*/
|
|
1673
1766
|
export interface ScheduleConfiguration {
|
|
1674
1767
|
/**
|
|
1675
|
-
* @public
|
|
1676
1768
|
* <p>Program transition configurations.</p>
|
|
1769
|
+
* @public
|
|
1677
1770
|
*/
|
|
1678
1771
|
Transition: Transition | undefined;
|
|
1679
1772
|
/**
|
|
1680
|
-
* @public
|
|
1681
1773
|
* <p>Program clip range configuration.</p>
|
|
1774
|
+
* @public
|
|
1682
1775
|
*/
|
|
1683
1776
|
ClipRange?: ClipRange;
|
|
1684
1777
|
}
|
|
@@ -1687,113 +1780,123 @@ export interface ScheduleConfiguration {
|
|
|
1687
1780
|
*/
|
|
1688
1781
|
export interface CreateProgramRequest {
|
|
1689
1782
|
/**
|
|
1690
|
-
* @public
|
|
1691
1783
|
* <p>The ad break configuration settings.</p>
|
|
1784
|
+
* @public
|
|
1692
1785
|
*/
|
|
1693
1786
|
AdBreaks?: AdBreak[];
|
|
1694
1787
|
/**
|
|
1695
|
-
* @public
|
|
1696
1788
|
* <p>The name of the channel for this Program.</p>
|
|
1789
|
+
* @public
|
|
1697
1790
|
*/
|
|
1698
1791
|
ChannelName: string | undefined;
|
|
1699
1792
|
/**
|
|
1700
|
-
* @public
|
|
1701
1793
|
* <p>The name of the LiveSource for this Program.</p>
|
|
1794
|
+
* @public
|
|
1702
1795
|
*/
|
|
1703
1796
|
LiveSourceName?: string;
|
|
1704
1797
|
/**
|
|
1705
|
-
* @public
|
|
1706
1798
|
* <p>The name of the Program.</p>
|
|
1799
|
+
* @public
|
|
1707
1800
|
*/
|
|
1708
1801
|
ProgramName: string | undefined;
|
|
1709
1802
|
/**
|
|
1710
|
-
* @public
|
|
1711
1803
|
* <p>The schedule configuration settings.</p>
|
|
1804
|
+
* @public
|
|
1712
1805
|
*/
|
|
1713
1806
|
ScheduleConfiguration: ScheduleConfiguration | undefined;
|
|
1714
1807
|
/**
|
|
1715
|
-
* @public
|
|
1716
1808
|
* <p>The name of the source location.</p>
|
|
1809
|
+
* @public
|
|
1717
1810
|
*/
|
|
1718
1811
|
SourceLocationName: string | undefined;
|
|
1719
1812
|
/**
|
|
1720
|
-
* @public
|
|
1721
1813
|
* <p>The name that's used to refer to a VOD source.</p>
|
|
1814
|
+
* @public
|
|
1722
1815
|
*/
|
|
1723
1816
|
VodSourceName?: string;
|
|
1817
|
+
/**
|
|
1818
|
+
* <p>The list of AudienceMedia defined in program.</p>
|
|
1819
|
+
* @public
|
|
1820
|
+
*/
|
|
1821
|
+
AudienceMedia?: AudienceMedia[];
|
|
1724
1822
|
}
|
|
1725
1823
|
/**
|
|
1726
1824
|
* @public
|
|
1727
1825
|
*/
|
|
1728
1826
|
export interface CreateProgramResponse {
|
|
1729
1827
|
/**
|
|
1730
|
-
* @public
|
|
1731
1828
|
* <p>The ad break configuration settings.</p>
|
|
1829
|
+
* @public
|
|
1732
1830
|
*/
|
|
1733
1831
|
AdBreaks?: AdBreak[];
|
|
1734
1832
|
/**
|
|
1735
|
-
* @public
|
|
1736
1833
|
* <p>The ARN to assign to the program.</p>
|
|
1834
|
+
* @public
|
|
1737
1835
|
*/
|
|
1738
1836
|
Arn?: string;
|
|
1739
1837
|
/**
|
|
1740
|
-
* @public
|
|
1741
1838
|
* <p>The name to assign to the channel for this program.</p>
|
|
1839
|
+
* @public
|
|
1742
1840
|
*/
|
|
1743
1841
|
ChannelName?: string;
|
|
1744
1842
|
/**
|
|
1745
|
-
* @public
|
|
1746
1843
|
* <p>The time the program was created.</p>
|
|
1844
|
+
* @public
|
|
1747
1845
|
*/
|
|
1748
1846
|
CreationTime?: Date;
|
|
1749
1847
|
/**
|
|
1750
|
-
* @public
|
|
1751
1848
|
* <p>The name of the LiveSource for this Program.</p>
|
|
1849
|
+
* @public
|
|
1752
1850
|
*/
|
|
1753
1851
|
LiveSourceName?: string;
|
|
1754
1852
|
/**
|
|
1755
|
-
* @public
|
|
1756
1853
|
* <p>The name to assign to this program.</p>
|
|
1854
|
+
* @public
|
|
1757
1855
|
*/
|
|
1758
1856
|
ProgramName?: string;
|
|
1759
1857
|
/**
|
|
1760
|
-
* @public
|
|
1761
1858
|
* <p>The scheduled start time for this Program.</p>
|
|
1859
|
+
* @public
|
|
1762
1860
|
*/
|
|
1763
1861
|
ScheduledStartTime?: Date;
|
|
1764
1862
|
/**
|
|
1765
|
-
* @public
|
|
1766
1863
|
* <p>The name to assign to the source location for this program.</p>
|
|
1864
|
+
* @public
|
|
1767
1865
|
*/
|
|
1768
1866
|
SourceLocationName?: string;
|
|
1769
1867
|
/**
|
|
1770
|
-
* @public
|
|
1771
1868
|
* <p>The name that's used to refer to a VOD source.</p>
|
|
1869
|
+
* @public
|
|
1772
1870
|
*/
|
|
1773
1871
|
VodSourceName?: string;
|
|
1774
1872
|
/**
|
|
1775
|
-
* @public
|
|
1776
1873
|
* <p>The clip range configuration settings.</p>
|
|
1874
|
+
* @public
|
|
1777
1875
|
*/
|
|
1778
1876
|
ClipRange?: ClipRange;
|
|
1779
1877
|
/**
|
|
1780
|
-
* @public
|
|
1781
1878
|
* <p>The duration of the live program in milliseconds.</p>
|
|
1879
|
+
* @public
|
|
1782
1880
|
*/
|
|
1783
1881
|
DurationMillis?: number;
|
|
1882
|
+
/**
|
|
1883
|
+
* <p>The list of AudienceMedia defined in program.</p>
|
|
1884
|
+
* @public
|
|
1885
|
+
*/
|
|
1886
|
+
AudienceMedia?: AudienceMedia[];
|
|
1784
1887
|
}
|
|
1785
1888
|
/**
|
|
1786
1889
|
* @public
|
|
1787
1890
|
*/
|
|
1788
1891
|
export interface DeleteProgramRequest {
|
|
1789
1892
|
/**
|
|
1790
|
-
* @public
|
|
1791
1893
|
* <p>The name of the channel.</p>
|
|
1894
|
+
* @public
|
|
1792
1895
|
*/
|
|
1793
1896
|
ChannelName: string | undefined;
|
|
1794
1897
|
/**
|
|
1795
|
-
* @public
|
|
1796
1898
|
* <p>The name of the program.</p>
|
|
1899
|
+
* @public
|
|
1797
1900
|
*/
|
|
1798
1901
|
ProgramName: string | undefined;
|
|
1799
1902
|
}
|
|
@@ -1807,13 +1910,13 @@ export interface DeleteProgramResponse {
|
|
|
1807
1910
|
*/
|
|
1808
1911
|
export interface DescribeProgramRequest {
|
|
1809
1912
|
/**
|
|
1810
|
-
* @public
|
|
1811
1913
|
* <p>The name of the channel associated with this Program.</p>
|
|
1914
|
+
* @public
|
|
1812
1915
|
*/
|
|
1813
1916
|
ChannelName: string | undefined;
|
|
1814
1917
|
/**
|
|
1815
|
-
* @public
|
|
1816
1918
|
* <p>The name of the program.</p>
|
|
1919
|
+
* @public
|
|
1817
1920
|
*/
|
|
1818
1921
|
ProgramName: string | undefined;
|
|
1819
1922
|
}
|
|
@@ -1822,90 +1925,95 @@ export interface DescribeProgramRequest {
|
|
|
1822
1925
|
*/
|
|
1823
1926
|
export interface DescribeProgramResponse {
|
|
1824
1927
|
/**
|
|
1825
|
-
* @public
|
|
1826
1928
|
* <p>The ad break configuration settings.</p>
|
|
1929
|
+
* @public
|
|
1827
1930
|
*/
|
|
1828
1931
|
AdBreaks?: AdBreak[];
|
|
1829
1932
|
/**
|
|
1830
|
-
* @public
|
|
1831
1933
|
* <p>The ARN of the program.</p>
|
|
1934
|
+
* @public
|
|
1832
1935
|
*/
|
|
1833
1936
|
Arn?: string;
|
|
1834
1937
|
/**
|
|
1835
|
-
* @public
|
|
1836
1938
|
* <p>The name of the channel that the program belongs to.</p>
|
|
1939
|
+
* @public
|
|
1837
1940
|
*/
|
|
1838
1941
|
ChannelName?: string;
|
|
1839
1942
|
/**
|
|
1840
|
-
* @public
|
|
1841
1943
|
* <p>The timestamp of when the program was created.</p>
|
|
1944
|
+
* @public
|
|
1842
1945
|
*/
|
|
1843
1946
|
CreationTime?: Date;
|
|
1844
1947
|
/**
|
|
1845
|
-
* @public
|
|
1846
1948
|
* <p>The name of the LiveSource for this Program.</p>
|
|
1949
|
+
* @public
|
|
1847
1950
|
*/
|
|
1848
1951
|
LiveSourceName?: string;
|
|
1849
1952
|
/**
|
|
1850
|
-
* @public
|
|
1851
1953
|
* <p>The name of the program.</p>
|
|
1954
|
+
* @public
|
|
1852
1955
|
*/
|
|
1853
1956
|
ProgramName?: string;
|
|
1854
1957
|
/**
|
|
1855
|
-
* @public
|
|
1856
1958
|
* <p>The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.</p>
|
|
1959
|
+
* @public
|
|
1857
1960
|
*/
|
|
1858
1961
|
ScheduledStartTime?: Date;
|
|
1859
1962
|
/**
|
|
1860
|
-
* @public
|
|
1861
1963
|
* <p>The source location name.</p>
|
|
1964
|
+
* @public
|
|
1862
1965
|
*/
|
|
1863
1966
|
SourceLocationName?: string;
|
|
1864
1967
|
/**
|
|
1865
|
-
* @public
|
|
1866
1968
|
* <p>The name that's used to refer to a VOD source.</p>
|
|
1969
|
+
* @public
|
|
1867
1970
|
*/
|
|
1868
1971
|
VodSourceName?: string;
|
|
1869
1972
|
/**
|
|
1870
|
-
* @public
|
|
1871
1973
|
* <p>The clip range configuration settings.</p>
|
|
1974
|
+
* @public
|
|
1872
1975
|
*/
|
|
1873
1976
|
ClipRange?: ClipRange;
|
|
1874
1977
|
/**
|
|
1875
|
-
* @public
|
|
1876
1978
|
* <p>The duration of the live program in milliseconds.</p>
|
|
1979
|
+
* @public
|
|
1877
1980
|
*/
|
|
1878
1981
|
DurationMillis?: number;
|
|
1982
|
+
/**
|
|
1983
|
+
* <p>The list of AudienceMedia defined in program.</p>
|
|
1984
|
+
* @public
|
|
1985
|
+
*/
|
|
1986
|
+
AudienceMedia?: AudienceMedia[];
|
|
1879
1987
|
}
|
|
1880
1988
|
/**
|
|
1881
|
-
* @public
|
|
1882
1989
|
* <p>Program transition configuration.</p>
|
|
1990
|
+
* @public
|
|
1883
1991
|
*/
|
|
1884
1992
|
export interface UpdateProgramTransition {
|
|
1885
1993
|
/**
|
|
1886
|
-
* @public
|
|
1887
1994
|
* <p>The date and time that the program is scheduled to start, in epoch milliseconds.</p>
|
|
1995
|
+
* @public
|
|
1888
1996
|
*/
|
|
1889
1997
|
ScheduledStartTimeMillis?: number;
|
|
1890
1998
|
/**
|
|
1891
|
-
* @public
|
|
1892
1999
|
* <p>The duration of the live program in seconds.</p>
|
|
2000
|
+
* @public
|
|
1893
2001
|
*/
|
|
1894
2002
|
DurationMillis?: number;
|
|
1895
2003
|
}
|
|
1896
2004
|
/**
|
|
1897
|
-
* @public
|
|
1898
2005
|
* <p>Schedule configuration parameters.</p>
|
|
2006
|
+
* @public
|
|
1899
2007
|
*/
|
|
1900
2008
|
export interface UpdateProgramScheduleConfiguration {
|
|
1901
2009
|
/**
|
|
1902
|
-
* @public
|
|
1903
2010
|
* <p>Program transition configuration.</p>
|
|
2011
|
+
* @public
|
|
1904
2012
|
*/
|
|
1905
2013
|
Transition?: UpdateProgramTransition;
|
|
1906
2014
|
/**
|
|
1907
|
-
* @public
|
|
1908
2015
|
* <p>Program clip range configuration.</p>
|
|
2016
|
+
* @public
|
|
1909
2017
|
*/
|
|
1910
2018
|
ClipRange?: ClipRange;
|
|
1911
2019
|
}
|
|
@@ -1914,93 +2022,103 @@ export interface UpdateProgramScheduleConfiguration {
|
|
|
1914
2022
|
*/
|
|
1915
2023
|
export interface UpdateProgramRequest {
|
|
1916
2024
|
/**
|
|
1917
|
-
* @public
|
|
1918
2025
|
* <p>The ad break configuration settings.</p>
|
|
2026
|
+
* @public
|
|
1919
2027
|
*/
|
|
1920
2028
|
AdBreaks?: AdBreak[];
|
|
1921
2029
|
/**
|
|
1922
|
-
* @public
|
|
1923
2030
|
* <p>The name of the channel for this Program.</p>
|
|
2031
|
+
* @public
|
|
1924
2032
|
*/
|
|
1925
2033
|
ChannelName: string | undefined;
|
|
1926
2034
|
/**
|
|
1927
|
-
* @public
|
|
1928
2035
|
* <p>The name of the Program.</p>
|
|
2036
|
+
* @public
|
|
1929
2037
|
*/
|
|
1930
2038
|
ProgramName: string | undefined;
|
|
1931
2039
|
/**
|
|
1932
|
-
* @public
|
|
1933
2040
|
* <p>The schedule configuration settings.</p>
|
|
2041
|
+
* @public
|
|
2042
|
+
*/
|
|
2043
|
+
ScheduleConfiguration: UpdateProgramScheduleConfiguration | undefined;
|
|
2044
|
+
/**
|
|
2045
|
+
* <p>The list of AudienceMedia defined in program.</p>
|
|
2046
|
+
* @public
|
|
1934
2047
|
*/
|
|
1935
|
-
|
|
2048
|
+
AudienceMedia?: AudienceMedia[];
|
|
1936
2049
|
}
|
|
1937
2050
|
/**
|
|
1938
2051
|
* @public
|
|
1939
2052
|
*/
|
|
1940
2053
|
export interface UpdateProgramResponse {
|
|
1941
2054
|
/**
|
|
1942
|
-
* @public
|
|
1943
2055
|
* <p>The ad break configuration settings.</p>
|
|
2056
|
+
* @public
|
|
1944
2057
|
*/
|
|
1945
2058
|
AdBreaks?: AdBreak[];
|
|
1946
2059
|
/**
|
|
1947
|
-
* @public
|
|
1948
2060
|
* <p>The ARN to assign to the program.</p>
|
|
2061
|
+
* @public
|
|
1949
2062
|
*/
|
|
1950
2063
|
Arn?: string;
|
|
1951
2064
|
/**
|
|
1952
|
-
* @public
|
|
1953
2065
|
* <p>The name to assign to the channel for this program.</p>
|
|
2066
|
+
* @public
|
|
1954
2067
|
*/
|
|
1955
2068
|
ChannelName?: string;
|
|
1956
2069
|
/**
|
|
1957
|
-
* @public
|
|
1958
2070
|
* <p>The time the program was created.</p>
|
|
2071
|
+
* @public
|
|
1959
2072
|
*/
|
|
1960
2073
|
CreationTime?: Date;
|
|
1961
2074
|
/**
|
|
1962
|
-
* @public
|
|
1963
2075
|
* <p>The name to assign to this program.</p>
|
|
2076
|
+
* @public
|
|
1964
2077
|
*/
|
|
1965
2078
|
ProgramName?: string;
|
|
1966
2079
|
/**
|
|
1967
|
-
* @public
|
|
1968
2080
|
* <p>The name to assign to the source location for this program.</p>
|
|
2081
|
+
* @public
|
|
1969
2082
|
*/
|
|
1970
2083
|
SourceLocationName?: string;
|
|
1971
2084
|
/**
|
|
1972
|
-
* @public
|
|
1973
2085
|
* <p>The name that's used to refer to a VOD source.</p>
|
|
2086
|
+
* @public
|
|
1974
2087
|
*/
|
|
1975
2088
|
VodSourceName?: string;
|
|
1976
2089
|
/**
|
|
1977
|
-
* @public
|
|
1978
2090
|
* <p>The name of the LiveSource for this Program.</p>
|
|
2091
|
+
* @public
|
|
1979
2092
|
*/
|
|
1980
2093
|
LiveSourceName?: string;
|
|
1981
2094
|
/**
|
|
1982
|
-
* @public
|
|
1983
2095
|
* <p>The clip range configuration settings.</p>
|
|
2096
|
+
* @public
|
|
1984
2097
|
*/
|
|
1985
2098
|
ClipRange?: ClipRange;
|
|
1986
2099
|
/**
|
|
1987
|
-
* @public
|
|
1988
2100
|
* <p>The duration of the live program in milliseconds.</p>
|
|
2101
|
+
* @public
|
|
1989
2102
|
*/
|
|
1990
2103
|
DurationMillis?: number;
|
|
1991
2104
|
/**
|
|
1992
|
-
* @public
|
|
1993
2105
|
* <p>The scheduled start time for this Program.</p>
|
|
2106
|
+
* @public
|
|
1994
2107
|
*/
|
|
1995
2108
|
ScheduledStartTime?: Date;
|
|
2109
|
+
/**
|
|
2110
|
+
* <p>The list of AudienceMedia defined in program.</p>
|
|
2111
|
+
* @public
|
|
2112
|
+
*/
|
|
2113
|
+
AudienceMedia?: AudienceMedia[];
|
|
1996
2114
|
}
|
|
1997
2115
|
/**
|
|
1998
2116
|
* @public
|
|
1999
2117
|
*/
|
|
2000
2118
|
export interface StartChannelRequest {
|
|
2001
2119
|
/**
|
|
2002
|
-
* @public
|
|
2003
2120
|
* <p>The name of the channel.</p>
|
|
2121
|
+
* @public
|
|
2004
2122
|
*/
|
|
2005
2123
|
ChannelName: string | undefined;
|
|
2006
2124
|
}
|
|
@@ -2014,8 +2132,8 @@ export interface StartChannelResponse {
|
|
|
2014
2132
|
*/
|
|
2015
2133
|
export interface StopChannelRequest {
|
|
2016
2134
|
/**
|
|
2017
|
-
* @public
|
|
2018
2135
|
* <p>The name of the channel.</p>
|
|
2136
|
+
* @public
|
|
2019
2137
|
*/
|
|
2020
2138
|
ChannelName: string | undefined;
|
|
2021
2139
|
}
|
|
@@ -2029,113 +2147,123 @@ export interface StopChannelResponse {
|
|
|
2029
2147
|
*/
|
|
2030
2148
|
export interface UpdateChannelRequest {
|
|
2031
2149
|
/**
|
|
2032
|
-
* @public
|
|
2033
2150
|
* <p>The name of the channel.</p>
|
|
2151
|
+
* @public
|
|
2034
2152
|
*/
|
|
2035
2153
|
ChannelName: string | undefined;
|
|
2036
2154
|
/**
|
|
2037
|
-
* @public
|
|
2038
2155
|
* <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>
|
|
2039
2156
|
* <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
|
|
2040
2157
|
* <code>PlaybackMode</code>.</p>
|
|
2158
|
+
* @public
|
|
2041
2159
|
*/
|
|
2042
2160
|
FillerSlate?: SlateSource;
|
|
2043
2161
|
/**
|
|
2044
|
-
* @public
|
|
2045
2162
|
* <p>The channel's output properties.</p>
|
|
2163
|
+
* @public
|
|
2046
2164
|
*/
|
|
2047
2165
|
Outputs: RequestOutputItem[] | undefined;
|
|
2048
2166
|
/**
|
|
2049
|
-
* @public
|
|
2050
2167
|
* <p>
|
|
2051
2168
|
* The time-shifted viewing configuration you want to associate to the channel.
|
|
2052
2169
|
* </p>
|
|
2170
|
+
* @public
|
|
2053
2171
|
*/
|
|
2054
2172
|
TimeShiftConfiguration?: TimeShiftConfiguration;
|
|
2173
|
+
/**
|
|
2174
|
+
* <p>The list of audiences defined in channel.</p>
|
|
2175
|
+
* @public
|
|
2176
|
+
*/
|
|
2177
|
+
Audiences?: string[];
|
|
2055
2178
|
}
|
|
2056
2179
|
/**
|
|
2057
2180
|
* @public
|
|
2058
2181
|
*/
|
|
2059
2182
|
export interface UpdateChannelResponse {
|
|
2060
2183
|
/**
|
|
2061
|
-
* @public
|
|
2062
2184
|
* <p>The Amazon Resource Name (ARN) associated with the channel.</p>
|
|
2185
|
+
* @public
|
|
2063
2186
|
*/
|
|
2064
2187
|
Arn?: string;
|
|
2065
2188
|
/**
|
|
2066
|
-
* @public
|
|
2067
2189
|
* <p>The name of the channel.</p>
|
|
2190
|
+
* @public
|
|
2068
2191
|
*/
|
|
2069
2192
|
ChannelName?: string;
|
|
2070
2193
|
/**
|
|
2071
|
-
* @public
|
|
2072
2194
|
* <p>Returns the state whether the channel is running or not.</p>
|
|
2195
|
+
* @public
|
|
2073
2196
|
*/
|
|
2074
2197
|
ChannelState?: ChannelState;
|
|
2075
2198
|
/**
|
|
2076
|
-
* @public
|
|
2077
2199
|
* <p>The timestamp of when the channel was created.</p>
|
|
2200
|
+
* @public
|
|
2078
2201
|
*/
|
|
2079
2202
|
CreationTime?: Date;
|
|
2080
2203
|
/**
|
|
2081
|
-
* @public
|
|
2082
2204
|
* <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>
|
|
2083
2205
|
* <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
|
|
2084
2206
|
* <code>PlaybackMode</code>.</p>
|
|
2207
|
+
* @public
|
|
2085
2208
|
*/
|
|
2086
2209
|
FillerSlate?: SlateSource;
|
|
2087
2210
|
/**
|
|
2088
|
-
* @public
|
|
2089
2211
|
* <p>The timestamp that indicates when the channel was last modified.</p>
|
|
2212
|
+
* @public
|
|
2090
2213
|
*/
|
|
2091
2214
|
LastModifiedTime?: Date;
|
|
2092
2215
|
/**
|
|
2093
|
-
* @public
|
|
2094
2216
|
* <p>The channel's output properties.</p>
|
|
2217
|
+
* @public
|
|
2095
2218
|
*/
|
|
2096
2219
|
Outputs?: ResponseOutputItem[];
|
|
2097
2220
|
/**
|
|
2098
|
-
* @public
|
|
2099
2221
|
* <p>The type of playback mode for this channel.</p>
|
|
2100
2222
|
* <p>
|
|
2101
2223
|
* <code>LINEAR</code> - Programs play back-to-back only once.</p>
|
|
2102
2224
|
* <p>
|
|
2103
2225
|
* <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>
|
|
2226
|
+
* @public
|
|
2104
2227
|
*/
|
|
2105
2228
|
PlaybackMode?: string;
|
|
2106
2229
|
/**
|
|
2107
|
-
* @public
|
|
2108
2230
|
* <p>The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
2231
|
+
* @public
|
|
2109
2232
|
*/
|
|
2110
2233
|
Tags?: Record<string, string>;
|
|
2111
2234
|
/**
|
|
2112
|
-
* @public
|
|
2113
2235
|
* <p>The tier associated with this Channel.</p>
|
|
2236
|
+
* @public
|
|
2114
2237
|
*/
|
|
2115
2238
|
Tier?: string;
|
|
2116
2239
|
/**
|
|
2117
|
-
* @public
|
|
2118
2240
|
* <p>
|
|
2119
2241
|
* The time-shifted viewing configuration for the channel.
|
|
2120
2242
|
* </p>
|
|
2243
|
+
* @public
|
|
2121
2244
|
*/
|
|
2122
2245
|
TimeShiftConfiguration?: TimeShiftConfiguration;
|
|
2246
|
+
/**
|
|
2247
|
+
* <p>The list of audiences defined in channel.</p>
|
|
2248
|
+
* @public
|
|
2249
|
+
*/
|
|
2250
|
+
Audiences?: string[];
|
|
2123
2251
|
}
|
|
2124
2252
|
/**
|
|
2125
|
-
* @public
|
|
2126
2253
|
* <p>Configures Amazon CloudWatch log settings for a playback configuration.</p>
|
|
2254
|
+
* @public
|
|
2127
2255
|
*/
|
|
2128
2256
|
export interface ConfigureLogsForPlaybackConfigurationRequest {
|
|
2129
2257
|
/**
|
|
2130
|
-
* @public
|
|
2131
2258
|
* <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>
|
|
2132
2259
|
* <p>Valid values: <code>0</code> - <code>100</code>
|
|
2133
2260
|
* </p>
|
|
2261
|
+
* @public
|
|
2134
2262
|
*/
|
|
2135
2263
|
PercentEnabled: number | undefined;
|
|
2136
2264
|
/**
|
|
2137
|
-
* @public
|
|
2138
2265
|
* <p>The name of the playback configuration.</p>
|
|
2266
|
+
* @public
|
|
2139
2267
|
*/
|
|
2140
2268
|
PlaybackConfigurationName: string | undefined;
|
|
2141
2269
|
}
|
|
@@ -2144,13 +2272,13 @@ export interface ConfigureLogsForPlaybackConfigurationRequest {
|
|
|
2144
2272
|
*/
|
|
2145
2273
|
export interface ConfigureLogsForPlaybackConfigurationResponse {
|
|
2146
2274
|
/**
|
|
2147
|
-
* @public
|
|
2148
2275
|
* <p>The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account.</p>
|
|
2276
|
+
* @public
|
|
2149
2277
|
*/
|
|
2150
2278
|
PercentEnabled: number | undefined;
|
|
2151
2279
|
/**
|
|
2152
|
-
* @public
|
|
2153
2280
|
* <p>The name of the playback configuration.</p>
|
|
2281
|
+
* @public
|
|
2154
2282
|
*/
|
|
2155
2283
|
PlaybackConfigurationName?: string;
|
|
2156
2284
|
}
|
|
@@ -2159,23 +2287,23 @@ export interface ConfigureLogsForPlaybackConfigurationResponse {
|
|
|
2159
2287
|
*/
|
|
2160
2288
|
export interface CreateLiveSourceRequest {
|
|
2161
2289
|
/**
|
|
2162
|
-
* @public
|
|
2163
2290
|
* <p>A list of HTTP package configuration parameters for this live source.</p>
|
|
2291
|
+
* @public
|
|
2164
2292
|
*/
|
|
2165
2293
|
HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
|
|
2166
2294
|
/**
|
|
2167
|
-
* @public
|
|
2168
2295
|
* <p>The name of the live source.</p>
|
|
2296
|
+
* @public
|
|
2169
2297
|
*/
|
|
2170
2298
|
LiveSourceName: string | undefined;
|
|
2171
2299
|
/**
|
|
2172
|
-
* @public
|
|
2173
2300
|
* <p>The name of the source location.</p>
|
|
2301
|
+
* @public
|
|
2174
2302
|
*/
|
|
2175
2303
|
SourceLocationName: string | undefined;
|
|
2176
2304
|
/**
|
|
2177
|
-
* @public
|
|
2178
2305
|
* <p>The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
2306
|
+
* @public
|
|
2179
2307
|
*/
|
|
2180
2308
|
Tags?: Record<string, string>;
|
|
2181
2309
|
}
|
|
@@ -2184,38 +2312,38 @@ export interface CreateLiveSourceRequest {
|
|
|
2184
2312
|
*/
|
|
2185
2313
|
export interface CreateLiveSourceResponse {
|
|
2186
2314
|
/**
|
|
2187
|
-
* @public
|
|
2188
2315
|
* <p>The ARN to assign to the live source.</p>
|
|
2316
|
+
* @public
|
|
2189
2317
|
*/
|
|
2190
2318
|
Arn?: string;
|
|
2191
2319
|
/**
|
|
2192
|
-
* @public
|
|
2193
2320
|
* <p>The time the live source was created.</p>
|
|
2321
|
+
* @public
|
|
2194
2322
|
*/
|
|
2195
2323
|
CreationTime?: Date;
|
|
2196
2324
|
/**
|
|
2197
|
-
* @public
|
|
2198
2325
|
* <p>A list of HTTP package configuration parameters for this live source.</p>
|
|
2326
|
+
* @public
|
|
2199
2327
|
*/
|
|
2200
2328
|
HttpPackageConfigurations?: HttpPackageConfiguration[];
|
|
2201
2329
|
/**
|
|
2202
|
-
* @public
|
|
2203
2330
|
* <p>The time the live source was last modified.</p>
|
|
2331
|
+
* @public
|
|
2204
2332
|
*/
|
|
2205
2333
|
LastModifiedTime?: Date;
|
|
2206
2334
|
/**
|
|
2207
|
-
* @public
|
|
2208
2335
|
* <p>The name to assign to the live source.</p>
|
|
2336
|
+
* @public
|
|
2209
2337
|
*/
|
|
2210
2338
|
LiveSourceName?: string;
|
|
2211
2339
|
/**
|
|
2212
|
-
* @public
|
|
2213
2340
|
* <p>The name to assign to the source location of the live source.</p>
|
|
2341
|
+
* @public
|
|
2214
2342
|
*/
|
|
2215
2343
|
SourceLocationName?: string;
|
|
2216
2344
|
/**
|
|
2217
|
-
* @public
|
|
2218
2345
|
* <p>The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
2346
|
+
* @public
|
|
2219
2347
|
*/
|
|
2220
2348
|
Tags?: Record<string, string>;
|
|
2221
2349
|
}
|
|
@@ -2224,28 +2352,28 @@ export interface CreateLiveSourceResponse {
|
|
|
2224
2352
|
*/
|
|
2225
2353
|
export interface CreatePrefetchScheduleRequest {
|
|
2226
2354
|
/**
|
|
2227
|
-
* @public
|
|
2228
2355
|
* <p>The configuration settings for MediaTailor's <i>consumption</i> of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the <i>consumption window</i>. Prefetch schedules automatically expire no earlier than seven days after the end time.</p>
|
|
2356
|
+
* @public
|
|
2229
2357
|
*/
|
|
2230
2358
|
Consumption: PrefetchConsumption | undefined;
|
|
2231
2359
|
/**
|
|
2232
|
-
* @public
|
|
2233
2360
|
* <p>The name to assign to the schedule request.</p>
|
|
2361
|
+
* @public
|
|
2234
2362
|
*/
|
|
2235
2363
|
Name: string | undefined;
|
|
2236
2364
|
/**
|
|
2237
|
-
* @public
|
|
2238
2365
|
* <p>The name to assign to the playback configuration.</p>
|
|
2366
|
+
* @public
|
|
2239
2367
|
*/
|
|
2240
2368
|
PlaybackConfigurationName: string | undefined;
|
|
2241
2369
|
/**
|
|
2242
|
-
* @public
|
|
2243
2370
|
* <p>The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.</p>
|
|
2371
|
+
* @public
|
|
2244
2372
|
*/
|
|
2245
2373
|
Retrieval: PrefetchRetrieval | undefined;
|
|
2246
2374
|
/**
|
|
2247
|
-
* @public
|
|
2248
2375
|
* <p>An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If <code>StreamId</code> is specified, MediaTailor returns all of the prefetch schedules with an exact match on <code>StreamId</code>. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of <code>StreamId</code>.</p>
|
|
2376
|
+
* @public
|
|
2249
2377
|
*/
|
|
2250
2378
|
StreamId?: string;
|
|
2251
2379
|
}
|
|
@@ -2254,33 +2382,33 @@ export interface CreatePrefetchScheduleRequest {
|
|
|
2254
2382
|
*/
|
|
2255
2383
|
export interface CreatePrefetchScheduleResponse {
|
|
2256
2384
|
/**
|
|
2257
|
-
* @public
|
|
2258
2385
|
* <p>The ARN to assign to the prefetch schedule.</p>
|
|
2386
|
+
* @public
|
|
2259
2387
|
*/
|
|
2260
2388
|
Arn?: string;
|
|
2261
2389
|
/**
|
|
2262
|
-
* @public
|
|
2263
2390
|
* <p>The configuration settings for MediaTailor's <i>consumption</i> of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the <i>consumption window</i>. Prefetch schedules automatically expire no earlier than seven days after the end time.</p>
|
|
2391
|
+
* @public
|
|
2264
2392
|
*/
|
|
2265
2393
|
Consumption?: PrefetchConsumption;
|
|
2266
2394
|
/**
|
|
2267
|
-
* @public
|
|
2268
2395
|
* <p>The name to assign to the prefetch schedule.</p>
|
|
2396
|
+
* @public
|
|
2269
2397
|
*/
|
|
2270
2398
|
Name?: string;
|
|
2271
2399
|
/**
|
|
2272
|
-
* @public
|
|
2273
2400
|
* <p>The name to assign to the playback configuration.</p>
|
|
2401
|
+
* @public
|
|
2274
2402
|
*/
|
|
2275
2403
|
PlaybackConfigurationName?: string;
|
|
2276
2404
|
/**
|
|
2277
|
-
* @public
|
|
2278
2405
|
* <p>The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.</p>
|
|
2406
|
+
* @public
|
|
2279
2407
|
*/
|
|
2280
2408
|
Retrieval?: PrefetchRetrieval;
|
|
2281
2409
|
/**
|
|
2282
|
-
* @public
|
|
2283
2410
|
* <p>An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If <code>StreamId</code> is specified, MediaTailor returns all of the prefetch schedules with an exact match on <code>StreamId</code>. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of <code>StreamId</code>.</p>
|
|
2411
|
+
* @public
|
|
2284
2412
|
*/
|
|
2285
2413
|
StreamId?: string;
|
|
2286
2414
|
}
|
|
@@ -2289,33 +2417,33 @@ export interface CreatePrefetchScheduleResponse {
|
|
|
2289
2417
|
*/
|
|
2290
2418
|
export interface CreateSourceLocationRequest {
|
|
2291
2419
|
/**
|
|
2292
|
-
* @public
|
|
2293
2420
|
* <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
|
|
2421
|
+
* @public
|
|
2294
2422
|
*/
|
|
2295
2423
|
AccessConfiguration?: AccessConfiguration;
|
|
2296
2424
|
/**
|
|
2297
|
-
* @public
|
|
2298
2425
|
* <p>The optional configuration for the server that serves segments.</p>
|
|
2426
|
+
* @public
|
|
2299
2427
|
*/
|
|
2300
2428
|
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
|
|
2301
2429
|
/**
|
|
2302
|
-
* @public
|
|
2303
2430
|
* <p>The source's HTTP package configurations.</p>
|
|
2431
|
+
* @public
|
|
2304
2432
|
*/
|
|
2305
2433
|
HttpConfiguration: HttpConfiguration | undefined;
|
|
2306
2434
|
/**
|
|
2307
|
-
* @public
|
|
2308
2435
|
* <p>A list of the segment delivery configurations associated with this resource.</p>
|
|
2436
|
+
* @public
|
|
2309
2437
|
*/
|
|
2310
2438
|
SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
|
|
2311
2439
|
/**
|
|
2312
|
-
* @public
|
|
2313
2440
|
* <p>The name associated with the source location.</p>
|
|
2441
|
+
* @public
|
|
2314
2442
|
*/
|
|
2315
2443
|
SourceLocationName: string | undefined;
|
|
2316
2444
|
/**
|
|
2317
|
-
* @public
|
|
2318
2445
|
* <p>The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
2446
|
+
* @public
|
|
2319
2447
|
*/
|
|
2320
2448
|
Tags?: Record<string, string>;
|
|
2321
2449
|
}
|
|
@@ -2324,48 +2452,48 @@ export interface CreateSourceLocationRequest {
|
|
|
2324
2452
|
*/
|
|
2325
2453
|
export interface CreateSourceLocationResponse {
|
|
2326
2454
|
/**
|
|
2327
|
-
* @public
|
|
2328
2455
|
* <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
|
|
2456
|
+
* @public
|
|
2329
2457
|
*/
|
|
2330
2458
|
AccessConfiguration?: AccessConfiguration;
|
|
2331
2459
|
/**
|
|
2332
|
-
* @public
|
|
2333
2460
|
* <p>The ARN to assign to the source location.</p>
|
|
2461
|
+
* @public
|
|
2334
2462
|
*/
|
|
2335
2463
|
Arn?: string;
|
|
2336
2464
|
/**
|
|
2337
|
-
* @public
|
|
2338
2465
|
* <p>The time the source location was created.</p>
|
|
2466
|
+
* @public
|
|
2339
2467
|
*/
|
|
2340
2468
|
CreationTime?: Date;
|
|
2341
2469
|
/**
|
|
2342
|
-
* @public
|
|
2343
2470
|
* <p>The optional configuration for the server that serves segments.</p>
|
|
2471
|
+
* @public
|
|
2344
2472
|
*/
|
|
2345
2473
|
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
|
|
2346
2474
|
/**
|
|
2347
|
-
* @public
|
|
2348
2475
|
* <p>The source's HTTP package configurations.</p>
|
|
2476
|
+
* @public
|
|
2349
2477
|
*/
|
|
2350
2478
|
HttpConfiguration?: HttpConfiguration;
|
|
2351
2479
|
/**
|
|
2352
|
-
* @public
|
|
2353
2480
|
* <p>The time the source location was last modified.</p>
|
|
2481
|
+
* @public
|
|
2354
2482
|
*/
|
|
2355
2483
|
LastModifiedTime?: Date;
|
|
2356
2484
|
/**
|
|
2357
|
-
* @public
|
|
2358
2485
|
* <p>The segment delivery configurations for the source location. For information about MediaTailor configurations, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html">Working with configurations in AWS Elemental MediaTailor</a>.</p>
|
|
2486
|
+
* @public
|
|
2359
2487
|
*/
|
|
2360
2488
|
SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
|
|
2361
2489
|
/**
|
|
2362
|
-
* @public
|
|
2363
2490
|
* <p>The name to assign to the source location.</p>
|
|
2491
|
+
* @public
|
|
2364
2492
|
*/
|
|
2365
2493
|
SourceLocationName?: string;
|
|
2366
2494
|
/**
|
|
2367
|
-
* @public
|
|
2368
2495
|
* <p>The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
2496
|
+
* @public
|
|
2369
2497
|
*/
|
|
2370
2498
|
Tags?: Record<string, string>;
|
|
2371
2499
|
}
|
|
@@ -2374,23 +2502,23 @@ export interface CreateSourceLocationResponse {
|
|
|
2374
2502
|
*/
|
|
2375
2503
|
export interface CreateVodSourceRequest {
|
|
2376
2504
|
/**
|
|
2377
|
-
* @public
|
|
2378
2505
|
* <p>A list of HTTP package configuration parameters for this VOD source.</p>
|
|
2506
|
+
* @public
|
|
2379
2507
|
*/
|
|
2380
2508
|
HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
|
|
2381
2509
|
/**
|
|
2382
|
-
* @public
|
|
2383
2510
|
* <p>The name of the source location for this VOD source.</p>
|
|
2511
|
+
* @public
|
|
2384
2512
|
*/
|
|
2385
2513
|
SourceLocationName: string | undefined;
|
|
2386
2514
|
/**
|
|
2387
|
-
* @public
|
|
2388
2515
|
* <p>The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
2516
|
+
* @public
|
|
2389
2517
|
*/
|
|
2390
2518
|
Tags?: Record<string, string>;
|
|
2391
2519
|
/**
|
|
2392
|
-
* @public
|
|
2393
2520
|
* <p>The name associated with the VOD source.></p>
|
|
2521
|
+
* @public
|
|
2394
2522
|
*/
|
|
2395
2523
|
VodSourceName: string | undefined;
|
|
2396
2524
|
}
|
|
@@ -2399,54 +2527,54 @@ export interface CreateVodSourceRequest {
|
|
|
2399
2527
|
*/
|
|
2400
2528
|
export interface CreateVodSourceResponse {
|
|
2401
2529
|
/**
|
|
2402
|
-
* @public
|
|
2403
2530
|
* <p>The ARN to assign to this VOD source.</p>
|
|
2531
|
+
* @public
|
|
2404
2532
|
*/
|
|
2405
2533
|
Arn?: string;
|
|
2406
2534
|
/**
|
|
2407
|
-
* @public
|
|
2408
2535
|
* <p>The time the VOD source was created.</p>
|
|
2536
|
+
* @public
|
|
2409
2537
|
*/
|
|
2410
2538
|
CreationTime?: Date;
|
|
2411
2539
|
/**
|
|
2412
|
-
* @public
|
|
2413
2540
|
* <p>A list of HTTP package configuration parameters for this VOD source.</p>
|
|
2541
|
+
* @public
|
|
2414
2542
|
*/
|
|
2415
2543
|
HttpPackageConfigurations?: HttpPackageConfiguration[];
|
|
2416
2544
|
/**
|
|
2417
|
-
* @public
|
|
2418
2545
|
* <p>The time the VOD source was last modified.</p>
|
|
2546
|
+
* @public
|
|
2419
2547
|
*/
|
|
2420
2548
|
LastModifiedTime?: Date;
|
|
2421
2549
|
/**
|
|
2422
|
-
* @public
|
|
2423
2550
|
* <p>The name to assign to the source location for this VOD source.</p>
|
|
2551
|
+
* @public
|
|
2424
2552
|
*/
|
|
2425
2553
|
SourceLocationName?: string;
|
|
2426
2554
|
/**
|
|
2427
|
-
* @public
|
|
2428
2555
|
* <p>The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
2556
|
+
* @public
|
|
2429
2557
|
*/
|
|
2430
2558
|
Tags?: Record<string, string>;
|
|
2431
2559
|
/**
|
|
2432
|
-
* @public
|
|
2433
2560
|
* <p>The name to assign to the VOD source.</p>
|
|
2561
|
+
* @public
|
|
2434
2562
|
*/
|
|
2435
2563
|
VodSourceName?: string;
|
|
2436
2564
|
}
|
|
2437
2565
|
/**
|
|
2438
|
-
* @public
|
|
2439
2566
|
* <p>The configuration for DASH PUT operations.</p>
|
|
2567
|
+
* @public
|
|
2440
2568
|
*/
|
|
2441
2569
|
export interface DashConfigurationForPut {
|
|
2442
2570
|
/**
|
|
2443
|
-
* @public
|
|
2444
2571
|
* <p>The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are <code>DISABLED</code> and <code>EMT_DEFAULT</code>. The <code>EMT_DEFAULT</code> setting enables the inclusion of the tag and is the default value.</p>
|
|
2572
|
+
* @public
|
|
2445
2573
|
*/
|
|
2446
2574
|
MpdLocation?: string;
|
|
2447
2575
|
/**
|
|
2448
|
-
* @public
|
|
2449
2576
|
* <p>The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to <code>SINGLE_PERIOD</code>. The default setting is <code>MULTI_PERIOD</code>. For multi-period manifests, omit this setting or set it to <code>MULTI_PERIOD</code>.</p>
|
|
2577
|
+
* @public
|
|
2450
2578
|
*/
|
|
2451
2579
|
OriginManifestType?: OriginManifestType;
|
|
2452
2580
|
}
|
|
@@ -2455,13 +2583,13 @@ export interface DashConfigurationForPut {
|
|
|
2455
2583
|
*/
|
|
2456
2584
|
export interface DeleteLiveSourceRequest {
|
|
2457
2585
|
/**
|
|
2458
|
-
* @public
|
|
2459
2586
|
* <p>The name of the live source.</p>
|
|
2587
|
+
* @public
|
|
2460
2588
|
*/
|
|
2461
2589
|
LiveSourceName: string | undefined;
|
|
2462
2590
|
/**
|
|
2463
|
-
* @public
|
|
2464
2591
|
* <p>The name of the source location associated with this Live Source.</p>
|
|
2592
|
+
* @public
|
|
2465
2593
|
*/
|
|
2466
2594
|
SourceLocationName: string | undefined;
|
|
2467
2595
|
}
|
|
@@ -2475,8 +2603,8 @@ export interface DeleteLiveSourceResponse {
|
|
|
2475
2603
|
*/
|
|
2476
2604
|
export interface DeletePlaybackConfigurationRequest {
|
|
2477
2605
|
/**
|
|
2478
|
-
* @public
|
|
2479
2606
|
* <p>The name of the playback configuration.</p>
|
|
2607
|
+
* @public
|
|
2480
2608
|
*/
|
|
2481
2609
|
Name: string | undefined;
|
|
2482
2610
|
}
|
|
@@ -2490,13 +2618,13 @@ export interface DeletePlaybackConfigurationResponse {
|
|
|
2490
2618
|
*/
|
|
2491
2619
|
export interface DeletePrefetchScheduleRequest {
|
|
2492
2620
|
/**
|
|
2493
|
-
* @public
|
|
2494
2621
|
* <p>The name of the prefetch schedule. If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.</p>
|
|
2622
|
+
* @public
|
|
2495
2623
|
*/
|
|
2496
2624
|
Name: string | undefined;
|
|
2497
2625
|
/**
|
|
2498
|
-
* @public
|
|
2499
2626
|
* <p>The name of the playback configuration for this prefetch schedule.</p>
|
|
2627
|
+
* @public
|
|
2500
2628
|
*/
|
|
2501
2629
|
PlaybackConfigurationName: string | undefined;
|
|
2502
2630
|
}
|
|
@@ -2510,8 +2638,8 @@ export interface DeletePrefetchScheduleResponse {
|
|
|
2510
2638
|
*/
|
|
2511
2639
|
export interface DeleteSourceLocationRequest {
|
|
2512
2640
|
/**
|
|
2513
|
-
* @public
|
|
2514
2641
|
* <p>The name of the source location.</p>
|
|
2642
|
+
* @public
|
|
2515
2643
|
*/
|
|
2516
2644
|
SourceLocationName: string | undefined;
|
|
2517
2645
|
}
|
|
@@ -2525,13 +2653,13 @@ export interface DeleteSourceLocationResponse {
|
|
|
2525
2653
|
*/
|
|
2526
2654
|
export interface DeleteVodSourceRequest {
|
|
2527
2655
|
/**
|
|
2528
|
-
* @public
|
|
2529
2656
|
* <p>The name of the source location associated with this VOD Source.</p>
|
|
2657
|
+
* @public
|
|
2530
2658
|
*/
|
|
2531
2659
|
SourceLocationName: string | undefined;
|
|
2532
2660
|
/**
|
|
2533
|
-
* @public
|
|
2534
2661
|
* <p>The name of the VOD source.</p>
|
|
2662
|
+
* @public
|
|
2535
2663
|
*/
|
|
2536
2664
|
VodSourceName: string | undefined;
|
|
2537
2665
|
}
|
|
@@ -2545,13 +2673,13 @@ export interface DeleteVodSourceResponse {
|
|
|
2545
2673
|
*/
|
|
2546
2674
|
export interface DescribeLiveSourceRequest {
|
|
2547
2675
|
/**
|
|
2548
|
-
* @public
|
|
2549
2676
|
* <p>The name of the live source.</p>
|
|
2677
|
+
* @public
|
|
2550
2678
|
*/
|
|
2551
2679
|
LiveSourceName: string | undefined;
|
|
2552
2680
|
/**
|
|
2553
|
-
* @public
|
|
2554
2681
|
* <p>The name of the source location associated with this Live Source.</p>
|
|
2682
|
+
* @public
|
|
2555
2683
|
*/
|
|
2556
2684
|
SourceLocationName: string | undefined;
|
|
2557
2685
|
}
|
|
@@ -2560,38 +2688,38 @@ export interface DescribeLiveSourceRequest {
|
|
|
2560
2688
|
*/
|
|
2561
2689
|
export interface DescribeLiveSourceResponse {
|
|
2562
2690
|
/**
|
|
2563
|
-
* @public
|
|
2564
2691
|
* <p>The ARN of the live source.</p>
|
|
2692
|
+
* @public
|
|
2565
2693
|
*/
|
|
2566
2694
|
Arn?: string;
|
|
2567
2695
|
/**
|
|
2568
|
-
* @public
|
|
2569
2696
|
* <p>The timestamp that indicates when the live source was created.</p>
|
|
2697
|
+
* @public
|
|
2570
2698
|
*/
|
|
2571
2699
|
CreationTime?: Date;
|
|
2572
2700
|
/**
|
|
2573
|
-
* @public
|
|
2574
2701
|
* <p>The HTTP package configurations.</p>
|
|
2702
|
+
* @public
|
|
2575
2703
|
*/
|
|
2576
2704
|
HttpPackageConfigurations?: HttpPackageConfiguration[];
|
|
2577
2705
|
/**
|
|
2578
|
-
* @public
|
|
2579
2706
|
* <p>The timestamp that indicates when the live source was modified.</p>
|
|
2707
|
+
* @public
|
|
2580
2708
|
*/
|
|
2581
2709
|
LastModifiedTime?: Date;
|
|
2582
2710
|
/**
|
|
2583
|
-
* @public
|
|
2584
2711
|
* <p>The name of the live source.</p>
|
|
2712
|
+
* @public
|
|
2585
2713
|
*/
|
|
2586
2714
|
LiveSourceName?: string;
|
|
2587
2715
|
/**
|
|
2588
|
-
* @public
|
|
2589
2716
|
* <p>The name of the source location associated with the live source.</p>
|
|
2717
|
+
* @public
|
|
2590
2718
|
*/
|
|
2591
2719
|
SourceLocationName?: string;
|
|
2592
2720
|
/**
|
|
2593
|
-
* @public
|
|
2594
2721
|
* <p>The tags assigned to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
2722
|
+
* @public
|
|
2595
2723
|
*/
|
|
2596
2724
|
Tags?: Record<string, string>;
|
|
2597
2725
|
}
|
|
@@ -2600,8 +2728,8 @@ export interface DescribeLiveSourceResponse {
|
|
|
2600
2728
|
*/
|
|
2601
2729
|
export interface DescribeSourceLocationRequest {
|
|
2602
2730
|
/**
|
|
2603
|
-
* @public
|
|
2604
2731
|
* <p>The name of the source location.</p>
|
|
2732
|
+
* @public
|
|
2605
2733
|
*/
|
|
2606
2734
|
SourceLocationName: string | undefined;
|
|
2607
2735
|
}
|
|
@@ -2610,48 +2738,48 @@ export interface DescribeSourceLocationRequest {
|
|
|
2610
2738
|
*/
|
|
2611
2739
|
export interface DescribeSourceLocationResponse {
|
|
2612
2740
|
/**
|
|
2613
|
-
* @public
|
|
2614
2741
|
* <p>The access configuration for the source location.</p>
|
|
2742
|
+
* @public
|
|
2615
2743
|
*/
|
|
2616
2744
|
AccessConfiguration?: AccessConfiguration;
|
|
2617
2745
|
/**
|
|
2618
|
-
* @public
|
|
2619
2746
|
* <p>The ARN of the source location.</p>
|
|
2747
|
+
* @public
|
|
2620
2748
|
*/
|
|
2621
2749
|
Arn?: string;
|
|
2622
2750
|
/**
|
|
2623
|
-
* @public
|
|
2624
2751
|
* <p>The timestamp that indicates when the source location was created.</p>
|
|
2752
|
+
* @public
|
|
2625
2753
|
*/
|
|
2626
2754
|
CreationTime?: Date;
|
|
2627
2755
|
/**
|
|
2628
|
-
* @public
|
|
2629
2756
|
* <p>The default segment delivery configuration settings.</p>
|
|
2757
|
+
* @public
|
|
2630
2758
|
*/
|
|
2631
2759
|
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
|
|
2632
2760
|
/**
|
|
2633
|
-
* @public
|
|
2634
2761
|
* <p>The HTTP package configuration settings for the source location.</p>
|
|
2762
|
+
* @public
|
|
2635
2763
|
*/
|
|
2636
2764
|
HttpConfiguration?: HttpConfiguration;
|
|
2637
2765
|
/**
|
|
2638
|
-
* @public
|
|
2639
2766
|
* <p>The timestamp that indicates when the source location was last modified.</p>
|
|
2767
|
+
* @public
|
|
2640
2768
|
*/
|
|
2641
2769
|
LastModifiedTime?: Date;
|
|
2642
2770
|
/**
|
|
2643
|
-
* @public
|
|
2644
2771
|
* <p>A list of the segment delivery configurations associated with this resource.</p>
|
|
2772
|
+
* @public
|
|
2645
2773
|
*/
|
|
2646
2774
|
SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
|
|
2647
2775
|
/**
|
|
2648
|
-
* @public
|
|
2649
2776
|
* <p>The name of the source location.</p>
|
|
2777
|
+
* @public
|
|
2650
2778
|
*/
|
|
2651
2779
|
SourceLocationName?: string;
|
|
2652
2780
|
/**
|
|
2653
|
-
* @public
|
|
2654
2781
|
* <p>The tags assigned to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
2782
|
+
* @public
|
|
2655
2783
|
*/
|
|
2656
2784
|
Tags?: Record<string, string>;
|
|
2657
2785
|
}
|
|
@@ -2660,13 +2788,13 @@ export interface DescribeSourceLocationResponse {
|
|
|
2660
2788
|
*/
|
|
2661
2789
|
export interface DescribeVodSourceRequest {
|
|
2662
2790
|
/**
|
|
2663
|
-
* @public
|
|
2664
2791
|
* <p>The name of the source location associated with this VOD Source.</p>
|
|
2792
|
+
* @public
|
|
2665
2793
|
*/
|
|
2666
2794
|
SourceLocationName: string | undefined;
|
|
2667
2795
|
/**
|
|
2668
|
-
* @public
|
|
2669
2796
|
* <p>The name of the VOD Source.</p>
|
|
2797
|
+
* @public
|
|
2670
2798
|
*/
|
|
2671
2799
|
VodSourceName: string | undefined;
|
|
2672
2800
|
}
|
|
@@ -2675,43 +2803,43 @@ export interface DescribeVodSourceRequest {
|
|
|
2675
2803
|
*/
|
|
2676
2804
|
export interface DescribeVodSourceResponse {
|
|
2677
2805
|
/**
|
|
2678
|
-
* @public
|
|
2679
2806
|
* <p>The ad break opportunities within the VOD source.</p>
|
|
2807
|
+
* @public
|
|
2680
2808
|
*/
|
|
2681
2809
|
AdBreakOpportunities?: AdBreakOpportunity[];
|
|
2682
2810
|
/**
|
|
2683
|
-
* @public
|
|
2684
2811
|
* <p>The ARN of the VOD source.</p>
|
|
2812
|
+
* @public
|
|
2685
2813
|
*/
|
|
2686
2814
|
Arn?: string;
|
|
2687
2815
|
/**
|
|
2688
|
-
* @public
|
|
2689
2816
|
* <p>The timestamp that indicates when the VOD source was created.</p>
|
|
2817
|
+
* @public
|
|
2690
2818
|
*/
|
|
2691
2819
|
CreationTime?: Date;
|
|
2692
2820
|
/**
|
|
2693
|
-
* @public
|
|
2694
2821
|
* <p>The HTTP package configurations.</p>
|
|
2822
|
+
* @public
|
|
2695
2823
|
*/
|
|
2696
2824
|
HttpPackageConfigurations?: HttpPackageConfiguration[];
|
|
2697
2825
|
/**
|
|
2698
|
-
* @public
|
|
2699
2826
|
* <p>The last modified time of the VOD source.</p>
|
|
2827
|
+
* @public
|
|
2700
2828
|
*/
|
|
2701
2829
|
LastModifiedTime?: Date;
|
|
2702
2830
|
/**
|
|
2703
|
-
* @public
|
|
2704
2831
|
* <p>The name of the source location associated with the VOD source.</p>
|
|
2832
|
+
* @public
|
|
2705
2833
|
*/
|
|
2706
2834
|
SourceLocationName?: string;
|
|
2707
2835
|
/**
|
|
2708
|
-
* @public
|
|
2709
2836
|
* <p>The tags assigned to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
2837
|
+
* @public
|
|
2710
2838
|
*/
|
|
2711
2839
|
Tags?: Record<string, string>;
|
|
2712
2840
|
/**
|
|
2713
|
-
* @public
|
|
2714
2841
|
* <p>The name of the VOD source.</p>
|
|
2842
|
+
* @public
|
|
2715
2843
|
*/
|
|
2716
2844
|
VodSourceName?: string;
|
|
2717
2845
|
}
|
|
@@ -2720,8 +2848,8 @@ export interface DescribeVodSourceResponse {
|
|
|
2720
2848
|
*/
|
|
2721
2849
|
export interface GetPlaybackConfigurationRequest {
|
|
2722
2850
|
/**
|
|
2723
|
-
* @public
|
|
2724
2851
|
* <p>The identifier for the playback configuration.</p>
|
|
2852
|
+
* @public
|
|
2725
2853
|
*/
|
|
2726
2854
|
Name: string | undefined;
|
|
2727
2855
|
}
|
|
@@ -2730,98 +2858,98 @@ export interface GetPlaybackConfigurationRequest {
|
|
|
2730
2858
|
*/
|
|
2731
2859
|
export interface GetPlaybackConfigurationResponse {
|
|
2732
2860
|
/**
|
|
2733
|
-
* @public
|
|
2734
2861
|
* <p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.</p>
|
|
2862
|
+
* @public
|
|
2735
2863
|
*/
|
|
2736
2864
|
AdDecisionServerUrl?: string;
|
|
2737
2865
|
/**
|
|
2738
|
-
* @public
|
|
2739
2866
|
* <p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Suppression</a>.</p>
|
|
2867
|
+
* @public
|
|
2740
2868
|
*/
|
|
2741
2869
|
AvailSuppression?: AvailSuppression;
|
|
2742
2870
|
/**
|
|
2743
|
-
* @public
|
|
2744
2871
|
* <p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html">Bumpers</a>.</p>
|
|
2872
|
+
* @public
|
|
2745
2873
|
*/
|
|
2746
2874
|
Bumper?: Bumper;
|
|
2747
2875
|
/**
|
|
2748
|
-
* @public
|
|
2749
2876
|
* <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
|
|
2877
|
+
* @public
|
|
2750
2878
|
*/
|
|
2751
2879
|
CdnConfiguration?: CdnConfiguration;
|
|
2752
2880
|
/**
|
|
2753
|
-
* @public
|
|
2754
2881
|
* <p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html">Domain Variables</a>.</p>
|
|
2882
|
+
* @public
|
|
2755
2883
|
*/
|
|
2756
2884
|
ConfigurationAliases?: Record<string, Record<string, string>>;
|
|
2757
2885
|
/**
|
|
2758
|
-
* @public
|
|
2759
2886
|
* <p>The configuration for DASH content.</p>
|
|
2887
|
+
* @public
|
|
2760
2888
|
*/
|
|
2761
2889
|
DashConfiguration?: DashConfiguration;
|
|
2762
2890
|
/**
|
|
2763
|
-
* @public
|
|
2764
2891
|
* <p>The configuration for HLS content.</p>
|
|
2892
|
+
* @public
|
|
2765
2893
|
*/
|
|
2766
2894
|
HlsConfiguration?: HlsConfiguration;
|
|
2767
2895
|
/**
|
|
2768
|
-
* @public
|
|
2769
2896
|
* <p>The configuration for pre-roll ad insertion.</p>
|
|
2897
|
+
* @public
|
|
2770
2898
|
*/
|
|
2771
2899
|
LivePreRollConfiguration?: LivePreRollConfiguration;
|
|
2772
2900
|
/**
|
|
2773
|
-
* @public
|
|
2774
2901
|
* <p>The Amazon CloudWatch log settings for a playback configuration.</p>
|
|
2902
|
+
* @public
|
|
2775
2903
|
*/
|
|
2776
2904
|
LogConfiguration?: LogConfiguration;
|
|
2777
2905
|
/**
|
|
2778
|
-
* @public
|
|
2779
2906
|
* <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
|
|
2907
|
+
* @public
|
|
2780
2908
|
*/
|
|
2781
2909
|
ManifestProcessingRules?: ManifestProcessingRules;
|
|
2782
2910
|
/**
|
|
2783
|
-
* @public
|
|
2784
2911
|
* <p>The identifier for the playback configuration.</p>
|
|
2912
|
+
* @public
|
|
2785
2913
|
*/
|
|
2786
2914
|
Name?: string;
|
|
2787
2915
|
/**
|
|
2788
|
-
* @public
|
|
2789
2916
|
* <p>Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to <i>ad replacement</i> in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Behavior in AWS Elemental MediaTailor</a>.</p>
|
|
2917
|
+
* @public
|
|
2790
2918
|
*/
|
|
2791
2919
|
PersonalizationThresholdSeconds?: number;
|
|
2792
2920
|
/**
|
|
2793
|
-
* @public
|
|
2794
2921
|
* <p>The Amazon Resource Name (ARN) for the playback configuration.</p>
|
|
2922
|
+
* @public
|
|
2795
2923
|
*/
|
|
2796
2924
|
PlaybackConfigurationArn?: string;
|
|
2797
2925
|
/**
|
|
2798
|
-
* @public
|
|
2799
2926
|
* <p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.</p>
|
|
2927
|
+
* @public
|
|
2800
2928
|
*/
|
|
2801
2929
|
PlaybackEndpointPrefix?: string;
|
|
2802
2930
|
/**
|
|
2803
|
-
* @public
|
|
2804
2931
|
* <p>The URL that the player uses to initialize a session that uses client-side reporting.</p>
|
|
2932
|
+
* @public
|
|
2805
2933
|
*/
|
|
2806
2934
|
SessionInitializationEndpointPrefix?: string;
|
|
2807
2935
|
/**
|
|
2808
|
-
* @public
|
|
2809
2936
|
* <p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.</p>
|
|
2937
|
+
* @public
|
|
2810
2938
|
*/
|
|
2811
2939
|
SlateAdUrl?: string;
|
|
2812
2940
|
/**
|
|
2813
|
-
* @public
|
|
2814
2941
|
* <p>The tags assigned to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
2942
|
+
* @public
|
|
2815
2943
|
*/
|
|
2816
2944
|
Tags?: Record<string, string>;
|
|
2817
2945
|
/**
|
|
2818
|
-
* @public
|
|
2819
2946
|
* <p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>
|
|
2947
|
+
* @public
|
|
2820
2948
|
*/
|
|
2821
2949
|
TranscodeProfileName?: string;
|
|
2822
2950
|
/**
|
|
2823
|
-
* @public
|
|
2824
2951
|
* <p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>
|
|
2952
|
+
* @public
|
|
2825
2953
|
*/
|
|
2826
2954
|
VideoContentSourceUrl?: string;
|
|
2827
2955
|
}
|
|
@@ -2830,13 +2958,13 @@ export interface GetPlaybackConfigurationResponse {
|
|
|
2830
2958
|
*/
|
|
2831
2959
|
export interface GetPrefetchScheduleRequest {
|
|
2832
2960
|
/**
|
|
2833
|
-
* @public
|
|
2834
2961
|
* <p>The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.</p>
|
|
2962
|
+
* @public
|
|
2835
2963
|
*/
|
|
2836
2964
|
Name: string | undefined;
|
|
2837
2965
|
/**
|
|
2838
|
-
* @public
|
|
2839
2966
|
* <p>Returns information about the prefetch schedule for a specific playback configuration. If you call <code>GetPrefetchSchedule</code> on an expired prefetch schedule, MediaTailor returns an HTTP 404 status code.</p>
|
|
2967
|
+
* @public
|
|
2840
2968
|
*/
|
|
2841
2969
|
PlaybackConfigurationName: string | undefined;
|
|
2842
2970
|
}
|
|
@@ -2845,33 +2973,33 @@ export interface GetPrefetchScheduleRequest {
|
|
|
2845
2973
|
*/
|
|
2846
2974
|
export interface GetPrefetchScheduleResponse {
|
|
2847
2975
|
/**
|
|
2848
|
-
* @public
|
|
2849
2976
|
* <p>The Amazon Resource Name (ARN) of the prefetch schedule.</p>
|
|
2977
|
+
* @public
|
|
2850
2978
|
*/
|
|
2851
2979
|
Arn?: string;
|
|
2852
2980
|
/**
|
|
2853
|
-
* @public
|
|
2854
2981
|
* <p>Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a <i>consumption window</i>. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.</p>
|
|
2982
|
+
* @public
|
|
2855
2983
|
*/
|
|
2856
2984
|
Consumption?: PrefetchConsumption;
|
|
2857
2985
|
/**
|
|
2858
|
-
* @public
|
|
2859
2986
|
* <p>The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.</p>
|
|
2987
|
+
* @public
|
|
2860
2988
|
*/
|
|
2861
2989
|
Name?: string;
|
|
2862
2990
|
/**
|
|
2863
|
-
* @public
|
|
2864
2991
|
* <p>The name of the playback configuration to create the prefetch schedule for.</p>
|
|
2992
|
+
* @public
|
|
2865
2993
|
*/
|
|
2866
2994
|
PlaybackConfigurationName?: string;
|
|
2867
2995
|
/**
|
|
2868
|
-
* @public
|
|
2869
2996
|
* <p>A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).</p>
|
|
2997
|
+
* @public
|
|
2870
2998
|
*/
|
|
2871
2999
|
Retrieval?: PrefetchRetrieval;
|
|
2872
3000
|
/**
|
|
2873
|
-
* @public
|
|
2874
3001
|
* <p>An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.</p>
|
|
3002
|
+
* @public
|
|
2875
3003
|
*/
|
|
2876
3004
|
StreamId?: string;
|
|
2877
3005
|
}
|
|
@@ -2880,18 +3008,18 @@ export interface GetPrefetchScheduleResponse {
|
|
|
2880
3008
|
*/
|
|
2881
3009
|
export interface ListAlertsRequest {
|
|
2882
3010
|
/**
|
|
2883
|
-
* @public
|
|
2884
3011
|
* <p>The maximum number of alerts that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> alerts, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
|
|
3012
|
+
* @public
|
|
2885
3013
|
*/
|
|
2886
3014
|
MaxResults?: number;
|
|
2887
3015
|
/**
|
|
2888
|
-
* @public
|
|
2889
3016
|
* <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
|
|
3017
|
+
* @public
|
|
2890
3018
|
*/
|
|
2891
3019
|
NextToken?: string;
|
|
2892
3020
|
/**
|
|
2893
|
-
* @public
|
|
2894
3021
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
3022
|
+
* @public
|
|
2895
3023
|
*/
|
|
2896
3024
|
ResourceArn: string | undefined;
|
|
2897
3025
|
}
|
|
@@ -2900,13 +3028,13 @@ export interface ListAlertsRequest {
|
|
|
2900
3028
|
*/
|
|
2901
3029
|
export interface ListAlertsResponse {
|
|
2902
3030
|
/**
|
|
2903
|
-
* @public
|
|
2904
3031
|
* <p>A list of alerts that are associated with this resource.</p>
|
|
3032
|
+
* @public
|
|
2905
3033
|
*/
|
|
2906
3034
|
Items?: Alert[];
|
|
2907
3035
|
/**
|
|
2908
|
-
* @public
|
|
2909
3036
|
* <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
|
|
3037
|
+
* @public
|
|
2910
3038
|
*/
|
|
2911
3039
|
NextToken?: string;
|
|
2912
3040
|
}
|
|
@@ -2915,18 +3043,18 @@ export interface ListAlertsResponse {
|
|
|
2915
3043
|
*/
|
|
2916
3044
|
export interface ListLiveSourcesRequest {
|
|
2917
3045
|
/**
|
|
2918
|
-
* @public
|
|
2919
3046
|
* <p>The maximum number of live sources that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> live sources, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
|
|
3047
|
+
* @public
|
|
2920
3048
|
*/
|
|
2921
3049
|
MaxResults?: number;
|
|
2922
3050
|
/**
|
|
2923
|
-
* @public
|
|
2924
3051
|
* <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
|
|
3052
|
+
* @public
|
|
2925
3053
|
*/
|
|
2926
3054
|
NextToken?: string;
|
|
2927
3055
|
/**
|
|
2928
|
-
* @public
|
|
2929
3056
|
* <p>The name of the source location associated with this Live Sources list.</p>
|
|
3057
|
+
* @public
|
|
2930
3058
|
*/
|
|
2931
3059
|
SourceLocationName: string | undefined;
|
|
2932
3060
|
}
|
|
@@ -2935,13 +3063,13 @@ export interface ListLiveSourcesRequest {
|
|
|
2935
3063
|
*/
|
|
2936
3064
|
export interface ListLiveSourcesResponse {
|
|
2937
3065
|
/**
|
|
2938
|
-
* @public
|
|
2939
3066
|
* <p>Lists the live sources.</p>
|
|
3067
|
+
* @public
|
|
2940
3068
|
*/
|
|
2941
3069
|
Items?: LiveSource[];
|
|
2942
3070
|
/**
|
|
2943
|
-
* @public
|
|
2944
3071
|
* <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
|
|
3072
|
+
* @public
|
|
2945
3073
|
*/
|
|
2946
3074
|
NextToken?: string;
|
|
2947
3075
|
}
|
|
@@ -2950,13 +3078,13 @@ export interface ListLiveSourcesResponse {
|
|
|
2950
3078
|
*/
|
|
2951
3079
|
export interface ListPlaybackConfigurationsRequest {
|
|
2952
3080
|
/**
|
|
2953
|
-
* @public
|
|
2954
3081
|
* <p>The maximum number of playback configurations that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> playback configurations, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
|
|
3082
|
+
* @public
|
|
2955
3083
|
*/
|
|
2956
3084
|
MaxResults?: number;
|
|
2957
3085
|
/**
|
|
2958
|
-
* @public
|
|
2959
3086
|
* <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
|
|
3087
|
+
* @public
|
|
2960
3088
|
*/
|
|
2961
3089
|
NextToken?: string;
|
|
2962
3090
|
}
|
|
@@ -2965,13 +3093,13 @@ export interface ListPlaybackConfigurationsRequest {
|
|
|
2965
3093
|
*/
|
|
2966
3094
|
export interface ListPlaybackConfigurationsResponse {
|
|
2967
3095
|
/**
|
|
2968
|
-
* @public
|
|
2969
3096
|
* <p>Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored.</p>
|
|
3097
|
+
* @public
|
|
2970
3098
|
*/
|
|
2971
3099
|
Items?: PlaybackConfiguration[];
|
|
2972
3100
|
/**
|
|
2973
|
-
* @public
|
|
2974
3101
|
* <p>Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
|
|
3102
|
+
* @public
|
|
2975
3103
|
*/
|
|
2976
3104
|
NextToken?: string;
|
|
2977
3105
|
}
|
|
@@ -2980,26 +3108,26 @@ export interface ListPlaybackConfigurationsResponse {
|
|
|
2980
3108
|
*/
|
|
2981
3109
|
export interface ListPrefetchSchedulesRequest {
|
|
2982
3110
|
/**
|
|
2983
|
-
* @public
|
|
2984
3111
|
* <p>The maximum number of prefetch schedules that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> prefetch schedules, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
|
|
3112
|
+
* @public
|
|
2985
3113
|
*/
|
|
2986
3114
|
MaxResults?: number;
|
|
2987
3115
|
/**
|
|
2988
|
-
* @public
|
|
2989
3116
|
* <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>
|
|
2990
3117
|
* <p> For the first <code>ListPrefetchSchedulesRequest</code> request, omit this value.</p>
|
|
2991
3118
|
* <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>
|
|
2992
3119
|
* <p> If the previous response didn't include a <code>NextToken</code> element, there are no more prefetch schedules to get.</p>
|
|
3120
|
+
* @public
|
|
2993
3121
|
*/
|
|
2994
3122
|
NextToken?: string;
|
|
2995
3123
|
/**
|
|
2996
|
-
* @public
|
|
2997
3124
|
* <p>Retrieves the prefetch schedule(s) for a specific playback configuration.</p>
|
|
3125
|
+
* @public
|
|
2998
3126
|
*/
|
|
2999
3127
|
PlaybackConfigurationName: string | undefined;
|
|
3000
3128
|
/**
|
|
3001
|
-
* @public
|
|
3002
3129
|
* <p>An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.</p>
|
|
3130
|
+
* @public
|
|
3003
3131
|
*/
|
|
3004
3132
|
StreamId?: string;
|
|
3005
3133
|
}
|
|
@@ -3008,13 +3136,13 @@ export interface ListPrefetchSchedulesRequest {
|
|
|
3008
3136
|
*/
|
|
3009
3137
|
export interface ListPrefetchSchedulesResponse {
|
|
3010
3138
|
/**
|
|
3011
|
-
* @public
|
|
3012
3139
|
* <p>Lists the prefetch schedules. An empty <code>Items</code> list doesn't mean there aren't more items to fetch, just that that page was empty.</p>
|
|
3140
|
+
* @public
|
|
3013
3141
|
*/
|
|
3014
3142
|
Items?: PrefetchSchedule[];
|
|
3015
3143
|
/**
|
|
3016
|
-
* @public
|
|
3017
3144
|
* <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
|
|
3145
|
+
* @public
|
|
3018
3146
|
*/
|
|
3019
3147
|
NextToken?: string;
|
|
3020
3148
|
}
|
|
@@ -3023,13 +3151,13 @@ export interface ListPrefetchSchedulesResponse {
|
|
|
3023
3151
|
*/
|
|
3024
3152
|
export interface ListSourceLocationsRequest {
|
|
3025
3153
|
/**
|
|
3026
|
-
* @public
|
|
3027
3154
|
* <p> The maximum number of source locations that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> source locations, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
|
|
3155
|
+
* @public
|
|
3028
3156
|
*/
|
|
3029
3157
|
MaxResults?: number;
|
|
3030
3158
|
/**
|
|
3031
|
-
* @public
|
|
3032
3159
|
* <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
|
|
3160
|
+
* @public
|
|
3033
3161
|
*/
|
|
3034
3162
|
NextToken?: string;
|
|
3035
3163
|
}
|
|
@@ -3038,13 +3166,13 @@ export interface ListSourceLocationsRequest {
|
|
|
3038
3166
|
*/
|
|
3039
3167
|
export interface ListSourceLocationsResponse {
|
|
3040
3168
|
/**
|
|
3041
|
-
* @public
|
|
3042
3169
|
* <p>A list of source locations.</p>
|
|
3170
|
+
* @public
|
|
3043
3171
|
*/
|
|
3044
3172
|
Items?: SourceLocation[];
|
|
3045
3173
|
/**
|
|
3046
|
-
* @public
|
|
3047
3174
|
* <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
|
|
3175
|
+
* @public
|
|
3048
3176
|
*/
|
|
3049
3177
|
NextToken?: string;
|
|
3050
3178
|
}
|
|
@@ -3053,8 +3181,8 @@ export interface ListSourceLocationsResponse {
|
|
|
3053
3181
|
*/
|
|
3054
3182
|
export interface ListTagsForResourceRequest {
|
|
3055
3183
|
/**
|
|
3056
|
-
* @public
|
|
3057
3184
|
* <p>The Amazon Resource Name (ARN) associated with this resource.</p>
|
|
3185
|
+
* @public
|
|
3058
3186
|
*/
|
|
3059
3187
|
ResourceArn: string | undefined;
|
|
3060
3188
|
}
|
|
@@ -3063,8 +3191,8 @@ export interface ListTagsForResourceRequest {
|
|
|
3063
3191
|
*/
|
|
3064
3192
|
export interface ListTagsForResourceResponse {
|
|
3065
3193
|
/**
|
|
3066
|
-
* @public
|
|
3067
3194
|
* <p>The tags associated with this resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
3195
|
+
* @public
|
|
3068
3196
|
*/
|
|
3069
3197
|
Tags?: Record<string, string>;
|
|
3070
3198
|
}
|
|
@@ -3073,18 +3201,18 @@ export interface ListTagsForResourceResponse {
|
|
|
3073
3201
|
*/
|
|
3074
3202
|
export interface ListVodSourcesRequest {
|
|
3075
3203
|
/**
|
|
3076
|
-
* @public
|
|
3077
3204
|
* <p> The maximum number of VOD sources that you want MediaTailor to return in response to the current request. If there are more than <code>MaxResults</code> VOD sources, use the value of <code>NextToken</code> in the response to get the next page of results.</p>
|
|
3205
|
+
* @public
|
|
3078
3206
|
*/
|
|
3079
3207
|
MaxResults?: number;
|
|
3080
3208
|
/**
|
|
3081
|
-
* @public
|
|
3082
3209
|
* <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
|
|
3210
|
+
* @public
|
|
3083
3211
|
*/
|
|
3084
3212
|
NextToken?: string;
|
|
3085
3213
|
/**
|
|
3086
|
-
* @public
|
|
3087
3214
|
* <p>The name of the source location associated with this VOD Source list.</p>
|
|
3215
|
+
* @public
|
|
3088
3216
|
*/
|
|
3089
3217
|
SourceLocationName: string | undefined;
|
|
3090
3218
|
}
|
|
@@ -3093,13 +3221,13 @@ export interface ListVodSourcesRequest {
|
|
|
3093
3221
|
*/
|
|
3094
3222
|
export interface ListVodSourcesResponse {
|
|
3095
3223
|
/**
|
|
3096
|
-
* @public
|
|
3097
3224
|
* <p>Lists the VOD sources.</p>
|
|
3225
|
+
* @public
|
|
3098
3226
|
*/
|
|
3099
3227
|
Items?: VodSource[];
|
|
3100
3228
|
/**
|
|
3101
|
-
* @public
|
|
3102
3229
|
* <p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>
|
|
3230
|
+
* @public
|
|
3103
3231
|
*/
|
|
3104
3232
|
NextToken?: string;
|
|
3105
3233
|
}
|
|
@@ -3108,18 +3236,18 @@ export interface ListVodSourcesResponse {
|
|
|
3108
3236
|
*/
|
|
3109
3237
|
export interface UpdateLiveSourceRequest {
|
|
3110
3238
|
/**
|
|
3111
|
-
* @public
|
|
3112
3239
|
* <p>A list of HTTP package configurations for the live source on this account.</p>
|
|
3240
|
+
* @public
|
|
3113
3241
|
*/
|
|
3114
3242
|
HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
|
|
3115
3243
|
/**
|
|
3116
|
-
* @public
|
|
3117
3244
|
* <p>The name of the live source.</p>
|
|
3245
|
+
* @public
|
|
3118
3246
|
*/
|
|
3119
3247
|
LiveSourceName: string | undefined;
|
|
3120
3248
|
/**
|
|
3121
|
-
* @public
|
|
3122
3249
|
* <p>The name of the source location associated with this Live Source.</p>
|
|
3250
|
+
* @public
|
|
3123
3251
|
*/
|
|
3124
3252
|
SourceLocationName: string | undefined;
|
|
3125
3253
|
}
|
|
@@ -3128,38 +3256,38 @@ export interface UpdateLiveSourceRequest {
|
|
|
3128
3256
|
*/
|
|
3129
3257
|
export interface UpdateLiveSourceResponse {
|
|
3130
3258
|
/**
|
|
3131
|
-
* @public
|
|
3132
3259
|
* <p>The Amazon Resource Name (ARN) associated with this live source.</p>
|
|
3260
|
+
* @public
|
|
3133
3261
|
*/
|
|
3134
3262
|
Arn?: string;
|
|
3135
3263
|
/**
|
|
3136
|
-
* @public
|
|
3137
3264
|
* <p>The timestamp that indicates when the live source was created.</p>
|
|
3265
|
+
* @public
|
|
3138
3266
|
*/
|
|
3139
3267
|
CreationTime?: Date;
|
|
3140
3268
|
/**
|
|
3141
|
-
* @public
|
|
3142
3269
|
* <p>A list of HTTP package configurations for the live source on this account.</p>
|
|
3270
|
+
* @public
|
|
3143
3271
|
*/
|
|
3144
3272
|
HttpPackageConfigurations?: HttpPackageConfiguration[];
|
|
3145
3273
|
/**
|
|
3146
|
-
* @public
|
|
3147
3274
|
* <p>The timestamp that indicates when the live source was last modified.</p>
|
|
3275
|
+
* @public
|
|
3148
3276
|
*/
|
|
3149
3277
|
LastModifiedTime?: Date;
|
|
3150
3278
|
/**
|
|
3151
|
-
* @public
|
|
3152
3279
|
* <p>The name of the live source.</p>
|
|
3280
|
+
* @public
|
|
3153
3281
|
*/
|
|
3154
3282
|
LiveSourceName?: string;
|
|
3155
3283
|
/**
|
|
3156
|
-
* @public
|
|
3157
3284
|
* <p>The name of the source location associated with the live source.</p>
|
|
3285
|
+
* @public
|
|
3158
3286
|
*/
|
|
3159
3287
|
SourceLocationName?: string;
|
|
3160
3288
|
/**
|
|
3161
|
-
* @public
|
|
3162
3289
|
* <p>The tags to assign to the live source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
3290
|
+
* @public
|
|
3163
3291
|
*/
|
|
3164
3292
|
Tags?: Record<string, string>;
|
|
3165
3293
|
}
|
|
@@ -3168,73 +3296,73 @@ export interface UpdateLiveSourceResponse {
|
|
|
3168
3296
|
*/
|
|
3169
3297
|
export interface PutPlaybackConfigurationRequest {
|
|
3170
3298
|
/**
|
|
3171
|
-
* @public
|
|
3172
3299
|
* <p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.</p>
|
|
3300
|
+
* @public
|
|
3173
3301
|
*/
|
|
3174
3302
|
AdDecisionServerUrl?: string;
|
|
3175
3303
|
/**
|
|
3176
|
-
* @public
|
|
3177
3304
|
* <p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Suppression</a>.</p>
|
|
3305
|
+
* @public
|
|
3178
3306
|
*/
|
|
3179
3307
|
AvailSuppression?: AvailSuppression;
|
|
3180
3308
|
/**
|
|
3181
|
-
* @public
|
|
3182
3309
|
* <p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html">Bumpers</a>.</p>
|
|
3310
|
+
* @public
|
|
3183
3311
|
*/
|
|
3184
3312
|
Bumper?: Bumper;
|
|
3185
3313
|
/**
|
|
3186
|
-
* @public
|
|
3187
3314
|
* <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
|
|
3315
|
+
* @public
|
|
3188
3316
|
*/
|
|
3189
3317
|
CdnConfiguration?: CdnConfiguration;
|
|
3190
3318
|
/**
|
|
3191
|
-
* @public
|
|
3192
3319
|
* <p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html">Domain Variables</a>.</p>
|
|
3320
|
+
* @public
|
|
3193
3321
|
*/
|
|
3194
3322
|
ConfigurationAliases?: Record<string, Record<string, string>>;
|
|
3195
3323
|
/**
|
|
3196
|
-
* @public
|
|
3197
3324
|
* <p>The configuration for DASH content.</p>
|
|
3325
|
+
* @public
|
|
3198
3326
|
*/
|
|
3199
3327
|
DashConfiguration?: DashConfigurationForPut;
|
|
3200
3328
|
/**
|
|
3201
|
-
* @public
|
|
3202
3329
|
* <p>The configuration for pre-roll ad insertion.</p>
|
|
3330
|
+
* @public
|
|
3203
3331
|
*/
|
|
3204
3332
|
LivePreRollConfiguration?: LivePreRollConfiguration;
|
|
3205
3333
|
/**
|
|
3206
|
-
* @public
|
|
3207
3334
|
* <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
|
|
3335
|
+
* @public
|
|
3208
3336
|
*/
|
|
3209
3337
|
ManifestProcessingRules?: ManifestProcessingRules;
|
|
3210
3338
|
/**
|
|
3211
|
-
* @public
|
|
3212
3339
|
* <p>The identifier for the playback configuration.</p>
|
|
3340
|
+
* @public
|
|
3213
3341
|
*/
|
|
3214
3342
|
Name: string | undefined;
|
|
3215
3343
|
/**
|
|
3216
|
-
* @public
|
|
3217
3344
|
* <p>Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to <i>ad replacement</i> in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Behavior in AWS Elemental MediaTailor</a>.</p>
|
|
3345
|
+
* @public
|
|
3218
3346
|
*/
|
|
3219
3347
|
PersonalizationThresholdSeconds?: number;
|
|
3220
3348
|
/**
|
|
3221
|
-
* @public
|
|
3222
3349
|
* <p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.</p>
|
|
3350
|
+
* @public
|
|
3223
3351
|
*/
|
|
3224
3352
|
SlateAdUrl?: string;
|
|
3225
3353
|
/**
|
|
3226
|
-
* @public
|
|
3227
3354
|
* <p>The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
3355
|
+
* @public
|
|
3228
3356
|
*/
|
|
3229
3357
|
Tags?: Record<string, string>;
|
|
3230
3358
|
/**
|
|
3231
|
-
* @public
|
|
3232
3359
|
* <p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>
|
|
3360
|
+
* @public
|
|
3233
3361
|
*/
|
|
3234
3362
|
TranscodeProfileName?: string;
|
|
3235
3363
|
/**
|
|
3236
|
-
* @public
|
|
3237
3364
|
* <p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>
|
|
3365
|
+
* @public
|
|
3238
3366
|
*/
|
|
3239
3367
|
VideoContentSourceUrl?: string;
|
|
3240
3368
|
}
|
|
@@ -3243,98 +3371,98 @@ export interface PutPlaybackConfigurationRequest {
|
|
|
3243
3371
|
*/
|
|
3244
3372
|
export interface PutPlaybackConfigurationResponse {
|
|
3245
3373
|
/**
|
|
3246
|
-
* @public
|
|
3247
3374
|
* <p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.</p>
|
|
3375
|
+
* @public
|
|
3248
3376
|
*/
|
|
3249
3377
|
AdDecisionServerUrl?: string;
|
|
3250
3378
|
/**
|
|
3251
|
-
* @public
|
|
3252
3379
|
* <p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Suppression</a>.</p>
|
|
3380
|
+
* @public
|
|
3253
3381
|
*/
|
|
3254
3382
|
AvailSuppression?: AvailSuppression;
|
|
3255
3383
|
/**
|
|
3256
|
-
* @public
|
|
3257
3384
|
* <p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html">Bumpers</a>.</p>
|
|
3385
|
+
* @public
|
|
3258
3386
|
*/
|
|
3259
3387
|
Bumper?: Bumper;
|
|
3260
3388
|
/**
|
|
3261
|
-
* @public
|
|
3262
3389
|
* <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
|
|
3390
|
+
* @public
|
|
3263
3391
|
*/
|
|
3264
3392
|
CdnConfiguration?: CdnConfiguration;
|
|
3265
3393
|
/**
|
|
3266
|
-
* @public
|
|
3267
3394
|
* <p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html">Domain Variables</a>.</p>
|
|
3395
|
+
* @public
|
|
3268
3396
|
*/
|
|
3269
3397
|
ConfigurationAliases?: Record<string, Record<string, string>>;
|
|
3270
3398
|
/**
|
|
3271
|
-
* @public
|
|
3272
3399
|
* <p>The configuration for DASH content.</p>
|
|
3400
|
+
* @public
|
|
3273
3401
|
*/
|
|
3274
3402
|
DashConfiguration?: DashConfiguration;
|
|
3275
3403
|
/**
|
|
3276
|
-
* @public
|
|
3277
3404
|
* <p>The configuration for HLS content.</p>
|
|
3405
|
+
* @public
|
|
3278
3406
|
*/
|
|
3279
3407
|
HlsConfiguration?: HlsConfiguration;
|
|
3280
3408
|
/**
|
|
3281
|
-
* @public
|
|
3282
3409
|
* <p>The configuration for pre-roll ad insertion.</p>
|
|
3410
|
+
* @public
|
|
3283
3411
|
*/
|
|
3284
3412
|
LivePreRollConfiguration?: LivePreRollConfiguration;
|
|
3285
3413
|
/**
|
|
3286
|
-
* @public
|
|
3287
3414
|
* <p>The Amazon CloudWatch log settings for a playback configuration.</p>
|
|
3415
|
+
* @public
|
|
3288
3416
|
*/
|
|
3289
3417
|
LogConfiguration?: LogConfiguration;
|
|
3290
3418
|
/**
|
|
3291
|
-
* @public
|
|
3292
3419
|
* <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
|
|
3420
|
+
* @public
|
|
3293
3421
|
*/
|
|
3294
3422
|
ManifestProcessingRules?: ManifestProcessingRules;
|
|
3295
3423
|
/**
|
|
3296
|
-
* @public
|
|
3297
3424
|
* <p>The identifier for the playback configuration.</p>
|
|
3425
|
+
* @public
|
|
3298
3426
|
*/
|
|
3299
3427
|
Name?: string;
|
|
3300
3428
|
/**
|
|
3301
|
-
* @public
|
|
3302
3429
|
* <p>Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to <i>ad replacement</i> in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html">Ad Behavior in AWS Elemental MediaTailor</a>.</p>
|
|
3430
|
+
* @public
|
|
3303
3431
|
*/
|
|
3304
3432
|
PersonalizationThresholdSeconds?: number;
|
|
3305
3433
|
/**
|
|
3306
|
-
* @public
|
|
3307
3434
|
* <p>The Amazon Resource Name (ARN) associated with the playback configuration.</p>
|
|
3435
|
+
* @public
|
|
3308
3436
|
*/
|
|
3309
3437
|
PlaybackConfigurationArn?: string;
|
|
3310
3438
|
/**
|
|
3311
|
-
* @public
|
|
3312
3439
|
* <p>The playback endpoint prefix associated with the playback configuration.</p>
|
|
3440
|
+
* @public
|
|
3313
3441
|
*/
|
|
3314
3442
|
PlaybackEndpointPrefix?: string;
|
|
3315
3443
|
/**
|
|
3316
|
-
* @public
|
|
3317
3444
|
* <p>The session initialization endpoint prefix associated with the playback configuration.</p>
|
|
3445
|
+
* @public
|
|
3318
3446
|
*/
|
|
3319
3447
|
SessionInitializationEndpointPrefix?: string;
|
|
3320
3448
|
/**
|
|
3321
|
-
* @public
|
|
3322
3449
|
* <p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.</p>
|
|
3450
|
+
* @public
|
|
3323
3451
|
*/
|
|
3324
3452
|
SlateAdUrl?: string;
|
|
3325
3453
|
/**
|
|
3326
|
-
* @public
|
|
3327
3454
|
* <p>The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
3455
|
+
* @public
|
|
3328
3456
|
*/
|
|
3329
3457
|
Tags?: Record<string, string>;
|
|
3330
3458
|
/**
|
|
3331
|
-
* @public
|
|
3332
3459
|
* <p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>
|
|
3460
|
+
* @public
|
|
3333
3461
|
*/
|
|
3334
3462
|
TranscodeProfileName?: string;
|
|
3335
3463
|
/**
|
|
3336
|
-
* @public
|
|
3337
3464
|
* <p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>
|
|
3465
|
+
* @public
|
|
3338
3466
|
*/
|
|
3339
3467
|
VideoContentSourceUrl?: string;
|
|
3340
3468
|
}
|
|
@@ -3343,28 +3471,28 @@ export interface PutPlaybackConfigurationResponse {
|
|
|
3343
3471
|
*/
|
|
3344
3472
|
export interface UpdateSourceLocationRequest {
|
|
3345
3473
|
/**
|
|
3346
|
-
* @public
|
|
3347
3474
|
* <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
|
|
3475
|
+
* @public
|
|
3348
3476
|
*/
|
|
3349
3477
|
AccessConfiguration?: AccessConfiguration;
|
|
3350
3478
|
/**
|
|
3351
|
-
* @public
|
|
3352
3479
|
* <p>The optional configuration for the host server that serves segments.</p>
|
|
3480
|
+
* @public
|
|
3353
3481
|
*/
|
|
3354
3482
|
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
|
|
3355
3483
|
/**
|
|
3356
|
-
* @public
|
|
3357
3484
|
* <p>The HTTP configuration for the source location.</p>
|
|
3485
|
+
* @public
|
|
3358
3486
|
*/
|
|
3359
3487
|
HttpConfiguration: HttpConfiguration | undefined;
|
|
3360
3488
|
/**
|
|
3361
|
-
* @public
|
|
3362
3489
|
* <p>A list of the segment delivery configurations associated with this resource.</p>
|
|
3490
|
+
* @public
|
|
3363
3491
|
*/
|
|
3364
3492
|
SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
|
|
3365
3493
|
/**
|
|
3366
|
-
* @public
|
|
3367
3494
|
* <p>The name of the source location.</p>
|
|
3495
|
+
* @public
|
|
3368
3496
|
*/
|
|
3369
3497
|
SourceLocationName: string | undefined;
|
|
3370
3498
|
}
|
|
@@ -3373,48 +3501,48 @@ export interface UpdateSourceLocationRequest {
|
|
|
3373
3501
|
*/
|
|
3374
3502
|
export interface UpdateSourceLocationResponse {
|
|
3375
3503
|
/**
|
|
3376
|
-
* @public
|
|
3377
3504
|
* <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
|
|
3505
|
+
* @public
|
|
3378
3506
|
*/
|
|
3379
3507
|
AccessConfiguration?: AccessConfiguration;
|
|
3380
3508
|
/**
|
|
3381
|
-
* @public
|
|
3382
3509
|
* <p>The Amazon Resource Name (ARN) associated with the source location.</p>
|
|
3510
|
+
* @public
|
|
3383
3511
|
*/
|
|
3384
3512
|
Arn?: string;
|
|
3385
3513
|
/**
|
|
3386
|
-
* @public
|
|
3387
3514
|
* <p>The timestamp that indicates when the source location was created.</p>
|
|
3515
|
+
* @public
|
|
3388
3516
|
*/
|
|
3389
3517
|
CreationTime?: Date;
|
|
3390
3518
|
/**
|
|
3391
|
-
* @public
|
|
3392
3519
|
* <p>The optional configuration for the host server that serves segments.</p>
|
|
3520
|
+
* @public
|
|
3393
3521
|
*/
|
|
3394
3522
|
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
|
|
3395
3523
|
/**
|
|
3396
|
-
* @public
|
|
3397
3524
|
* <p>The HTTP configuration for the source location.</p>
|
|
3525
|
+
* @public
|
|
3398
3526
|
*/
|
|
3399
3527
|
HttpConfiguration?: HttpConfiguration;
|
|
3400
3528
|
/**
|
|
3401
|
-
* @public
|
|
3402
3529
|
* <p>The timestamp that indicates when the source location was last modified.</p>
|
|
3530
|
+
* @public
|
|
3403
3531
|
*/
|
|
3404
3532
|
LastModifiedTime?: Date;
|
|
3405
3533
|
/**
|
|
3406
|
-
* @public
|
|
3407
3534
|
* <p>The segment delivery configurations for the source location. For information about MediaTailor configurations, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html">Working with configurations in AWS Elemental MediaTailor</a>.</p>
|
|
3535
|
+
* @public
|
|
3408
3536
|
*/
|
|
3409
3537
|
SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
|
|
3410
3538
|
/**
|
|
3411
|
-
* @public
|
|
3412
3539
|
* <p>The name of the source location.</p>
|
|
3540
|
+
* @public
|
|
3413
3541
|
*/
|
|
3414
3542
|
SourceLocationName?: string;
|
|
3415
3543
|
/**
|
|
3416
|
-
* @public
|
|
3417
3544
|
* <p>The tags to assign to the source location. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
3545
|
+
* @public
|
|
3418
3546
|
*/
|
|
3419
3547
|
Tags?: Record<string, string>;
|
|
3420
3548
|
}
|
|
@@ -3423,13 +3551,13 @@ export interface UpdateSourceLocationResponse {
|
|
|
3423
3551
|
*/
|
|
3424
3552
|
export interface TagResourceRequest {
|
|
3425
3553
|
/**
|
|
3426
|
-
* @public
|
|
3427
3554
|
* <p>The Amazon Resource Name (ARN) associated with the resource.</p>
|
|
3555
|
+
* @public
|
|
3428
3556
|
*/
|
|
3429
3557
|
ResourceArn: string | undefined;
|
|
3430
3558
|
/**
|
|
3431
|
-
* @public
|
|
3432
3559
|
* <p>The tags to assign to the resource. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
3560
|
+
* @public
|
|
3433
3561
|
*/
|
|
3434
3562
|
Tags: Record<string, string> | undefined;
|
|
3435
3563
|
}
|
|
@@ -3438,13 +3566,13 @@ export interface TagResourceRequest {
|
|
|
3438
3566
|
*/
|
|
3439
3567
|
export interface UntagResourceRequest {
|
|
3440
3568
|
/**
|
|
3441
|
-
* @public
|
|
3442
3569
|
* <p>The Amazon Resource Name (ARN) of the resource to untag.</p>
|
|
3570
|
+
* @public
|
|
3443
3571
|
*/
|
|
3444
3572
|
ResourceArn: string | undefined;
|
|
3445
3573
|
/**
|
|
3446
|
-
* @public
|
|
3447
3574
|
* <p>The tag keys associated with the resource.</p>
|
|
3575
|
+
* @public
|
|
3448
3576
|
*/
|
|
3449
3577
|
TagKeys: string[] | undefined;
|
|
3450
3578
|
}
|
|
@@ -3453,18 +3581,18 @@ export interface UntagResourceRequest {
|
|
|
3453
3581
|
*/
|
|
3454
3582
|
export interface UpdateVodSourceRequest {
|
|
3455
3583
|
/**
|
|
3456
|
-
* @public
|
|
3457
3584
|
* <p>A list of HTTP package configurations for the VOD source on this account.</p>
|
|
3585
|
+
* @public
|
|
3458
3586
|
*/
|
|
3459
3587
|
HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
|
|
3460
3588
|
/**
|
|
3461
|
-
* @public
|
|
3462
3589
|
* <p>The name of the source location associated with this VOD Source.</p>
|
|
3590
|
+
* @public
|
|
3463
3591
|
*/
|
|
3464
3592
|
SourceLocationName: string | undefined;
|
|
3465
3593
|
/**
|
|
3466
|
-
* @public
|
|
3467
3594
|
* <p>The name of the VOD source.</p>
|
|
3595
|
+
* @public
|
|
3468
3596
|
*/
|
|
3469
3597
|
VodSourceName: string | undefined;
|
|
3470
3598
|
}
|
|
@@ -3473,38 +3601,38 @@ export interface UpdateVodSourceRequest {
|
|
|
3473
3601
|
*/
|
|
3474
3602
|
export interface UpdateVodSourceResponse {
|
|
3475
3603
|
/**
|
|
3476
|
-
* @public
|
|
3477
3604
|
* <p>The Amazon Resource Name (ARN) associated with the VOD source.</p>
|
|
3605
|
+
* @public
|
|
3478
3606
|
*/
|
|
3479
3607
|
Arn?: string;
|
|
3480
3608
|
/**
|
|
3481
|
-
* @public
|
|
3482
3609
|
* <p>The timestamp that indicates when the VOD source was created.</p>
|
|
3610
|
+
* @public
|
|
3483
3611
|
*/
|
|
3484
3612
|
CreationTime?: Date;
|
|
3485
3613
|
/**
|
|
3486
|
-
* @public
|
|
3487
3614
|
* <p>A list of HTTP package configurations for the VOD source on this account.</p>
|
|
3615
|
+
* @public
|
|
3488
3616
|
*/
|
|
3489
3617
|
HttpPackageConfigurations?: HttpPackageConfiguration[];
|
|
3490
3618
|
/**
|
|
3491
|
-
* @public
|
|
3492
3619
|
* <p>The timestamp that indicates when the VOD source was last modified.</p>
|
|
3620
|
+
* @public
|
|
3493
3621
|
*/
|
|
3494
3622
|
LastModifiedTime?: Date;
|
|
3495
3623
|
/**
|
|
3496
|
-
* @public
|
|
3497
3624
|
* <p>The name of the source location associated with the VOD source.</p>
|
|
3625
|
+
* @public
|
|
3498
3626
|
*/
|
|
3499
3627
|
SourceLocationName?: string;
|
|
3500
3628
|
/**
|
|
3501
|
-
* @public
|
|
3502
3629
|
* <p>The tags to assign to the VOD source. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/tagging.html">Tagging AWS Elemental MediaTailor Resources</a>.</p>
|
|
3630
|
+
* @public
|
|
3503
3631
|
*/
|
|
3504
3632
|
Tags?: Record<string, string>;
|
|
3505
3633
|
/**
|
|
3506
|
-
* @public
|
|
3507
3634
|
* <p>The name of the VOD source.</p>
|
|
3635
|
+
* @public
|
|
3508
3636
|
*/
|
|
3509
3637
|
VodSourceName?: string;
|
|
3510
3638
|
}
|