UNPKG

35.6 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 MediaConnect extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: MediaConnect.Types.ClientConfiguration)
13 config: Config & MediaConnect.Types.ClientConfiguration;
14 /**
15 * Adds outputs to an existing flow. You can create up to 20 outputs per flow.
16 */
17 addFlowOutputs(params: MediaConnect.Types.AddFlowOutputsRequest, callback?: (err: AWSError, data: MediaConnect.Types.AddFlowOutputsResponse) => void): Request<MediaConnect.Types.AddFlowOutputsResponse, AWSError>;
18 /**
19 * Adds outputs to an existing flow. You can create up to 20 outputs per flow.
20 */
21 addFlowOutputs(callback?: (err: AWSError, data: MediaConnect.Types.AddFlowOutputsResponse) => void): Request<MediaConnect.Types.AddFlowOutputsResponse, AWSError>;
22 /**
23 * Creates a new flow. The request must include one source. The request optionally can include outputs (up to 20) and entitlements (up to 50).
24 */
25 createFlow(params: MediaConnect.Types.CreateFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.CreateFlowResponse) => void): Request<MediaConnect.Types.CreateFlowResponse, AWSError>;
26 /**
27 * Creates a new flow. The request must include one source. The request optionally can include outputs (up to 20) and entitlements (up to 50).
28 */
29 createFlow(callback?: (err: AWSError, data: MediaConnect.Types.CreateFlowResponse) => void): Request<MediaConnect.Types.CreateFlowResponse, AWSError>;
30 /**
31 * Deletes a flow. Before you can delete a flow, you must stop the flow.
32 */
33 deleteFlow(params: MediaConnect.Types.DeleteFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.DeleteFlowResponse) => void): Request<MediaConnect.Types.DeleteFlowResponse, AWSError>;
34 /**
35 * Deletes a flow. Before you can delete a flow, you must stop the flow.
36 */
37 deleteFlow(callback?: (err: AWSError, data: MediaConnect.Types.DeleteFlowResponse) => void): Request<MediaConnect.Types.DeleteFlowResponse, AWSError>;
38 /**
39 * Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements.
40 */
41 describeFlow(params: MediaConnect.Types.DescribeFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowResponse) => void): Request<MediaConnect.Types.DescribeFlowResponse, AWSError>;
42 /**
43 * Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements.
44 */
45 describeFlow(callback?: (err: AWSError, data: MediaConnect.Types.DescribeFlowResponse) => void): Request<MediaConnect.Types.DescribeFlowResponse, AWSError>;
46 /**
47 * Grants entitlements to an existing flow.
48 */
49 grantFlowEntitlements(params: MediaConnect.Types.GrantFlowEntitlementsRequest, callback?: (err: AWSError, data: MediaConnect.Types.GrantFlowEntitlementsResponse) => void): Request<MediaConnect.Types.GrantFlowEntitlementsResponse, AWSError>;
50 /**
51 * Grants entitlements to an existing flow.
52 */
53 grantFlowEntitlements(callback?: (err: AWSError, data: MediaConnect.Types.GrantFlowEntitlementsResponse) => void): Request<MediaConnect.Types.GrantFlowEntitlementsResponse, AWSError>;
54 /**
55 * Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.
56 */
57 listEntitlements(params: MediaConnect.Types.ListEntitlementsRequest, callback?: (err: AWSError, data: MediaConnect.Types.ListEntitlementsResponse) => void): Request<MediaConnect.Types.ListEntitlementsResponse, AWSError>;
58 /**
59 * Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.
60 */
61 listEntitlements(callback?: (err: AWSError, data: MediaConnect.Types.ListEntitlementsResponse) => void): Request<MediaConnect.Types.ListEntitlementsResponse, AWSError>;
62 /**
63 * Displays a list of flows that are associated with this account. This request returns a paginated result.
64 */
65 listFlows(params: MediaConnect.Types.ListFlowsRequest, callback?: (err: AWSError, data: MediaConnect.Types.ListFlowsResponse) => void): Request<MediaConnect.Types.ListFlowsResponse, AWSError>;
66 /**
67 * Displays a list of flows that are associated with this account. This request returns a paginated result.
68 */
69 listFlows(callback?: (err: AWSError, data: MediaConnect.Types.ListFlowsResponse) => void): Request<MediaConnect.Types.ListFlowsResponse, AWSError>;
70 /**
71 * Lists all tags associated with the resource.
72 */
73 listTagsForResource(params: MediaConnect.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: MediaConnect.Types.ListTagsForResourceResponse) => void): Request<MediaConnect.Types.ListTagsForResourceResponse, AWSError>;
74 /**
75 * Lists all tags associated with the resource.
76 */
77 listTagsForResource(callback?: (err: AWSError, data: MediaConnect.Types.ListTagsForResourceResponse) => void): Request<MediaConnect.Types.ListTagsForResourceResponse, AWSError>;
78 /**
79 * Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output.
80 */
81 removeFlowOutput(params: MediaConnect.Types.RemoveFlowOutputRequest, callback?: (err: AWSError, data: MediaConnect.Types.RemoveFlowOutputResponse) => void): Request<MediaConnect.Types.RemoveFlowOutputResponse, AWSError>;
82 /**
83 * Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output.
84 */
85 removeFlowOutput(callback?: (err: AWSError, data: MediaConnect.Types.RemoveFlowOutputResponse) => void): Request<MediaConnect.Types.RemoveFlowOutputResponse, AWSError>;
86 /**
87 * Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.
88 */
89 revokeFlowEntitlement(params: MediaConnect.Types.RevokeFlowEntitlementRequest, callback?: (err: AWSError, data: MediaConnect.Types.RevokeFlowEntitlementResponse) => void): Request<MediaConnect.Types.RevokeFlowEntitlementResponse, AWSError>;
90 /**
91 * Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.
92 */
93 revokeFlowEntitlement(callback?: (err: AWSError, data: MediaConnect.Types.RevokeFlowEntitlementResponse) => void): Request<MediaConnect.Types.RevokeFlowEntitlementResponse, AWSError>;
94 /**
95 * Starts a flow.
96 */
97 startFlow(params: MediaConnect.Types.StartFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.StartFlowResponse) => void): Request<MediaConnect.Types.StartFlowResponse, AWSError>;
98 /**
99 * Starts a flow.
100 */
101 startFlow(callback?: (err: AWSError, data: MediaConnect.Types.StartFlowResponse) => void): Request<MediaConnect.Types.StartFlowResponse, AWSError>;
102 /**
103 * Stops a flow.
104 */
105 stopFlow(params: MediaConnect.Types.StopFlowRequest, callback?: (err: AWSError, data: MediaConnect.Types.StopFlowResponse) => void): Request<MediaConnect.Types.StopFlowResponse, AWSError>;
106 /**
107 * Stops a flow.
108 */
109 stopFlow(callback?: (err: AWSError, data: MediaConnect.Types.StopFlowResponse) => void): Request<MediaConnect.Types.StopFlowResponse, AWSError>;
110 /**
111 * Associates the specified tags to a resource. If the request does not mention an existing tag associated with the resource, that tag is not changed.
112 */
113 tagResource(params: MediaConnect.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
114 /**
115 * Associates the specified tags to a resource. If the request does not mention an existing tag associated with the resource, that tag is not changed.
116 */
117 tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
118 /**
119 * Deletes the specified tags from a resource.
120 */
121 untagResource(params: MediaConnect.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
122 /**
123 * Deletes the specified tags from a resource.
124 */
125 untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
126 /**
127 * You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed.
128 */
129 updateFlowEntitlement(params: MediaConnect.Types.UpdateFlowEntitlementRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowEntitlementResponse) => void): Request<MediaConnect.Types.UpdateFlowEntitlementResponse, AWSError>;
130 /**
131 * You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed.
132 */
133 updateFlowEntitlement(callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowEntitlementResponse) => void): Request<MediaConnect.Types.UpdateFlowEntitlementResponse, AWSError>;
134 /**
135 * Updates an existing flow output.
136 */
137 updateFlowOutput(params: MediaConnect.Types.UpdateFlowOutputRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowOutputResponse) => void): Request<MediaConnect.Types.UpdateFlowOutputResponse, AWSError>;
138 /**
139 * Updates an existing flow output.
140 */
141 updateFlowOutput(callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowOutputResponse) => void): Request<MediaConnect.Types.UpdateFlowOutputResponse, AWSError>;
142 /**
143 * Updates the source of a flow.
144 */
145 updateFlowSource(params: MediaConnect.Types.UpdateFlowSourceRequest, callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowSourceResponse) => void): Request<MediaConnect.Types.UpdateFlowSourceResponse, AWSError>;
146 /**
147 * Updates the source of a flow.
148 */
149 updateFlowSource(callback?: (err: AWSError, data: MediaConnect.Types.UpdateFlowSourceResponse) => void): Request<MediaConnect.Types.UpdateFlowSourceResponse, AWSError>;
150}
151declare namespace MediaConnect {
152 export interface AddFlowOutputsRequest {
153 /**
154 * The flow that you want to add outputs to.
155 */
156 FlowArn: __string;
157 /**
158 * A list of outputs that you want to add.
159 */
160 Outputs: __listOfAddOutputRequest;
161 }
162 export interface AddFlowOutputsResponse {
163 /**
164 * The ARN of the flow that these outputs were added to.
165 */
166 FlowArn?: __string;
167 /**
168 * The details of the newly added outputs.
169 */
170 Outputs?: __listOfOutput;
171 }
172 export interface AddOutputRequest {
173 /**
174 * A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
175 */
176 Description?: __string;
177 /**
178 * The IP address from which video will be sent to output destinations.
179 */
180 Destination: __string;
181 /**
182 * The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
183 */
184 Encryption?: Encryption;
185 /**
186 * The maximum latency in milliseconds for Zixi-based streams.
187 */
188 MaxLatency?: __integer;
189 /**
190 * The name of the output. This value must be unique within the current flow.
191 */
192 Name?: __string;
193 /**
194 * The port to use when content is distributed to this output.
195 */
196 Port: __integer;
197 /**
198 * The protocol to use for the output.
199 */
200 Protocol: Protocol;
201 /**
202 * The smoothing latency in milliseconds for RTP and RTP-FEC streams.
203 */
204 SmoothingLatency?: __integer;
205 /**
206 * The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
207 */
208 StreamId?: __string;
209 }
210 export type Algorithm = "aes128"|"aes192"|"aes256"|string;
211 export interface CreateFlowRequest {
212 /**
213 * The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region.
214 */
215 AvailabilityZone?: __string;
216 /**
217 * The entitlements that you want to grant on a flow.
218 */
219 Entitlements?: __listOfGrantEntitlementRequest;
220 /**
221 * The name of the flow.
222 */
223 Name: __string;
224 /**
225 * The outputs that you want to add to this flow.
226 */
227 Outputs?: __listOfAddOutputRequest;
228 Source: SetSourceRequest;
229 }
230 export interface CreateFlowResponse {
231 Flow?: Flow;
232 }
233 export interface DeleteFlowRequest {
234 /**
235 * The ARN of the flow that you want to delete.
236 */
237 FlowArn: __string;
238 }
239 export interface DeleteFlowResponse {
240 /**
241 * The ARN of the flow that was deleted.
242 */
243 FlowArn?: __string;
244 /**
245 * The status of the flow when the DeleteFlow process begins.
246 */
247 Status?: Status;
248 }
249 export interface DescribeFlowRequest {
250 /**
251 * The ARN of the flow that you want to describe.
252 */
253 FlowArn: __string;
254 }
255 export interface DescribeFlowResponse {
256 Flow?: Flow;
257 Messages?: Messages;
258 }
259 export interface Encryption {
260 /**
261 * The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
262 */
263 Algorithm: Algorithm;
264 /**
265 * The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
266 */
267 KeyType?: KeyType;
268 /**
269 * The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
270 */
271 RoleArn: __string;
272 /**
273 * The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
274 */
275 SecretArn: __string;
276 }
277 export interface Entitlement {
278 /**
279 * A description of the entitlement.
280 */
281 Description?: __string;
282 /**
283 * The type of encryption that will be used on the output that is associated with this entitlement.
284 */
285 Encryption?: Encryption;
286 /**
287 * The ARN of the entitlement.
288 */
289 EntitlementArn: __string;
290 /**
291 * The name of the entitlement.
292 */
293 Name: __string;
294 /**
295 * The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
296 */
297 Subscribers: __listOf__string;
298 }
299 export interface Flow {
300 /**
301 * The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
302 */
303 AvailabilityZone: __string;
304 /**
305 * A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
306 */
307 Description?: __string;
308 /**
309 * The IP address from which video will be sent to output destinations.
310 */
311 EgressIp?: __string;
312 /**
313 * The entitlements in this flow.
314 */
315 Entitlements: __listOfEntitlement;
316 /**
317 * The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.
318 */
319 FlowArn: __string;
320 /**
321 * The name of the flow.
322 */
323 Name: __string;
324 /**
325 * The outputs in this flow.
326 */
327 Outputs: __listOfOutput;
328 Source: Source;
329 /**
330 * The current status of the flow.
331 */
332 Status: Status;
333 }
334 export interface GrantEntitlementRequest {
335 /**
336 * A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
337 */
338 Description?: __string;
339 /**
340 * The type of encryption that will be used on the output that is associated with this entitlement.
341 */
342 Encryption?: Encryption;
343 /**
344 * The name of the entitlement. This value must be unique within the current flow.
345 */
346 Name?: __string;
347 /**
348 * The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source.
349 */
350 Subscribers: __listOf__string;
351 }
352 export interface GrantFlowEntitlementsRequest {
353 /**
354 * The list of entitlements that you want to grant.
355 */
356 Entitlements: __listOfGrantEntitlementRequest;
357 /**
358 * The flow that you want to grant entitlements on.
359 */
360 FlowArn: __string;
361 }
362 export interface GrantFlowEntitlementsResponse {
363 /**
364 * The entitlements that were just granted.
365 */
366 Entitlements?: __listOfEntitlement;
367 /**
368 * The ARN of the flow that these entitlements were granted to.
369 */
370 FlowArn?: __string;
371 }
372 export type KeyType = "static-key"|string;
373 export interface ListEntitlementsRequest {
374 /**
375 * The maximum number of results to return per API request. For example, you submit a ListEntitlements request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page.
376 */
377 MaxResults?: MaxResults;
378 /**
379 * The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.
380 */
381 NextToken?: __string;
382 }
383 export interface ListEntitlementsResponse {
384 /**
385 * A list of entitlements that have been granted to you from other AWS accounts.
386 */
387 Entitlements?: __listOfListedEntitlement;
388 /**
389 * The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.
390 */
391 NextToken?: __string;
392 }
393 export interface ListFlowsRequest {
394 /**
395 * The maximum number of results to return per API request. For example, you submit a ListFlows request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page.
396 */
397 MaxResults?: MaxResults;
398 /**
399 * The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.
400 */
401 NextToken?: __string;
402 }
403 export interface ListFlowsResponse {
404 /**
405 * A list of flow summaries.
406 */
407 Flows?: __listOfListedFlow;
408 /**
409 * The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value.
410 */
411 NextToken?: __string;
412 }
413 export interface ListTagsForResourceRequest {
414 /**
415 * The Amazon Resource Name (ARN) of the resource that you want to view tags for.
416 */
417 ResourceArn: __string;
418 }
419 export interface ListTagsForResourceResponse {
420 /**
421 * A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
422 */
423 Tags?: __mapOf__string;
424 }
425 export interface ListedEntitlement {
426 /**
427 * The ARN of the entitlement.
428 */
429 EntitlementArn: __string;
430 /**
431 * The name of the entitlement.
432 */
433 EntitlementName: __string;
434 }
435 export interface ListedFlow {
436 /**
437 * The Availability Zone that the flow was created in.
438 */
439 AvailabilityZone: __string;
440 /**
441 * A description of the flow.
442 */
443 Description: __string;
444 /**
445 * The ARN of the flow.
446 */
447 FlowArn: __string;
448 /**
449 * The name of the flow.
450 */
451 Name: __string;
452 /**
453 * The type of source. This value is either owned (originated somewhere other than an AWS Elemental MediaConnect flow owned by another AWS account) or entitled (originated at an AWS Elemental MediaConnect flow owned by another AWS account).
454 */
455 SourceType: SourceType;
456 /**
457 * The current status of the flow.
458 */
459 Status: Status;
460 }
461 export type MaxResults = number;
462 export interface Messages {
463 /**
464 * A list of errors that might have been generated from processes on this flow.
465 */
466 Errors: __listOf__string;
467 }
468 export interface Output {
469 /**
470 * A description of the output.
471 */
472 Description?: __string;
473 /**
474 * The address where you want to send the output.
475 */
476 Destination?: __string;
477 /**
478 * The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
479 */
480 Encryption?: Encryption;
481 /**
482 * The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
483 */
484 EntitlementArn?: __string;
485 /**
486 * The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
487 */
488 MediaLiveInputArn?: __string;
489 /**
490 * The name of the output. This value must be unique within the current flow.
491 */
492 Name: __string;
493 /**
494 * The ARN of the output.
495 */
496 OutputArn: __string;
497 /**
498 * The port to use when content is distributed to this output.
499 */
500 Port?: __integer;
501 /**
502 * Attributes related to the transport stream that are used in the output.
503 */
504 Transport?: Transport;
505 }
506 export type Protocol = "zixi-push"|"rtp-fec"|"rtp"|string;
507 export interface RemoveFlowOutputRequest {
508 /**
509 * The flow that you want to remove an output from.
510 */
511 FlowArn: __string;
512 /**
513 * The ARN of the output that you want to remove.
514 */
515 OutputArn: __string;
516 }
517 export interface RemoveFlowOutputResponse {
518 /**
519 * The ARN of the flow that is associated with the output you removed.
520 */
521 FlowArn?: __string;
522 /**
523 * The ARN of the output that was removed.
524 */
525 OutputArn?: __string;
526 }
527 export interface RevokeFlowEntitlementRequest {
528 /**
529 * The ARN of the entitlement that you want to revoke.
530 */
531 EntitlementArn: __string;
532 /**
533 * The flow that you want to revoke an entitlement from.
534 */
535 FlowArn: __string;
536 }
537 export interface RevokeFlowEntitlementResponse {
538 /**
539 * The ARN of the entitlement that was revoked.
540 */
541 EntitlementArn?: __string;
542 /**
543 * The ARN of the flow that the entitlement was revoked from.
544 */
545 FlowArn?: __string;
546 }
547 export interface SetSourceRequest {
548 /**
549 * The type of encryption that is used on the content ingested from this source.
550 */
551 Decryption?: Encryption;
552 /**
553 * A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
554 */
555 Description?: __string;
556 /**
557 * The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
558 */
559 EntitlementArn?: __string;
560 /**
561 * The port that the flow will be listening on for incoming content.
562 */
563 IngestPort?: __integer;
564 /**
565 * The smoothing max bitrate for RTP and RTP-FEC streams.
566 */
567 MaxBitrate?: __integer;
568 /**
569 * The maximum latency in milliseconds for Zixi-based streams.
570 */
571 MaxLatency?: __integer;
572 /**
573 * The name of the source.
574 */
575 Name?: __string;
576 /**
577 * The protocol that is used by the source.
578 */
579 Protocol?: Protocol;
580 /**
581 * The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
582 */
583 StreamId?: __string;
584 /**
585 * The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
586 */
587 WhitelistCidr?: __string;
588 }
589 export interface Source {
590 /**
591 * The type of encryption that is used on the content ingested from this source.
592 */
593 Decryption?: Encryption;
594 /**
595 * A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
596 */
597 Description?: __string;
598 /**
599 * The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow.
600 */
601 EntitlementArn?: __string;
602 /**
603 * The IP address that the flow will be listening on for incoming content.
604 */
605 IngestIp?: __string;
606 /**
607 * The port that the flow will be listening on for incoming content.
608 */
609 IngestPort?: __integer;
610 /**
611 * The name of the source.
612 */
613 Name: __string;
614 /**
615 * The ARN of the source.
616 */
617 SourceArn: __string;
618 /**
619 * Attributes related to the transport stream that are used in the source.
620 */
621 Transport?: Transport;
622 /**
623 * The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
624 */
625 WhitelistCidr?: __string;
626 }
627 export type SourceType = "OWNED"|"ENTITLED"|string;
628 export interface StartFlowRequest {
629 /**
630 * The ARN of the flow that you want to start.
631 */
632 FlowArn: __string;
633 }
634 export interface StartFlowResponse {
635 /**
636 * The ARN of the flow that you started.
637 */
638 FlowArn?: __string;
639 /**
640 * The status of the flow when the StartFlow process begins.
641 */
642 Status?: Status;
643 }
644 export type Status = "STANDBY"|"ACTIVE"|"UPDATING"|"DELETING"|"STARTING"|"STOPPING"|"ERROR"|string;
645 export interface StopFlowRequest {
646 /**
647 * The ARN of the flow that you want to stop.
648 */
649 FlowArn: __string;
650 }
651 export interface StopFlowResponse {
652 /**
653 * The ARN of the flow that you stopped.
654 */
655 FlowArn?: __string;
656 /**
657 * The status of the flow when the StopFlow process begins.
658 */
659 Status?: Status;
660 }
661 export interface TagResourceRequest {
662 /**
663 * The Amazon Resource Name (ARN) of the resource that you want to add tags to.
664 */
665 ResourceArn: __string;
666 /**
667 * A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
668 */
669 Tags: __mapOf__string;
670 }
671 export interface Transport {
672 /**
673 * The smoothing max bitrate for RTP and RTP-FEC streams.
674 */
675 MaxBitrate?: __integer;
676 /**
677 * The maximum latency in milliseconds for Zixi-based streams.
678 */
679 MaxLatency?: __integer;
680 /**
681 * The protocol that is used by the source or output.
682 */
683 Protocol: Protocol;
684 /**
685 * The smoothing latency in milliseconds for RTP and RTP-FEC streams.
686 */
687 SmoothingLatency?: __integer;
688 /**
689 * The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
690 */
691 StreamId?: __string;
692 }
693 export interface UntagResourceRequest {
694 /**
695 * The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
696 */
697 ResourceArn: __string;
698 /**
699 * The keys of the tags to be removed.
700 */
701 TagKeys: __listOf__string;
702 }
703 export interface UpdateEncryption {
704 /**
705 * The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
706 */
707 Algorithm?: Algorithm;
708 /**
709 * The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
710 */
711 KeyType?: KeyType;
712 /**
713 * The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
714 */
715 RoleArn?: __string;
716 /**
717 * The ARN that was assigned to the secret that you created in AWS Secrets Manager to store the encryption key.
718 */
719 SecretArn?: __string;
720 }
721 export interface UpdateFlowEntitlementRequest {
722 /**
723 * A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user.
724 */
725 Description?: __string;
726 /**
727 * The type of encryption that will be used on the output associated with this entitlement.
728 */
729 Encryption?: UpdateEncryption;
730 /**
731 * The ARN of the entitlement that you want to update.
732 */
733 EntitlementArn: __string;
734 /**
735 * The flow that is associated with the entitlement that you want to update.
736 */
737 FlowArn: __string;
738 /**
739 * The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source.
740 */
741 Subscribers?: __listOf__string;
742 }
743 export interface UpdateFlowEntitlementResponse {
744 Entitlement?: Entitlement;
745 /**
746 * The ARN of the flow that this entitlement was granted on.
747 */
748 FlowArn?: __string;
749 }
750 export interface UpdateFlowOutputRequest {
751 /**
752 * A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
753 */
754 Description?: __string;
755 /**
756 * The IP address where you want to send the output.
757 */
758 Destination?: __string;
759 /**
760 * The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
761 */
762 Encryption?: UpdateEncryption;
763 /**
764 * The flow that is associated with the output that you want to update.
765 */
766 FlowArn: __string;
767 /**
768 * The maximum latency in milliseconds for Zixi-based streams.
769 */
770 MaxLatency?: __integer;
771 /**
772 * The ARN of the output that you want to update.
773 */
774 OutputArn: __string;
775 /**
776 * The port to use when content is distributed to this output.
777 */
778 Port?: __integer;
779 /**
780 * The protocol to use for the output.
781 */
782 Protocol?: Protocol;
783 /**
784 * The smoothing latency in milliseconds for RTP and RTP-FEC streams.
785 */
786 SmoothingLatency?: __integer;
787 /**
788 * The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
789 */
790 StreamId?: __string;
791 }
792 export interface UpdateFlowOutputResponse {
793 /**
794 * The ARN of the flow that is associated with the updated output.
795 */
796 FlowArn?: __string;
797 Output?: Output;
798 }
799 export interface UpdateFlowSourceRequest {
800 /**
801 * The type of encryption used on the content ingested from this source.
802 */
803 Decryption?: UpdateEncryption;
804 /**
805 * A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
806 */
807 Description?: __string;
808 /**
809 * The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow.
810 */
811 EntitlementArn?: __string;
812 /**
813 * The flow that is associated with the source that you want to update.
814 */
815 FlowArn: __string;
816 /**
817 * The port that the flow will be listening on for incoming content.
818 */
819 IngestPort?: __integer;
820 /**
821 * The smoothing max bitrate for RTP and RTP-FEC streams.
822 */
823 MaxBitrate?: __integer;
824 /**
825 * The maximum latency in milliseconds for Zixi-based streams.
826 */
827 MaxLatency?: __integer;
828 /**
829 * The protocol that is used by the source.
830 */
831 Protocol?: Protocol;
832 /**
833 * The ARN of the source that you want to update.
834 */
835 SourceArn: __string;
836 /**
837 * The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.
838 */
839 StreamId?: __string;
840 /**
841 * The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
842 */
843 WhitelistCidr?: __string;
844 }
845 export interface UpdateFlowSourceResponse {
846 /**
847 * The ARN of the flow that you want to update.
848 */
849 FlowArn?: __string;
850 /**
851 * The settings for the source of the flow.
852 */
853 Source?: Source;
854 }
855 export type __integer = number;
856 export type __listOfAddOutputRequest = AddOutputRequest[];
857 export type __listOfEntitlement = Entitlement[];
858 export type __listOfGrantEntitlementRequest = GrantEntitlementRequest[];
859 export type __listOfListedEntitlement = ListedEntitlement[];
860 export type __listOfListedFlow = ListedFlow[];
861 export type __listOfOutput = Output[];
862 export type __listOf__string = __string[];
863 export type __mapOf__string = {[key: string]: __string};
864 export type __string = string;
865 /**
866 * 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.
867 */
868 export type apiVersion = "2018-11-14"|"latest"|string;
869 export interface ClientApiVersions {
870 /**
871 * 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.
872 */
873 apiVersion?: apiVersion;
874 }
875 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
876 /**
877 * Contains interfaces for use with the MediaConnect client.
878 */
879 export import Types = MediaConnect;
880}
881export = MediaConnect;