UNPKG

35.8 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class MediaPackage extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: MediaPackage.Types.ClientConfiguration)
13 config: Config & MediaPackage.Types.ClientConfiguration;
14 /**
15 * Creates a new Channel.
16 */
17 createChannel(params: MediaPackage.Types.CreateChannelRequest, callback?: (err: AWSError, data: MediaPackage.Types.CreateChannelResponse) => void): Request<MediaPackage.Types.CreateChannelResponse, AWSError>;
18 /**
19 * Creates a new Channel.
20 */
21 createChannel(callback?: (err: AWSError, data: MediaPackage.Types.CreateChannelResponse) => void): Request<MediaPackage.Types.CreateChannelResponse, AWSError>;
22 /**
23 * Creates a new OriginEndpoint record.
24 */
25 createOriginEndpoint(params: MediaPackage.Types.CreateOriginEndpointRequest, callback?: (err: AWSError, data: MediaPackage.Types.CreateOriginEndpointResponse) => void): Request<MediaPackage.Types.CreateOriginEndpointResponse, AWSError>;
26 /**
27 * Creates a new OriginEndpoint record.
28 */
29 createOriginEndpoint(callback?: (err: AWSError, data: MediaPackage.Types.CreateOriginEndpointResponse) => void): Request<MediaPackage.Types.CreateOriginEndpointResponse, AWSError>;
30 /**
31 * Deletes an existing Channel.
32 */
33 deleteChannel(params: MediaPackage.Types.DeleteChannelRequest, callback?: (err: AWSError, data: MediaPackage.Types.DeleteChannelResponse) => void): Request<MediaPackage.Types.DeleteChannelResponse, AWSError>;
34 /**
35 * Deletes an existing Channel.
36 */
37 deleteChannel(callback?: (err: AWSError, data: MediaPackage.Types.DeleteChannelResponse) => void): Request<MediaPackage.Types.DeleteChannelResponse, AWSError>;
38 /**
39 * Deletes an existing OriginEndpoint.
40 */
41 deleteOriginEndpoint(params: MediaPackage.Types.DeleteOriginEndpointRequest, callback?: (err: AWSError, data: MediaPackage.Types.DeleteOriginEndpointResponse) => void): Request<MediaPackage.Types.DeleteOriginEndpointResponse, AWSError>;
42 /**
43 * Deletes an existing OriginEndpoint.
44 */
45 deleteOriginEndpoint(callback?: (err: AWSError, data: MediaPackage.Types.DeleteOriginEndpointResponse) => void): Request<MediaPackage.Types.DeleteOriginEndpointResponse, AWSError>;
46 /**
47 * Gets details about a Channel.
48 */
49 describeChannel(params: MediaPackage.Types.DescribeChannelRequest, callback?: (err: AWSError, data: MediaPackage.Types.DescribeChannelResponse) => void): Request<MediaPackage.Types.DescribeChannelResponse, AWSError>;
50 /**
51 * Gets details about a Channel.
52 */
53 describeChannel(callback?: (err: AWSError, data: MediaPackage.Types.DescribeChannelResponse) => void): Request<MediaPackage.Types.DescribeChannelResponse, AWSError>;
54 /**
55 * Gets details about an existing OriginEndpoint.
56 */
57 describeOriginEndpoint(params: MediaPackage.Types.DescribeOriginEndpointRequest, callback?: (err: AWSError, data: MediaPackage.Types.DescribeOriginEndpointResponse) => void): Request<MediaPackage.Types.DescribeOriginEndpointResponse, AWSError>;
58 /**
59 * Gets details about an existing OriginEndpoint.
60 */
61 describeOriginEndpoint(callback?: (err: AWSError, data: MediaPackage.Types.DescribeOriginEndpointResponse) => void): Request<MediaPackage.Types.DescribeOriginEndpointResponse, AWSError>;
62 /**
63 * Returns a collection of Channels.
64 */
65 listChannels(params: MediaPackage.Types.ListChannelsRequest, callback?: (err: AWSError, data: MediaPackage.Types.ListChannelsResponse) => void): Request<MediaPackage.Types.ListChannelsResponse, AWSError>;
66 /**
67 * Returns a collection of Channels.
68 */
69 listChannels(callback?: (err: AWSError, data: MediaPackage.Types.ListChannelsResponse) => void): Request<MediaPackage.Types.ListChannelsResponse, AWSError>;
70 /**
71 * Returns a collection of OriginEndpoint records.
72 */
73 listOriginEndpoints(params: MediaPackage.Types.ListOriginEndpointsRequest, callback?: (err: AWSError, data: MediaPackage.Types.ListOriginEndpointsResponse) => void): Request<MediaPackage.Types.ListOriginEndpointsResponse, AWSError>;
74 /**
75 * Returns a collection of OriginEndpoint records.
76 */
77 listOriginEndpoints(callback?: (err: AWSError, data: MediaPackage.Types.ListOriginEndpointsResponse) => void): Request<MediaPackage.Types.ListOriginEndpointsResponse, AWSError>;
78 /**
79 *
80 */
81 listTagsForResource(params: MediaPackage.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: MediaPackage.Types.ListTagsForResourceResponse) => void): Request<MediaPackage.Types.ListTagsForResourceResponse, AWSError>;
82 /**
83 *
84 */
85 listTagsForResource(callback?: (err: AWSError, data: MediaPackage.Types.ListTagsForResourceResponse) => void): Request<MediaPackage.Types.ListTagsForResourceResponse, AWSError>;
86 /**
87 * Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead
88 */
89 rotateChannelCredentials(params: MediaPackage.Types.RotateChannelCredentialsRequest, callback?: (err: AWSError, data: MediaPackage.Types.RotateChannelCredentialsResponse) => void): Request<MediaPackage.Types.RotateChannelCredentialsResponse, AWSError>;
90 /**
91 * Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead
92 */
93 rotateChannelCredentials(callback?: (err: AWSError, data: MediaPackage.Types.RotateChannelCredentialsResponse) => void): Request<MediaPackage.Types.RotateChannelCredentialsResponse, AWSError>;
94 /**
95 * Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.
96 */
97 rotateIngestEndpointCredentials(params: MediaPackage.Types.RotateIngestEndpointCredentialsRequest, callback?: (err: AWSError, data: MediaPackage.Types.RotateIngestEndpointCredentialsResponse) => void): Request<MediaPackage.Types.RotateIngestEndpointCredentialsResponse, AWSError>;
98 /**
99 * Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.
100 */
101 rotateIngestEndpointCredentials(callback?: (err: AWSError, data: MediaPackage.Types.RotateIngestEndpointCredentialsResponse) => void): Request<MediaPackage.Types.RotateIngestEndpointCredentialsResponse, AWSError>;
102 /**
103 *
104 */
105 tagResource(params: MediaPackage.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
106 /**
107 *
108 */
109 tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
110 /**
111 *
112 */
113 untagResource(params: MediaPackage.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
114 /**
115 *
116 */
117 untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
118 /**
119 * Updates an existing Channel.
120 */
121 updateChannel(params: MediaPackage.Types.UpdateChannelRequest, callback?: (err: AWSError, data: MediaPackage.Types.UpdateChannelResponse) => void): Request<MediaPackage.Types.UpdateChannelResponse, AWSError>;
122 /**
123 * Updates an existing Channel.
124 */
125 updateChannel(callback?: (err: AWSError, data: MediaPackage.Types.UpdateChannelResponse) => void): Request<MediaPackage.Types.UpdateChannelResponse, AWSError>;
126 /**
127 * Updates an existing OriginEndpoint.
128 */
129 updateOriginEndpoint(params: MediaPackage.Types.UpdateOriginEndpointRequest, callback?: (err: AWSError, data: MediaPackage.Types.UpdateOriginEndpointResponse) => void): Request<MediaPackage.Types.UpdateOriginEndpointResponse, AWSError>;
130 /**
131 * Updates an existing OriginEndpoint.
132 */
133 updateOriginEndpoint(callback?: (err: AWSError, data: MediaPackage.Types.UpdateOriginEndpointResponse) => void): Request<MediaPackage.Types.UpdateOriginEndpointResponse, AWSError>;
134}
135declare namespace MediaPackage {
136 export type AdMarkers = "NONE"|"SCTE35_ENHANCED"|"PASSTHROUGH"|string;
137 export interface Channel {
138 /**
139 * The Amazon Resource Name (ARN) assigned to the Channel.
140 */
141 Arn?: __string;
142 /**
143 * A short text description of the Channel.
144 */
145 Description?: __string;
146 HlsIngest?: HlsIngest;
147 /**
148 * The ID of the Channel.
149 */
150 Id?: __string;
151 Tags?: Tags;
152 }
153 export interface CmafEncryption {
154 /**
155 * Time (in seconds) between each encryption key rotation.
156 */
157 KeyRotationIntervalSeconds?: __integer;
158 SpekeKeyProvider: SpekeKeyProvider;
159 }
160 export interface CmafPackage {
161 Encryption?: CmafEncryption;
162 /**
163 * A list of HLS manifest configurations
164 */
165 HlsManifests?: __listOfHlsManifest;
166 /**
167 * Duration (in seconds) of each segment. Actual segments will be
168rounded to the nearest multiple of the source segment duration.
169
170 */
171 SegmentDurationSeconds?: __integer;
172 /**
173 * An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
174 */
175 SegmentPrefix?: __string;
176 StreamSelection?: StreamSelection;
177 }
178 export interface CmafPackageCreateOrUpdateParameters {
179 Encryption?: CmafEncryption;
180 /**
181 * A list of HLS manifest configurations
182 */
183 HlsManifests?: __listOfHlsManifestCreateOrUpdateParameters;
184 /**
185 * Duration (in seconds) of each segment. Actual segments will be
186rounded to the nearest multiple of the source segment duration.
187
188 */
189 SegmentDurationSeconds?: __integer;
190 /**
191 * An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.
192 */
193 SegmentPrefix?: __string;
194 StreamSelection?: StreamSelection;
195 }
196 export interface CreateChannelRequest {
197 /**
198 * A short text description of the Channel.
199 */
200 Description?: __string;
201 /**
202 * The ID of the Channel. The ID must be unique within the region and it
203cannot be changed after a Channel is created.
204
205 */
206 Id: __string;
207 Tags?: Tags;
208 }
209 export interface CreateChannelResponse {
210 /**
211 * The Amazon Resource Name (ARN) assigned to the Channel.
212 */
213 Arn?: __string;
214 /**
215 * A short text description of the Channel.
216 */
217 Description?: __string;
218 HlsIngest?: HlsIngest;
219 /**
220 * The ID of the Channel.
221 */
222 Id?: __string;
223 Tags?: Tags;
224 }
225 export interface CreateOriginEndpointRequest {
226 /**
227 * The ID of the Channel that the OriginEndpoint will be associated with.
228This cannot be changed after the OriginEndpoint is created.
229
230 */
231 ChannelId: __string;
232 CmafPackage?: CmafPackageCreateOrUpdateParameters;
233 DashPackage?: DashPackage;
234 /**
235 * A short text description of the OriginEndpoint.
236 */
237 Description?: __string;
238 HlsPackage?: HlsPackage;
239 /**
240 * The ID of the OriginEndpoint. The ID must be unique within the region
241and it cannot be changed after the OriginEndpoint is created.
242
243 */
244 Id: __string;
245 /**
246 * A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index").
247 */
248 ManifestName?: __string;
249 MssPackage?: MssPackage;
250 /**
251 * Maximum duration (seconds) of content to retain for startover playback.
252If not specified, startover playback will be disabled for the OriginEndpoint.
253
254 */
255 StartoverWindowSeconds?: __integer;
256 Tags?: Tags;
257 /**
258 * Amount of delay (seconds) to enforce on the playback of live content.
259If not specified, there will be no time delay in effect for the OriginEndpoint.
260
261 */
262 TimeDelaySeconds?: __integer;
263 /**
264 * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
265 */
266 Whitelist?: __listOf__string;
267 }
268 export interface CreateOriginEndpointResponse {
269 /**
270 * The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
271 */
272 Arn?: __string;
273 /**
274 * The ID of the Channel the OriginEndpoint is associated with.
275 */
276 ChannelId?: __string;
277 CmafPackage?: CmafPackage;
278 DashPackage?: DashPackage;
279 /**
280 * A short text description of the OriginEndpoint.
281 */
282 Description?: __string;
283 HlsPackage?: HlsPackage;
284 /**
285 * The ID of the OriginEndpoint.
286 */
287 Id?: __string;
288 /**
289 * A short string appended to the end of the OriginEndpoint URL.
290 */
291 ManifestName?: __string;
292 MssPackage?: MssPackage;
293 /**
294 * Maximum duration (seconds) of content to retain for startover playback.
295If not specified, startover playback will be disabled for the OriginEndpoint.
296
297 */
298 StartoverWindowSeconds?: __integer;
299 Tags?: Tags;
300 /**
301 * Amount of delay (seconds) to enforce on the playback of live content.
302If not specified, there will be no time delay in effect for the OriginEndpoint.
303
304 */
305 TimeDelaySeconds?: __integer;
306 /**
307 * The URL of the packaged OriginEndpoint for consumption.
308 */
309 Url?: __string;
310 /**
311 * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
312 */
313 Whitelist?: __listOf__string;
314 }
315 export interface DashEncryption {
316 /**
317 * Time (in seconds) between each encryption key rotation.
318 */
319 KeyRotationIntervalSeconds?: __integer;
320 SpekeKeyProvider: SpekeKeyProvider;
321 }
322 export interface DashPackage {
323 Encryption?: DashEncryption;
324 /**
325 * Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.
326 */
327 ManifestLayout?: ManifestLayout;
328 /**
329 * Time window (in seconds) contained in each manifest.
330 */
331 ManifestWindowSeconds?: __integer;
332 /**
333 * Minimum duration (in seconds) that a player will buffer media before starting the presentation.
334 */
335 MinBufferTimeSeconds?: __integer;
336 /**
337 * Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).
338 */
339 MinUpdatePeriodSeconds?: __integer;
340 /**
341 * A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH)
342Media Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not
343be partitioned into more than one period. If the list contains "ADS", new periods will be created where
344the Channel source contains SCTE-35 ad markers.
345
346 */
347 PeriodTriggers?: __listOf__PeriodTriggersElement;
348 /**
349 * The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output is enabled.
350 */
351 Profile?: Profile;
352 /**
353 * Duration (in seconds) of each segment. Actual segments will be
354rounded to the nearest multiple of the source segment duration.
355
356 */
357 SegmentDurationSeconds?: __integer;
358 /**
359 * Determines the type of SegmentTimeline included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs.
360 */
361 SegmentTemplateFormat?: SegmentTemplateFormat;
362 StreamSelection?: StreamSelection;
363 /**
364 * Duration (in seconds) to delay live content before presentation.
365 */
366 SuggestedPresentationDelaySeconds?: __integer;
367 }
368 export interface DeleteChannelRequest {
369 /**
370 * The ID of the Channel to delete.
371 */
372 Id: __string;
373 }
374 export interface DeleteChannelResponse {
375 }
376 export interface DeleteOriginEndpointRequest {
377 /**
378 * The ID of the OriginEndpoint to delete.
379 */
380 Id: __string;
381 }
382 export interface DeleteOriginEndpointResponse {
383 }
384 export interface DescribeChannelRequest {
385 /**
386 * The ID of a Channel.
387 */
388 Id: __string;
389 }
390 export interface DescribeChannelResponse {
391 /**
392 * The Amazon Resource Name (ARN) assigned to the Channel.
393 */
394 Arn?: __string;
395 /**
396 * A short text description of the Channel.
397 */
398 Description?: __string;
399 HlsIngest?: HlsIngest;
400 /**
401 * The ID of the Channel.
402 */
403 Id?: __string;
404 Tags?: Tags;
405 }
406 export interface DescribeOriginEndpointRequest {
407 /**
408 * The ID of the OriginEndpoint.
409 */
410 Id: __string;
411 }
412 export interface DescribeOriginEndpointResponse {
413 /**
414 * The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
415 */
416 Arn?: __string;
417 /**
418 * The ID of the Channel the OriginEndpoint is associated with.
419 */
420 ChannelId?: __string;
421 CmafPackage?: CmafPackage;
422 DashPackage?: DashPackage;
423 /**
424 * A short text description of the OriginEndpoint.
425 */
426 Description?: __string;
427 HlsPackage?: HlsPackage;
428 /**
429 * The ID of the OriginEndpoint.
430 */
431 Id?: __string;
432 /**
433 * A short string appended to the end of the OriginEndpoint URL.
434 */
435 ManifestName?: __string;
436 MssPackage?: MssPackage;
437 /**
438 * Maximum duration (seconds) of content to retain for startover playback.
439If not specified, startover playback will be disabled for the OriginEndpoint.
440
441 */
442 StartoverWindowSeconds?: __integer;
443 Tags?: Tags;
444 /**
445 * Amount of delay (seconds) to enforce on the playback of live content.
446If not specified, there will be no time delay in effect for the OriginEndpoint.
447
448 */
449 TimeDelaySeconds?: __integer;
450 /**
451 * The URL of the packaged OriginEndpoint for consumption.
452 */
453 Url?: __string;
454 /**
455 * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
456 */
457 Whitelist?: __listOf__string;
458 }
459 export type EncryptionMethod = "AES_128"|"SAMPLE_AES"|string;
460 export interface HlsEncryption {
461 /**
462 * A constant initialization vector for encryption (optional).
463When not specified the initialization vector will be periodically rotated.
464
465 */
466 ConstantInitializationVector?: __string;
467 /**
468 * The encryption method to use.
469 */
470 EncryptionMethod?: EncryptionMethod;
471 /**
472 * Interval (in seconds) between each encryption key rotation.
473 */
474 KeyRotationIntervalSeconds?: __integer;
475 /**
476 * When enabled, the EXT-X-KEY tag will be repeated in output manifests.
477 */
478 RepeatExtXKey?: __boolean;
479 SpekeKeyProvider: SpekeKeyProvider;
480 }
481 export interface HlsIngest {
482 /**
483 * A list of endpoints to which the source stream should be sent.
484 */
485 IngestEndpoints?: __listOfIngestEndpoint;
486 }
487 export interface HlsManifest {
488 /**
489 * This setting controls how ad markers are included in the packaged OriginEndpoint.
490"NONE" will omit all SCTE-35 ad markers from the output.
491"PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad
492markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.
493"SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35
494messages in the input source.
495
496 */
497 AdMarkers?: AdMarkers;
498 /**
499 * The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.
500 */
501 Id: __string;
502 /**
503 * When enabled, an I-Frame only stream will be included in the output.
504 */
505 IncludeIframeOnlyStream?: __boolean;
506 /**
507 * An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.
508 */
509 ManifestName?: __string;
510 /**
511 * The HTTP Live Streaming (HLS) playlist type.
512When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE
513entry will be included in the media playlist.
514
515 */
516 PlaylistType?: PlaylistType;
517 /**
518 * Time window (in seconds) contained in each parent manifest.
519 */
520 PlaylistWindowSeconds?: __integer;
521 /**
522 * The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag
523inserted into manifests. Additionally, when an interval is specified
524ID3Timed Metadata messages will be generated every 5 seconds using the
525ingest time of the content.
526If the interval is not specified, or set to 0, then
527no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no
528ID3Timed Metadata messages will be generated. Note that irrespective
529of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,
530it will be passed through to HLS output.
531
532 */
533 ProgramDateTimeIntervalSeconds?: __integer;
534 /**
535 * The URL of the packaged OriginEndpoint for consumption.
536 */
537 Url?: __string;
538 }
539 export interface HlsManifestCreateOrUpdateParameters {
540 /**
541 * This setting controls how ad markers are included in the packaged OriginEndpoint.
542"NONE" will omit all SCTE-35 ad markers from the output.
543"PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad
544markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.
545"SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35
546messages in the input source.
547
548 */
549 AdMarkers?: AdMarkers;
550 /**
551 * The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.
552 */
553 Id: __string;
554 /**
555 * When enabled, an I-Frame only stream will be included in the output.
556 */
557 IncludeIframeOnlyStream?: __boolean;
558 /**
559 * An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.
560 */
561 ManifestName?: __string;
562 /**
563 * The HTTP Live Streaming (HLS) playlist type.
564When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE
565entry will be included in the media playlist.
566
567 */
568 PlaylistType?: PlaylistType;
569 /**
570 * Time window (in seconds) contained in each parent manifest.
571 */
572 PlaylistWindowSeconds?: __integer;
573 /**
574 * The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag
575inserted into manifests. Additionally, when an interval is specified
576ID3Timed Metadata messages will be generated every 5 seconds using the
577ingest time of the content.
578If the interval is not specified, or set to 0, then
579no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no
580ID3Timed Metadata messages will be generated. Note that irrespective
581of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,
582it will be passed through to HLS output.
583
584 */
585 ProgramDateTimeIntervalSeconds?: __integer;
586 }
587 export interface HlsPackage {
588 /**
589 * This setting controls how ad markers are included in the packaged OriginEndpoint.
590"NONE" will omit all SCTE-35 ad markers from the output.
591"PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad
592markers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.
593"SCTE35_ENHANCED" generates ad markers and blackout tags based on SCTE-35
594messages in the input source.
595
596 */
597 AdMarkers?: AdMarkers;
598 Encryption?: HlsEncryption;
599 /**
600 * When enabled, an I-Frame only stream will be included in the output.
601 */
602 IncludeIframeOnlyStream?: __boolean;
603 /**
604 * The HTTP Live Streaming (HLS) playlist type.
605When either "EVENT" or "VOD" is specified, a corresponding EXT-X-PLAYLIST-TYPE
606entry will be included in the media playlist.
607
608 */
609 PlaylistType?: PlaylistType;
610 /**
611 * Time window (in seconds) contained in each parent manifest.
612 */
613 PlaylistWindowSeconds?: __integer;
614 /**
615 * The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag
616inserted into manifests. Additionally, when an interval is specified
617ID3Timed Metadata messages will be generated every 5 seconds using the
618ingest time of the content.
619If the interval is not specified, or set to 0, then
620no EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no
621ID3Timed Metadata messages will be generated. Note that irrespective
622of this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,
623it will be passed through to HLS output.
624
625 */
626 ProgramDateTimeIntervalSeconds?: __integer;
627 /**
628 * Duration (in seconds) of each fragment. Actual fragments will be
629rounded to the nearest multiple of the source fragment duration.
630
631 */
632 SegmentDurationSeconds?: __integer;
633 StreamSelection?: StreamSelection;
634 /**
635 * When enabled, audio streams will be placed in rendition groups in the output.
636 */
637 UseAudioRenditionGroup?: __boolean;
638 }
639 export interface IngestEndpoint {
640 /**
641 * The system generated unique identifier for the IngestEndpoint
642 */
643 Id?: __string;
644 /**
645 * The system generated password for ingest authentication.
646 */
647 Password?: __string;
648 /**
649 * The ingest URL to which the source stream should be sent.
650 */
651 Url?: __string;
652 /**
653 * The system generated username for ingest authentication.
654 */
655 Username?: __string;
656 }
657 export interface ListChannelsRequest {
658 /**
659 * Upper bound on number of records to return.
660 */
661 MaxResults?: MaxResults;
662 /**
663 * A token used to resume pagination from the end of a previous request.
664 */
665 NextToken?: __string;
666 }
667 export interface ListChannelsResponse {
668 /**
669 * A list of Channel records.
670 */
671 Channels?: __listOfChannel;
672 /**
673 * A token that can be used to resume pagination from the end of the collection.
674 */
675 NextToken?: __string;
676 }
677 export interface ListOriginEndpointsRequest {
678 /**
679 * When specified, the request will return only OriginEndpoints associated with the given Channel ID.
680 */
681 ChannelId?: __string;
682 /**
683 * The upper bound on the number of records to return.
684 */
685 MaxResults?: MaxResults;
686 /**
687 * A token used to resume pagination from the end of a previous request.
688 */
689 NextToken?: __string;
690 }
691 export interface ListOriginEndpointsResponse {
692 /**
693 * A token that can be used to resume pagination from the end of the collection.
694 */
695 NextToken?: __string;
696 /**
697 * A list of OriginEndpoint records.
698 */
699 OriginEndpoints?: __listOfOriginEndpoint;
700 }
701 export interface ListTagsForResourceRequest {
702 ResourceArn: __string;
703 }
704 export interface ListTagsForResourceResponse {
705 Tags?: __mapOf__string;
706 }
707 export type ManifestLayout = "FULL"|"COMPACT"|string;
708 export type MaxResults = number;
709 export interface MssEncryption {
710 SpekeKeyProvider: SpekeKeyProvider;
711 }
712 export interface MssPackage {
713 Encryption?: MssEncryption;
714 /**
715 * The time window (in seconds) contained in each manifest.
716 */
717 ManifestWindowSeconds?: __integer;
718 /**
719 * The duration (in seconds) of each segment.
720 */
721 SegmentDurationSeconds?: __integer;
722 StreamSelection?: StreamSelection;
723 }
724 export interface OriginEndpoint {
725 /**
726 * The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
727 */
728 Arn?: __string;
729 /**
730 * The ID of the Channel the OriginEndpoint is associated with.
731 */
732 ChannelId?: __string;
733 CmafPackage?: CmafPackage;
734 DashPackage?: DashPackage;
735 /**
736 * A short text description of the OriginEndpoint.
737 */
738 Description?: __string;
739 HlsPackage?: HlsPackage;
740 /**
741 * The ID of the OriginEndpoint.
742 */
743 Id?: __string;
744 /**
745 * A short string appended to the end of the OriginEndpoint URL.
746 */
747 ManifestName?: __string;
748 MssPackage?: MssPackage;
749 /**
750 * Maximum duration (seconds) of content to retain for startover playback.
751If not specified, startover playback will be disabled for the OriginEndpoint.
752
753 */
754 StartoverWindowSeconds?: __integer;
755 Tags?: Tags;
756 /**
757 * Amount of delay (seconds) to enforce on the playback of live content.
758If not specified, there will be no time delay in effect for the OriginEndpoint.
759
760 */
761 TimeDelaySeconds?: __integer;
762 /**
763 * The URL of the packaged OriginEndpoint for consumption.
764 */
765 Url?: __string;
766 /**
767 * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
768 */
769 Whitelist?: __listOf__string;
770 }
771 export type PlaylistType = "NONE"|"EVENT"|"VOD"|string;
772 export type Profile = "NONE"|"HBBTV_1_5"|string;
773 export interface RotateChannelCredentialsRequest {
774 /**
775 * The ID of the channel to update.
776 */
777 Id: __string;
778 }
779 export interface RotateChannelCredentialsResponse {
780 /**
781 * The Amazon Resource Name (ARN) assigned to the Channel.
782 */
783 Arn?: __string;
784 /**
785 * A short text description of the Channel.
786 */
787 Description?: __string;
788 HlsIngest?: HlsIngest;
789 /**
790 * The ID of the Channel.
791 */
792 Id?: __string;
793 Tags?: Tags;
794 }
795 export interface RotateIngestEndpointCredentialsRequest {
796 /**
797 * The ID of the channel the IngestEndpoint is on.
798 */
799 Id: __string;
800 /**
801 * The id of the IngestEndpoint whose credentials should be rotated
802 */
803 IngestEndpointId: __string;
804 }
805 export interface RotateIngestEndpointCredentialsResponse {
806 /**
807 * The Amazon Resource Name (ARN) assigned to the Channel.
808 */
809 Arn?: __string;
810 /**
811 * A short text description of the Channel.
812 */
813 Description?: __string;
814 HlsIngest?: HlsIngest;
815 /**
816 * The ID of the Channel.
817 */
818 Id?: __string;
819 Tags?: Tags;
820 }
821 export type SegmentTemplateFormat = "NUMBER_WITH_TIMELINE"|"TIME_WITH_TIMELINE"|string;
822 export interface SpekeKeyProvider {
823 /**
824 * An Amazon Resource Name (ARN) of a Certificate Manager certificate
825that MediaPackage will use for enforcing secure end-to-end data
826transfer with the key provider service.
827
828 */
829 CertificateArn?: __string;
830 /**
831 * The resource ID to include in key requests.
832 */
833 ResourceId: __string;
834 /**
835 * An Amazon Resource Name (ARN) of an IAM role that AWS Elemental
836MediaPackage will assume when accessing the key provider service.
837
838 */
839 RoleArn: __string;
840 /**
841 * The system IDs to include in key requests.
842 */
843 SystemIds: __listOf__string;
844 /**
845 * The URL of the external key provider service.
846 */
847 Url: __string;
848 }
849 export type StreamOrder = "ORIGINAL"|"VIDEO_BITRATE_ASCENDING"|"VIDEO_BITRATE_DESCENDING"|string;
850 export interface StreamSelection {
851 /**
852 * The maximum video bitrate (bps) to include in output.
853 */
854 MaxVideoBitsPerSecond?: __integer;
855 /**
856 * The minimum video bitrate (bps) to include in output.
857 */
858 MinVideoBitsPerSecond?: __integer;
859 /**
860 * A directive that determines the order of streams in the output.
861 */
862 StreamOrder?: StreamOrder;
863 }
864 export interface TagResourceRequest {
865 ResourceArn: __string;
866 Tags: __mapOf__string;
867 }
868 export type Tags = {[key: string]: __string};
869 export interface UntagResourceRequest {
870 ResourceArn: __string;
871 /**
872 * The key(s) of tag to be deleted
873 */
874 TagKeys: __listOf__string;
875 }
876 export interface UpdateChannelRequest {
877 /**
878 * A short text description of the Channel.
879 */
880 Description?: __string;
881 /**
882 * The ID of the Channel to update.
883 */
884 Id: __string;
885 }
886 export interface UpdateChannelResponse {
887 /**
888 * The Amazon Resource Name (ARN) assigned to the Channel.
889 */
890 Arn?: __string;
891 /**
892 * A short text description of the Channel.
893 */
894 Description?: __string;
895 HlsIngest?: HlsIngest;
896 /**
897 * The ID of the Channel.
898 */
899 Id?: __string;
900 Tags?: Tags;
901 }
902 export interface UpdateOriginEndpointRequest {
903 CmafPackage?: CmafPackageCreateOrUpdateParameters;
904 DashPackage?: DashPackage;
905 /**
906 * A short text description of the OriginEndpoint.
907 */
908 Description?: __string;
909 HlsPackage?: HlsPackage;
910 /**
911 * The ID of the OriginEndpoint to update.
912 */
913 Id: __string;
914 /**
915 * A short string that will be appended to the end of the Endpoint URL.
916 */
917 ManifestName?: __string;
918 MssPackage?: MssPackage;
919 /**
920 * Maximum duration (in seconds) of content to retain for startover playback.
921If not specified, startover playback will be disabled for the OriginEndpoint.
922
923 */
924 StartoverWindowSeconds?: __integer;
925 /**
926 * Amount of delay (in seconds) to enforce on the playback of live content.
927If not specified, there will be no time delay in effect for the OriginEndpoint.
928
929 */
930 TimeDelaySeconds?: __integer;
931 /**
932 * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
933 */
934 Whitelist?: __listOf__string;
935 }
936 export interface UpdateOriginEndpointResponse {
937 /**
938 * The Amazon Resource Name (ARN) assigned to the OriginEndpoint.
939 */
940 Arn?: __string;
941 /**
942 * The ID of the Channel the OriginEndpoint is associated with.
943 */
944 ChannelId?: __string;
945 CmafPackage?: CmafPackage;
946 DashPackage?: DashPackage;
947 /**
948 * A short text description of the OriginEndpoint.
949 */
950 Description?: __string;
951 HlsPackage?: HlsPackage;
952 /**
953 * The ID of the OriginEndpoint.
954 */
955 Id?: __string;
956 /**
957 * A short string appended to the end of the OriginEndpoint URL.
958 */
959 ManifestName?: __string;
960 MssPackage?: MssPackage;
961 /**
962 * Maximum duration (seconds) of content to retain for startover playback.
963If not specified, startover playback will be disabled for the OriginEndpoint.
964
965 */
966 StartoverWindowSeconds?: __integer;
967 Tags?: Tags;
968 /**
969 * Amount of delay (seconds) to enforce on the playback of live content.
970If not specified, there will be no time delay in effect for the OriginEndpoint.
971
972 */
973 TimeDelaySeconds?: __integer;
974 /**
975 * The URL of the packaged OriginEndpoint for consumption.
976 */
977 Url?: __string;
978 /**
979 * A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.
980 */
981 Whitelist?: __listOf__string;
982 }
983 export type __PeriodTriggersElement = "ADS"|string;
984 export type __boolean = boolean;
985 export type __integer = number;
986 export type __listOfChannel = Channel[];
987 export type __listOfHlsManifest = HlsManifest[];
988 export type __listOfHlsManifestCreateOrUpdateParameters = HlsManifestCreateOrUpdateParameters[];
989 export type __listOfIngestEndpoint = IngestEndpoint[];
990 export type __listOfOriginEndpoint = OriginEndpoint[];
991 export type __listOf__PeriodTriggersElement = __PeriodTriggersElement[];
992 export type __listOf__string = __string[];
993 export type __mapOf__string = {[key: string]: __string};
994 export type __string = string;
995 /**
996 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
997 */
998 export type apiVersion = "2017-10-12"|"latest"|string;
999 export interface ClientApiVersions {
1000 /**
1001 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1002 */
1003 apiVersion?: apiVersion;
1004 }
1005 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1006 /**
1007 * Contains interfaces for use with the MediaPackage client.
1008 */
1009 export import Types = MediaPackage;
1010}
1011export = MediaPackage;