@aws-sdk/client-mediatailor 3.533.0 → 3.535.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-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 +2 -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 +2 -1
- 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 +2 -1
- package/dist-types/commands/DescribeLiveSourceCommand.d.ts +2 -1
- package/dist-types/commands/DescribeProgramCommand.d.ts +2 -1
- 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 +2 -1
- 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 +2 -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 +2 -1
- package/dist-types/commands/UpdateLiveSourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateProgramCommand.d.ts +2 -1
- 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 +553 -553
- 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/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,38 +184,38 @@ 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
|
}
|
|
@@ -231,21 +231,21 @@ export declare const Operator: {
|
|
|
231
231
|
*/
|
|
232
232
|
export type Operator = (typeof Operator)[keyof typeof Operator];
|
|
233
233
|
/**
|
|
234
|
-
* @public
|
|
235
234
|
* <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
235
|
* <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
236
|
* <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>
|
|
237
|
+
* @public
|
|
238
238
|
*/
|
|
239
239
|
export interface AvailMatchingCriteria {
|
|
240
240
|
/**
|
|
241
|
-
* @public
|
|
242
241
|
* <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
242
|
* <p>You can include up to 100 dynamic variables.</p>
|
|
243
|
+
* @public
|
|
244
244
|
*/
|
|
245
245
|
DynamicVariable: string | undefined;
|
|
246
246
|
/**
|
|
247
|
-
* @public
|
|
248
247
|
* <p>For the <code>DynamicVariable</code> specified in <code>AvailMatchingCriteria</code>, the Operator that is used for the comparison.</p>
|
|
248
|
+
* @public
|
|
249
249
|
*/
|
|
250
250
|
Operator: Operator | undefined;
|
|
251
251
|
}
|
|
@@ -261,39 +261,39 @@ export declare const LogType: {
|
|
|
261
261
|
*/
|
|
262
262
|
export type LogType = (typeof LogType)[keyof typeof LogType];
|
|
263
263
|
/**
|
|
264
|
-
* @public
|
|
265
264
|
* <p>The log configuration for the channel.</p>
|
|
265
|
+
* @public
|
|
266
266
|
*/
|
|
267
267
|
export interface LogConfigurationForChannel {
|
|
268
268
|
/**
|
|
269
|
-
* @public
|
|
270
269
|
* <p>The log types.</p>
|
|
270
|
+
* @public
|
|
271
271
|
*/
|
|
272
272
|
LogTypes?: LogType[];
|
|
273
273
|
}
|
|
274
274
|
/**
|
|
275
|
-
* @public
|
|
276
275
|
* <p>Dash manifest configuration parameters.</p>
|
|
276
|
+
* @public
|
|
277
277
|
*/
|
|
278
278
|
export interface DashPlaylistSettings {
|
|
279
279
|
/**
|
|
280
|
-
* @public
|
|
281
280
|
* <p>The total duration (in seconds) of each manifest. Minimum value: <code>30</code> seconds. Maximum value: <code>3600</code> seconds.</p>
|
|
281
|
+
* @public
|
|
282
282
|
*/
|
|
283
283
|
ManifestWindowSeconds?: number;
|
|
284
284
|
/**
|
|
285
|
-
* @public
|
|
286
285
|
* <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>
|
|
286
|
+
* @public
|
|
287
287
|
*/
|
|
288
288
|
MinBufferTimeSeconds?: number;
|
|
289
289
|
/**
|
|
290
|
-
* @public
|
|
291
290
|
* <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>
|
|
291
|
+
* @public
|
|
292
292
|
*/
|
|
293
293
|
MinUpdatePeriodSeconds?: number;
|
|
294
294
|
/**
|
|
295
|
-
* @public
|
|
296
295
|
* <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>
|
|
296
|
+
* @public
|
|
297
297
|
*/
|
|
298
298
|
SuggestedPresentationDelaySeconds?: number;
|
|
299
299
|
}
|
|
@@ -310,116 +310,116 @@ export declare const AdMarkupType: {
|
|
|
310
310
|
*/
|
|
311
311
|
export type AdMarkupType = (typeof AdMarkupType)[keyof typeof AdMarkupType];
|
|
312
312
|
/**
|
|
313
|
-
* @public
|
|
314
313
|
* <p>HLS playlist configuration parameters.</p>
|
|
314
|
+
* @public
|
|
315
315
|
*/
|
|
316
316
|
export interface HlsPlaylistSettings {
|
|
317
317
|
/**
|
|
318
|
-
* @public
|
|
319
318
|
* <p>The total duration (in seconds) of each manifest. Minimum value: <code>30</code> seconds. Maximum value: <code>3600</code> seconds.</p>
|
|
319
|
+
* @public
|
|
320
320
|
*/
|
|
321
321
|
ManifestWindowSeconds?: number;
|
|
322
322
|
/**
|
|
323
|
-
* @public
|
|
324
323
|
* <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>
|
|
324
|
+
* @public
|
|
325
325
|
*/
|
|
326
326
|
AdMarkupType?: AdMarkupType[];
|
|
327
327
|
}
|
|
328
328
|
/**
|
|
329
|
-
* @public
|
|
330
329
|
* <p>The output item response.</p>
|
|
330
|
+
* @public
|
|
331
331
|
*/
|
|
332
332
|
export interface ResponseOutputItem {
|
|
333
333
|
/**
|
|
334
|
-
* @public
|
|
335
334
|
* <p>DASH manifest configuration settings.</p>
|
|
335
|
+
* @public
|
|
336
336
|
*/
|
|
337
337
|
DashPlaylistSettings?: DashPlaylistSettings;
|
|
338
338
|
/**
|
|
339
|
-
* @public
|
|
340
339
|
* <p>HLS manifest configuration settings.</p>
|
|
340
|
+
* @public
|
|
341
341
|
*/
|
|
342
342
|
HlsPlaylistSettings?: HlsPlaylistSettings;
|
|
343
343
|
/**
|
|
344
|
-
* @public
|
|
345
344
|
* <p>The name of the manifest for the channel that will appear in the channel output's playback URL.</p>
|
|
345
|
+
* @public
|
|
346
346
|
*/
|
|
347
347
|
ManifestName: string | undefined;
|
|
348
348
|
/**
|
|
349
|
-
* @public
|
|
350
349
|
* <p>The URL used for playback by content players.</p>
|
|
350
|
+
* @public
|
|
351
351
|
*/
|
|
352
352
|
PlaybackUrl: string | undefined;
|
|
353
353
|
/**
|
|
354
|
-
* @public
|
|
355
354
|
* <p>A string used to associate a package configuration source group with a channel output.</p>
|
|
355
|
+
* @public
|
|
356
356
|
*/
|
|
357
357
|
SourceGroup: string | undefined;
|
|
358
358
|
}
|
|
359
359
|
/**
|
|
360
|
-
* @public
|
|
361
360
|
* <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>
|
|
361
|
+
* @public
|
|
362
362
|
*/
|
|
363
363
|
export interface Channel {
|
|
364
364
|
/**
|
|
365
|
-
* @public
|
|
366
365
|
* <p>The ARN of the channel.</p>
|
|
366
|
+
* @public
|
|
367
367
|
*/
|
|
368
368
|
Arn: string | undefined;
|
|
369
369
|
/**
|
|
370
|
-
* @public
|
|
371
370
|
* <p>The name of the channel.</p>
|
|
371
|
+
* @public
|
|
372
372
|
*/
|
|
373
373
|
ChannelName: string | undefined;
|
|
374
374
|
/**
|
|
375
|
-
* @public
|
|
376
375
|
* <p>Returns the state whether the channel is running or not.</p>
|
|
376
|
+
* @public
|
|
377
377
|
*/
|
|
378
378
|
ChannelState: string | undefined;
|
|
379
379
|
/**
|
|
380
|
-
* @public
|
|
381
380
|
* <p>The timestamp of when the channel was created.</p>
|
|
381
|
+
* @public
|
|
382
382
|
*/
|
|
383
383
|
CreationTime?: Date;
|
|
384
384
|
/**
|
|
385
|
-
* @public
|
|
386
385
|
* <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
386
|
* <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
|
|
388
387
|
* <code>PlaybackMode</code>.</p>
|
|
388
|
+
* @public
|
|
389
389
|
*/
|
|
390
390
|
FillerSlate?: SlateSource;
|
|
391
391
|
/**
|
|
392
|
-
* @public
|
|
393
392
|
* <p>The timestamp of when the channel was last modified.</p>
|
|
393
|
+
* @public
|
|
394
394
|
*/
|
|
395
395
|
LastModifiedTime?: Date;
|
|
396
396
|
/**
|
|
397
|
-
* @public
|
|
398
397
|
* <p>The channel's output properties.</p>
|
|
398
|
+
* @public
|
|
399
399
|
*/
|
|
400
400
|
Outputs: ResponseOutputItem[] | undefined;
|
|
401
401
|
/**
|
|
402
|
-
* @public
|
|
403
402
|
* <p>The type of playback mode for this channel.</p>
|
|
404
403
|
* <p>
|
|
405
404
|
* <code>LINEAR</code> - Programs play back-to-back only once.</p>
|
|
406
405
|
* <p>
|
|
407
406
|
* <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>
|
|
407
|
+
* @public
|
|
408
408
|
*/
|
|
409
409
|
PlaybackMode: string | undefined;
|
|
410
410
|
/**
|
|
411
|
-
* @public
|
|
412
411
|
* <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>
|
|
412
|
+
* @public
|
|
413
413
|
*/
|
|
414
414
|
Tags?: Record<string, string>;
|
|
415
415
|
/**
|
|
416
|
-
* @public
|
|
417
416
|
* <p>The tier for this channel. STANDARD tier channels can contain live programs.</p>
|
|
417
|
+
* @public
|
|
418
418
|
*/
|
|
419
419
|
Tier: string | undefined;
|
|
420
420
|
/**
|
|
421
|
-
* @public
|
|
422
421
|
* <p>The log configuration.</p>
|
|
422
|
+
* @public
|
|
423
423
|
*/
|
|
424
424
|
LogConfiguration: LogConfigurationForChannel | undefined;
|
|
425
425
|
}
|
|
@@ -436,64 +436,64 @@ export declare const Type: {
|
|
|
436
436
|
*/
|
|
437
437
|
export type Type = (typeof Type)[keyof typeof Type];
|
|
438
438
|
/**
|
|
439
|
-
* @public
|
|
440
439
|
* <p>The HTTP package configuration properties for the requested VOD source.</p>
|
|
440
|
+
* @public
|
|
441
441
|
*/
|
|
442
442
|
export interface HttpPackageConfiguration {
|
|
443
443
|
/**
|
|
444
|
-
* @public
|
|
445
444
|
* <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>
|
|
445
|
+
* @public
|
|
446
446
|
*/
|
|
447
447
|
Path: string | undefined;
|
|
448
448
|
/**
|
|
449
|
-
* @public
|
|
450
449
|
* <p>The name of the source group. This has to match one of the <code>Channel::Outputs::SourceGroup</code>.</p>
|
|
450
|
+
* @public
|
|
451
451
|
*/
|
|
452
452
|
SourceGroup: string | undefined;
|
|
453
453
|
/**
|
|
454
|
-
* @public
|
|
455
454
|
* <p>The streaming protocol for this package configuration. Supported values are <code>HLS</code> and <code>DASH</code>.</p>
|
|
455
|
+
* @public
|
|
456
456
|
*/
|
|
457
457
|
Type: Type | undefined;
|
|
458
458
|
}
|
|
459
459
|
/**
|
|
460
|
-
* @public
|
|
461
460
|
* <p>Live source configuration parameters.</p>
|
|
461
|
+
* @public
|
|
462
462
|
*/
|
|
463
463
|
export interface LiveSource {
|
|
464
464
|
/**
|
|
465
|
-
* @public
|
|
466
465
|
* <p>The ARN for the live source.</p>
|
|
466
|
+
* @public
|
|
467
467
|
*/
|
|
468
468
|
Arn: string | undefined;
|
|
469
469
|
/**
|
|
470
|
-
* @public
|
|
471
470
|
* <p>The timestamp that indicates when the live source was created.</p>
|
|
471
|
+
* @public
|
|
472
472
|
*/
|
|
473
473
|
CreationTime?: Date;
|
|
474
474
|
/**
|
|
475
|
-
* @public
|
|
476
475
|
* <p>The HTTP package configurations for the live source.</p>
|
|
476
|
+
* @public
|
|
477
477
|
*/
|
|
478
478
|
HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
|
|
479
479
|
/**
|
|
480
|
-
* @public
|
|
481
480
|
* <p>The timestamp that indicates when the live source was last modified.</p>
|
|
481
|
+
* @public
|
|
482
482
|
*/
|
|
483
483
|
LastModifiedTime?: Date;
|
|
484
484
|
/**
|
|
485
|
-
* @public
|
|
486
485
|
* <p>The name that's used to refer to a live source.</p>
|
|
486
|
+
* @public
|
|
487
487
|
*/
|
|
488
488
|
LiveSourceName: string | undefined;
|
|
489
489
|
/**
|
|
490
|
-
* @public
|
|
491
490
|
* <p>The name of the source location.</p>
|
|
491
|
+
* @public
|
|
492
492
|
*/
|
|
493
493
|
SourceLocationName: string | undefined;
|
|
494
494
|
/**
|
|
495
|
-
* @public
|
|
496
495
|
* <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>
|
|
496
|
+
* @public
|
|
497
497
|
*/
|
|
498
498
|
Tags?: Record<string, string>;
|
|
499
499
|
}
|
|
@@ -523,55 +523,55 @@ export declare const Mode: {
|
|
|
523
523
|
*/
|
|
524
524
|
export type Mode = (typeof Mode)[keyof typeof Mode];
|
|
525
525
|
/**
|
|
526
|
-
* @public
|
|
527
526
|
* <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>
|
|
527
|
+
* @public
|
|
528
528
|
*/
|
|
529
529
|
export interface AvailSuppression {
|
|
530
530
|
/**
|
|
531
|
-
* @public
|
|
532
531
|
* <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>
|
|
532
|
+
* @public
|
|
533
533
|
*/
|
|
534
534
|
Mode?: Mode;
|
|
535
535
|
/**
|
|
536
|
-
* @public
|
|
537
536
|
* <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>
|
|
537
|
+
* @public
|
|
538
538
|
*/
|
|
539
539
|
Value?: string;
|
|
540
540
|
/**
|
|
541
|
-
* @public
|
|
542
541
|
* <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>
|
|
542
|
+
* @public
|
|
543
543
|
*/
|
|
544
544
|
FillPolicy?: FillPolicy;
|
|
545
545
|
}
|
|
546
546
|
/**
|
|
547
|
-
* @public
|
|
548
547
|
* <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>
|
|
548
|
+
* @public
|
|
549
549
|
*/
|
|
550
550
|
export interface Bumper {
|
|
551
551
|
/**
|
|
552
|
-
* @public
|
|
553
552
|
* <p>The URL for the end bumper asset.</p>
|
|
553
|
+
* @public
|
|
554
554
|
*/
|
|
555
555
|
EndUrl?: string;
|
|
556
556
|
/**
|
|
557
|
-
* @public
|
|
558
557
|
* <p>The URL for the start bumper asset.</p>
|
|
558
|
+
* @public
|
|
559
559
|
*/
|
|
560
560
|
StartUrl?: string;
|
|
561
561
|
}
|
|
562
562
|
/**
|
|
563
|
-
* @public
|
|
564
563
|
* <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
|
|
564
|
+
* @public
|
|
565
565
|
*/
|
|
566
566
|
export interface CdnConfiguration {
|
|
567
567
|
/**
|
|
568
|
-
* @public
|
|
569
568
|
* <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>
|
|
569
|
+
* @public
|
|
570
570
|
*/
|
|
571
571
|
AdSegmentUrlPrefix?: string;
|
|
572
572
|
/**
|
|
573
|
-
* @public
|
|
574
573
|
* <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>
|
|
574
|
+
* @public
|
|
575
575
|
*/
|
|
576
576
|
ContentSegmentUrlPrefix?: string;
|
|
577
577
|
}
|
|
@@ -588,293 +588,293 @@ export declare const OriginManifestType: {
|
|
|
588
588
|
*/
|
|
589
589
|
export type OriginManifestType = (typeof OriginManifestType)[keyof typeof OriginManifestType];
|
|
590
590
|
/**
|
|
591
|
-
* @public
|
|
592
591
|
* <p>The configuration for DASH content.</p>
|
|
592
|
+
* @public
|
|
593
593
|
*/
|
|
594
594
|
export interface DashConfiguration {
|
|
595
595
|
/**
|
|
596
|
-
* @public
|
|
597
596
|
* <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>
|
|
597
|
+
* @public
|
|
598
598
|
*/
|
|
599
599
|
ManifestEndpointPrefix?: string;
|
|
600
600
|
/**
|
|
601
|
-
* @public
|
|
602
601
|
* <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>
|
|
602
|
+
* @public
|
|
603
603
|
*/
|
|
604
604
|
MpdLocation?: string;
|
|
605
605
|
/**
|
|
606
|
-
* @public
|
|
607
606
|
* <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>
|
|
607
|
+
* @public
|
|
608
608
|
*/
|
|
609
609
|
OriginManifestType?: OriginManifestType;
|
|
610
610
|
}
|
|
611
611
|
/**
|
|
612
|
-
* @public
|
|
613
612
|
* <p>The configuration for HLS content.</p>
|
|
613
|
+
* @public
|
|
614
614
|
*/
|
|
615
615
|
export interface HlsConfiguration {
|
|
616
616
|
/**
|
|
617
|
-
* @public
|
|
618
617
|
* <p>The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.</p>
|
|
618
|
+
* @public
|
|
619
619
|
*/
|
|
620
620
|
ManifestEndpointPrefix?: string;
|
|
621
621
|
}
|
|
622
622
|
/**
|
|
623
|
-
* @public
|
|
624
623
|
* <p>The configuration for pre-roll ad insertion.</p>
|
|
624
|
+
* @public
|
|
625
625
|
*/
|
|
626
626
|
export interface LivePreRollConfiguration {
|
|
627
627
|
/**
|
|
628
|
-
* @public
|
|
629
628
|
* <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>
|
|
629
|
+
* @public
|
|
630
630
|
*/
|
|
631
631
|
AdDecisionServerUrl?: string;
|
|
632
632
|
/**
|
|
633
|
-
* @public
|
|
634
633
|
* <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>
|
|
634
|
+
* @public
|
|
635
635
|
*/
|
|
636
636
|
MaxDurationSeconds?: number;
|
|
637
637
|
}
|
|
638
638
|
/**
|
|
639
|
-
* @public
|
|
640
639
|
* <p>Returns Amazon CloudWatch log settings for a playback configuration.</p>
|
|
640
|
+
* @public
|
|
641
641
|
*/
|
|
642
642
|
export interface LogConfiguration {
|
|
643
643
|
/**
|
|
644
|
-
* @public
|
|
645
644
|
* <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
645
|
* <p>Valid values: <code>0</code> - <code>100</code>
|
|
647
646
|
* </p>
|
|
647
|
+
* @public
|
|
648
648
|
*/
|
|
649
649
|
PercentEnabled: number | undefined;
|
|
650
650
|
}
|
|
651
651
|
/**
|
|
652
|
-
* @public
|
|
653
652
|
* <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
653
|
* <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>
|
|
654
|
+
* @public
|
|
655
655
|
*/
|
|
656
656
|
export interface AdMarkerPassthrough {
|
|
657
657
|
/**
|
|
658
|
-
* @public
|
|
659
658
|
* <p>Enables ad marker passthrough for your configuration.</p>
|
|
659
|
+
* @public
|
|
660
660
|
*/
|
|
661
661
|
Enabled?: boolean;
|
|
662
662
|
}
|
|
663
663
|
/**
|
|
664
|
-
* @public
|
|
665
664
|
* <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
|
|
665
|
+
* @public
|
|
666
666
|
*/
|
|
667
667
|
export interface ManifestProcessingRules {
|
|
668
668
|
/**
|
|
669
|
-
* @public
|
|
670
669
|
* <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
670
|
* <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>
|
|
671
|
+
* @public
|
|
672
672
|
*/
|
|
673
673
|
AdMarkerPassthrough?: AdMarkerPassthrough;
|
|
674
674
|
}
|
|
675
675
|
/**
|
|
676
|
-
* @public
|
|
677
676
|
* <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>
|
|
677
|
+
* @public
|
|
678
678
|
*/
|
|
679
679
|
export interface PlaybackConfiguration {
|
|
680
680
|
/**
|
|
681
|
-
* @public
|
|
682
681
|
* <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>
|
|
682
|
+
* @public
|
|
683
683
|
*/
|
|
684
684
|
AdDecisionServerUrl?: string;
|
|
685
685
|
/**
|
|
686
|
-
* @public
|
|
687
686
|
* <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>
|
|
687
|
+
* @public
|
|
688
688
|
*/
|
|
689
689
|
AvailSuppression?: AvailSuppression;
|
|
690
690
|
/**
|
|
691
|
-
* @public
|
|
692
691
|
* <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>
|
|
692
|
+
* @public
|
|
693
693
|
*/
|
|
694
694
|
Bumper?: Bumper;
|
|
695
695
|
/**
|
|
696
|
-
* @public
|
|
697
696
|
* <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
|
|
697
|
+
* @public
|
|
698
698
|
*/
|
|
699
699
|
CdnConfiguration?: CdnConfiguration;
|
|
700
700
|
/**
|
|
701
|
-
* @public
|
|
702
701
|
* <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>
|
|
702
|
+
* @public
|
|
703
703
|
*/
|
|
704
704
|
ConfigurationAliases?: Record<string, Record<string, string>>;
|
|
705
705
|
/**
|
|
706
|
-
* @public
|
|
707
706
|
* <p>The configuration for a DASH source.</p>
|
|
707
|
+
* @public
|
|
708
708
|
*/
|
|
709
709
|
DashConfiguration?: DashConfiguration;
|
|
710
710
|
/**
|
|
711
|
-
* @public
|
|
712
711
|
* <p>The configuration for HLS content.</p>
|
|
712
|
+
* @public
|
|
713
713
|
*/
|
|
714
714
|
HlsConfiguration?: HlsConfiguration;
|
|
715
715
|
/**
|
|
716
|
-
* @public
|
|
717
716
|
* <p>The configuration for pre-roll ad insertion.</p>
|
|
717
|
+
* @public
|
|
718
718
|
*/
|
|
719
719
|
LivePreRollConfiguration?: LivePreRollConfiguration;
|
|
720
720
|
/**
|
|
721
|
-
* @public
|
|
722
721
|
* <p>The Amazon CloudWatch log settings for a playback configuration.</p>
|
|
722
|
+
* @public
|
|
723
723
|
*/
|
|
724
724
|
LogConfiguration?: LogConfiguration;
|
|
725
725
|
/**
|
|
726
|
-
* @public
|
|
727
726
|
* <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
|
|
727
|
+
* @public
|
|
728
728
|
*/
|
|
729
729
|
ManifestProcessingRules?: ManifestProcessingRules;
|
|
730
730
|
/**
|
|
731
|
-
* @public
|
|
732
731
|
* <p>The identifier for the playback configuration.</p>
|
|
732
|
+
* @public
|
|
733
733
|
*/
|
|
734
734
|
Name?: string;
|
|
735
735
|
/**
|
|
736
|
-
* @public
|
|
737
736
|
* <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>
|
|
737
|
+
* @public
|
|
738
738
|
*/
|
|
739
739
|
PersonalizationThresholdSeconds?: number;
|
|
740
740
|
/**
|
|
741
|
-
* @public
|
|
742
741
|
* <p>The Amazon Resource Name (ARN) for the playback configuration.</p>
|
|
742
|
+
* @public
|
|
743
743
|
*/
|
|
744
744
|
PlaybackConfigurationArn?: string;
|
|
745
745
|
/**
|
|
746
|
-
* @public
|
|
747
746
|
* <p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.</p>
|
|
747
|
+
* @public
|
|
748
748
|
*/
|
|
749
749
|
PlaybackEndpointPrefix?: string;
|
|
750
750
|
/**
|
|
751
|
-
* @public
|
|
752
751
|
* <p>The URL that the player uses to initialize a session that uses client-side reporting.</p>
|
|
752
|
+
* @public
|
|
753
753
|
*/
|
|
754
754
|
SessionInitializationEndpointPrefix?: string;
|
|
755
755
|
/**
|
|
756
|
-
* @public
|
|
757
756
|
* <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>
|
|
757
|
+
* @public
|
|
758
758
|
*/
|
|
759
759
|
SlateAdUrl?: string;
|
|
760
760
|
/**
|
|
761
|
-
* @public
|
|
762
761
|
* <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>
|
|
762
|
+
* @public
|
|
763
763
|
*/
|
|
764
764
|
Tags?: Record<string, string>;
|
|
765
765
|
/**
|
|
766
|
-
* @public
|
|
767
766
|
* <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>
|
|
767
|
+
* @public
|
|
768
768
|
*/
|
|
769
769
|
TranscodeProfileName?: string;
|
|
770
770
|
/**
|
|
771
|
-
* @public
|
|
772
771
|
* <p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>
|
|
772
|
+
* @public
|
|
773
773
|
*/
|
|
774
774
|
VideoContentSourceUrl?: string;
|
|
775
775
|
}
|
|
776
776
|
/**
|
|
777
|
-
* @public
|
|
778
777
|
* <p>A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.</p>
|
|
778
|
+
* @public
|
|
779
779
|
*/
|
|
780
780
|
export interface PrefetchConsumption {
|
|
781
781
|
/**
|
|
782
|
-
* @public
|
|
783
782
|
* <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>
|
|
783
|
+
* @public
|
|
784
784
|
*/
|
|
785
785
|
AvailMatchingCriteria?: AvailMatchingCriteria[];
|
|
786
786
|
/**
|
|
787
|
-
* @public
|
|
788
787
|
* <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>
|
|
788
|
+
* @public
|
|
789
789
|
*/
|
|
790
790
|
EndTime: Date | undefined;
|
|
791
791
|
/**
|
|
792
|
-
* @public
|
|
793
792
|
* <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>
|
|
793
|
+
* @public
|
|
794
794
|
*/
|
|
795
795
|
StartTime?: Date;
|
|
796
796
|
}
|
|
797
797
|
/**
|
|
798
|
-
* @public
|
|
799
798
|
* <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>
|
|
799
|
+
* @public
|
|
800
800
|
*/
|
|
801
801
|
export interface PrefetchRetrieval {
|
|
802
802
|
/**
|
|
803
|
-
* @public
|
|
804
803
|
* <p>The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).</p>
|
|
805
804
|
* <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>
|
|
805
|
+
* @public
|
|
806
806
|
*/
|
|
807
807
|
DynamicVariables?: Record<string, string>;
|
|
808
808
|
/**
|
|
809
|
-
* @public
|
|
810
809
|
* <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>
|
|
810
|
+
* @public
|
|
811
811
|
*/
|
|
812
812
|
EndTime: Date | undefined;
|
|
813
813
|
/**
|
|
814
|
-
* @public
|
|
815
814
|
* <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>
|
|
815
|
+
* @public
|
|
816
816
|
*/
|
|
817
817
|
StartTime?: Date;
|
|
818
818
|
}
|
|
819
819
|
/**
|
|
820
|
-
* @public
|
|
821
820
|
* <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>
|
|
821
|
+
* @public
|
|
822
822
|
*/
|
|
823
823
|
export interface PrefetchSchedule {
|
|
824
824
|
/**
|
|
825
|
-
* @public
|
|
826
825
|
* <p>The Amazon Resource Name (ARN) of the prefetch schedule.</p>
|
|
826
|
+
* @public
|
|
827
827
|
*/
|
|
828
828
|
Arn: string | undefined;
|
|
829
829
|
/**
|
|
830
|
-
* @public
|
|
831
830
|
* <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>
|
|
831
|
+
* @public
|
|
832
832
|
*/
|
|
833
833
|
Consumption: PrefetchConsumption | undefined;
|
|
834
834
|
/**
|
|
835
|
-
* @public
|
|
836
835
|
* <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>
|
|
836
|
+
* @public
|
|
837
837
|
*/
|
|
838
838
|
Name: string | undefined;
|
|
839
839
|
/**
|
|
840
|
-
* @public
|
|
841
840
|
* <p>The name of the playback configuration to create the prefetch schedule for.</p>
|
|
841
|
+
* @public
|
|
842
842
|
*/
|
|
843
843
|
PlaybackConfigurationName: string | undefined;
|
|
844
844
|
/**
|
|
845
|
-
* @public
|
|
846
845
|
* <p>A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).</p>
|
|
846
|
+
* @public
|
|
847
847
|
*/
|
|
848
848
|
Retrieval: PrefetchRetrieval | undefined;
|
|
849
849
|
/**
|
|
850
|
-
* @public
|
|
851
850
|
* <p>An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.</p>
|
|
851
|
+
* @public
|
|
852
852
|
*/
|
|
853
853
|
StreamId?: string;
|
|
854
854
|
}
|
|
855
855
|
/**
|
|
856
|
-
* @public
|
|
857
856
|
* <p>The schedule's ad break properties.</p>
|
|
857
|
+
* @public
|
|
858
858
|
*/
|
|
859
859
|
export interface ScheduleAdBreak {
|
|
860
860
|
/**
|
|
861
|
-
* @public
|
|
862
861
|
* <p>The approximate duration of the ad break, in seconds.</p>
|
|
862
|
+
* @public
|
|
863
863
|
*/
|
|
864
864
|
ApproximateDurationSeconds?: number;
|
|
865
865
|
/**
|
|
866
|
-
* @public
|
|
867
866
|
* <p>The approximate time that the ad will start playing.</p>
|
|
867
|
+
* @public
|
|
868
868
|
*/
|
|
869
869
|
ApproximateStartTime?: Date;
|
|
870
870
|
/**
|
|
871
|
-
* @public
|
|
872
871
|
* <p>The name of the source location containing the VOD source used for the ad break.</p>
|
|
872
|
+
* @public
|
|
873
873
|
*/
|
|
874
874
|
SourceLocationName?: string;
|
|
875
875
|
/**
|
|
876
|
-
* @public
|
|
877
876
|
* <p>The name of the VOD source used for the ad break.</p>
|
|
877
|
+
* @public
|
|
878
878
|
*/
|
|
879
879
|
VodSourceName?: string;
|
|
880
880
|
}
|
|
@@ -891,74 +891,74 @@ export declare const ScheduleEntryType: {
|
|
|
891
891
|
*/
|
|
892
892
|
export type ScheduleEntryType = (typeof ScheduleEntryType)[keyof typeof ScheduleEntryType];
|
|
893
893
|
/**
|
|
894
|
-
* @public
|
|
895
894
|
* <p>The properties for a schedule.</p>
|
|
895
|
+
* @public
|
|
896
896
|
*/
|
|
897
897
|
export interface ScheduleEntry {
|
|
898
898
|
/**
|
|
899
|
-
* @public
|
|
900
899
|
* <p>The approximate duration of this program, in seconds.</p>
|
|
900
|
+
* @public
|
|
901
901
|
*/
|
|
902
902
|
ApproximateDurationSeconds?: number;
|
|
903
903
|
/**
|
|
904
|
-
* @public
|
|
905
904
|
* <p>The approximate time that the program will start playing.</p>
|
|
905
|
+
* @public
|
|
906
906
|
*/
|
|
907
907
|
ApproximateStartTime?: Date;
|
|
908
908
|
/**
|
|
909
|
-
* @public
|
|
910
909
|
* <p>The ARN of the program.</p>
|
|
910
|
+
* @public
|
|
911
911
|
*/
|
|
912
912
|
Arn: string | undefined;
|
|
913
913
|
/**
|
|
914
|
-
* @public
|
|
915
914
|
* <p>The name of the channel that uses this schedule.</p>
|
|
915
|
+
* @public
|
|
916
916
|
*/
|
|
917
917
|
ChannelName: string | undefined;
|
|
918
918
|
/**
|
|
919
|
-
* @public
|
|
920
919
|
* <p>The name of the live source used for the program.</p>
|
|
920
|
+
* @public
|
|
921
921
|
*/
|
|
922
922
|
LiveSourceName?: string;
|
|
923
923
|
/**
|
|
924
|
-
* @public
|
|
925
924
|
* <p>The name of the program.</p>
|
|
925
|
+
* @public
|
|
926
926
|
*/
|
|
927
927
|
ProgramName: string | undefined;
|
|
928
928
|
/**
|
|
929
|
-
* @public
|
|
930
929
|
* <p>The schedule's ad break properties.</p>
|
|
930
|
+
* @public
|
|
931
931
|
*/
|
|
932
932
|
ScheduleAdBreaks?: ScheduleAdBreak[];
|
|
933
933
|
/**
|
|
934
|
-
* @public
|
|
935
934
|
* <p>The type of schedule entry.</p>
|
|
935
|
+
* @public
|
|
936
936
|
*/
|
|
937
937
|
ScheduleEntryType?: ScheduleEntryType;
|
|
938
938
|
/**
|
|
939
|
-
* @public
|
|
940
939
|
* <p>The name of the source location.</p>
|
|
940
|
+
* @public
|
|
941
941
|
*/
|
|
942
942
|
SourceLocationName: string | undefined;
|
|
943
943
|
/**
|
|
944
|
-
* @public
|
|
945
944
|
* <p>The name of the VOD source.</p>
|
|
945
|
+
* @public
|
|
946
946
|
*/
|
|
947
947
|
VodSourceName?: string;
|
|
948
948
|
}
|
|
949
949
|
/**
|
|
950
|
-
* @public
|
|
951
950
|
* <p>The segment delivery configuration settings.</p>
|
|
951
|
+
* @public
|
|
952
952
|
*/
|
|
953
953
|
export interface SegmentDeliveryConfiguration {
|
|
954
954
|
/**
|
|
955
|
-
* @public
|
|
956
955
|
* <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>
|
|
956
|
+
* @public
|
|
957
957
|
*/
|
|
958
958
|
BaseUrl?: string;
|
|
959
959
|
/**
|
|
960
|
-
* @public
|
|
961
960
|
* <p>A unique identifier used to distinguish between multiple segment delivery configurations in a source location.</p>
|
|
961
|
+
* @public
|
|
962
962
|
*/
|
|
963
963
|
Name?: string;
|
|
964
964
|
}
|
|
@@ -976,33 +976,32 @@ export declare const AccessType: {
|
|
|
976
976
|
*/
|
|
977
977
|
export type AccessType = (typeof AccessType)[keyof typeof AccessType];
|
|
978
978
|
/**
|
|
979
|
-
* @public
|
|
980
979
|
* <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>
|
|
980
|
+
* @public
|
|
981
981
|
*/
|
|
982
982
|
export interface SecretsManagerAccessTokenConfiguration {
|
|
983
983
|
/**
|
|
984
|
-
* @public
|
|
985
984
|
* <p>The name of the HTTP header used to supply the access token in requests to the source location.</p>
|
|
985
|
+
* @public
|
|
986
986
|
*/
|
|
987
987
|
HeaderName?: string;
|
|
988
988
|
/**
|
|
989
|
-
* @public
|
|
990
989
|
* <p>The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the access token.</p>
|
|
990
|
+
* @public
|
|
991
991
|
*/
|
|
992
992
|
SecretArn?: string;
|
|
993
993
|
/**
|
|
994
|
-
* @public
|
|
995
994
|
* <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>
|
|
995
|
+
* @public
|
|
996
996
|
*/
|
|
997
997
|
SecretStringKey?: string;
|
|
998
998
|
}
|
|
999
999
|
/**
|
|
1000
|
-
* @public
|
|
1001
1000
|
* <p>Access configuration parameters.</p>
|
|
1001
|
+
* @public
|
|
1002
1002
|
*/
|
|
1003
1003
|
export interface AccessConfiguration {
|
|
1004
1004
|
/**
|
|
1005
|
-
* @public
|
|
1006
1005
|
* <p>The type of authentication used to access content from <code>HttpConfiguration::BaseUrl</code> on your source location.</p>
|
|
1007
1006
|
* <p>
|
|
1008
1007
|
* <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 +1019,143 @@ export interface AccessConfiguration {
|
|
|
1020
1019
|
* <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
1020
|
* <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
1021
|
* <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>
|
|
1022
|
+
* @public
|
|
1023
1023
|
*/
|
|
1024
1024
|
AccessType?: AccessType;
|
|
1025
1025
|
/**
|
|
1026
|
-
* @public
|
|
1027
1026
|
* <p>AWS Secrets Manager access token configuration parameters.</p>
|
|
1027
|
+
* @public
|
|
1028
1028
|
*/
|
|
1029
1029
|
SecretsManagerAccessTokenConfiguration?: SecretsManagerAccessTokenConfiguration;
|
|
1030
1030
|
}
|
|
1031
1031
|
/**
|
|
1032
|
-
* @public
|
|
1033
1032
|
* <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>
|
|
1033
|
+
* @public
|
|
1034
1034
|
*/
|
|
1035
1035
|
export interface DefaultSegmentDeliveryConfiguration {
|
|
1036
1036
|
/**
|
|
1037
|
-
* @public
|
|
1038
1037
|
* <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>
|
|
1038
|
+
* @public
|
|
1039
1039
|
*/
|
|
1040
1040
|
BaseUrl?: string;
|
|
1041
1041
|
}
|
|
1042
1042
|
/**
|
|
1043
|
-
* @public
|
|
1044
1043
|
* <p>The HTTP configuration for the source location.</p>
|
|
1044
|
+
* @public
|
|
1045
1045
|
*/
|
|
1046
1046
|
export interface HttpConfiguration {
|
|
1047
1047
|
/**
|
|
1048
|
-
* @public
|
|
1049
1048
|
* <p>The base URL for the source location host server. This string must include the protocol, such as <b>https://</b>.</p>
|
|
1049
|
+
* @public
|
|
1050
1050
|
*/
|
|
1051
1051
|
BaseUrl: string | undefined;
|
|
1052
1052
|
}
|
|
1053
1053
|
/**
|
|
1054
|
-
* @public
|
|
1055
1054
|
* <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>
|
|
1055
|
+
* @public
|
|
1056
1056
|
*/
|
|
1057
1057
|
export interface SourceLocation {
|
|
1058
1058
|
/**
|
|
1059
|
-
* @public
|
|
1060
1059
|
* <p>The access configuration for the source location.</p>
|
|
1060
|
+
* @public
|
|
1061
1061
|
*/
|
|
1062
1062
|
AccessConfiguration?: AccessConfiguration;
|
|
1063
1063
|
/**
|
|
1064
|
-
* @public
|
|
1065
1064
|
* <p>The ARN of the SourceLocation.</p>
|
|
1065
|
+
* @public
|
|
1066
1066
|
*/
|
|
1067
1067
|
Arn: string | undefined;
|
|
1068
1068
|
/**
|
|
1069
|
-
* @public
|
|
1070
1069
|
* <p>The timestamp that indicates when the source location was created.</p>
|
|
1070
|
+
* @public
|
|
1071
1071
|
*/
|
|
1072
1072
|
CreationTime?: Date;
|
|
1073
1073
|
/**
|
|
1074
|
-
* @public
|
|
1075
1074
|
* <p>The default segment delivery configuration.</p>
|
|
1075
|
+
* @public
|
|
1076
1076
|
*/
|
|
1077
1077
|
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
|
|
1078
1078
|
/**
|
|
1079
|
-
* @public
|
|
1080
1079
|
* <p>The HTTP configuration for the source location.</p>
|
|
1080
|
+
* @public
|
|
1081
1081
|
*/
|
|
1082
1082
|
HttpConfiguration: HttpConfiguration | undefined;
|
|
1083
1083
|
/**
|
|
1084
|
-
* @public
|
|
1085
1084
|
* <p>The timestamp that indicates when the source location was last modified.</p>
|
|
1085
|
+
* @public
|
|
1086
1086
|
*/
|
|
1087
1087
|
LastModifiedTime?: Date;
|
|
1088
1088
|
/**
|
|
1089
|
-
* @public
|
|
1090
1089
|
* <p>The segment delivery configurations for the source location.</p>
|
|
1090
|
+
* @public
|
|
1091
1091
|
*/
|
|
1092
1092
|
SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
|
|
1093
1093
|
/**
|
|
1094
|
-
* @public
|
|
1095
1094
|
* <p>The name of the source location.</p>
|
|
1095
|
+
* @public
|
|
1096
1096
|
*/
|
|
1097
1097
|
SourceLocationName: string | undefined;
|
|
1098
1098
|
/**
|
|
1099
|
-
* @public
|
|
1100
1099
|
* <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>
|
|
1100
|
+
* @public
|
|
1101
1101
|
*/
|
|
1102
1102
|
Tags?: Record<string, string>;
|
|
1103
1103
|
}
|
|
1104
1104
|
/**
|
|
1105
|
-
* @public
|
|
1106
1105
|
* <p>VOD source configuration parameters.</p>
|
|
1106
|
+
* @public
|
|
1107
1107
|
*/
|
|
1108
1108
|
export interface VodSource {
|
|
1109
1109
|
/**
|
|
1110
|
-
* @public
|
|
1111
1110
|
* <p>The ARN for the VOD source.</p>
|
|
1111
|
+
* @public
|
|
1112
1112
|
*/
|
|
1113
1113
|
Arn: string | undefined;
|
|
1114
1114
|
/**
|
|
1115
|
-
* @public
|
|
1116
1115
|
* <p>The timestamp that indicates when the VOD source was created.</p>
|
|
1116
|
+
* @public
|
|
1117
1117
|
*/
|
|
1118
1118
|
CreationTime?: Date;
|
|
1119
1119
|
/**
|
|
1120
|
-
* @public
|
|
1121
1120
|
* <p>The HTTP package configurations for the VOD source.</p>
|
|
1121
|
+
* @public
|
|
1122
1122
|
*/
|
|
1123
1123
|
HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
|
|
1124
1124
|
/**
|
|
1125
|
-
* @public
|
|
1126
1125
|
* <p>The timestamp that indicates when the VOD source was last modified.</p>
|
|
1126
|
+
* @public
|
|
1127
1127
|
*/
|
|
1128
1128
|
LastModifiedTime?: Date;
|
|
1129
1129
|
/**
|
|
1130
|
-
* @public
|
|
1131
1130
|
* <p>The name of the source location that the VOD source is associated with.</p>
|
|
1131
|
+
* @public
|
|
1132
1132
|
*/
|
|
1133
1133
|
SourceLocationName: string | undefined;
|
|
1134
1134
|
/**
|
|
1135
|
-
* @public
|
|
1136
1135
|
* <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>
|
|
1136
|
+
* @public
|
|
1137
1137
|
*/
|
|
1138
1138
|
Tags?: Record<string, string>;
|
|
1139
1139
|
/**
|
|
1140
|
-
* @public
|
|
1141
1140
|
* <p>The name of the VOD source.</p>
|
|
1141
|
+
* @public
|
|
1142
1142
|
*/
|
|
1143
1143
|
VodSourceName: string | undefined;
|
|
1144
1144
|
}
|
|
1145
1145
|
/**
|
|
1146
|
-
* @public
|
|
1147
1146
|
* <p>A location at which a zero-duration ad marker was detected in a VOD source manifest.</p>
|
|
1147
|
+
* @public
|
|
1148
1148
|
*/
|
|
1149
1149
|
export interface AdBreakOpportunity {
|
|
1150
1150
|
/**
|
|
1151
|
-
* @public
|
|
1152
1151
|
* <p>The offset in milliseconds from the start of the VOD source at which an ad marker was detected.</p>
|
|
1152
|
+
* @public
|
|
1153
1153
|
*/
|
|
1154
1154
|
OffsetMillis: number | undefined;
|
|
1155
1155
|
}
|
|
1156
1156
|
/**
|
|
1157
|
-
* @public
|
|
1158
1157
|
* <p>A request contains unexpected data.</p>
|
|
1158
|
+
* @public
|
|
1159
1159
|
*/
|
|
1160
1160
|
export declare class BadRequestException extends __BaseException {
|
|
1161
1161
|
readonly name: "BadRequestException";
|
|
@@ -1171,8 +1171,8 @@ export declare class BadRequestException extends __BaseException {
|
|
|
1171
1171
|
*/
|
|
1172
1172
|
export interface DeleteChannelPolicyRequest {
|
|
1173
1173
|
/**
|
|
1174
|
-
* @public
|
|
1175
1174
|
* <p>The name of the channel associated with this channel policy.</p>
|
|
1175
|
+
* @public
|
|
1176
1176
|
*/
|
|
1177
1177
|
ChannelName: string | undefined;
|
|
1178
1178
|
}
|
|
@@ -1186,8 +1186,8 @@ export interface DeleteChannelPolicyResponse {
|
|
|
1186
1186
|
*/
|
|
1187
1187
|
export interface GetChannelPolicyRequest {
|
|
1188
1188
|
/**
|
|
1189
|
-
* @public
|
|
1190
1189
|
* <p>The name of the channel associated with this Channel Policy.</p>
|
|
1190
|
+
* @public
|
|
1191
1191
|
*/
|
|
1192
1192
|
ChannelName: string | undefined;
|
|
1193
1193
|
}
|
|
@@ -1196,8 +1196,8 @@ export interface GetChannelPolicyRequest {
|
|
|
1196
1196
|
*/
|
|
1197
1197
|
export interface GetChannelPolicyResponse {
|
|
1198
1198
|
/**
|
|
1199
|
-
* @public
|
|
1200
1199
|
* <p>The IAM policy for the channel. IAM policies are used to control access to your channel.</p>
|
|
1200
|
+
* @public
|
|
1201
1201
|
*/
|
|
1202
1202
|
Policy?: string;
|
|
1203
1203
|
}
|
|
@@ -1206,13 +1206,13 @@ export interface GetChannelPolicyResponse {
|
|
|
1206
1206
|
*/
|
|
1207
1207
|
export interface PutChannelPolicyRequest {
|
|
1208
1208
|
/**
|
|
1209
|
-
* @public
|
|
1210
1209
|
* <p>The channel name associated with this Channel Policy.</p>
|
|
1210
|
+
* @public
|
|
1211
1211
|
*/
|
|
1212
1212
|
ChannelName: string | undefined;
|
|
1213
1213
|
/**
|
|
1214
|
-
* @public
|
|
1215
1214
|
* <p>Adds an IAM role that determines the permissions of your channel.</p>
|
|
1215
|
+
* @public
|
|
1216
1216
|
*/
|
|
1217
1217
|
Policy: string | undefined;
|
|
1218
1218
|
}
|
|
@@ -1226,13 +1226,13 @@ export interface PutChannelPolicyResponse {
|
|
|
1226
1226
|
*/
|
|
1227
1227
|
export interface ConfigureLogsForChannelRequest {
|
|
1228
1228
|
/**
|
|
1229
|
-
* @public
|
|
1230
1229
|
* <p>The name of the channel.</p>
|
|
1230
|
+
* @public
|
|
1231
1231
|
*/
|
|
1232
1232
|
ChannelName: string | undefined;
|
|
1233
1233
|
/**
|
|
1234
|
-
* @public
|
|
1235
1234
|
* <p>The types of logs to collect.</p>
|
|
1235
|
+
* @public
|
|
1236
1236
|
*/
|
|
1237
1237
|
LogTypes: LogType[] | undefined;
|
|
1238
1238
|
}
|
|
@@ -1241,39 +1241,39 @@ export interface ConfigureLogsForChannelRequest {
|
|
|
1241
1241
|
*/
|
|
1242
1242
|
export interface ConfigureLogsForChannelResponse {
|
|
1243
1243
|
/**
|
|
1244
|
-
* @public
|
|
1245
1244
|
* <p>The name of the channel.</p>
|
|
1245
|
+
* @public
|
|
1246
1246
|
*/
|
|
1247
1247
|
ChannelName?: string;
|
|
1248
1248
|
/**
|
|
1249
|
-
* @public
|
|
1250
1249
|
* <p>The types of logs collected.</p>
|
|
1250
|
+
* @public
|
|
1251
1251
|
*/
|
|
1252
1252
|
LogTypes?: LogType[];
|
|
1253
1253
|
}
|
|
1254
1254
|
/**
|
|
1255
|
-
* @public
|
|
1256
1255
|
* <p>The output configuration for this channel.</p>
|
|
1256
|
+
* @public
|
|
1257
1257
|
*/
|
|
1258
1258
|
export interface RequestOutputItem {
|
|
1259
1259
|
/**
|
|
1260
|
-
* @public
|
|
1261
1260
|
* <p>DASH manifest configuration parameters.</p>
|
|
1261
|
+
* @public
|
|
1262
1262
|
*/
|
|
1263
1263
|
DashPlaylistSettings?: DashPlaylistSettings;
|
|
1264
1264
|
/**
|
|
1265
|
-
* @public
|
|
1266
1265
|
* <p>HLS playlist configuration parameters.</p>
|
|
1266
|
+
* @public
|
|
1267
1267
|
*/
|
|
1268
1268
|
HlsPlaylistSettings?: HlsPlaylistSettings;
|
|
1269
1269
|
/**
|
|
1270
|
-
* @public
|
|
1271
1270
|
* <p>The name of the manifest for the channel. The name appears in the <code>PlaybackUrl</code>.</p>
|
|
1271
|
+
* @public
|
|
1272
1272
|
*/
|
|
1273
1273
|
ManifestName: string | undefined;
|
|
1274
1274
|
/**
|
|
1275
|
-
* @public
|
|
1276
1275
|
* <p>A string used to match which <code>HttpPackageConfiguration</code> is used for each <code>VodSource</code>.</p>
|
|
1276
|
+
* @public
|
|
1277
1277
|
*/
|
|
1278
1278
|
SourceGroup: string | undefined;
|
|
1279
1279
|
}
|
|
@@ -1302,18 +1302,18 @@ export declare const Tier: {
|
|
|
1302
1302
|
*/
|
|
1303
1303
|
export type Tier = (typeof Tier)[keyof typeof Tier];
|
|
1304
1304
|
/**
|
|
1305
|
-
* @public
|
|
1306
1305
|
* <p>
|
|
1307
1306
|
* The configuration for time-shifted viewing.
|
|
1308
1307
|
* </p>
|
|
1308
|
+
* @public
|
|
1309
1309
|
*/
|
|
1310
1310
|
export interface TimeShiftConfiguration {
|
|
1311
1311
|
/**
|
|
1312
|
-
* @public
|
|
1313
1312
|
* <p>
|
|
1314
1313
|
* The maximum time delay for time-shifted viewing. The minimum allowed maximum time delay is 0 seconds,
|
|
1315
1314
|
* and the maximum allowed maximum time delay is 21600 seconds (6 hours).
|
|
1316
1315
|
* </p>
|
|
1316
|
+
* @public
|
|
1317
1317
|
*/
|
|
1318
1318
|
MaxTimeDelaySeconds: number | undefined;
|
|
1319
1319
|
}
|
|
@@ -1322,46 +1322,46 @@ export interface TimeShiftConfiguration {
|
|
|
1322
1322
|
*/
|
|
1323
1323
|
export interface CreateChannelRequest {
|
|
1324
1324
|
/**
|
|
1325
|
-
* @public
|
|
1326
1325
|
* <p>The name of the channel.</p>
|
|
1326
|
+
* @public
|
|
1327
1327
|
*/
|
|
1328
1328
|
ChannelName: string | undefined;
|
|
1329
1329
|
/**
|
|
1330
|
-
* @public
|
|
1331
1330
|
* <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
1331
|
* <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
|
|
1333
1332
|
* <code>PlaybackMode</code>.</p>
|
|
1333
|
+
* @public
|
|
1334
1334
|
*/
|
|
1335
1335
|
FillerSlate?: SlateSource;
|
|
1336
1336
|
/**
|
|
1337
|
-
* @public
|
|
1338
1337
|
* <p>The channel's output properties.</p>
|
|
1338
|
+
* @public
|
|
1339
1339
|
*/
|
|
1340
1340
|
Outputs: RequestOutputItem[] | undefined;
|
|
1341
1341
|
/**
|
|
1342
|
-
* @public
|
|
1343
1342
|
* <p>The type of playback mode to use for this channel.</p>
|
|
1344
1343
|
* <p>
|
|
1345
1344
|
* <code>LINEAR</code> - The programs in the schedule play once back-to-back in the schedule.</p>
|
|
1346
1345
|
* <p>
|
|
1347
1346
|
* <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>
|
|
1347
|
+
* @public
|
|
1348
1348
|
*/
|
|
1349
1349
|
PlaybackMode: PlaybackMode | undefined;
|
|
1350
1350
|
/**
|
|
1351
|
-
* @public
|
|
1352
1351
|
* <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>
|
|
1352
|
+
* @public
|
|
1353
1353
|
*/
|
|
1354
1354
|
Tags?: Record<string, string>;
|
|
1355
1355
|
/**
|
|
1356
|
-
* @public
|
|
1357
1356
|
* <p>The tier of the channel.</p>
|
|
1357
|
+
* @public
|
|
1358
1358
|
*/
|
|
1359
1359
|
Tier?: Tier;
|
|
1360
1360
|
/**
|
|
1361
|
-
* @public
|
|
1362
1361
|
* <p>
|
|
1363
1362
|
* The time-shifted viewing configuration you want to associate to the channel.
|
|
1364
1363
|
* </p>
|
|
1364
|
+
* @public
|
|
1365
1365
|
*/
|
|
1366
1366
|
TimeShiftConfiguration?: TimeShiftConfiguration;
|
|
1367
1367
|
}
|
|
@@ -1382,60 +1382,60 @@ export type ChannelState = (typeof ChannelState)[keyof typeof ChannelState];
|
|
|
1382
1382
|
*/
|
|
1383
1383
|
export interface CreateChannelResponse {
|
|
1384
1384
|
/**
|
|
1385
|
-
* @public
|
|
1386
1385
|
* <p>The Amazon Resource Name (ARN) to assign to the channel.</p>
|
|
1386
|
+
* @public
|
|
1387
1387
|
*/
|
|
1388
1388
|
Arn?: string;
|
|
1389
1389
|
/**
|
|
1390
|
-
* @public
|
|
1391
1390
|
* <p>The name to assign to the channel.</p>
|
|
1391
|
+
* @public
|
|
1392
1392
|
*/
|
|
1393
1393
|
ChannelName?: string;
|
|
1394
1394
|
/**
|
|
1395
|
-
* @public
|
|
1396
1395
|
* <p>Indicates whether the channel is in a running state or not.</p>
|
|
1396
|
+
* @public
|
|
1397
1397
|
*/
|
|
1398
1398
|
ChannelState?: ChannelState;
|
|
1399
1399
|
/**
|
|
1400
|
-
* @public
|
|
1401
1400
|
* <p>The timestamp of when the channel was created.</p>
|
|
1401
|
+
* @public
|
|
1402
1402
|
*/
|
|
1403
1403
|
CreationTime?: Date;
|
|
1404
1404
|
/**
|
|
1405
|
-
* @public
|
|
1406
1405
|
* <p>Contains information about the slate used to fill gaps between programs in the schedule.</p>
|
|
1406
|
+
* @public
|
|
1407
1407
|
*/
|
|
1408
1408
|
FillerSlate?: SlateSource;
|
|
1409
1409
|
/**
|
|
1410
|
-
* @public
|
|
1411
1410
|
* <p>The timestamp of when the channel was last modified.</p>
|
|
1411
|
+
* @public
|
|
1412
1412
|
*/
|
|
1413
1413
|
LastModifiedTime?: Date;
|
|
1414
1414
|
/**
|
|
1415
|
-
* @public
|
|
1416
1415
|
* <p>The output properties to assign to the channel.</p>
|
|
1416
|
+
* @public
|
|
1417
1417
|
*/
|
|
1418
1418
|
Outputs?: ResponseOutputItem[];
|
|
1419
1419
|
/**
|
|
1420
|
-
* @public
|
|
1421
1420
|
* <p>The playback mode to assign to the channel.</p>
|
|
1421
|
+
* @public
|
|
1422
1422
|
*/
|
|
1423
1423
|
PlaybackMode?: string;
|
|
1424
1424
|
/**
|
|
1425
|
-
* @public
|
|
1426
1425
|
* <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>
|
|
1426
|
+
* @public
|
|
1427
1427
|
*/
|
|
1428
1428
|
Tags?: Record<string, string>;
|
|
1429
1429
|
/**
|
|
1430
|
-
* @public
|
|
1431
1430
|
* <p>The tier of the channel.</p>
|
|
1431
|
+
* @public
|
|
1432
1432
|
*/
|
|
1433
1433
|
Tier?: string;
|
|
1434
1434
|
/**
|
|
1435
|
-
* @public
|
|
1436
1435
|
* <p>
|
|
1437
1436
|
* The time-shifted viewing configuration assigned to the channel.
|
|
1438
1437
|
* </p>
|
|
1438
|
+
* @public
|
|
1439
1439
|
*/
|
|
1440
1440
|
TimeShiftConfiguration?: TimeShiftConfiguration;
|
|
1441
1441
|
}
|
|
@@ -1444,8 +1444,8 @@ export interface CreateChannelResponse {
|
|
|
1444
1444
|
*/
|
|
1445
1445
|
export interface DeleteChannelRequest {
|
|
1446
1446
|
/**
|
|
1447
|
-
* @public
|
|
1448
1447
|
* <p>The name of the channel.</p>
|
|
1448
|
+
* @public
|
|
1449
1449
|
*/
|
|
1450
1450
|
ChannelName: string | undefined;
|
|
1451
1451
|
}
|
|
@@ -1459,8 +1459,8 @@ export interface DeleteChannelResponse {
|
|
|
1459
1459
|
*/
|
|
1460
1460
|
export interface DescribeChannelRequest {
|
|
1461
1461
|
/**
|
|
1462
|
-
* @public
|
|
1463
1462
|
* <p>The name of the channel.</p>
|
|
1463
|
+
* @public
|
|
1464
1464
|
*/
|
|
1465
1465
|
ChannelName: string | undefined;
|
|
1466
1466
|
}
|
|
@@ -1469,65 +1469,65 @@ export interface DescribeChannelRequest {
|
|
|
1469
1469
|
*/
|
|
1470
1470
|
export interface DescribeChannelResponse {
|
|
1471
1471
|
/**
|
|
1472
|
-
* @public
|
|
1473
1472
|
* <p>The ARN of the channel.</p>
|
|
1473
|
+
* @public
|
|
1474
1474
|
*/
|
|
1475
1475
|
Arn?: string;
|
|
1476
1476
|
/**
|
|
1477
|
-
* @public
|
|
1478
1477
|
* <p>The name of the channel.</p>
|
|
1478
|
+
* @public
|
|
1479
1479
|
*/
|
|
1480
1480
|
ChannelName?: string;
|
|
1481
1481
|
/**
|
|
1482
|
-
* @public
|
|
1483
1482
|
* <p>Indicates whether the channel is in a running state or not.</p>
|
|
1483
|
+
* @public
|
|
1484
1484
|
*/
|
|
1485
1485
|
ChannelState?: ChannelState;
|
|
1486
1486
|
/**
|
|
1487
|
-
* @public
|
|
1488
1487
|
* <p>The timestamp of when the channel was created.</p>
|
|
1488
|
+
* @public
|
|
1489
1489
|
*/
|
|
1490
1490
|
CreationTime?: Date;
|
|
1491
1491
|
/**
|
|
1492
|
-
* @public
|
|
1493
1492
|
* <p>Contains information about the slate used to fill gaps between programs in the schedule.</p>
|
|
1493
|
+
* @public
|
|
1494
1494
|
*/
|
|
1495
1495
|
FillerSlate?: SlateSource;
|
|
1496
1496
|
/**
|
|
1497
|
-
* @public
|
|
1498
1497
|
* <p>The timestamp of when the channel was last modified.</p>
|
|
1498
|
+
* @public
|
|
1499
1499
|
*/
|
|
1500
1500
|
LastModifiedTime?: Date;
|
|
1501
1501
|
/**
|
|
1502
|
-
* @public
|
|
1503
1502
|
* <p>The channel's output properties.</p>
|
|
1503
|
+
* @public
|
|
1504
1504
|
*/
|
|
1505
1505
|
Outputs?: ResponseOutputItem[];
|
|
1506
1506
|
/**
|
|
1507
|
-
* @public
|
|
1508
1507
|
* <p>The channel's playback mode.</p>
|
|
1508
|
+
* @public
|
|
1509
1509
|
*/
|
|
1510
1510
|
PlaybackMode?: string;
|
|
1511
1511
|
/**
|
|
1512
|
-
* @public
|
|
1513
1512
|
* <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>
|
|
1513
|
+
* @public
|
|
1514
1514
|
*/
|
|
1515
1515
|
Tags?: Record<string, string>;
|
|
1516
1516
|
/**
|
|
1517
|
-
* @public
|
|
1518
1517
|
* <p>The channel's tier.</p>
|
|
1518
|
+
* @public
|
|
1519
1519
|
*/
|
|
1520
1520
|
Tier?: string;
|
|
1521
1521
|
/**
|
|
1522
|
-
* @public
|
|
1523
1522
|
* <p>The log configuration for the channel.</p>
|
|
1523
|
+
* @public
|
|
1524
1524
|
*/
|
|
1525
1525
|
LogConfiguration: LogConfigurationForChannel | undefined;
|
|
1526
1526
|
/**
|
|
1527
|
-
* @public
|
|
1528
1527
|
* <p>
|
|
1529
1528
|
* The time-shifted viewing configuration for the channel.
|
|
1530
1529
|
* </p>
|
|
1530
|
+
* @public
|
|
1531
1531
|
*/
|
|
1532
1532
|
TimeShiftConfiguration?: TimeShiftConfiguration;
|
|
1533
1533
|
}
|
|
@@ -1536,26 +1536,26 @@ export interface DescribeChannelResponse {
|
|
|
1536
1536
|
*/
|
|
1537
1537
|
export interface GetChannelScheduleRequest {
|
|
1538
1538
|
/**
|
|
1539
|
-
* @public
|
|
1540
1539
|
* <p>The name of the channel associated with this Channel Schedule.</p>
|
|
1540
|
+
* @public
|
|
1541
1541
|
*/
|
|
1542
1542
|
ChannelName: string | undefined;
|
|
1543
1543
|
/**
|
|
1544
|
-
* @public
|
|
1545
1544
|
* <p>The duration in minutes of the channel schedule.</p>
|
|
1545
|
+
* @public
|
|
1546
1546
|
*/
|
|
1547
1547
|
DurationMinutes?: string;
|
|
1548
1548
|
/**
|
|
1549
|
-
* @public
|
|
1550
1549
|
* <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>
|
|
1550
|
+
* @public
|
|
1551
1551
|
*/
|
|
1552
1552
|
MaxResults?: number;
|
|
1553
1553
|
/**
|
|
1554
|
-
* @public
|
|
1555
1554
|
* <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
1555
|
* <p>For the first <code>GetChannelScheduleRequest</code> request, omit this value.</p>
|
|
1557
1556
|
* <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
1557
|
* <p>If the previous response didn't include a <code>NextToken</code> element, there are no more channel schedules to get.</p>
|
|
1558
|
+
* @public
|
|
1559
1559
|
*/
|
|
1560
1560
|
NextToken?: string;
|
|
1561
1561
|
}
|
|
@@ -1564,13 +1564,13 @@ export interface GetChannelScheduleRequest {
|
|
|
1564
1564
|
*/
|
|
1565
1565
|
export interface GetChannelScheduleResponse {
|
|
1566
1566
|
/**
|
|
1567
|
-
* @public
|
|
1568
1567
|
* <p>A list of schedule entries for the channel.</p>
|
|
1568
|
+
* @public
|
|
1569
1569
|
*/
|
|
1570
1570
|
Items?: ScheduleEntry[];
|
|
1571
1571
|
/**
|
|
1572
|
-
* @public
|
|
1573
1572
|
* <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>
|
|
1573
|
+
* @public
|
|
1574
1574
|
*/
|
|
1575
1575
|
NextToken?: string;
|
|
1576
1576
|
}
|
|
@@ -1579,13 +1579,13 @@ export interface GetChannelScheduleResponse {
|
|
|
1579
1579
|
*/
|
|
1580
1580
|
export interface ListChannelsRequest {
|
|
1581
1581
|
/**
|
|
1582
|
-
* @public
|
|
1583
1582
|
* <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>
|
|
1583
|
+
* @public
|
|
1584
1584
|
*/
|
|
1585
1585
|
MaxResults?: number;
|
|
1586
1586
|
/**
|
|
1587
|
-
* @public
|
|
1588
1587
|
* <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>
|
|
1588
|
+
* @public
|
|
1589
1589
|
*/
|
|
1590
1590
|
NextToken?: string;
|
|
1591
1591
|
}
|
|
@@ -1594,24 +1594,24 @@ export interface ListChannelsRequest {
|
|
|
1594
1594
|
*/
|
|
1595
1595
|
export interface ListChannelsResponse {
|
|
1596
1596
|
/**
|
|
1597
|
-
* @public
|
|
1598
1597
|
* <p>A list of channels that are associated with this account.</p>
|
|
1598
|
+
* @public
|
|
1599
1599
|
*/
|
|
1600
1600
|
Items?: Channel[];
|
|
1601
1601
|
/**
|
|
1602
|
-
* @public
|
|
1603
1602
|
* <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>
|
|
1603
|
+
* @public
|
|
1604
1604
|
*/
|
|
1605
1605
|
NextToken?: string;
|
|
1606
1606
|
}
|
|
1607
1607
|
/**
|
|
1608
|
-
* @public
|
|
1609
1608
|
* <p>Clip range configuration for the VOD source associated with the program.</p>
|
|
1609
|
+
* @public
|
|
1610
1610
|
*/
|
|
1611
1611
|
export interface ClipRange {
|
|
1612
1612
|
/**
|
|
1613
|
-
* @public
|
|
1614
1613
|
* <p>The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.</p>
|
|
1614
|
+
* @public
|
|
1615
1615
|
*/
|
|
1616
1616
|
EndOffsetMillis: number | undefined;
|
|
1617
1617
|
}
|
|
@@ -1628,32 +1628,31 @@ export declare const RelativePosition: {
|
|
|
1628
1628
|
*/
|
|
1629
1629
|
export type RelativePosition = (typeof RelativePosition)[keyof typeof RelativePosition];
|
|
1630
1630
|
/**
|
|
1631
|
-
* @public
|
|
1632
1631
|
* <p>Program transition configuration.</p>
|
|
1632
|
+
* @public
|
|
1633
1633
|
*/
|
|
1634
1634
|
export interface Transition {
|
|
1635
1635
|
/**
|
|
1636
|
-
* @public
|
|
1637
1636
|
* <p>The duration of the live program in seconds.</p>
|
|
1637
|
+
* @public
|
|
1638
1638
|
*/
|
|
1639
1639
|
DurationMillis?: number;
|
|
1640
1640
|
/**
|
|
1641
|
-
* @public
|
|
1642
1641
|
* <p>The position where this program will be inserted relative to the <code>RelativePosition</code>.</p>
|
|
1642
|
+
* @public
|
|
1643
1643
|
*/
|
|
1644
1644
|
RelativePosition: RelativePosition | undefined;
|
|
1645
1645
|
/**
|
|
1646
|
-
* @public
|
|
1647
1646
|
* <p>The name of the program that this program will be inserted next to, as defined by <code>RelativePosition</code>.</p>
|
|
1647
|
+
* @public
|
|
1648
1648
|
*/
|
|
1649
1649
|
RelativeProgram?: string;
|
|
1650
1650
|
/**
|
|
1651
|
-
* @public
|
|
1652
1651
|
* <p>The date and time that the program is scheduled to start, in epoch milliseconds.</p>
|
|
1652
|
+
* @public
|
|
1653
1653
|
*/
|
|
1654
1654
|
ScheduledStartTimeMillis?: number;
|
|
1655
1655
|
/**
|
|
1656
|
-
* @public
|
|
1657
1656
|
* <p>Defines when the program plays in the schedule. You can set the value to <code>ABSOLUTE</code> or <code>RELATIVE</code>.</p>
|
|
1658
1657
|
* <p>
|
|
1659
1658
|
* <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 +1662,23 @@ export interface Transition {
|
|
|
1663
1662
|
* <p>If there are gaps in playback, MediaTailor plays the <code>FillerSlate</code> you configured for your linear channel.</p>
|
|
1664
1663
|
* <p>
|
|
1665
1664
|
* <code>RELATIVE</code> - The program is inserted into the schedule either before or after a program that you specify via <code>RelativePosition</code>.</p>
|
|
1665
|
+
* @public
|
|
1666
1666
|
*/
|
|
1667
1667
|
Type: string | undefined;
|
|
1668
1668
|
}
|
|
1669
1669
|
/**
|
|
1670
|
-
* @public
|
|
1671
1670
|
* <p>Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.</p>
|
|
1671
|
+
* @public
|
|
1672
1672
|
*/
|
|
1673
1673
|
export interface ScheduleConfiguration {
|
|
1674
1674
|
/**
|
|
1675
|
-
* @public
|
|
1676
1675
|
* <p>Program transition configurations.</p>
|
|
1676
|
+
* @public
|
|
1677
1677
|
*/
|
|
1678
1678
|
Transition: Transition | undefined;
|
|
1679
1679
|
/**
|
|
1680
|
-
* @public
|
|
1681
1680
|
* <p>Program clip range configuration.</p>
|
|
1681
|
+
* @public
|
|
1682
1682
|
*/
|
|
1683
1683
|
ClipRange?: ClipRange;
|
|
1684
1684
|
}
|
|
@@ -1687,38 +1687,38 @@ export interface ScheduleConfiguration {
|
|
|
1687
1687
|
*/
|
|
1688
1688
|
export interface CreateProgramRequest {
|
|
1689
1689
|
/**
|
|
1690
|
-
* @public
|
|
1691
1690
|
* <p>The ad break configuration settings.</p>
|
|
1691
|
+
* @public
|
|
1692
1692
|
*/
|
|
1693
1693
|
AdBreaks?: AdBreak[];
|
|
1694
1694
|
/**
|
|
1695
|
-
* @public
|
|
1696
1695
|
* <p>The name of the channel for this Program.</p>
|
|
1696
|
+
* @public
|
|
1697
1697
|
*/
|
|
1698
1698
|
ChannelName: string | undefined;
|
|
1699
1699
|
/**
|
|
1700
|
-
* @public
|
|
1701
1700
|
* <p>The name of the LiveSource for this Program.</p>
|
|
1701
|
+
* @public
|
|
1702
1702
|
*/
|
|
1703
1703
|
LiveSourceName?: string;
|
|
1704
1704
|
/**
|
|
1705
|
-
* @public
|
|
1706
1705
|
* <p>The name of the Program.</p>
|
|
1706
|
+
* @public
|
|
1707
1707
|
*/
|
|
1708
1708
|
ProgramName: string | undefined;
|
|
1709
1709
|
/**
|
|
1710
|
-
* @public
|
|
1711
1710
|
* <p>The schedule configuration settings.</p>
|
|
1711
|
+
* @public
|
|
1712
1712
|
*/
|
|
1713
1713
|
ScheduleConfiguration: ScheduleConfiguration | undefined;
|
|
1714
1714
|
/**
|
|
1715
|
-
* @public
|
|
1716
1715
|
* <p>The name of the source location.</p>
|
|
1716
|
+
* @public
|
|
1717
1717
|
*/
|
|
1718
1718
|
SourceLocationName: string | undefined;
|
|
1719
1719
|
/**
|
|
1720
|
-
* @public
|
|
1721
1720
|
* <p>The name that's used to refer to a VOD source.</p>
|
|
1721
|
+
* @public
|
|
1722
1722
|
*/
|
|
1723
1723
|
VodSourceName?: string;
|
|
1724
1724
|
}
|
|
@@ -1727,58 +1727,58 @@ export interface CreateProgramRequest {
|
|
|
1727
1727
|
*/
|
|
1728
1728
|
export interface CreateProgramResponse {
|
|
1729
1729
|
/**
|
|
1730
|
-
* @public
|
|
1731
1730
|
* <p>The ad break configuration settings.</p>
|
|
1731
|
+
* @public
|
|
1732
1732
|
*/
|
|
1733
1733
|
AdBreaks?: AdBreak[];
|
|
1734
1734
|
/**
|
|
1735
|
-
* @public
|
|
1736
1735
|
* <p>The ARN to assign to the program.</p>
|
|
1736
|
+
* @public
|
|
1737
1737
|
*/
|
|
1738
1738
|
Arn?: string;
|
|
1739
1739
|
/**
|
|
1740
|
-
* @public
|
|
1741
1740
|
* <p>The name to assign to the channel for this program.</p>
|
|
1741
|
+
* @public
|
|
1742
1742
|
*/
|
|
1743
1743
|
ChannelName?: string;
|
|
1744
1744
|
/**
|
|
1745
|
-
* @public
|
|
1746
1745
|
* <p>The time the program was created.</p>
|
|
1746
|
+
* @public
|
|
1747
1747
|
*/
|
|
1748
1748
|
CreationTime?: Date;
|
|
1749
1749
|
/**
|
|
1750
|
-
* @public
|
|
1751
1750
|
* <p>The name of the LiveSource for this Program.</p>
|
|
1751
|
+
* @public
|
|
1752
1752
|
*/
|
|
1753
1753
|
LiveSourceName?: string;
|
|
1754
1754
|
/**
|
|
1755
|
-
* @public
|
|
1756
1755
|
* <p>The name to assign to this program.</p>
|
|
1756
|
+
* @public
|
|
1757
1757
|
*/
|
|
1758
1758
|
ProgramName?: string;
|
|
1759
1759
|
/**
|
|
1760
|
-
* @public
|
|
1761
1760
|
* <p>The scheduled start time for this Program.</p>
|
|
1761
|
+
* @public
|
|
1762
1762
|
*/
|
|
1763
1763
|
ScheduledStartTime?: Date;
|
|
1764
1764
|
/**
|
|
1765
|
-
* @public
|
|
1766
1765
|
* <p>The name to assign to the source location for this program.</p>
|
|
1766
|
+
* @public
|
|
1767
1767
|
*/
|
|
1768
1768
|
SourceLocationName?: string;
|
|
1769
1769
|
/**
|
|
1770
|
-
* @public
|
|
1771
1770
|
* <p>The name that's used to refer to a VOD source.</p>
|
|
1771
|
+
* @public
|
|
1772
1772
|
*/
|
|
1773
1773
|
VodSourceName?: string;
|
|
1774
1774
|
/**
|
|
1775
|
-
* @public
|
|
1776
1775
|
* <p>The clip range configuration settings.</p>
|
|
1776
|
+
* @public
|
|
1777
1777
|
*/
|
|
1778
1778
|
ClipRange?: ClipRange;
|
|
1779
1779
|
/**
|
|
1780
|
-
* @public
|
|
1781
1780
|
* <p>The duration of the live program in milliseconds.</p>
|
|
1781
|
+
* @public
|
|
1782
1782
|
*/
|
|
1783
1783
|
DurationMillis?: number;
|
|
1784
1784
|
}
|
|
@@ -1787,13 +1787,13 @@ export interface CreateProgramResponse {
|
|
|
1787
1787
|
*/
|
|
1788
1788
|
export interface DeleteProgramRequest {
|
|
1789
1789
|
/**
|
|
1790
|
-
* @public
|
|
1791
1790
|
* <p>The name of the channel.</p>
|
|
1791
|
+
* @public
|
|
1792
1792
|
*/
|
|
1793
1793
|
ChannelName: string | undefined;
|
|
1794
1794
|
/**
|
|
1795
|
-
* @public
|
|
1796
1795
|
* <p>The name of the program.</p>
|
|
1796
|
+
* @public
|
|
1797
1797
|
*/
|
|
1798
1798
|
ProgramName: string | undefined;
|
|
1799
1799
|
}
|
|
@@ -1807,13 +1807,13 @@ export interface DeleteProgramResponse {
|
|
|
1807
1807
|
*/
|
|
1808
1808
|
export interface DescribeProgramRequest {
|
|
1809
1809
|
/**
|
|
1810
|
-
* @public
|
|
1811
1810
|
* <p>The name of the channel associated with this Program.</p>
|
|
1811
|
+
* @public
|
|
1812
1812
|
*/
|
|
1813
1813
|
ChannelName: string | undefined;
|
|
1814
1814
|
/**
|
|
1815
|
-
* @public
|
|
1816
1815
|
* <p>The name of the program.</p>
|
|
1816
|
+
* @public
|
|
1817
1817
|
*/
|
|
1818
1818
|
ProgramName: string | undefined;
|
|
1819
1819
|
}
|
|
@@ -1822,90 +1822,90 @@ export interface DescribeProgramRequest {
|
|
|
1822
1822
|
*/
|
|
1823
1823
|
export interface DescribeProgramResponse {
|
|
1824
1824
|
/**
|
|
1825
|
-
* @public
|
|
1826
1825
|
* <p>The ad break configuration settings.</p>
|
|
1826
|
+
* @public
|
|
1827
1827
|
*/
|
|
1828
1828
|
AdBreaks?: AdBreak[];
|
|
1829
1829
|
/**
|
|
1830
|
-
* @public
|
|
1831
1830
|
* <p>The ARN of the program.</p>
|
|
1831
|
+
* @public
|
|
1832
1832
|
*/
|
|
1833
1833
|
Arn?: string;
|
|
1834
1834
|
/**
|
|
1835
|
-
* @public
|
|
1836
1835
|
* <p>The name of the channel that the program belongs to.</p>
|
|
1836
|
+
* @public
|
|
1837
1837
|
*/
|
|
1838
1838
|
ChannelName?: string;
|
|
1839
1839
|
/**
|
|
1840
|
-
* @public
|
|
1841
1840
|
* <p>The timestamp of when the program was created.</p>
|
|
1841
|
+
* @public
|
|
1842
1842
|
*/
|
|
1843
1843
|
CreationTime?: Date;
|
|
1844
1844
|
/**
|
|
1845
|
-
* @public
|
|
1846
1845
|
* <p>The name of the LiveSource for this Program.</p>
|
|
1846
|
+
* @public
|
|
1847
1847
|
*/
|
|
1848
1848
|
LiveSourceName?: string;
|
|
1849
1849
|
/**
|
|
1850
|
-
* @public
|
|
1851
1850
|
* <p>The name of the program.</p>
|
|
1851
|
+
* @public
|
|
1852
1852
|
*/
|
|
1853
1853
|
ProgramName?: string;
|
|
1854
1854
|
/**
|
|
1855
|
-
* @public
|
|
1856
1855
|
* <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>
|
|
1856
|
+
* @public
|
|
1857
1857
|
*/
|
|
1858
1858
|
ScheduledStartTime?: Date;
|
|
1859
1859
|
/**
|
|
1860
|
-
* @public
|
|
1861
1860
|
* <p>The source location name.</p>
|
|
1861
|
+
* @public
|
|
1862
1862
|
*/
|
|
1863
1863
|
SourceLocationName?: string;
|
|
1864
1864
|
/**
|
|
1865
|
-
* @public
|
|
1866
1865
|
* <p>The name that's used to refer to a VOD source.</p>
|
|
1866
|
+
* @public
|
|
1867
1867
|
*/
|
|
1868
1868
|
VodSourceName?: string;
|
|
1869
1869
|
/**
|
|
1870
|
-
* @public
|
|
1871
1870
|
* <p>The clip range configuration settings.</p>
|
|
1871
|
+
* @public
|
|
1872
1872
|
*/
|
|
1873
1873
|
ClipRange?: ClipRange;
|
|
1874
1874
|
/**
|
|
1875
|
-
* @public
|
|
1876
1875
|
* <p>The duration of the live program in milliseconds.</p>
|
|
1876
|
+
* @public
|
|
1877
1877
|
*/
|
|
1878
1878
|
DurationMillis?: number;
|
|
1879
1879
|
}
|
|
1880
1880
|
/**
|
|
1881
|
-
* @public
|
|
1882
1881
|
* <p>Program transition configuration.</p>
|
|
1882
|
+
* @public
|
|
1883
1883
|
*/
|
|
1884
1884
|
export interface UpdateProgramTransition {
|
|
1885
1885
|
/**
|
|
1886
|
-
* @public
|
|
1887
1886
|
* <p>The date and time that the program is scheduled to start, in epoch milliseconds.</p>
|
|
1887
|
+
* @public
|
|
1888
1888
|
*/
|
|
1889
1889
|
ScheduledStartTimeMillis?: number;
|
|
1890
1890
|
/**
|
|
1891
|
-
* @public
|
|
1892
1891
|
* <p>The duration of the live program in seconds.</p>
|
|
1892
|
+
* @public
|
|
1893
1893
|
*/
|
|
1894
1894
|
DurationMillis?: number;
|
|
1895
1895
|
}
|
|
1896
1896
|
/**
|
|
1897
|
-
* @public
|
|
1898
1897
|
* <p>Schedule configuration parameters.</p>
|
|
1898
|
+
* @public
|
|
1899
1899
|
*/
|
|
1900
1900
|
export interface UpdateProgramScheduleConfiguration {
|
|
1901
1901
|
/**
|
|
1902
|
-
* @public
|
|
1903
1902
|
* <p>Program transition configuration.</p>
|
|
1903
|
+
* @public
|
|
1904
1904
|
*/
|
|
1905
1905
|
Transition?: UpdateProgramTransition;
|
|
1906
1906
|
/**
|
|
1907
|
-
* @public
|
|
1908
1907
|
* <p>Program clip range configuration.</p>
|
|
1908
|
+
* @public
|
|
1909
1909
|
*/
|
|
1910
1910
|
ClipRange?: ClipRange;
|
|
1911
1911
|
}
|
|
@@ -1914,23 +1914,23 @@ export interface UpdateProgramScheduleConfiguration {
|
|
|
1914
1914
|
*/
|
|
1915
1915
|
export interface UpdateProgramRequest {
|
|
1916
1916
|
/**
|
|
1917
|
-
* @public
|
|
1918
1917
|
* <p>The ad break configuration settings.</p>
|
|
1918
|
+
* @public
|
|
1919
1919
|
*/
|
|
1920
1920
|
AdBreaks?: AdBreak[];
|
|
1921
1921
|
/**
|
|
1922
|
-
* @public
|
|
1923
1922
|
* <p>The name of the channel for this Program.</p>
|
|
1923
|
+
* @public
|
|
1924
1924
|
*/
|
|
1925
1925
|
ChannelName: string | undefined;
|
|
1926
1926
|
/**
|
|
1927
|
-
* @public
|
|
1928
1927
|
* <p>The name of the Program.</p>
|
|
1928
|
+
* @public
|
|
1929
1929
|
*/
|
|
1930
1930
|
ProgramName: string | undefined;
|
|
1931
1931
|
/**
|
|
1932
|
-
* @public
|
|
1933
1932
|
* <p>The schedule configuration settings.</p>
|
|
1933
|
+
* @public
|
|
1934
1934
|
*/
|
|
1935
1935
|
ScheduleConfiguration: UpdateProgramScheduleConfiguration | undefined;
|
|
1936
1936
|
}
|
|
@@ -1939,58 +1939,58 @@ export interface UpdateProgramRequest {
|
|
|
1939
1939
|
*/
|
|
1940
1940
|
export interface UpdateProgramResponse {
|
|
1941
1941
|
/**
|
|
1942
|
-
* @public
|
|
1943
1942
|
* <p>The ad break configuration settings.</p>
|
|
1943
|
+
* @public
|
|
1944
1944
|
*/
|
|
1945
1945
|
AdBreaks?: AdBreak[];
|
|
1946
1946
|
/**
|
|
1947
|
-
* @public
|
|
1948
1947
|
* <p>The ARN to assign to the program.</p>
|
|
1948
|
+
* @public
|
|
1949
1949
|
*/
|
|
1950
1950
|
Arn?: string;
|
|
1951
1951
|
/**
|
|
1952
|
-
* @public
|
|
1953
1952
|
* <p>The name to assign to the channel for this program.</p>
|
|
1953
|
+
* @public
|
|
1954
1954
|
*/
|
|
1955
1955
|
ChannelName?: string;
|
|
1956
1956
|
/**
|
|
1957
|
-
* @public
|
|
1958
1957
|
* <p>The time the program was created.</p>
|
|
1958
|
+
* @public
|
|
1959
1959
|
*/
|
|
1960
1960
|
CreationTime?: Date;
|
|
1961
1961
|
/**
|
|
1962
|
-
* @public
|
|
1963
1962
|
* <p>The name to assign to this program.</p>
|
|
1963
|
+
* @public
|
|
1964
1964
|
*/
|
|
1965
1965
|
ProgramName?: string;
|
|
1966
1966
|
/**
|
|
1967
|
-
* @public
|
|
1968
1967
|
* <p>The name to assign to the source location for this program.</p>
|
|
1968
|
+
* @public
|
|
1969
1969
|
*/
|
|
1970
1970
|
SourceLocationName?: string;
|
|
1971
1971
|
/**
|
|
1972
|
-
* @public
|
|
1973
1972
|
* <p>The name that's used to refer to a VOD source.</p>
|
|
1973
|
+
* @public
|
|
1974
1974
|
*/
|
|
1975
1975
|
VodSourceName?: string;
|
|
1976
1976
|
/**
|
|
1977
|
-
* @public
|
|
1978
1977
|
* <p>The name of the LiveSource for this Program.</p>
|
|
1978
|
+
* @public
|
|
1979
1979
|
*/
|
|
1980
1980
|
LiveSourceName?: string;
|
|
1981
1981
|
/**
|
|
1982
|
-
* @public
|
|
1983
1982
|
* <p>The clip range configuration settings.</p>
|
|
1983
|
+
* @public
|
|
1984
1984
|
*/
|
|
1985
1985
|
ClipRange?: ClipRange;
|
|
1986
1986
|
/**
|
|
1987
|
-
* @public
|
|
1988
1987
|
* <p>The duration of the live program in milliseconds.</p>
|
|
1988
|
+
* @public
|
|
1989
1989
|
*/
|
|
1990
1990
|
DurationMillis?: number;
|
|
1991
1991
|
/**
|
|
1992
|
-
* @public
|
|
1993
1992
|
* <p>The scheduled start time for this Program.</p>
|
|
1993
|
+
* @public
|
|
1994
1994
|
*/
|
|
1995
1995
|
ScheduledStartTime?: Date;
|
|
1996
1996
|
}
|
|
@@ -1999,8 +1999,8 @@ export interface UpdateProgramResponse {
|
|
|
1999
1999
|
*/
|
|
2000
2000
|
export interface StartChannelRequest {
|
|
2001
2001
|
/**
|
|
2002
|
-
* @public
|
|
2003
2002
|
* <p>The name of the channel.</p>
|
|
2003
|
+
* @public
|
|
2004
2004
|
*/
|
|
2005
2005
|
ChannelName: string | undefined;
|
|
2006
2006
|
}
|
|
@@ -2014,8 +2014,8 @@ export interface StartChannelResponse {
|
|
|
2014
2014
|
*/
|
|
2015
2015
|
export interface StopChannelRequest {
|
|
2016
2016
|
/**
|
|
2017
|
-
* @public
|
|
2018
2017
|
* <p>The name of the channel.</p>
|
|
2018
|
+
* @public
|
|
2019
2019
|
*/
|
|
2020
2020
|
ChannelName: string | undefined;
|
|
2021
2021
|
}
|
|
@@ -2029,27 +2029,27 @@ export interface StopChannelResponse {
|
|
|
2029
2029
|
*/
|
|
2030
2030
|
export interface UpdateChannelRequest {
|
|
2031
2031
|
/**
|
|
2032
|
-
* @public
|
|
2033
2032
|
* <p>The name of the channel.</p>
|
|
2033
|
+
* @public
|
|
2034
2034
|
*/
|
|
2035
2035
|
ChannelName: string | undefined;
|
|
2036
2036
|
/**
|
|
2037
|
-
* @public
|
|
2038
2037
|
* <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
2038
|
* <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
|
|
2040
2039
|
* <code>PlaybackMode</code>.</p>
|
|
2040
|
+
* @public
|
|
2041
2041
|
*/
|
|
2042
2042
|
FillerSlate?: SlateSource;
|
|
2043
2043
|
/**
|
|
2044
|
-
* @public
|
|
2045
2044
|
* <p>The channel's output properties.</p>
|
|
2045
|
+
* @public
|
|
2046
2046
|
*/
|
|
2047
2047
|
Outputs: RequestOutputItem[] | undefined;
|
|
2048
2048
|
/**
|
|
2049
|
-
* @public
|
|
2050
2049
|
* <p>
|
|
2051
2050
|
* The time-shifted viewing configuration you want to associate to the channel.
|
|
2052
2051
|
* </p>
|
|
2052
|
+
* @public
|
|
2053
2053
|
*/
|
|
2054
2054
|
TimeShiftConfiguration?: TimeShiftConfiguration;
|
|
2055
2055
|
}
|
|
@@ -2058,84 +2058,84 @@ export interface UpdateChannelRequest {
|
|
|
2058
2058
|
*/
|
|
2059
2059
|
export interface UpdateChannelResponse {
|
|
2060
2060
|
/**
|
|
2061
|
-
* @public
|
|
2062
2061
|
* <p>The Amazon Resource Name (ARN) associated with the channel.</p>
|
|
2062
|
+
* @public
|
|
2063
2063
|
*/
|
|
2064
2064
|
Arn?: string;
|
|
2065
2065
|
/**
|
|
2066
|
-
* @public
|
|
2067
2066
|
* <p>The name of the channel.</p>
|
|
2067
|
+
* @public
|
|
2068
2068
|
*/
|
|
2069
2069
|
ChannelName?: string;
|
|
2070
2070
|
/**
|
|
2071
|
-
* @public
|
|
2072
2071
|
* <p>Returns the state whether the channel is running or not.</p>
|
|
2072
|
+
* @public
|
|
2073
2073
|
*/
|
|
2074
2074
|
ChannelState?: ChannelState;
|
|
2075
2075
|
/**
|
|
2076
|
-
* @public
|
|
2077
2076
|
* <p>The timestamp of when the channel was created.</p>
|
|
2077
|
+
* @public
|
|
2078
2078
|
*/
|
|
2079
2079
|
CreationTime?: Date;
|
|
2080
2080
|
/**
|
|
2081
|
-
* @public
|
|
2082
2081
|
* <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
2082
|
* <code>PlaybackMode</code>. MediaTailor doesn't support filler slate for channels using the <code>LOOP</code>
|
|
2084
2083
|
* <code>PlaybackMode</code>.</p>
|
|
2084
|
+
* @public
|
|
2085
2085
|
*/
|
|
2086
2086
|
FillerSlate?: SlateSource;
|
|
2087
2087
|
/**
|
|
2088
|
-
* @public
|
|
2089
2088
|
* <p>The timestamp that indicates when the channel was last modified.</p>
|
|
2089
|
+
* @public
|
|
2090
2090
|
*/
|
|
2091
2091
|
LastModifiedTime?: Date;
|
|
2092
2092
|
/**
|
|
2093
|
-
* @public
|
|
2094
2093
|
* <p>The channel's output properties.</p>
|
|
2094
|
+
* @public
|
|
2095
2095
|
*/
|
|
2096
2096
|
Outputs?: ResponseOutputItem[];
|
|
2097
2097
|
/**
|
|
2098
|
-
* @public
|
|
2099
2098
|
* <p>The type of playback mode for this channel.</p>
|
|
2100
2099
|
* <p>
|
|
2101
2100
|
* <code>LINEAR</code> - Programs play back-to-back only once.</p>
|
|
2102
2101
|
* <p>
|
|
2103
2102
|
* <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>
|
|
2103
|
+
* @public
|
|
2104
2104
|
*/
|
|
2105
2105
|
PlaybackMode?: string;
|
|
2106
2106
|
/**
|
|
2107
|
-
* @public
|
|
2108
2107
|
* <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>
|
|
2108
|
+
* @public
|
|
2109
2109
|
*/
|
|
2110
2110
|
Tags?: Record<string, string>;
|
|
2111
2111
|
/**
|
|
2112
|
-
* @public
|
|
2113
2112
|
* <p>The tier associated with this Channel.</p>
|
|
2113
|
+
* @public
|
|
2114
2114
|
*/
|
|
2115
2115
|
Tier?: string;
|
|
2116
2116
|
/**
|
|
2117
|
-
* @public
|
|
2118
2117
|
* <p>
|
|
2119
2118
|
* The time-shifted viewing configuration for the channel.
|
|
2120
2119
|
* </p>
|
|
2120
|
+
* @public
|
|
2121
2121
|
*/
|
|
2122
2122
|
TimeShiftConfiguration?: TimeShiftConfiguration;
|
|
2123
2123
|
}
|
|
2124
2124
|
/**
|
|
2125
|
-
* @public
|
|
2126
2125
|
* <p>Configures Amazon CloudWatch log settings for a playback configuration.</p>
|
|
2126
|
+
* @public
|
|
2127
2127
|
*/
|
|
2128
2128
|
export interface ConfigureLogsForPlaybackConfigurationRequest {
|
|
2129
2129
|
/**
|
|
2130
|
-
* @public
|
|
2131
2130
|
* <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
2131
|
* <p>Valid values: <code>0</code> - <code>100</code>
|
|
2133
2132
|
* </p>
|
|
2133
|
+
* @public
|
|
2134
2134
|
*/
|
|
2135
2135
|
PercentEnabled: number | undefined;
|
|
2136
2136
|
/**
|
|
2137
|
-
* @public
|
|
2138
2137
|
* <p>The name of the playback configuration.</p>
|
|
2138
|
+
* @public
|
|
2139
2139
|
*/
|
|
2140
2140
|
PlaybackConfigurationName: string | undefined;
|
|
2141
2141
|
}
|
|
@@ -2144,13 +2144,13 @@ export interface ConfigureLogsForPlaybackConfigurationRequest {
|
|
|
2144
2144
|
*/
|
|
2145
2145
|
export interface ConfigureLogsForPlaybackConfigurationResponse {
|
|
2146
2146
|
/**
|
|
2147
|
-
* @public
|
|
2148
2147
|
* <p>The percentage of session logs that MediaTailor sends to your Cloudwatch Logs account.</p>
|
|
2148
|
+
* @public
|
|
2149
2149
|
*/
|
|
2150
2150
|
PercentEnabled: number | undefined;
|
|
2151
2151
|
/**
|
|
2152
|
-
* @public
|
|
2153
2152
|
* <p>The name of the playback configuration.</p>
|
|
2153
|
+
* @public
|
|
2154
2154
|
*/
|
|
2155
2155
|
PlaybackConfigurationName?: string;
|
|
2156
2156
|
}
|
|
@@ -2159,23 +2159,23 @@ export interface ConfigureLogsForPlaybackConfigurationResponse {
|
|
|
2159
2159
|
*/
|
|
2160
2160
|
export interface CreateLiveSourceRequest {
|
|
2161
2161
|
/**
|
|
2162
|
-
* @public
|
|
2163
2162
|
* <p>A list of HTTP package configuration parameters for this live source.</p>
|
|
2163
|
+
* @public
|
|
2164
2164
|
*/
|
|
2165
2165
|
HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
|
|
2166
2166
|
/**
|
|
2167
|
-
* @public
|
|
2168
2167
|
* <p>The name of the live source.</p>
|
|
2168
|
+
* @public
|
|
2169
2169
|
*/
|
|
2170
2170
|
LiveSourceName: string | undefined;
|
|
2171
2171
|
/**
|
|
2172
|
-
* @public
|
|
2173
2172
|
* <p>The name of the source location.</p>
|
|
2173
|
+
* @public
|
|
2174
2174
|
*/
|
|
2175
2175
|
SourceLocationName: string | undefined;
|
|
2176
2176
|
/**
|
|
2177
|
-
* @public
|
|
2178
2177
|
* <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>
|
|
2178
|
+
* @public
|
|
2179
2179
|
*/
|
|
2180
2180
|
Tags?: Record<string, string>;
|
|
2181
2181
|
}
|
|
@@ -2184,38 +2184,38 @@ export interface CreateLiveSourceRequest {
|
|
|
2184
2184
|
*/
|
|
2185
2185
|
export interface CreateLiveSourceResponse {
|
|
2186
2186
|
/**
|
|
2187
|
-
* @public
|
|
2188
2187
|
* <p>The ARN to assign to the live source.</p>
|
|
2188
|
+
* @public
|
|
2189
2189
|
*/
|
|
2190
2190
|
Arn?: string;
|
|
2191
2191
|
/**
|
|
2192
|
-
* @public
|
|
2193
2192
|
* <p>The time the live source was created.</p>
|
|
2193
|
+
* @public
|
|
2194
2194
|
*/
|
|
2195
2195
|
CreationTime?: Date;
|
|
2196
2196
|
/**
|
|
2197
|
-
* @public
|
|
2198
2197
|
* <p>A list of HTTP package configuration parameters for this live source.</p>
|
|
2198
|
+
* @public
|
|
2199
2199
|
*/
|
|
2200
2200
|
HttpPackageConfigurations?: HttpPackageConfiguration[];
|
|
2201
2201
|
/**
|
|
2202
|
-
* @public
|
|
2203
2202
|
* <p>The time the live source was last modified.</p>
|
|
2203
|
+
* @public
|
|
2204
2204
|
*/
|
|
2205
2205
|
LastModifiedTime?: Date;
|
|
2206
2206
|
/**
|
|
2207
|
-
* @public
|
|
2208
2207
|
* <p>The name to assign to the live source.</p>
|
|
2208
|
+
* @public
|
|
2209
2209
|
*/
|
|
2210
2210
|
LiveSourceName?: string;
|
|
2211
2211
|
/**
|
|
2212
|
-
* @public
|
|
2213
2212
|
* <p>The name to assign to the source location of the live source.</p>
|
|
2213
|
+
* @public
|
|
2214
2214
|
*/
|
|
2215
2215
|
SourceLocationName?: string;
|
|
2216
2216
|
/**
|
|
2217
|
-
* @public
|
|
2218
2217
|
* <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>
|
|
2218
|
+
* @public
|
|
2219
2219
|
*/
|
|
2220
2220
|
Tags?: Record<string, string>;
|
|
2221
2221
|
}
|
|
@@ -2224,28 +2224,28 @@ export interface CreateLiveSourceResponse {
|
|
|
2224
2224
|
*/
|
|
2225
2225
|
export interface CreatePrefetchScheduleRequest {
|
|
2226
2226
|
/**
|
|
2227
|
-
* @public
|
|
2228
2227
|
* <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>
|
|
2228
|
+
* @public
|
|
2229
2229
|
*/
|
|
2230
2230
|
Consumption: PrefetchConsumption | undefined;
|
|
2231
2231
|
/**
|
|
2232
|
-
* @public
|
|
2233
2232
|
* <p>The name to assign to the schedule request.</p>
|
|
2233
|
+
* @public
|
|
2234
2234
|
*/
|
|
2235
2235
|
Name: string | undefined;
|
|
2236
2236
|
/**
|
|
2237
|
-
* @public
|
|
2238
2237
|
* <p>The name to assign to the playback configuration.</p>
|
|
2238
|
+
* @public
|
|
2239
2239
|
*/
|
|
2240
2240
|
PlaybackConfigurationName: string | undefined;
|
|
2241
2241
|
/**
|
|
2242
|
-
* @public
|
|
2243
2242
|
* <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>
|
|
2243
|
+
* @public
|
|
2244
2244
|
*/
|
|
2245
2245
|
Retrieval: PrefetchRetrieval | undefined;
|
|
2246
2246
|
/**
|
|
2247
|
-
* @public
|
|
2248
2247
|
* <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>
|
|
2248
|
+
* @public
|
|
2249
2249
|
*/
|
|
2250
2250
|
StreamId?: string;
|
|
2251
2251
|
}
|
|
@@ -2254,33 +2254,33 @@ export interface CreatePrefetchScheduleRequest {
|
|
|
2254
2254
|
*/
|
|
2255
2255
|
export interface CreatePrefetchScheduleResponse {
|
|
2256
2256
|
/**
|
|
2257
|
-
* @public
|
|
2258
2257
|
* <p>The ARN to assign to the prefetch schedule.</p>
|
|
2258
|
+
* @public
|
|
2259
2259
|
*/
|
|
2260
2260
|
Arn?: string;
|
|
2261
2261
|
/**
|
|
2262
|
-
* @public
|
|
2263
2262
|
* <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>
|
|
2263
|
+
* @public
|
|
2264
2264
|
*/
|
|
2265
2265
|
Consumption?: PrefetchConsumption;
|
|
2266
2266
|
/**
|
|
2267
|
-
* @public
|
|
2268
2267
|
* <p>The name to assign to the prefetch schedule.</p>
|
|
2268
|
+
* @public
|
|
2269
2269
|
*/
|
|
2270
2270
|
Name?: string;
|
|
2271
2271
|
/**
|
|
2272
|
-
* @public
|
|
2273
2272
|
* <p>The name to assign to the playback configuration.</p>
|
|
2273
|
+
* @public
|
|
2274
2274
|
*/
|
|
2275
2275
|
PlaybackConfigurationName?: string;
|
|
2276
2276
|
/**
|
|
2277
|
-
* @public
|
|
2278
2277
|
* <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>
|
|
2278
|
+
* @public
|
|
2279
2279
|
*/
|
|
2280
2280
|
Retrieval?: PrefetchRetrieval;
|
|
2281
2281
|
/**
|
|
2282
|
-
* @public
|
|
2283
2282
|
* <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>
|
|
2283
|
+
* @public
|
|
2284
2284
|
*/
|
|
2285
2285
|
StreamId?: string;
|
|
2286
2286
|
}
|
|
@@ -2289,33 +2289,33 @@ export interface CreatePrefetchScheduleResponse {
|
|
|
2289
2289
|
*/
|
|
2290
2290
|
export interface CreateSourceLocationRequest {
|
|
2291
2291
|
/**
|
|
2292
|
-
* @public
|
|
2293
2292
|
* <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
|
|
2293
|
+
* @public
|
|
2294
2294
|
*/
|
|
2295
2295
|
AccessConfiguration?: AccessConfiguration;
|
|
2296
2296
|
/**
|
|
2297
|
-
* @public
|
|
2298
2297
|
* <p>The optional configuration for the server that serves segments.</p>
|
|
2298
|
+
* @public
|
|
2299
2299
|
*/
|
|
2300
2300
|
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
|
|
2301
2301
|
/**
|
|
2302
|
-
* @public
|
|
2303
2302
|
* <p>The source's HTTP package configurations.</p>
|
|
2303
|
+
* @public
|
|
2304
2304
|
*/
|
|
2305
2305
|
HttpConfiguration: HttpConfiguration | undefined;
|
|
2306
2306
|
/**
|
|
2307
|
-
* @public
|
|
2308
2307
|
* <p>A list of the segment delivery configurations associated with this resource.</p>
|
|
2308
|
+
* @public
|
|
2309
2309
|
*/
|
|
2310
2310
|
SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
|
|
2311
2311
|
/**
|
|
2312
|
-
* @public
|
|
2313
2312
|
* <p>The name associated with the source location.</p>
|
|
2313
|
+
* @public
|
|
2314
2314
|
*/
|
|
2315
2315
|
SourceLocationName: string | undefined;
|
|
2316
2316
|
/**
|
|
2317
|
-
* @public
|
|
2318
2317
|
* <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>
|
|
2318
|
+
* @public
|
|
2319
2319
|
*/
|
|
2320
2320
|
Tags?: Record<string, string>;
|
|
2321
2321
|
}
|
|
@@ -2324,48 +2324,48 @@ export interface CreateSourceLocationRequest {
|
|
|
2324
2324
|
*/
|
|
2325
2325
|
export interface CreateSourceLocationResponse {
|
|
2326
2326
|
/**
|
|
2327
|
-
* @public
|
|
2328
2327
|
* <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
|
|
2328
|
+
* @public
|
|
2329
2329
|
*/
|
|
2330
2330
|
AccessConfiguration?: AccessConfiguration;
|
|
2331
2331
|
/**
|
|
2332
|
-
* @public
|
|
2333
2332
|
* <p>The ARN to assign to the source location.</p>
|
|
2333
|
+
* @public
|
|
2334
2334
|
*/
|
|
2335
2335
|
Arn?: string;
|
|
2336
2336
|
/**
|
|
2337
|
-
* @public
|
|
2338
2337
|
* <p>The time the source location was created.</p>
|
|
2338
|
+
* @public
|
|
2339
2339
|
*/
|
|
2340
2340
|
CreationTime?: Date;
|
|
2341
2341
|
/**
|
|
2342
|
-
* @public
|
|
2343
2342
|
* <p>The optional configuration for the server that serves segments.</p>
|
|
2343
|
+
* @public
|
|
2344
2344
|
*/
|
|
2345
2345
|
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
|
|
2346
2346
|
/**
|
|
2347
|
-
* @public
|
|
2348
2347
|
* <p>The source's HTTP package configurations.</p>
|
|
2348
|
+
* @public
|
|
2349
2349
|
*/
|
|
2350
2350
|
HttpConfiguration?: HttpConfiguration;
|
|
2351
2351
|
/**
|
|
2352
|
-
* @public
|
|
2353
2352
|
* <p>The time the source location was last modified.</p>
|
|
2353
|
+
* @public
|
|
2354
2354
|
*/
|
|
2355
2355
|
LastModifiedTime?: Date;
|
|
2356
2356
|
/**
|
|
2357
|
-
* @public
|
|
2358
2357
|
* <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>
|
|
2358
|
+
* @public
|
|
2359
2359
|
*/
|
|
2360
2360
|
SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
|
|
2361
2361
|
/**
|
|
2362
|
-
* @public
|
|
2363
2362
|
* <p>The name to assign to the source location.</p>
|
|
2363
|
+
* @public
|
|
2364
2364
|
*/
|
|
2365
2365
|
SourceLocationName?: string;
|
|
2366
2366
|
/**
|
|
2367
|
-
* @public
|
|
2368
2367
|
* <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>
|
|
2368
|
+
* @public
|
|
2369
2369
|
*/
|
|
2370
2370
|
Tags?: Record<string, string>;
|
|
2371
2371
|
}
|
|
@@ -2374,23 +2374,23 @@ export interface CreateSourceLocationResponse {
|
|
|
2374
2374
|
*/
|
|
2375
2375
|
export interface CreateVodSourceRequest {
|
|
2376
2376
|
/**
|
|
2377
|
-
* @public
|
|
2378
2377
|
* <p>A list of HTTP package configuration parameters for this VOD source.</p>
|
|
2378
|
+
* @public
|
|
2379
2379
|
*/
|
|
2380
2380
|
HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
|
|
2381
2381
|
/**
|
|
2382
|
-
* @public
|
|
2383
2382
|
* <p>The name of the source location for this VOD source.</p>
|
|
2383
|
+
* @public
|
|
2384
2384
|
*/
|
|
2385
2385
|
SourceLocationName: string | undefined;
|
|
2386
2386
|
/**
|
|
2387
|
-
* @public
|
|
2388
2387
|
* <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>
|
|
2388
|
+
* @public
|
|
2389
2389
|
*/
|
|
2390
2390
|
Tags?: Record<string, string>;
|
|
2391
2391
|
/**
|
|
2392
|
-
* @public
|
|
2393
2392
|
* <p>The name associated with the VOD source.></p>
|
|
2393
|
+
* @public
|
|
2394
2394
|
*/
|
|
2395
2395
|
VodSourceName: string | undefined;
|
|
2396
2396
|
}
|
|
@@ -2399,54 +2399,54 @@ export interface CreateVodSourceRequest {
|
|
|
2399
2399
|
*/
|
|
2400
2400
|
export interface CreateVodSourceResponse {
|
|
2401
2401
|
/**
|
|
2402
|
-
* @public
|
|
2403
2402
|
* <p>The ARN to assign to this VOD source.</p>
|
|
2403
|
+
* @public
|
|
2404
2404
|
*/
|
|
2405
2405
|
Arn?: string;
|
|
2406
2406
|
/**
|
|
2407
|
-
* @public
|
|
2408
2407
|
* <p>The time the VOD source was created.</p>
|
|
2408
|
+
* @public
|
|
2409
2409
|
*/
|
|
2410
2410
|
CreationTime?: Date;
|
|
2411
2411
|
/**
|
|
2412
|
-
* @public
|
|
2413
2412
|
* <p>A list of HTTP package configuration parameters for this VOD source.</p>
|
|
2413
|
+
* @public
|
|
2414
2414
|
*/
|
|
2415
2415
|
HttpPackageConfigurations?: HttpPackageConfiguration[];
|
|
2416
2416
|
/**
|
|
2417
|
-
* @public
|
|
2418
2417
|
* <p>The time the VOD source was last modified.</p>
|
|
2418
|
+
* @public
|
|
2419
2419
|
*/
|
|
2420
2420
|
LastModifiedTime?: Date;
|
|
2421
2421
|
/**
|
|
2422
|
-
* @public
|
|
2423
2422
|
* <p>The name to assign to the source location for this VOD source.</p>
|
|
2423
|
+
* @public
|
|
2424
2424
|
*/
|
|
2425
2425
|
SourceLocationName?: string;
|
|
2426
2426
|
/**
|
|
2427
|
-
* @public
|
|
2428
2427
|
* <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>
|
|
2428
|
+
* @public
|
|
2429
2429
|
*/
|
|
2430
2430
|
Tags?: Record<string, string>;
|
|
2431
2431
|
/**
|
|
2432
|
-
* @public
|
|
2433
2432
|
* <p>The name to assign to the VOD source.</p>
|
|
2433
|
+
* @public
|
|
2434
2434
|
*/
|
|
2435
2435
|
VodSourceName?: string;
|
|
2436
2436
|
}
|
|
2437
2437
|
/**
|
|
2438
|
-
* @public
|
|
2439
2438
|
* <p>The configuration for DASH PUT operations.</p>
|
|
2439
|
+
* @public
|
|
2440
2440
|
*/
|
|
2441
2441
|
export interface DashConfigurationForPut {
|
|
2442
2442
|
/**
|
|
2443
|
-
* @public
|
|
2444
2443
|
* <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>
|
|
2444
|
+
* @public
|
|
2445
2445
|
*/
|
|
2446
2446
|
MpdLocation?: string;
|
|
2447
2447
|
/**
|
|
2448
|
-
* @public
|
|
2449
2448
|
* <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>
|
|
2449
|
+
* @public
|
|
2450
2450
|
*/
|
|
2451
2451
|
OriginManifestType?: OriginManifestType;
|
|
2452
2452
|
}
|
|
@@ -2455,13 +2455,13 @@ export interface DashConfigurationForPut {
|
|
|
2455
2455
|
*/
|
|
2456
2456
|
export interface DeleteLiveSourceRequest {
|
|
2457
2457
|
/**
|
|
2458
|
-
* @public
|
|
2459
2458
|
* <p>The name of the live source.</p>
|
|
2459
|
+
* @public
|
|
2460
2460
|
*/
|
|
2461
2461
|
LiveSourceName: string | undefined;
|
|
2462
2462
|
/**
|
|
2463
|
-
* @public
|
|
2464
2463
|
* <p>The name of the source location associated with this Live Source.</p>
|
|
2464
|
+
* @public
|
|
2465
2465
|
*/
|
|
2466
2466
|
SourceLocationName: string | undefined;
|
|
2467
2467
|
}
|
|
@@ -2475,8 +2475,8 @@ export interface DeleteLiveSourceResponse {
|
|
|
2475
2475
|
*/
|
|
2476
2476
|
export interface DeletePlaybackConfigurationRequest {
|
|
2477
2477
|
/**
|
|
2478
|
-
* @public
|
|
2479
2478
|
* <p>The name of the playback configuration.</p>
|
|
2479
|
+
* @public
|
|
2480
2480
|
*/
|
|
2481
2481
|
Name: string | undefined;
|
|
2482
2482
|
}
|
|
@@ -2490,13 +2490,13 @@ export interface DeletePlaybackConfigurationResponse {
|
|
|
2490
2490
|
*/
|
|
2491
2491
|
export interface DeletePrefetchScheduleRequest {
|
|
2492
2492
|
/**
|
|
2493
|
-
* @public
|
|
2494
2493
|
* <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>
|
|
2494
|
+
* @public
|
|
2495
2495
|
*/
|
|
2496
2496
|
Name: string | undefined;
|
|
2497
2497
|
/**
|
|
2498
|
-
* @public
|
|
2499
2498
|
* <p>The name of the playback configuration for this prefetch schedule.</p>
|
|
2499
|
+
* @public
|
|
2500
2500
|
*/
|
|
2501
2501
|
PlaybackConfigurationName: string | undefined;
|
|
2502
2502
|
}
|
|
@@ -2510,8 +2510,8 @@ export interface DeletePrefetchScheduleResponse {
|
|
|
2510
2510
|
*/
|
|
2511
2511
|
export interface DeleteSourceLocationRequest {
|
|
2512
2512
|
/**
|
|
2513
|
-
* @public
|
|
2514
2513
|
* <p>The name of the source location.</p>
|
|
2514
|
+
* @public
|
|
2515
2515
|
*/
|
|
2516
2516
|
SourceLocationName: string | undefined;
|
|
2517
2517
|
}
|
|
@@ -2525,13 +2525,13 @@ export interface DeleteSourceLocationResponse {
|
|
|
2525
2525
|
*/
|
|
2526
2526
|
export interface DeleteVodSourceRequest {
|
|
2527
2527
|
/**
|
|
2528
|
-
* @public
|
|
2529
2528
|
* <p>The name of the source location associated with this VOD Source.</p>
|
|
2529
|
+
* @public
|
|
2530
2530
|
*/
|
|
2531
2531
|
SourceLocationName: string | undefined;
|
|
2532
2532
|
/**
|
|
2533
|
-
* @public
|
|
2534
2533
|
* <p>The name of the VOD source.</p>
|
|
2534
|
+
* @public
|
|
2535
2535
|
*/
|
|
2536
2536
|
VodSourceName: string | undefined;
|
|
2537
2537
|
}
|
|
@@ -2545,13 +2545,13 @@ export interface DeleteVodSourceResponse {
|
|
|
2545
2545
|
*/
|
|
2546
2546
|
export interface DescribeLiveSourceRequest {
|
|
2547
2547
|
/**
|
|
2548
|
-
* @public
|
|
2549
2548
|
* <p>The name of the live source.</p>
|
|
2549
|
+
* @public
|
|
2550
2550
|
*/
|
|
2551
2551
|
LiveSourceName: string | undefined;
|
|
2552
2552
|
/**
|
|
2553
|
-
* @public
|
|
2554
2553
|
* <p>The name of the source location associated with this Live Source.</p>
|
|
2554
|
+
* @public
|
|
2555
2555
|
*/
|
|
2556
2556
|
SourceLocationName: string | undefined;
|
|
2557
2557
|
}
|
|
@@ -2560,38 +2560,38 @@ export interface DescribeLiveSourceRequest {
|
|
|
2560
2560
|
*/
|
|
2561
2561
|
export interface DescribeLiveSourceResponse {
|
|
2562
2562
|
/**
|
|
2563
|
-
* @public
|
|
2564
2563
|
* <p>The ARN of the live source.</p>
|
|
2564
|
+
* @public
|
|
2565
2565
|
*/
|
|
2566
2566
|
Arn?: string;
|
|
2567
2567
|
/**
|
|
2568
|
-
* @public
|
|
2569
2568
|
* <p>The timestamp that indicates when the live source was created.</p>
|
|
2569
|
+
* @public
|
|
2570
2570
|
*/
|
|
2571
2571
|
CreationTime?: Date;
|
|
2572
2572
|
/**
|
|
2573
|
-
* @public
|
|
2574
2573
|
* <p>The HTTP package configurations.</p>
|
|
2574
|
+
* @public
|
|
2575
2575
|
*/
|
|
2576
2576
|
HttpPackageConfigurations?: HttpPackageConfiguration[];
|
|
2577
2577
|
/**
|
|
2578
|
-
* @public
|
|
2579
2578
|
* <p>The timestamp that indicates when the live source was modified.</p>
|
|
2579
|
+
* @public
|
|
2580
2580
|
*/
|
|
2581
2581
|
LastModifiedTime?: Date;
|
|
2582
2582
|
/**
|
|
2583
|
-
* @public
|
|
2584
2583
|
* <p>The name of the live source.</p>
|
|
2584
|
+
* @public
|
|
2585
2585
|
*/
|
|
2586
2586
|
LiveSourceName?: string;
|
|
2587
2587
|
/**
|
|
2588
|
-
* @public
|
|
2589
2588
|
* <p>The name of the source location associated with the live source.</p>
|
|
2589
|
+
* @public
|
|
2590
2590
|
*/
|
|
2591
2591
|
SourceLocationName?: string;
|
|
2592
2592
|
/**
|
|
2593
|
-
* @public
|
|
2594
2593
|
* <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>
|
|
2594
|
+
* @public
|
|
2595
2595
|
*/
|
|
2596
2596
|
Tags?: Record<string, string>;
|
|
2597
2597
|
}
|
|
@@ -2600,8 +2600,8 @@ export interface DescribeLiveSourceResponse {
|
|
|
2600
2600
|
*/
|
|
2601
2601
|
export interface DescribeSourceLocationRequest {
|
|
2602
2602
|
/**
|
|
2603
|
-
* @public
|
|
2604
2603
|
* <p>The name of the source location.</p>
|
|
2604
|
+
* @public
|
|
2605
2605
|
*/
|
|
2606
2606
|
SourceLocationName: string | undefined;
|
|
2607
2607
|
}
|
|
@@ -2610,48 +2610,48 @@ export interface DescribeSourceLocationRequest {
|
|
|
2610
2610
|
*/
|
|
2611
2611
|
export interface DescribeSourceLocationResponse {
|
|
2612
2612
|
/**
|
|
2613
|
-
* @public
|
|
2614
2613
|
* <p>The access configuration for the source location.</p>
|
|
2614
|
+
* @public
|
|
2615
2615
|
*/
|
|
2616
2616
|
AccessConfiguration?: AccessConfiguration;
|
|
2617
2617
|
/**
|
|
2618
|
-
* @public
|
|
2619
2618
|
* <p>The ARN of the source location.</p>
|
|
2619
|
+
* @public
|
|
2620
2620
|
*/
|
|
2621
2621
|
Arn?: string;
|
|
2622
2622
|
/**
|
|
2623
|
-
* @public
|
|
2624
2623
|
* <p>The timestamp that indicates when the source location was created.</p>
|
|
2624
|
+
* @public
|
|
2625
2625
|
*/
|
|
2626
2626
|
CreationTime?: Date;
|
|
2627
2627
|
/**
|
|
2628
|
-
* @public
|
|
2629
2628
|
* <p>The default segment delivery configuration settings.</p>
|
|
2629
|
+
* @public
|
|
2630
2630
|
*/
|
|
2631
2631
|
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
|
|
2632
2632
|
/**
|
|
2633
|
-
* @public
|
|
2634
2633
|
* <p>The HTTP package configuration settings for the source location.</p>
|
|
2634
|
+
* @public
|
|
2635
2635
|
*/
|
|
2636
2636
|
HttpConfiguration?: HttpConfiguration;
|
|
2637
2637
|
/**
|
|
2638
|
-
* @public
|
|
2639
2638
|
* <p>The timestamp that indicates when the source location was last modified.</p>
|
|
2639
|
+
* @public
|
|
2640
2640
|
*/
|
|
2641
2641
|
LastModifiedTime?: Date;
|
|
2642
2642
|
/**
|
|
2643
|
-
* @public
|
|
2644
2643
|
* <p>A list of the segment delivery configurations associated with this resource.</p>
|
|
2644
|
+
* @public
|
|
2645
2645
|
*/
|
|
2646
2646
|
SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
|
|
2647
2647
|
/**
|
|
2648
|
-
* @public
|
|
2649
2648
|
* <p>The name of the source location.</p>
|
|
2649
|
+
* @public
|
|
2650
2650
|
*/
|
|
2651
2651
|
SourceLocationName?: string;
|
|
2652
2652
|
/**
|
|
2653
|
-
* @public
|
|
2654
2653
|
* <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>
|
|
2654
|
+
* @public
|
|
2655
2655
|
*/
|
|
2656
2656
|
Tags?: Record<string, string>;
|
|
2657
2657
|
}
|
|
@@ -2660,13 +2660,13 @@ export interface DescribeSourceLocationResponse {
|
|
|
2660
2660
|
*/
|
|
2661
2661
|
export interface DescribeVodSourceRequest {
|
|
2662
2662
|
/**
|
|
2663
|
-
* @public
|
|
2664
2663
|
* <p>The name of the source location associated with this VOD Source.</p>
|
|
2664
|
+
* @public
|
|
2665
2665
|
*/
|
|
2666
2666
|
SourceLocationName: string | undefined;
|
|
2667
2667
|
/**
|
|
2668
|
-
* @public
|
|
2669
2668
|
* <p>The name of the VOD Source.</p>
|
|
2669
|
+
* @public
|
|
2670
2670
|
*/
|
|
2671
2671
|
VodSourceName: string | undefined;
|
|
2672
2672
|
}
|
|
@@ -2675,43 +2675,43 @@ export interface DescribeVodSourceRequest {
|
|
|
2675
2675
|
*/
|
|
2676
2676
|
export interface DescribeVodSourceResponse {
|
|
2677
2677
|
/**
|
|
2678
|
-
* @public
|
|
2679
2678
|
* <p>The ad break opportunities within the VOD source.</p>
|
|
2679
|
+
* @public
|
|
2680
2680
|
*/
|
|
2681
2681
|
AdBreakOpportunities?: AdBreakOpportunity[];
|
|
2682
2682
|
/**
|
|
2683
|
-
* @public
|
|
2684
2683
|
* <p>The ARN of the VOD source.</p>
|
|
2684
|
+
* @public
|
|
2685
2685
|
*/
|
|
2686
2686
|
Arn?: string;
|
|
2687
2687
|
/**
|
|
2688
|
-
* @public
|
|
2689
2688
|
* <p>The timestamp that indicates when the VOD source was created.</p>
|
|
2689
|
+
* @public
|
|
2690
2690
|
*/
|
|
2691
2691
|
CreationTime?: Date;
|
|
2692
2692
|
/**
|
|
2693
|
-
* @public
|
|
2694
2693
|
* <p>The HTTP package configurations.</p>
|
|
2694
|
+
* @public
|
|
2695
2695
|
*/
|
|
2696
2696
|
HttpPackageConfigurations?: HttpPackageConfiguration[];
|
|
2697
2697
|
/**
|
|
2698
|
-
* @public
|
|
2699
2698
|
* <p>The last modified time of the VOD source.</p>
|
|
2699
|
+
* @public
|
|
2700
2700
|
*/
|
|
2701
2701
|
LastModifiedTime?: Date;
|
|
2702
2702
|
/**
|
|
2703
|
-
* @public
|
|
2704
2703
|
* <p>The name of the source location associated with the VOD source.</p>
|
|
2704
|
+
* @public
|
|
2705
2705
|
*/
|
|
2706
2706
|
SourceLocationName?: string;
|
|
2707
2707
|
/**
|
|
2708
|
-
* @public
|
|
2709
2708
|
* <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>
|
|
2709
|
+
* @public
|
|
2710
2710
|
*/
|
|
2711
2711
|
Tags?: Record<string, string>;
|
|
2712
2712
|
/**
|
|
2713
|
-
* @public
|
|
2714
2713
|
* <p>The name of the VOD source.</p>
|
|
2714
|
+
* @public
|
|
2715
2715
|
*/
|
|
2716
2716
|
VodSourceName?: string;
|
|
2717
2717
|
}
|
|
@@ -2720,8 +2720,8 @@ export interface DescribeVodSourceResponse {
|
|
|
2720
2720
|
*/
|
|
2721
2721
|
export interface GetPlaybackConfigurationRequest {
|
|
2722
2722
|
/**
|
|
2723
|
-
* @public
|
|
2724
2723
|
* <p>The identifier for the playback configuration.</p>
|
|
2724
|
+
* @public
|
|
2725
2725
|
*/
|
|
2726
2726
|
Name: string | undefined;
|
|
2727
2727
|
}
|
|
@@ -2730,98 +2730,98 @@ export interface GetPlaybackConfigurationRequest {
|
|
|
2730
2730
|
*/
|
|
2731
2731
|
export interface GetPlaybackConfigurationResponse {
|
|
2732
2732
|
/**
|
|
2733
|
-
* @public
|
|
2734
2733
|
* <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>
|
|
2734
|
+
* @public
|
|
2735
2735
|
*/
|
|
2736
2736
|
AdDecisionServerUrl?: string;
|
|
2737
2737
|
/**
|
|
2738
|
-
* @public
|
|
2739
2738
|
* <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>
|
|
2739
|
+
* @public
|
|
2740
2740
|
*/
|
|
2741
2741
|
AvailSuppression?: AvailSuppression;
|
|
2742
2742
|
/**
|
|
2743
|
-
* @public
|
|
2744
2743
|
* <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>
|
|
2744
|
+
* @public
|
|
2745
2745
|
*/
|
|
2746
2746
|
Bumper?: Bumper;
|
|
2747
2747
|
/**
|
|
2748
|
-
* @public
|
|
2749
2748
|
* <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
|
|
2749
|
+
* @public
|
|
2750
2750
|
*/
|
|
2751
2751
|
CdnConfiguration?: CdnConfiguration;
|
|
2752
2752
|
/**
|
|
2753
|
-
* @public
|
|
2754
2753
|
* <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>
|
|
2754
|
+
* @public
|
|
2755
2755
|
*/
|
|
2756
2756
|
ConfigurationAliases?: Record<string, Record<string, string>>;
|
|
2757
2757
|
/**
|
|
2758
|
-
* @public
|
|
2759
2758
|
* <p>The configuration for DASH content.</p>
|
|
2759
|
+
* @public
|
|
2760
2760
|
*/
|
|
2761
2761
|
DashConfiguration?: DashConfiguration;
|
|
2762
2762
|
/**
|
|
2763
|
-
* @public
|
|
2764
2763
|
* <p>The configuration for HLS content.</p>
|
|
2764
|
+
* @public
|
|
2765
2765
|
*/
|
|
2766
2766
|
HlsConfiguration?: HlsConfiguration;
|
|
2767
2767
|
/**
|
|
2768
|
-
* @public
|
|
2769
2768
|
* <p>The configuration for pre-roll ad insertion.</p>
|
|
2769
|
+
* @public
|
|
2770
2770
|
*/
|
|
2771
2771
|
LivePreRollConfiguration?: LivePreRollConfiguration;
|
|
2772
2772
|
/**
|
|
2773
|
-
* @public
|
|
2774
2773
|
* <p>The Amazon CloudWatch log settings for a playback configuration.</p>
|
|
2774
|
+
* @public
|
|
2775
2775
|
*/
|
|
2776
2776
|
LogConfiguration?: LogConfiguration;
|
|
2777
2777
|
/**
|
|
2778
|
-
* @public
|
|
2779
2778
|
* <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
|
|
2779
|
+
* @public
|
|
2780
2780
|
*/
|
|
2781
2781
|
ManifestProcessingRules?: ManifestProcessingRules;
|
|
2782
2782
|
/**
|
|
2783
|
-
* @public
|
|
2784
2783
|
* <p>The identifier for the playback configuration.</p>
|
|
2784
|
+
* @public
|
|
2785
2785
|
*/
|
|
2786
2786
|
Name?: string;
|
|
2787
2787
|
/**
|
|
2788
|
-
* @public
|
|
2789
2788
|
* <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>
|
|
2789
|
+
* @public
|
|
2790
2790
|
*/
|
|
2791
2791
|
PersonalizationThresholdSeconds?: number;
|
|
2792
2792
|
/**
|
|
2793
|
-
* @public
|
|
2794
2793
|
* <p>The Amazon Resource Name (ARN) for the playback configuration.</p>
|
|
2794
|
+
* @public
|
|
2795
2795
|
*/
|
|
2796
2796
|
PlaybackConfigurationArn?: string;
|
|
2797
2797
|
/**
|
|
2798
|
-
* @public
|
|
2799
2798
|
* <p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.</p>
|
|
2799
|
+
* @public
|
|
2800
2800
|
*/
|
|
2801
2801
|
PlaybackEndpointPrefix?: string;
|
|
2802
2802
|
/**
|
|
2803
|
-
* @public
|
|
2804
2803
|
* <p>The URL that the player uses to initialize a session that uses client-side reporting.</p>
|
|
2804
|
+
* @public
|
|
2805
2805
|
*/
|
|
2806
2806
|
SessionInitializationEndpointPrefix?: string;
|
|
2807
2807
|
/**
|
|
2808
|
-
* @public
|
|
2809
2808
|
* <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>
|
|
2809
|
+
* @public
|
|
2810
2810
|
*/
|
|
2811
2811
|
SlateAdUrl?: string;
|
|
2812
2812
|
/**
|
|
2813
|
-
* @public
|
|
2814
2813
|
* <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>
|
|
2814
|
+
* @public
|
|
2815
2815
|
*/
|
|
2816
2816
|
Tags?: Record<string, string>;
|
|
2817
2817
|
/**
|
|
2818
|
-
* @public
|
|
2819
2818
|
* <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>
|
|
2819
|
+
* @public
|
|
2820
2820
|
*/
|
|
2821
2821
|
TranscodeProfileName?: string;
|
|
2822
2822
|
/**
|
|
2823
|
-
* @public
|
|
2824
2823
|
* <p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>
|
|
2824
|
+
* @public
|
|
2825
2825
|
*/
|
|
2826
2826
|
VideoContentSourceUrl?: string;
|
|
2827
2827
|
}
|
|
@@ -2830,13 +2830,13 @@ export interface GetPlaybackConfigurationResponse {
|
|
|
2830
2830
|
*/
|
|
2831
2831
|
export interface GetPrefetchScheduleRequest {
|
|
2832
2832
|
/**
|
|
2833
|
-
* @public
|
|
2834
2833
|
* <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>
|
|
2834
|
+
* @public
|
|
2835
2835
|
*/
|
|
2836
2836
|
Name: string | undefined;
|
|
2837
2837
|
/**
|
|
2838
|
-
* @public
|
|
2839
2838
|
* <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>
|
|
2839
|
+
* @public
|
|
2840
2840
|
*/
|
|
2841
2841
|
PlaybackConfigurationName: string | undefined;
|
|
2842
2842
|
}
|
|
@@ -2845,33 +2845,33 @@ export interface GetPrefetchScheduleRequest {
|
|
|
2845
2845
|
*/
|
|
2846
2846
|
export interface GetPrefetchScheduleResponse {
|
|
2847
2847
|
/**
|
|
2848
|
-
* @public
|
|
2849
2848
|
* <p>The Amazon Resource Name (ARN) of the prefetch schedule.</p>
|
|
2849
|
+
* @public
|
|
2850
2850
|
*/
|
|
2851
2851
|
Arn?: string;
|
|
2852
2852
|
/**
|
|
2853
|
-
* @public
|
|
2854
2853
|
* <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>
|
|
2854
|
+
* @public
|
|
2855
2855
|
*/
|
|
2856
2856
|
Consumption?: PrefetchConsumption;
|
|
2857
2857
|
/**
|
|
2858
|
-
* @public
|
|
2859
2858
|
* <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>
|
|
2859
|
+
* @public
|
|
2860
2860
|
*/
|
|
2861
2861
|
Name?: string;
|
|
2862
2862
|
/**
|
|
2863
|
-
* @public
|
|
2864
2863
|
* <p>The name of the playback configuration to create the prefetch schedule for.</p>
|
|
2864
|
+
* @public
|
|
2865
2865
|
*/
|
|
2866
2866
|
PlaybackConfigurationName?: string;
|
|
2867
2867
|
/**
|
|
2868
|
-
* @public
|
|
2869
2868
|
* <p>A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).</p>
|
|
2869
|
+
* @public
|
|
2870
2870
|
*/
|
|
2871
2871
|
Retrieval?: PrefetchRetrieval;
|
|
2872
2872
|
/**
|
|
2873
|
-
* @public
|
|
2874
2873
|
* <p>An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.</p>
|
|
2874
|
+
* @public
|
|
2875
2875
|
*/
|
|
2876
2876
|
StreamId?: string;
|
|
2877
2877
|
}
|
|
@@ -2880,18 +2880,18 @@ export interface GetPrefetchScheduleResponse {
|
|
|
2880
2880
|
*/
|
|
2881
2881
|
export interface ListAlertsRequest {
|
|
2882
2882
|
/**
|
|
2883
|
-
* @public
|
|
2884
2883
|
* <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>
|
|
2884
|
+
* @public
|
|
2885
2885
|
*/
|
|
2886
2886
|
MaxResults?: number;
|
|
2887
2887
|
/**
|
|
2888
|
-
* @public
|
|
2889
2888
|
* <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>
|
|
2889
|
+
* @public
|
|
2890
2890
|
*/
|
|
2891
2891
|
NextToken?: string;
|
|
2892
2892
|
/**
|
|
2893
|
-
* @public
|
|
2894
2893
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
2894
|
+
* @public
|
|
2895
2895
|
*/
|
|
2896
2896
|
ResourceArn: string | undefined;
|
|
2897
2897
|
}
|
|
@@ -2900,13 +2900,13 @@ export interface ListAlertsRequest {
|
|
|
2900
2900
|
*/
|
|
2901
2901
|
export interface ListAlertsResponse {
|
|
2902
2902
|
/**
|
|
2903
|
-
* @public
|
|
2904
2903
|
* <p>A list of alerts that are associated with this resource.</p>
|
|
2904
|
+
* @public
|
|
2905
2905
|
*/
|
|
2906
2906
|
Items?: Alert[];
|
|
2907
2907
|
/**
|
|
2908
|
-
* @public
|
|
2909
2908
|
* <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>
|
|
2909
|
+
* @public
|
|
2910
2910
|
*/
|
|
2911
2911
|
NextToken?: string;
|
|
2912
2912
|
}
|
|
@@ -2915,18 +2915,18 @@ export interface ListAlertsResponse {
|
|
|
2915
2915
|
*/
|
|
2916
2916
|
export interface ListLiveSourcesRequest {
|
|
2917
2917
|
/**
|
|
2918
|
-
* @public
|
|
2919
2918
|
* <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>
|
|
2919
|
+
* @public
|
|
2920
2920
|
*/
|
|
2921
2921
|
MaxResults?: number;
|
|
2922
2922
|
/**
|
|
2923
|
-
* @public
|
|
2924
2923
|
* <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>
|
|
2924
|
+
* @public
|
|
2925
2925
|
*/
|
|
2926
2926
|
NextToken?: string;
|
|
2927
2927
|
/**
|
|
2928
|
-
* @public
|
|
2929
2928
|
* <p>The name of the source location associated with this Live Sources list.</p>
|
|
2929
|
+
* @public
|
|
2930
2930
|
*/
|
|
2931
2931
|
SourceLocationName: string | undefined;
|
|
2932
2932
|
}
|
|
@@ -2935,13 +2935,13 @@ export interface ListLiveSourcesRequest {
|
|
|
2935
2935
|
*/
|
|
2936
2936
|
export interface ListLiveSourcesResponse {
|
|
2937
2937
|
/**
|
|
2938
|
-
* @public
|
|
2939
2938
|
* <p>Lists the live sources.</p>
|
|
2939
|
+
* @public
|
|
2940
2940
|
*/
|
|
2941
2941
|
Items?: LiveSource[];
|
|
2942
2942
|
/**
|
|
2943
|
-
* @public
|
|
2944
2943
|
* <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>
|
|
2944
|
+
* @public
|
|
2945
2945
|
*/
|
|
2946
2946
|
NextToken?: string;
|
|
2947
2947
|
}
|
|
@@ -2950,13 +2950,13 @@ export interface ListLiveSourcesResponse {
|
|
|
2950
2950
|
*/
|
|
2951
2951
|
export interface ListPlaybackConfigurationsRequest {
|
|
2952
2952
|
/**
|
|
2953
|
-
* @public
|
|
2954
2953
|
* <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>
|
|
2954
|
+
* @public
|
|
2955
2955
|
*/
|
|
2956
2956
|
MaxResults?: number;
|
|
2957
2957
|
/**
|
|
2958
|
-
* @public
|
|
2959
2958
|
* <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>
|
|
2959
|
+
* @public
|
|
2960
2960
|
*/
|
|
2961
2961
|
NextToken?: string;
|
|
2962
2962
|
}
|
|
@@ -2965,13 +2965,13 @@ export interface ListPlaybackConfigurationsRequest {
|
|
|
2965
2965
|
*/
|
|
2966
2966
|
export interface ListPlaybackConfigurationsResponse {
|
|
2967
2967
|
/**
|
|
2968
|
-
* @public
|
|
2969
2968
|
* <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>
|
|
2969
|
+
* @public
|
|
2970
2970
|
*/
|
|
2971
2971
|
Items?: PlaybackConfiguration[];
|
|
2972
2972
|
/**
|
|
2973
|
-
* @public
|
|
2974
2973
|
* <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>
|
|
2974
|
+
* @public
|
|
2975
2975
|
*/
|
|
2976
2976
|
NextToken?: string;
|
|
2977
2977
|
}
|
|
@@ -2980,26 +2980,26 @@ export interface ListPlaybackConfigurationsResponse {
|
|
|
2980
2980
|
*/
|
|
2981
2981
|
export interface ListPrefetchSchedulesRequest {
|
|
2982
2982
|
/**
|
|
2983
|
-
* @public
|
|
2984
2983
|
* <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>
|
|
2984
|
+
* @public
|
|
2985
2985
|
*/
|
|
2986
2986
|
MaxResults?: number;
|
|
2987
2987
|
/**
|
|
2988
|
-
* @public
|
|
2989
2988
|
* <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
2989
|
* <p> For the first <code>ListPrefetchSchedulesRequest</code> request, omit this value.</p>
|
|
2991
2990
|
* <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
2991
|
* <p> If the previous response didn't include a <code>NextToken</code> element, there are no more prefetch schedules to get.</p>
|
|
2992
|
+
* @public
|
|
2993
2993
|
*/
|
|
2994
2994
|
NextToken?: string;
|
|
2995
2995
|
/**
|
|
2996
|
-
* @public
|
|
2997
2996
|
* <p>Retrieves the prefetch schedule(s) for a specific playback configuration.</p>
|
|
2997
|
+
* @public
|
|
2998
2998
|
*/
|
|
2999
2999
|
PlaybackConfigurationName: string | undefined;
|
|
3000
3000
|
/**
|
|
3001
|
-
* @public
|
|
3002
3001
|
* <p>An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.</p>
|
|
3002
|
+
* @public
|
|
3003
3003
|
*/
|
|
3004
3004
|
StreamId?: string;
|
|
3005
3005
|
}
|
|
@@ -3008,13 +3008,13 @@ export interface ListPrefetchSchedulesRequest {
|
|
|
3008
3008
|
*/
|
|
3009
3009
|
export interface ListPrefetchSchedulesResponse {
|
|
3010
3010
|
/**
|
|
3011
|
-
* @public
|
|
3012
3011
|
* <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>
|
|
3012
|
+
* @public
|
|
3013
3013
|
*/
|
|
3014
3014
|
Items?: PrefetchSchedule[];
|
|
3015
3015
|
/**
|
|
3016
|
-
* @public
|
|
3017
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
|
|
3018
3018
|
*/
|
|
3019
3019
|
NextToken?: string;
|
|
3020
3020
|
}
|
|
@@ -3023,13 +3023,13 @@ export interface ListPrefetchSchedulesResponse {
|
|
|
3023
3023
|
*/
|
|
3024
3024
|
export interface ListSourceLocationsRequest {
|
|
3025
3025
|
/**
|
|
3026
|
-
* @public
|
|
3027
3026
|
* <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>
|
|
3027
|
+
* @public
|
|
3028
3028
|
*/
|
|
3029
3029
|
MaxResults?: number;
|
|
3030
3030
|
/**
|
|
3031
|
-
* @public
|
|
3032
3031
|
* <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>
|
|
3032
|
+
* @public
|
|
3033
3033
|
*/
|
|
3034
3034
|
NextToken?: string;
|
|
3035
3035
|
}
|
|
@@ -3038,13 +3038,13 @@ export interface ListSourceLocationsRequest {
|
|
|
3038
3038
|
*/
|
|
3039
3039
|
export interface ListSourceLocationsResponse {
|
|
3040
3040
|
/**
|
|
3041
|
-
* @public
|
|
3042
3041
|
* <p>A list of source locations.</p>
|
|
3042
|
+
* @public
|
|
3043
3043
|
*/
|
|
3044
3044
|
Items?: SourceLocation[];
|
|
3045
3045
|
/**
|
|
3046
|
-
* @public
|
|
3047
3046
|
* <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>
|
|
3047
|
+
* @public
|
|
3048
3048
|
*/
|
|
3049
3049
|
NextToken?: string;
|
|
3050
3050
|
}
|
|
@@ -3053,8 +3053,8 @@ export interface ListSourceLocationsResponse {
|
|
|
3053
3053
|
*/
|
|
3054
3054
|
export interface ListTagsForResourceRequest {
|
|
3055
3055
|
/**
|
|
3056
|
-
* @public
|
|
3057
3056
|
* <p>The Amazon Resource Name (ARN) associated with this resource.</p>
|
|
3057
|
+
* @public
|
|
3058
3058
|
*/
|
|
3059
3059
|
ResourceArn: string | undefined;
|
|
3060
3060
|
}
|
|
@@ -3063,8 +3063,8 @@ export interface ListTagsForResourceRequest {
|
|
|
3063
3063
|
*/
|
|
3064
3064
|
export interface ListTagsForResourceResponse {
|
|
3065
3065
|
/**
|
|
3066
|
-
* @public
|
|
3067
3066
|
* <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>
|
|
3067
|
+
* @public
|
|
3068
3068
|
*/
|
|
3069
3069
|
Tags?: Record<string, string>;
|
|
3070
3070
|
}
|
|
@@ -3073,18 +3073,18 @@ export interface ListTagsForResourceResponse {
|
|
|
3073
3073
|
*/
|
|
3074
3074
|
export interface ListVodSourcesRequest {
|
|
3075
3075
|
/**
|
|
3076
|
-
* @public
|
|
3077
3076
|
* <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>
|
|
3077
|
+
* @public
|
|
3078
3078
|
*/
|
|
3079
3079
|
MaxResults?: number;
|
|
3080
3080
|
/**
|
|
3081
|
-
* @public
|
|
3082
3081
|
* <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>
|
|
3082
|
+
* @public
|
|
3083
3083
|
*/
|
|
3084
3084
|
NextToken?: string;
|
|
3085
3085
|
/**
|
|
3086
|
-
* @public
|
|
3087
3086
|
* <p>The name of the source location associated with this VOD Source list.</p>
|
|
3087
|
+
* @public
|
|
3088
3088
|
*/
|
|
3089
3089
|
SourceLocationName: string | undefined;
|
|
3090
3090
|
}
|
|
@@ -3093,13 +3093,13 @@ export interface ListVodSourcesRequest {
|
|
|
3093
3093
|
*/
|
|
3094
3094
|
export interface ListVodSourcesResponse {
|
|
3095
3095
|
/**
|
|
3096
|
-
* @public
|
|
3097
3096
|
* <p>Lists the VOD sources.</p>
|
|
3097
|
+
* @public
|
|
3098
3098
|
*/
|
|
3099
3099
|
Items?: VodSource[];
|
|
3100
3100
|
/**
|
|
3101
|
-
* @public
|
|
3102
3101
|
* <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>
|
|
3102
|
+
* @public
|
|
3103
3103
|
*/
|
|
3104
3104
|
NextToken?: string;
|
|
3105
3105
|
}
|
|
@@ -3108,18 +3108,18 @@ export interface ListVodSourcesResponse {
|
|
|
3108
3108
|
*/
|
|
3109
3109
|
export interface UpdateLiveSourceRequest {
|
|
3110
3110
|
/**
|
|
3111
|
-
* @public
|
|
3112
3111
|
* <p>A list of HTTP package configurations for the live source on this account.</p>
|
|
3112
|
+
* @public
|
|
3113
3113
|
*/
|
|
3114
3114
|
HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
|
|
3115
3115
|
/**
|
|
3116
|
-
* @public
|
|
3117
3116
|
* <p>The name of the live source.</p>
|
|
3117
|
+
* @public
|
|
3118
3118
|
*/
|
|
3119
3119
|
LiveSourceName: string | undefined;
|
|
3120
3120
|
/**
|
|
3121
|
-
* @public
|
|
3122
3121
|
* <p>The name of the source location associated with this Live Source.</p>
|
|
3122
|
+
* @public
|
|
3123
3123
|
*/
|
|
3124
3124
|
SourceLocationName: string | undefined;
|
|
3125
3125
|
}
|
|
@@ -3128,38 +3128,38 @@ export interface UpdateLiveSourceRequest {
|
|
|
3128
3128
|
*/
|
|
3129
3129
|
export interface UpdateLiveSourceResponse {
|
|
3130
3130
|
/**
|
|
3131
|
-
* @public
|
|
3132
3131
|
* <p>The Amazon Resource Name (ARN) associated with this live source.</p>
|
|
3132
|
+
* @public
|
|
3133
3133
|
*/
|
|
3134
3134
|
Arn?: string;
|
|
3135
3135
|
/**
|
|
3136
|
-
* @public
|
|
3137
3136
|
* <p>The timestamp that indicates when the live source was created.</p>
|
|
3137
|
+
* @public
|
|
3138
3138
|
*/
|
|
3139
3139
|
CreationTime?: Date;
|
|
3140
3140
|
/**
|
|
3141
|
-
* @public
|
|
3142
3141
|
* <p>A list of HTTP package configurations for the live source on this account.</p>
|
|
3142
|
+
* @public
|
|
3143
3143
|
*/
|
|
3144
3144
|
HttpPackageConfigurations?: HttpPackageConfiguration[];
|
|
3145
3145
|
/**
|
|
3146
|
-
* @public
|
|
3147
3146
|
* <p>The timestamp that indicates when the live source was last modified.</p>
|
|
3147
|
+
* @public
|
|
3148
3148
|
*/
|
|
3149
3149
|
LastModifiedTime?: Date;
|
|
3150
3150
|
/**
|
|
3151
|
-
* @public
|
|
3152
3151
|
* <p>The name of the live source.</p>
|
|
3152
|
+
* @public
|
|
3153
3153
|
*/
|
|
3154
3154
|
LiveSourceName?: string;
|
|
3155
3155
|
/**
|
|
3156
|
-
* @public
|
|
3157
3156
|
* <p>The name of the source location associated with the live source.</p>
|
|
3157
|
+
* @public
|
|
3158
3158
|
*/
|
|
3159
3159
|
SourceLocationName?: string;
|
|
3160
3160
|
/**
|
|
3161
|
-
* @public
|
|
3162
3161
|
* <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>
|
|
3162
|
+
* @public
|
|
3163
3163
|
*/
|
|
3164
3164
|
Tags?: Record<string, string>;
|
|
3165
3165
|
}
|
|
@@ -3168,73 +3168,73 @@ export interface UpdateLiveSourceResponse {
|
|
|
3168
3168
|
*/
|
|
3169
3169
|
export interface PutPlaybackConfigurationRequest {
|
|
3170
3170
|
/**
|
|
3171
|
-
* @public
|
|
3172
3171
|
* <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>
|
|
3172
|
+
* @public
|
|
3173
3173
|
*/
|
|
3174
3174
|
AdDecisionServerUrl?: string;
|
|
3175
3175
|
/**
|
|
3176
|
-
* @public
|
|
3177
3176
|
* <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>
|
|
3177
|
+
* @public
|
|
3178
3178
|
*/
|
|
3179
3179
|
AvailSuppression?: AvailSuppression;
|
|
3180
3180
|
/**
|
|
3181
|
-
* @public
|
|
3182
3181
|
* <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>
|
|
3182
|
+
* @public
|
|
3183
3183
|
*/
|
|
3184
3184
|
Bumper?: Bumper;
|
|
3185
3185
|
/**
|
|
3186
|
-
* @public
|
|
3187
3186
|
* <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
|
|
3187
|
+
* @public
|
|
3188
3188
|
*/
|
|
3189
3189
|
CdnConfiguration?: CdnConfiguration;
|
|
3190
3190
|
/**
|
|
3191
|
-
* @public
|
|
3192
3191
|
* <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>
|
|
3192
|
+
* @public
|
|
3193
3193
|
*/
|
|
3194
3194
|
ConfigurationAliases?: Record<string, Record<string, string>>;
|
|
3195
3195
|
/**
|
|
3196
|
-
* @public
|
|
3197
3196
|
* <p>The configuration for DASH content.</p>
|
|
3197
|
+
* @public
|
|
3198
3198
|
*/
|
|
3199
3199
|
DashConfiguration?: DashConfigurationForPut;
|
|
3200
3200
|
/**
|
|
3201
|
-
* @public
|
|
3202
3201
|
* <p>The configuration for pre-roll ad insertion.</p>
|
|
3202
|
+
* @public
|
|
3203
3203
|
*/
|
|
3204
3204
|
LivePreRollConfiguration?: LivePreRollConfiguration;
|
|
3205
3205
|
/**
|
|
3206
|
-
* @public
|
|
3207
3206
|
* <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
|
|
3207
|
+
* @public
|
|
3208
3208
|
*/
|
|
3209
3209
|
ManifestProcessingRules?: ManifestProcessingRules;
|
|
3210
3210
|
/**
|
|
3211
|
-
* @public
|
|
3212
3211
|
* <p>The identifier for the playback configuration.</p>
|
|
3212
|
+
* @public
|
|
3213
3213
|
*/
|
|
3214
3214
|
Name: string | undefined;
|
|
3215
3215
|
/**
|
|
3216
|
-
* @public
|
|
3217
3216
|
* <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>
|
|
3217
|
+
* @public
|
|
3218
3218
|
*/
|
|
3219
3219
|
PersonalizationThresholdSeconds?: number;
|
|
3220
3220
|
/**
|
|
3221
|
-
* @public
|
|
3222
3221
|
* <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>
|
|
3222
|
+
* @public
|
|
3223
3223
|
*/
|
|
3224
3224
|
SlateAdUrl?: string;
|
|
3225
3225
|
/**
|
|
3226
|
-
* @public
|
|
3227
3226
|
* <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>
|
|
3227
|
+
* @public
|
|
3228
3228
|
*/
|
|
3229
3229
|
Tags?: Record<string, string>;
|
|
3230
3230
|
/**
|
|
3231
|
-
* @public
|
|
3232
3231
|
* <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>
|
|
3232
|
+
* @public
|
|
3233
3233
|
*/
|
|
3234
3234
|
TranscodeProfileName?: string;
|
|
3235
3235
|
/**
|
|
3236
|
-
* @public
|
|
3237
3236
|
* <p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>
|
|
3237
|
+
* @public
|
|
3238
3238
|
*/
|
|
3239
3239
|
VideoContentSourceUrl?: string;
|
|
3240
3240
|
}
|
|
@@ -3243,98 +3243,98 @@ export interface PutPlaybackConfigurationRequest {
|
|
|
3243
3243
|
*/
|
|
3244
3244
|
export interface PutPlaybackConfigurationResponse {
|
|
3245
3245
|
/**
|
|
3246
|
-
* @public
|
|
3247
3246
|
* <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>
|
|
3247
|
+
* @public
|
|
3248
3248
|
*/
|
|
3249
3249
|
AdDecisionServerUrl?: string;
|
|
3250
3250
|
/**
|
|
3251
|
-
* @public
|
|
3252
3251
|
* <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>
|
|
3252
|
+
* @public
|
|
3253
3253
|
*/
|
|
3254
3254
|
AvailSuppression?: AvailSuppression;
|
|
3255
3255
|
/**
|
|
3256
|
-
* @public
|
|
3257
3256
|
* <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>
|
|
3257
|
+
* @public
|
|
3258
3258
|
*/
|
|
3259
3259
|
Bumper?: Bumper;
|
|
3260
3260
|
/**
|
|
3261
|
-
* @public
|
|
3262
3261
|
* <p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>
|
|
3262
|
+
* @public
|
|
3263
3263
|
*/
|
|
3264
3264
|
CdnConfiguration?: CdnConfiguration;
|
|
3265
3265
|
/**
|
|
3266
|
-
* @public
|
|
3267
3266
|
* <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>
|
|
3267
|
+
* @public
|
|
3268
3268
|
*/
|
|
3269
3269
|
ConfigurationAliases?: Record<string, Record<string, string>>;
|
|
3270
3270
|
/**
|
|
3271
|
-
* @public
|
|
3272
3271
|
* <p>The configuration for DASH content.</p>
|
|
3272
|
+
* @public
|
|
3273
3273
|
*/
|
|
3274
3274
|
DashConfiguration?: DashConfiguration;
|
|
3275
3275
|
/**
|
|
3276
|
-
* @public
|
|
3277
3276
|
* <p>The configuration for HLS content.</p>
|
|
3277
|
+
* @public
|
|
3278
3278
|
*/
|
|
3279
3279
|
HlsConfiguration?: HlsConfiguration;
|
|
3280
3280
|
/**
|
|
3281
|
-
* @public
|
|
3282
3281
|
* <p>The configuration for pre-roll ad insertion.</p>
|
|
3282
|
+
* @public
|
|
3283
3283
|
*/
|
|
3284
3284
|
LivePreRollConfiguration?: LivePreRollConfiguration;
|
|
3285
3285
|
/**
|
|
3286
|
-
* @public
|
|
3287
3286
|
* <p>The Amazon CloudWatch log settings for a playback configuration.</p>
|
|
3287
|
+
* @public
|
|
3288
3288
|
*/
|
|
3289
3289
|
LogConfiguration?: LogConfiguration;
|
|
3290
3290
|
/**
|
|
3291
|
-
* @public
|
|
3292
3291
|
* <p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>
|
|
3292
|
+
* @public
|
|
3293
3293
|
*/
|
|
3294
3294
|
ManifestProcessingRules?: ManifestProcessingRules;
|
|
3295
3295
|
/**
|
|
3296
|
-
* @public
|
|
3297
3296
|
* <p>The identifier for the playback configuration.</p>
|
|
3297
|
+
* @public
|
|
3298
3298
|
*/
|
|
3299
3299
|
Name?: string;
|
|
3300
3300
|
/**
|
|
3301
|
-
* @public
|
|
3302
3301
|
* <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>
|
|
3302
|
+
* @public
|
|
3303
3303
|
*/
|
|
3304
3304
|
PersonalizationThresholdSeconds?: number;
|
|
3305
3305
|
/**
|
|
3306
|
-
* @public
|
|
3307
3306
|
* <p>The Amazon Resource Name (ARN) associated with the playback configuration.</p>
|
|
3307
|
+
* @public
|
|
3308
3308
|
*/
|
|
3309
3309
|
PlaybackConfigurationArn?: string;
|
|
3310
3310
|
/**
|
|
3311
|
-
* @public
|
|
3312
3311
|
* <p>The playback endpoint prefix associated with the playback configuration.</p>
|
|
3312
|
+
* @public
|
|
3313
3313
|
*/
|
|
3314
3314
|
PlaybackEndpointPrefix?: string;
|
|
3315
3315
|
/**
|
|
3316
|
-
* @public
|
|
3317
3316
|
* <p>The session initialization endpoint prefix associated with the playback configuration.</p>
|
|
3317
|
+
* @public
|
|
3318
3318
|
*/
|
|
3319
3319
|
SessionInitializationEndpointPrefix?: string;
|
|
3320
3320
|
/**
|
|
3321
|
-
* @public
|
|
3322
3321
|
* <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>
|
|
3322
|
+
* @public
|
|
3323
3323
|
*/
|
|
3324
3324
|
SlateAdUrl?: string;
|
|
3325
3325
|
/**
|
|
3326
|
-
* @public
|
|
3327
3326
|
* <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>
|
|
3327
|
+
* @public
|
|
3328
3328
|
*/
|
|
3329
3329
|
Tags?: Record<string, string>;
|
|
3330
3330
|
/**
|
|
3331
|
-
* @public
|
|
3332
3331
|
* <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>
|
|
3332
|
+
* @public
|
|
3333
3333
|
*/
|
|
3334
3334
|
TranscodeProfileName?: string;
|
|
3335
3335
|
/**
|
|
3336
|
-
* @public
|
|
3337
3336
|
* <p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>
|
|
3337
|
+
* @public
|
|
3338
3338
|
*/
|
|
3339
3339
|
VideoContentSourceUrl?: string;
|
|
3340
3340
|
}
|
|
@@ -3343,28 +3343,28 @@ export interface PutPlaybackConfigurationResponse {
|
|
|
3343
3343
|
*/
|
|
3344
3344
|
export interface UpdateSourceLocationRequest {
|
|
3345
3345
|
/**
|
|
3346
|
-
* @public
|
|
3347
3346
|
* <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
|
|
3347
|
+
* @public
|
|
3348
3348
|
*/
|
|
3349
3349
|
AccessConfiguration?: AccessConfiguration;
|
|
3350
3350
|
/**
|
|
3351
|
-
* @public
|
|
3352
3351
|
* <p>The optional configuration for the host server that serves segments.</p>
|
|
3352
|
+
* @public
|
|
3353
3353
|
*/
|
|
3354
3354
|
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
|
|
3355
3355
|
/**
|
|
3356
|
-
* @public
|
|
3357
3356
|
* <p>The HTTP configuration for the source location.</p>
|
|
3357
|
+
* @public
|
|
3358
3358
|
*/
|
|
3359
3359
|
HttpConfiguration: HttpConfiguration | undefined;
|
|
3360
3360
|
/**
|
|
3361
|
-
* @public
|
|
3362
3361
|
* <p>A list of the segment delivery configurations associated with this resource.</p>
|
|
3362
|
+
* @public
|
|
3363
3363
|
*/
|
|
3364
3364
|
SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
|
|
3365
3365
|
/**
|
|
3366
|
-
* @public
|
|
3367
3366
|
* <p>The name of the source location.</p>
|
|
3367
|
+
* @public
|
|
3368
3368
|
*/
|
|
3369
3369
|
SourceLocationName: string | undefined;
|
|
3370
3370
|
}
|
|
@@ -3373,48 +3373,48 @@ export interface UpdateSourceLocationRequest {
|
|
|
3373
3373
|
*/
|
|
3374
3374
|
export interface UpdateSourceLocationResponse {
|
|
3375
3375
|
/**
|
|
3376
|
-
* @public
|
|
3377
3376
|
* <p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>
|
|
3377
|
+
* @public
|
|
3378
3378
|
*/
|
|
3379
3379
|
AccessConfiguration?: AccessConfiguration;
|
|
3380
3380
|
/**
|
|
3381
|
-
* @public
|
|
3382
3381
|
* <p>The Amazon Resource Name (ARN) associated with the source location.</p>
|
|
3382
|
+
* @public
|
|
3383
3383
|
*/
|
|
3384
3384
|
Arn?: string;
|
|
3385
3385
|
/**
|
|
3386
|
-
* @public
|
|
3387
3386
|
* <p>The timestamp that indicates when the source location was created.</p>
|
|
3387
|
+
* @public
|
|
3388
3388
|
*/
|
|
3389
3389
|
CreationTime?: Date;
|
|
3390
3390
|
/**
|
|
3391
|
-
* @public
|
|
3392
3391
|
* <p>The optional configuration for the host server that serves segments.</p>
|
|
3392
|
+
* @public
|
|
3393
3393
|
*/
|
|
3394
3394
|
DefaultSegmentDeliveryConfiguration?: DefaultSegmentDeliveryConfiguration;
|
|
3395
3395
|
/**
|
|
3396
|
-
* @public
|
|
3397
3396
|
* <p>The HTTP configuration for the source location.</p>
|
|
3397
|
+
* @public
|
|
3398
3398
|
*/
|
|
3399
3399
|
HttpConfiguration?: HttpConfiguration;
|
|
3400
3400
|
/**
|
|
3401
|
-
* @public
|
|
3402
3401
|
* <p>The timestamp that indicates when the source location was last modified.</p>
|
|
3402
|
+
* @public
|
|
3403
3403
|
*/
|
|
3404
3404
|
LastModifiedTime?: Date;
|
|
3405
3405
|
/**
|
|
3406
|
-
* @public
|
|
3407
3406
|
* <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>
|
|
3407
|
+
* @public
|
|
3408
3408
|
*/
|
|
3409
3409
|
SegmentDeliveryConfigurations?: SegmentDeliveryConfiguration[];
|
|
3410
3410
|
/**
|
|
3411
|
-
* @public
|
|
3412
3411
|
* <p>The name of the source location.</p>
|
|
3412
|
+
* @public
|
|
3413
3413
|
*/
|
|
3414
3414
|
SourceLocationName?: string;
|
|
3415
3415
|
/**
|
|
3416
|
-
* @public
|
|
3417
3416
|
* <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>
|
|
3417
|
+
* @public
|
|
3418
3418
|
*/
|
|
3419
3419
|
Tags?: Record<string, string>;
|
|
3420
3420
|
}
|
|
@@ -3423,13 +3423,13 @@ export interface UpdateSourceLocationResponse {
|
|
|
3423
3423
|
*/
|
|
3424
3424
|
export interface TagResourceRequest {
|
|
3425
3425
|
/**
|
|
3426
|
-
* @public
|
|
3427
3426
|
* <p>The Amazon Resource Name (ARN) associated with the resource.</p>
|
|
3427
|
+
* @public
|
|
3428
3428
|
*/
|
|
3429
3429
|
ResourceArn: string | undefined;
|
|
3430
3430
|
/**
|
|
3431
|
-
* @public
|
|
3432
3431
|
* <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>
|
|
3432
|
+
* @public
|
|
3433
3433
|
*/
|
|
3434
3434
|
Tags: Record<string, string> | undefined;
|
|
3435
3435
|
}
|
|
@@ -3438,13 +3438,13 @@ export interface TagResourceRequest {
|
|
|
3438
3438
|
*/
|
|
3439
3439
|
export interface UntagResourceRequest {
|
|
3440
3440
|
/**
|
|
3441
|
-
* @public
|
|
3442
3441
|
* <p>The Amazon Resource Name (ARN) of the resource to untag.</p>
|
|
3442
|
+
* @public
|
|
3443
3443
|
*/
|
|
3444
3444
|
ResourceArn: string | undefined;
|
|
3445
3445
|
/**
|
|
3446
|
-
* @public
|
|
3447
3446
|
* <p>The tag keys associated with the resource.</p>
|
|
3447
|
+
* @public
|
|
3448
3448
|
*/
|
|
3449
3449
|
TagKeys: string[] | undefined;
|
|
3450
3450
|
}
|
|
@@ -3453,18 +3453,18 @@ export interface UntagResourceRequest {
|
|
|
3453
3453
|
*/
|
|
3454
3454
|
export interface UpdateVodSourceRequest {
|
|
3455
3455
|
/**
|
|
3456
|
-
* @public
|
|
3457
3456
|
* <p>A list of HTTP package configurations for the VOD source on this account.</p>
|
|
3457
|
+
* @public
|
|
3458
3458
|
*/
|
|
3459
3459
|
HttpPackageConfigurations: HttpPackageConfiguration[] | undefined;
|
|
3460
3460
|
/**
|
|
3461
|
-
* @public
|
|
3462
3461
|
* <p>The name of the source location associated with this VOD Source.</p>
|
|
3462
|
+
* @public
|
|
3463
3463
|
*/
|
|
3464
3464
|
SourceLocationName: string | undefined;
|
|
3465
3465
|
/**
|
|
3466
|
-
* @public
|
|
3467
3466
|
* <p>The name of the VOD source.</p>
|
|
3467
|
+
* @public
|
|
3468
3468
|
*/
|
|
3469
3469
|
VodSourceName: string | undefined;
|
|
3470
3470
|
}
|
|
@@ -3473,38 +3473,38 @@ export interface UpdateVodSourceRequest {
|
|
|
3473
3473
|
*/
|
|
3474
3474
|
export interface UpdateVodSourceResponse {
|
|
3475
3475
|
/**
|
|
3476
|
-
* @public
|
|
3477
3476
|
* <p>The Amazon Resource Name (ARN) associated with the VOD source.</p>
|
|
3477
|
+
* @public
|
|
3478
3478
|
*/
|
|
3479
3479
|
Arn?: string;
|
|
3480
3480
|
/**
|
|
3481
|
-
* @public
|
|
3482
3481
|
* <p>The timestamp that indicates when the VOD source was created.</p>
|
|
3482
|
+
* @public
|
|
3483
3483
|
*/
|
|
3484
3484
|
CreationTime?: Date;
|
|
3485
3485
|
/**
|
|
3486
|
-
* @public
|
|
3487
3486
|
* <p>A list of HTTP package configurations for the VOD source on this account.</p>
|
|
3487
|
+
* @public
|
|
3488
3488
|
*/
|
|
3489
3489
|
HttpPackageConfigurations?: HttpPackageConfiguration[];
|
|
3490
3490
|
/**
|
|
3491
|
-
* @public
|
|
3492
3491
|
* <p>The timestamp that indicates when the VOD source was last modified.</p>
|
|
3492
|
+
* @public
|
|
3493
3493
|
*/
|
|
3494
3494
|
LastModifiedTime?: Date;
|
|
3495
3495
|
/**
|
|
3496
|
-
* @public
|
|
3497
3496
|
* <p>The name of the source location associated with the VOD source.</p>
|
|
3497
|
+
* @public
|
|
3498
3498
|
*/
|
|
3499
3499
|
SourceLocationName?: string;
|
|
3500
3500
|
/**
|
|
3501
|
-
* @public
|
|
3502
3501
|
* <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>
|
|
3502
|
+
* @public
|
|
3503
3503
|
*/
|
|
3504
3504
|
Tags?: Record<string, string>;
|
|
3505
3505
|
/**
|
|
3506
|
-
* @public
|
|
3507
3506
|
* <p>The name of the VOD source.</p>
|
|
3507
|
+
* @public
|
|
3508
3508
|
*/
|
|
3509
3509
|
VodSourceName?: string;
|
|
3510
3510
|
}
|