@aws-sdk/client-mediaconnect 3.378.0 → 3.382.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.
Files changed (5) hide show
  1. package/dist-types/endpoint/EndpointParameters.d.ts +3 -0
  2. package/dist-types/index.d.ts +1 -0
  3. package/dist-types/models/models_0.d.ts +588 -0
  4. package/dist-types/ts3.4/index.d.ts +1 -0
  5. package/package.json +7 -7
package/dist-types/models/models_0.d.ts CHANGED
@@ -27,26 +27,32 @@ export type Protocol = (typeof Protocol)[keyof typeof Protocol];
27
27
  */
28
28
  export interface AddBridgeNetworkOutputRequest {
29
29
  /**
30
+ * @public
30
31
  * The network output IP Address.
31
32
  */
32
33
  IpAddress: string | undefined;
33
34
  /**
35
+ * @public
34
36
  * The network output name. This name is used to reference the output and must be unique among outputs in this bridge.
35
37
  */
36
38
  Name: string | undefined;
37
39
  /**
40
+ * @public
38
41
  * The network output's gateway network name.
39
42
  */
40
43
  NetworkName: string | undefined;
41
44
  /**
45
+ * @public
42
46
  * The network output port.
43
47
  */
44
48
  Port: number | undefined;
45
49
  /**
50
+ * @public
46
51
  * The network output protocol.
47
52
  */
48
53
  Protocol: Protocol | string | undefined;
49
54
  /**
55
+ * @public
50
56
  * The network output TTL.
51
57
  */
52
58
  Ttl: number | undefined;
@@ -57,6 +63,7 @@ export interface AddBridgeNetworkOutputRequest {
57
63
  */
58
64
  export interface AddBridgeOutputRequest {
59
65
  /**
66
+ * @public
60
67
  * Add a network output to an existing bridge.
61
68
  */
62
69
  NetworkOutput?: AddBridgeNetworkOutputRequest;
@@ -67,6 +74,7 @@ export interface AddBridgeOutputRequest {
67
74
  */
68
75
  export interface VpcInterfaceAttachment {
69
76
  /**
77
+ * @public
70
78
  * The name of the VPC interface to use for this resource.
71
79
  */
72
80
  VpcInterfaceName?: string;
@@ -77,14 +85,17 @@ export interface VpcInterfaceAttachment {
77
85
  */
78
86
  export interface AddBridgeFlowSourceRequest {
79
87
  /**
88
+ * @public
80
89
  * The Amazon Resource Number (ARN) of the cloud flow to use as a source of this bridge.
81
90
  */
82
91
  FlowArn: string | undefined;
83
92
  /**
93
+ * @public
84
94
  * The name of the VPC interface attachment to use for this source.
85
95
  */
86
96
  FlowVpcInterfaceAttachment?: VpcInterfaceAttachment;
87
97
  /**
98
+ * @public
88
99
  * The name of the flow source. This name is used to reference the source and must be unique among sources in this bridge.
89
100
  */
90
101
  Name: string | undefined;
@@ -95,22 +106,27 @@ export interface AddBridgeFlowSourceRequest {
95
106
  */
96
107
  export interface AddBridgeNetworkSourceRequest {
97
108
  /**
109
+ * @public
98
110
  * The network source multicast IP.
99
111
  */
100
112
  MulticastIp: string | undefined;
101
113
  /**
114
+ * @public
102
115
  * The name of the network source. This name is used to reference the source and must be unique among sources in this bridge.
103
116
  */
104
117
  Name: string | undefined;
105
118
  /**
119
+ * @public
106
120
  * The network source's gateway network name.
107
121
  */
108
122
  NetworkName: string | undefined;
109
123
  /**
124
+ * @public
110
125
  * The network source port.
111
126
  */
112
127
  Port: number | undefined;
113
128
  /**
129
+ * @public
114
130
  * The network source protocol.
115
131
  */
116
132
  Protocol: Protocol | string | undefined;
@@ -121,10 +137,12 @@ export interface AddBridgeNetworkSourceRequest {
121
137
  */
122
138
  export interface AddBridgeSourceRequest {
123
139
  /**
140
+ * @public
124
141
  * Add a flow source to an existing bridge.
125
142
  */
126
143
  FlowSource?: AddBridgeFlowSourceRequest;
127
144
  /**
145
+ * @public
128
146
  * Add a network source to an existing bridge.
129
147
  */
130
148
  NetworkSource?: AddBridgeNetworkSourceRequest;
@@ -197,30 +215,37 @@ export type Tcs = (typeof Tcs)[keyof typeof Tcs];
197
215
  */
198
216
  export interface FmtpRequest {
199
217
  /**
218
+ * @public
200
219
  * The format of the audio channel.
201
220
  */
202
221
  ChannelOrder?: string;
203
222
  /**
223
+ * @public
204
224
  * The format that is used for the representation of color.
205
225
  */
206
226
  Colorimetry?: Colorimetry | string;
207
227
  /**
228
+ * @public
208
229
  * The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
209
230
  */
210
231
  ExactFramerate?: string;
211
232
  /**
233
+ * @public
212
234
  * The pixel aspect ratio (PAR) of the video.
213
235
  */
214
236
  Par?: string;
215
237
  /**
238
+ * @public
216
239
  * The encoding range of the video.
217
240
  */
218
241
  Range?: Range | string;
219
242
  /**
243
+ * @public
220
244
  * The type of compression that was used to smooth the video’s appearance.
221
245
  */
222
246
  ScanMode?: ScanMode | string;
223
247
  /**
248
+ * @public
224
249
  * The transfer characteristic system (TCS) that is used in the video.
225
250
  */
226
251
  Tcs?: Tcs | string;
@@ -231,10 +256,12 @@ export interface FmtpRequest {
231
256
  */
232
257
  export interface MediaStreamAttributesRequest {
233
258
  /**
259
+ * @public
234
260
  * The settings that you want to use to define the media stream.
235
261
  */
236
262
  Fmtp?: FmtpRequest;
237
263
  /**
264
+ * @public
238
265
  * The audio language, in a format that is recognized by the receiver.
239
266
  */
240
267
  Lang?: string;
@@ -258,30 +285,37 @@ export type MediaStreamType = (typeof MediaStreamType)[keyof typeof MediaStreamT
258
285
  */
259
286
  export interface AddMediaStreamRequest {
260
287
  /**
288
+ * @public
261
289
  * The attributes that you want to assign to the new media stream.
262
290
  */
263
291
  Attributes?: MediaStreamAttributesRequest;
264
292
  /**
293
+ * @public
265
294
  * The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
266
295
  */
267
296
  ClockRate?: number;
268
297
  /**
298
+ * @public
269
299
  * A description that can help you quickly identify what your media stream is used for.
270
300
  */
271
301
  Description?: string;
272
302
  /**
303
+ * @public
273
304
  * A unique identifier for the media stream.
274
305
  */
275
306
  MediaStreamId: number | undefined;
276
307
  /**
308
+ * @public
277
309
  * A name that helps you distinguish one media stream from another.
278
310
  */
279
311
  MediaStreamName: string | undefined;
280
312
  /**
313
+ * @public
281
314
  * The type of media stream.
282
315
  */
283
316
  MediaStreamType: MediaStreamType | string | undefined;
284
317
  /**
318
+ * @public
285
319
  * The resolution of the video.
286
320
  */
287
321
  VideoFormat?: string;
@@ -318,38 +352,47 @@ export type KeyType = (typeof KeyType)[keyof typeof KeyType];
318
352
  */
319
353
  export interface Encryption {
320
354
  /**
355
+ * @public
321
356
  * The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
322
357
  */
323
358
  Algorithm?: Algorithm | string;
324
359
  /**
360
+ * @public
325
361
  * A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
326
362
  */
327
363
  ConstantInitializationVector?: string;
328
364
  /**
365
+ * @public
329
366
  * The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
330
367
  */
331
368
  DeviceId?: string;
332
369
  /**
370
+ * @public
333
371
  * The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
334
372
  */
335
373
  KeyType?: KeyType | string;
336
374
  /**
375
+ * @public
337
376
  * The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
338
377
  */
339
378
  Region?: string;
340
379
  /**
380
+ * @public
341
381
  * An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
342
382
  */
343
383
  ResourceId?: string;
344
384
  /**
385
+ * @public
345
386
  * The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
346
387
  */
347
388
  RoleArn: string | undefined;
348
389
  /**
390
+ * @public
349
391
  * The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
350
392
  */
351
393
  SecretArn?: string;
352
394
  /**
395
+ * @public
353
396
  * The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
354
397
  */
355
398
  Url?: string;
@@ -360,6 +403,7 @@ export interface Encryption {
360
403
  */
361
404
  export interface InterfaceRequest {
362
405
  /**
406
+ * @public
363
407
  * The name of the VPC interface.
364
408
  */
365
409
  Name: string | undefined;
@@ -370,14 +414,17 @@ export interface InterfaceRequest {
370
414
  */
371
415
  export interface DestinationConfigurationRequest {
372
416
  /**
417
+ * @public
373
418
  * The IP address where you want MediaConnect to send contents of the media stream.
374
419
  */
375
420
  DestinationIp: string | undefined;
376
421
  /**
422
+ * @public
377
423
  * The port that you want MediaConnect to use when it distributes the media stream to the output.
378
424
  */
379
425
  DestinationPort: number | undefined;
380
426
  /**
427
+ * @public
381
428
  * The VPC interface that you want to use for the media stream associated with the output.
382
429
  */
383
430
  Interface: InterfaceRequest | undefined;
@@ -414,10 +461,12 @@ export type EncoderProfile = (typeof EncoderProfile)[keyof typeof EncoderProfile
414
461
  */
415
462
  export interface EncodingParametersRequest {
416
463
  /**
464
+ * @public
417
465
  * A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
418
466
  */
419
467
  CompressionFactor: number | undefined;
420
468
  /**
469
+ * @public
421
470
  * A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, if at least one source on the flow uses the CDI protocol.
422
471
  */
423
472
  EncoderProfile: EncoderProfile | string | undefined;
@@ -428,18 +477,22 @@ export interface EncodingParametersRequest {
428
477
  */
429
478
  export interface MediaStreamOutputConfigurationRequest {
430
479
  /**
480
+ * @public
431
481
  * The transport parameters that you want to associate with the media stream.
432
482
  */
433
483
  DestinationConfigurations?: DestinationConfigurationRequest[];
434
484
  /**
485
+ * @public
435
486
  * The format that will be used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
436
487
  */
437
488
  EncodingName: EncodingName | string | undefined;
438
489
  /**
490
+ * @public
439
491
  * A collection of parameters that determine how MediaConnect will convert the content. These fields only apply to outputs on flows that have a CDI source.
440
492
  */
441
493
  EncodingParameters?: EncodingParametersRequest;
442
494
  /**
495
+ * @public
443
496
  * The name of the media stream that is associated with the output.
444
497
  */
445
498
  MediaStreamName: string | undefined;
@@ -450,62 +503,77 @@ export interface MediaStreamOutputConfigurationRequest {
450
503
  */
451
504
  export interface AddOutputRequest {
452
505
  /**
506
+ * @public
453
507
  * The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
454
508
  */
455
509
  CidrAllowList?: string[];
456
510
  /**
511
+ * @public
457
512
  * A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
458
513
  */
459
514
  Description?: string;
460
515
  /**
516
+ * @public
461
517
  * The IP address from which video will be sent to output destinations.
462
518
  */
463
519
  Destination?: string;
464
520
  /**
521
+ * @public
465
522
  * The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.
466
523
  */
467
524
  Encryption?: Encryption;
468
525
  /**
526
+ * @public
469
527
  * The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
470
528
  */
471
529
  MaxLatency?: number;
472
530
  /**
531
+ * @public
473
532
  * The media streams that are associated with the output, and the parameters for those associations.
474
533
  */
475
534
  MediaStreamOutputConfigurations?: MediaStreamOutputConfigurationRequest[];
476
535
  /**
536
+ * @public
477
537
  * The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
478
538
  */
479
539
  MinLatency?: number;
480
540
  /**
541
+ * @public
481
542
  * The name of the output. This value must be unique within the current flow.
482
543
  */
483
544
  Name?: string;
484
545
  /**
546
+ * @public
485
547
  * The port to use when content is distributed to this output.
486
548
  */
487
549
  Port?: number;
488
550
  /**
551
+ * @public
489
552
  * The protocol to use for the output.
490
553
  */
491
554
  Protocol: Protocol | string | undefined;
492
555
  /**
556
+ * @public
493
557
  * The remote ID for the Zixi-pull output stream.
494
558
  */
495
559
  RemoteId?: string;
496
560
  /**
561
+ * @public
497
562
  * The port that the flow uses to send outbound requests to initiate connection with the sender.
498
563
  */
499
564
  SenderControlPort?: number;
500
565
  /**
566
+ * @public
501
567
  * The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
502
568
  */
503
569
  SmoothingLatency?: number;
504
570
  /**
571
+ * @public
505
572
  * The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
506
573
  */
507
574
  StreamId?: string;
508
575
  /**
576
+ * @public
509
577
  * The name of the VPC interface attachment to use for this output.
510
578
  */
511
579
  VpcInterfaceAttachment?: VpcInterfaceAttachment;
@@ -516,14 +584,17 @@ export interface AddOutputRequest {
516
584
  */
517
585
  export interface BridgeFlowOutput {
518
586
  /**
587
+ * @public
519
588
  * The Amazon Resource Number (ARN) of the cloud flow.
520
589
  */
521
590
  FlowArn: string | undefined;
522
591
  /**
592
+ * @public
523
593
  * The Amazon Resource Number (ARN) of the flow source.
524
594
  */
525
595
  FlowSourceArn: string | undefined;
526
596
  /**
597
+ * @public
527
598
  * The name of the bridge's output.
528
599
  */
529
600
  Name: string | undefined;
@@ -534,26 +605,32 @@ export interface BridgeFlowOutput {
534
605
  */
535
606
  export interface BridgeNetworkOutput {
536
607
  /**
608
+ * @public
537
609
  * The network output IP Address.
538
610
  */
539
611
  IpAddress: string | undefined;
540
612
  /**
613
+ * @public
541
614
  * The network output name.
542
615
  */
543
616
  Name: string | undefined;
544
617
  /**
618
+ * @public
545
619
  * The network output's gateway network name.
546
620
  */
547
621
  NetworkName: string | undefined;
548
622
  /**
623
+ * @public
549
624
  * The network output port.
550
625
  */
551
626
  Port: number | undefined;
552
627
  /**
628
+ * @public
553
629
  * The network output protocol.
554
630
  */
555
631
  Protocol: Protocol | string | undefined;
556
632
  /**
633
+ * @public
557
634
  * The network output TTL.
558
635
  */
559
636
  Ttl: number | undefined;
@@ -564,10 +641,12 @@ export interface BridgeNetworkOutput {
564
641
  */
565
642
  export interface BridgeOutput {
566
643
  /**
644
+ * @public
567
645
  * The output of the bridge. A flow output is delivered to the AWS cloud.
568
646
  */
569
647
  FlowOutput?: BridgeFlowOutput;
570
648
  /**
649
+ * @public
571
650
  * The output of the bridge. A network output is delivered to your premises.
572
651
  */
573
652
  NetworkOutput?: BridgeNetworkOutput;
@@ -578,18 +657,22 @@ export interface BridgeOutput {
578
657
  */
579
658
  export interface BridgeFlowSource {
580
659
  /**
660
+ * @public
581
661
  * The ARN of the cloud flow used as a source of this bridge.
582
662
  */
583
663
  FlowArn: string | undefined;
584
664
  /**
665
+ * @public
585
666
  * The name of the VPC interface attachment to use for this source.
586
667
  */
587
668
  FlowVpcInterfaceAttachment?: VpcInterfaceAttachment;
588
669
  /**
670
+ * @public
589
671
  * The name of the flow source.
590
672
  */
591
673
  Name: string | undefined;
592
674
  /**
675
+ * @public
593
676
  * The Amazon Resource Number (ARN) of the output.
594
677
  */
595
678
  OutputArn?: string;
@@ -600,22 +683,27 @@ export interface BridgeFlowSource {
600
683
  */
601
684
  export interface BridgeNetworkSource {
602
685
  /**
686
+ * @public
603
687
  * The network source multicast IP.
604
688
  */
605
689
  MulticastIp: string | undefined;
606
690
  /**
691
+ * @public
607
692
  * The name of the network source.
608
693
  */
609
694
  Name: string | undefined;
610
695
  /**
696
+ * @public
611
697
  * The network source's gateway network name.
612
698
  */
613
699
  NetworkName: string | undefined;
614
700
  /**
701
+ * @public
615
702
  * The network source port.
616
703
  */
617
704
  Port: number | undefined;
618
705
  /**
706
+ * @public
619
707
  * The network source protocol.
620
708
  */
621
709
  Protocol: Protocol | string | undefined;
@@ -626,10 +714,12 @@ export interface BridgeNetworkSource {
626
714
  */
627
715
  export interface BridgeSource {
628
716
  /**
717
+ * @public
629
718
  * The source of the bridge. A flow source originates in MediaConnect as an existing cloud flow.
630
719
  */
631
720
  FlowSource?: BridgeFlowSource;
632
721
  /**
722
+ * @public
633
723
  * The source of the bridge. A network source originates at your premises.
634
724
  */
635
725
  NetworkSource?: BridgeNetworkSource;
@@ -640,6 +730,7 @@ export interface BridgeSource {
640
730
  */
641
731
  export interface Interface {
642
732
  /**
733
+ * @public
643
734
  * The name of the VPC interface.
644
735
  */
645
736
  Name: string | undefined;
@@ -650,18 +741,22 @@ export interface Interface {
650
741
  */
651
742
  export interface DestinationConfiguration {
652
743
  /**
744
+ * @public
653
745
  * The IP address where contents of the media stream will be sent.
654
746
  */
655
747
  DestinationIp: string | undefined;
656
748
  /**
749
+ * @public
657
750
  * The port to use when the content of the media stream is distributed to the output.
658
751
  */
659
752
  DestinationPort: number | undefined;
660
753
  /**
754
+ * @public
661
755
  * The VPC interface that is used for the media stream associated with the output.
662
756
  */
663
757
  Interface: Interface | undefined;
664
758
  /**
759
+ * @public
665
760
  * The IP address that the receiver requires in order to establish a connection with the flow. This value is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the CDI or ST 2110 JPEG XS protocol.
666
761
  */
667
762
  OutboundIp: string | undefined;
@@ -684,30 +779,37 @@ export type EntitlementStatus = (typeof EntitlementStatus)[keyof typeof Entitlem
684
779
  */
685
780
  export interface Entitlement {
686
781
  /**
782
+ * @public
687
783
  * Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
688
784
  */
689
785
  DataTransferSubscriberFeePercent?: number;
690
786
  /**
787
+ * @public
691
788
  * A description of the entitlement.
692
789
  */
693
790
  Description?: string;
694
791
  /**
792
+ * @public
695
793
  * The type of encryption that will be used on the output that is associated with this entitlement.
696
794
  */
697
795
  Encryption?: Encryption;
698
796
  /**
797
+ * @public
699
798
  * The ARN of the entitlement.
700
799
  */
701
800
  EntitlementArn: string | undefined;
702
801
  /**
802
+ * @public
703
803
  * An indication of whether the entitlement is enabled.
704
804
  */
705
805
  EntitlementStatus?: EntitlementStatus | string;
706
806
  /**
807
+ * @public
707
808
  * The name of the entitlement.
708
809
  */
709
810
  Name: string | undefined;
710
811
  /**
812
+ * @public
711
813
  * 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.
712
814
  */
713
815
  Subscribers: string[] | undefined;
@@ -718,10 +820,12 @@ export interface Entitlement {
718
820
  */
719
821
  export interface GatewayNetwork {
720
822
  /**
823
+ * @public
721
824
  * A unique IP address range to use for this network. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
722
825
  */
723
826
  CidrBlock: string | undefined;
724
827
  /**
828
+ * @public
725
829
  * The name of the network. This name is used to reference the network and must be unique among networks in this gateway.
726
830
  */
727
831
  Name: string | undefined;
@@ -732,26 +836,32 @@ export interface GatewayNetwork {
732
836
  */
733
837
  export interface GrantEntitlementRequest {
734
838
  /**
839
+ * @public
735
840
  * Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
736
841
  */
737
842
  DataTransferSubscriberFeePercent?: number;
738
843
  /**
844
+ * @public
739
845
  * 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.
740
846
  */
741
847
  Description?: string;
742
848
  /**
849
+ * @public
743
850
  * The type of encryption that will be used on the output that is associated with this entitlement. Allowable encryption types: static-key, speke.
744
851
  */
745
852
  Encryption?: Encryption;
746
853
  /**
854
+ * @public
747
855
  * An indication of whether the new entitlement should be enabled or disabled as soon as it is created. If you don’t specify the entitlementStatus field in your request, MediaConnect sets it to ENABLED.
748
856
  */
749
857
  EntitlementStatus?: EntitlementStatus | string;
750
858
  /**
859
+ * @public
751
860
  * The name of the entitlement. This value must be unique within the current flow.
752
861
  */
753
862
  Name?: string;
754
863
  /**
864
+ * @public
755
865
  * 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.
756
866
  */
757
867
  Subscribers: string[] | undefined;
@@ -762,14 +872,17 @@ export interface GrantEntitlementRequest {
762
872
  */
763
873
  export interface InputConfiguration {
764
874
  /**
875
+ * @public
765
876
  * The IP address that the flow listens on for incoming content for a media stream.
766
877
  */
767
878
  InputIp: string | undefined;
768
879
  /**
880
+ * @public
769
881
  * The port that the flow listens on for an incoming media stream.
770
882
  */
771
883
  InputPort: number | undefined;
772
884
  /**
885
+ * @public
773
886
  * The VPC interface where the media stream comes in from.
774
887
  */
775
888
  Interface: Interface | undefined;
@@ -780,10 +893,12 @@ export interface InputConfiguration {
780
893
  */
781
894
  export interface InputConfigurationRequest {
782
895
  /**
896
+ * @public
783
897
  * The port that you want the flow to listen on for an incoming media stream.
784
898
  */
785
899
  InputPort: number | undefined;
786
900
  /**
901
+ * @public
787
902
  * The VPC interface that you want to use for the incoming media stream.
788
903
  */
789
904
  Interface: InterfaceRequest | undefined;
@@ -816,19 +931,23 @@ export type BridgeState = (typeof BridgeState)[keyof typeof BridgeState];
816
931
  */
817
932
  export interface ListedBridge {
818
933
  /**
934
+ * @public
819
935
  * The ARN of the bridge.
820
936
  */
821
937
  BridgeArn: string | undefined;
822
938
  BridgeState: BridgeState | string | undefined;
823
939
  /**
940
+ * @public
824
941
  * The type of the bridge.
825
942
  */
826
943
  BridgeType: string | undefined;
827
944
  /**
945
+ * @public
828
946
  * The name of the bridge.
829
947
  */
830
948
  Name: string | undefined;
831
949
  /**
950
+ * @public
832
951
  * The ARN of the gateway associated with the bridge.
833
952
  */
834
953
  PlacementArn: string | undefined;
@@ -839,14 +958,17 @@ export interface ListedBridge {
839
958
  */
840
959
  export interface ListedEntitlement {
841
960
  /**
961
+ * @public
842
962
  * Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
843
963
  */
844
964
  DataTransferSubscriberFeePercent?: number;
845
965
  /**
966
+ * @public
846
967
  * The ARN of the entitlement.
847
968
  */
848
969
  EntitlementArn: string | undefined;
849
970
  /**
971
+ * @public
850
972
  * The name of the entitlement.
851
973
  */
852
974
  EntitlementName: string | undefined;
@@ -874,18 +996,22 @@ export type MaintenanceDay = (typeof MaintenanceDay)[keyof typeof MaintenanceDay
874
996
  */
875
997
  export interface Maintenance {
876
998
  /**
999
+ * @public
877
1000
  * A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
878
1001
  */
879
1002
  MaintenanceDay?: MaintenanceDay | string;
880
1003
  /**
1004
+ * @public
881
1005
  * The Maintenance has to be performed before this deadline in ISO UTC format. Example: 2021-01-30T08:30:00Z.
882
1006
  */
883
1007
  MaintenanceDeadline?: string;
884
1008
  /**
1009
+ * @public
885
1010
  * A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
886
1011
  */
887
1012
  MaintenanceScheduledDate?: string;
888
1013
  /**
1014
+ * @public
889
1015
  * UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
890
1016
  */
891
1017
  MaintenanceStartHour?: string;
@@ -925,30 +1051,37 @@ export type Status = (typeof Status)[keyof typeof Status];
925
1051
  */
926
1052
  export interface ListedFlow {
927
1053
  /**
1054
+ * @public
928
1055
  * The Availability Zone that the flow was created in.
929
1056
  */
930
1057
  AvailabilityZone: string | undefined;
931
1058
  /**
1059
+ * @public
932
1060
  * A description of the flow.
933
1061
  */
934
1062
  Description: string | undefined;
935
1063
  /**
1064
+ * @public
936
1065
  * The ARN of the flow.
937
1066
  */
938
1067
  FlowArn: string | undefined;
939
1068
  /**
1069
+ * @public
940
1070
  * The name of the flow.
941
1071
  */
942
1072
  Name: string | undefined;
943
1073
  /**
1074
+ * @public
944
1075
  * 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).
945
1076
  */
946
1077
  SourceType: SourceType | string | undefined;
947
1078
  /**
1079
+ * @public
948
1080
  * The current status of the flow.
949
1081
  */
950
1082
  Status: Status | string | undefined;
951
1083
  /**
1084
+ * @public
952
1085
  * The maintenance setting of a flow
953
1086
  */
954
1087
  Maintenance?: Maintenance;
@@ -975,11 +1108,13 @@ export type GatewayState = (typeof GatewayState)[keyof typeof GatewayState];
975
1108
  */
976
1109
  export interface ListedGateway {
977
1110
  /**
1111
+ * @public
978
1112
  * The Amazon Resource Name (ARN) of the gateway.
979
1113
  */
980
1114
  GatewayArn: string | undefined;
981
1115
  GatewayState: GatewayState | string | undefined;
982
1116
  /**
1117
+ * @public
983
1118
  * The name of the gateway.
984
1119
  */
985
1120
  Name: string | undefined;
@@ -1006,18 +1141,22 @@ export type InstanceState = (typeof InstanceState)[keyof typeof InstanceState];
1006
1141
  */
1007
1142
  export interface ListedGatewayInstance {
1008
1143
  /**
1144
+ * @public
1009
1145
  * The Amazon Resource Name (ARN) of the gateway.
1010
1146
  */
1011
1147
  GatewayArn: string | undefined;
1012
1148
  /**
1149
+ * @public
1013
1150
  * The Amazon Resource Name (ARN) of the instance.
1014
1151
  */
1015
1152
  GatewayInstanceArn: string | undefined;
1016
1153
  /**
1154
+ * @public
1017
1155
  * The managed instance ID generated by the SSM install. This will begin with "mi-".
1018
1156
  */
1019
1157
  InstanceId: string | undefined;
1020
1158
  /**
1159
+ * @public
1021
1160
  * The status of the instance.
1022
1161
  */
1023
1162
  InstanceState?: InstanceState | string;
@@ -1028,30 +1167,37 @@ export interface ListedGatewayInstance {
1028
1167
  */
1029
1168
  export interface Fmtp {
1030
1169
  /**
1170
+ * @public
1031
1171
  * The format of the audio channel.
1032
1172
  */
1033
1173
  ChannelOrder?: string;
1034
1174
  /**
1175
+ * @public
1035
1176
  * The format that is used for the representation of color.
1036
1177
  */
1037
1178
  Colorimetry?: Colorimetry | string;
1038
1179
  /**
1180
+ * @public
1039
1181
  * The frame rate for the video stream, in frames/second. For example: 60000/1001. If you specify a whole number, MediaConnect uses a ratio of N/1. For example, if you specify 60, MediaConnect uses 60/1 as the exactFramerate.
1040
1182
  */
1041
1183
  ExactFramerate?: string;
1042
1184
  /**
1185
+ * @public
1043
1186
  * The pixel aspect ratio (PAR) of the video.
1044
1187
  */
1045
1188
  Par?: string;
1046
1189
  /**
1190
+ * @public
1047
1191
  * The encoding range of the video.
1048
1192
  */
1049
1193
  Range?: Range | string;
1050
1194
  /**
1195
+ * @public
1051
1196
  * The type of compression that was used to smooth the video’s appearance
1052
1197
  */
1053
1198
  ScanMode?: ScanMode | string;
1054
1199
  /**
1200
+ * @public
1055
1201
  * The transfer characteristic system (TCS) that is used in the video.
1056
1202
  */
1057
1203
  Tcs?: Tcs | string;
@@ -1062,10 +1208,12 @@ export interface Fmtp {
1062
1208
  */
1063
1209
  export interface MediaStreamAttributes {
1064
1210
  /**
1211
+ * @public
1065
1212
  * A set of parameters that define the media stream.
1066
1213
  */
1067
1214
  Fmtp: Fmtp | undefined;
1068
1215
  /**
1216
+ * @public
1069
1217
  * The audio language, in a format that is recognized by the receiver.
1070
1218
  */
1071
1219
  Lang?: string;
@@ -1076,34 +1224,42 @@ export interface MediaStreamAttributes {
1076
1224
  */
1077
1225
  export interface MediaStream {
1078
1226
  /**
1227
+ * @public
1079
1228
  * Attributes that are related to the media stream.
1080
1229
  */
1081
1230
  Attributes?: MediaStreamAttributes;
1082
1231
  /**
1232
+ * @public
1083
1233
  * The sample rate for the stream. This value is measured in Hz.
1084
1234
  */
1085
1235
  ClockRate?: number;
1086
1236
  /**
1237
+ * @public
1087
1238
  * A description that can help you quickly identify what your media stream is used for.
1088
1239
  */
1089
1240
  Description?: string;
1090
1241
  /**
1242
+ * @public
1091
1243
  * The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver.
1092
1244
  */
1093
1245
  Fmt: number | undefined;
1094
1246
  /**
1247
+ * @public
1095
1248
  * A unique identifier for the media stream.
1096
1249
  */
1097
1250
  MediaStreamId: number | undefined;
1098
1251
  /**
1252
+ * @public
1099
1253
  * A name that helps you distinguish one media stream from another.
1100
1254
  */
1101
1255
  MediaStreamName: string | undefined;
1102
1256
  /**
1257
+ * @public
1103
1258
  * The type of media stream.
1104
1259
  */
1105
1260
  MediaStreamType: MediaStreamType | string | undefined;
1106
1261
  /**
1262
+ * @public
1107
1263
  * The resolution of the video.
1108
1264
  */
1109
1265
  VideoFormat?: string;
@@ -1114,10 +1270,12 @@ export interface MediaStream {
1114
1270
  */
1115
1271
  export interface EncodingParameters {
1116
1272
  /**
1273
+ * @public
1117
1274
  * A value that is used to calculate compression for an output. The bitrate of the output is calculated as follows: Output bitrate = (1 / compressionFactor) * (source bitrate) This property only applies to outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol. Valid values are floating point numbers in the range of 3.0 to 10.0, inclusive.
1118
1275
  */
1119
1276
  CompressionFactor: number | undefined;
1120
1277
  /**
1278
+ * @public
1121
1279
  * A setting on the encoder that drives compression settings. This property only applies to video media streams associated with outputs that use the ST 2110 JPEG XS protocol, with a flow source that uses the CDI protocol.
1122
1280
  */
1123
1281
  EncoderProfile: EncoderProfile | string | undefined;
@@ -1128,18 +1286,22 @@ export interface EncodingParameters {
1128
1286
  */
1129
1287
  export interface MediaStreamOutputConfiguration {
1130
1288
  /**
1289
+ * @public
1131
1290
  * The transport parameters that are associated with each outbound media stream.
1132
1291
  */
1133
1292
  DestinationConfigurations?: DestinationConfiguration[];
1134
1293
  /**
1294
+ * @public
1135
1295
  * The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
1136
1296
  */
1137
1297
  EncodingName: EncodingName | string | undefined;
1138
1298
  /**
1299
+ * @public
1139
1300
  * Encoding parameters
1140
1301
  */
1141
1302
  EncodingParameters?: EncodingParameters;
1142
1303
  /**
1304
+ * @public
1143
1305
  * The name of the media stream.
1144
1306
  */
1145
1307
  MediaStreamName: string | undefined;
@@ -1150,14 +1312,17 @@ export interface MediaStreamOutputConfiguration {
1150
1312
  */
1151
1313
  export interface MediaStreamSourceConfiguration {
1152
1314
  /**
1315
+ * @public
1153
1316
  * The format that was used to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
1154
1317
  */
1155
1318
  EncodingName: EncodingName | string | undefined;
1156
1319
  /**
1320
+ * @public
1157
1321
  * The transport parameters that are associated with an incoming media stream.
1158
1322
  */
1159
1323
  InputConfigurations?: InputConfiguration[];
1160
1324
  /**
1325
+ * @public
1161
1326
  * The name of the media stream.
1162
1327
  */
1163
1328
  MediaStreamName: string | undefined;
@@ -1168,14 +1333,17 @@ export interface MediaStreamSourceConfiguration {
1168
1333
  */
1169
1334
  export interface MediaStreamSourceConfigurationRequest {
1170
1335
  /**
1336
+ * @public
1171
1337
  * The format you want to use to encode the data. For ancillary data streams, set the encoding name to smpte291. For audio streams, set the encoding name to pcm. For video, 2110 streams, set the encoding name to raw. For video, JPEG XS streams, set the encoding name to jxsv.
1172
1338
  */
1173
1339
  EncodingName: EncodingName | string | undefined;
1174
1340
  /**
1341
+ * @public
1175
1342
  * The transport parameters that you want to associate with the media stream.
1176
1343
  */
1177
1344
  InputConfigurations?: InputConfigurationRequest[];
1178
1345
  /**
1346
+ * @public
1179
1347
  * The name of the media stream.
1180
1348
  */
1181
1349
  MediaStreamName: string | undefined;
@@ -1185,14 +1353,17 @@ export interface MediaStreamSourceConfigurationRequest {
1185
1353
  */
1186
1354
  export interface MessageDetail {
1187
1355
  /**
1356
+ * @public
1188
1357
  * The error code.
1189
1358
  */
1190
1359
  Code: string | undefined;
1191
1360
  /**
1361
+ * @public
1192
1362
  * The specific error message that MediaConnect returns to help you understand the reason that the request did not succeed.
1193
1363
  */
1194
1364
  Message: string | undefined;
1195
1365
  /**
1366
+ * @public
1196
1367
  * The name of the resource.
1197
1368
  */
1198
1369
  ResourceName?: string;
@@ -1236,10 +1407,12 @@ export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
1236
1407
  */
1237
1408
  export interface ResourceSpecification {
1238
1409
  /**
1410
+ * @public
1239
1411
  * The amount of outbound bandwidth that is discounted in the offering.
1240
1412
  */
1241
1413
  ReservedBitrate?: number;
1242
1414
  /**
1415
+ * @public
1243
1416
  * The type of resource and the unit that is being billed for.
1244
1417
  */
1245
1418
  ResourceType: ResourceType | string | undefined;
@@ -1250,34 +1423,42 @@ export interface ResourceSpecification {
1250
1423
  */
1251
1424
  export interface Offering {
1252
1425
  /**
1426
+ * @public
1253
1427
  * The type of currency that is used for billing. The currencyCode used for all reservations is US dollars.
1254
1428
  */
1255
1429
  CurrencyCode: string | undefined;
1256
1430
  /**
1431
+ * @public
1257
1432
  * The length of time that your reservation would be active.
1258
1433
  */
1259
1434
  Duration: number | undefined;
1260
1435
  /**
1436
+ * @public
1261
1437
  * The unit of measurement for the duration of the offering.
1262
1438
  */
1263
1439
  DurationUnits: DurationUnits | string | undefined;
1264
1440
  /**
1441
+ * @public
1265
1442
  * The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
1266
1443
  */
1267
1444
  OfferingArn: string | undefined;
1268
1445
  /**
1446
+ * @public
1269
1447
  * A description of the offering.
1270
1448
  */
1271
1449
  OfferingDescription: string | undefined;
1272
1450
  /**
1451
+ * @public
1273
1452
  * The cost of a single unit. This value, in combination with priceUnits, makes up the rate.
1274
1453
  */
1275
1454
  PricePerUnit: string | undefined;
1276
1455
  /**
1456
+ * @public
1277
1457
  * The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate.
1278
1458
  */
1279
1459
  PriceUnits: PriceUnits | string | undefined;
1280
1460
  /**
1461
+ * @public
1281
1462
  * A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering.
1282
1463
  */
1283
1464
  ResourceSpecification: ResourceSpecification | undefined;
@@ -1288,54 +1469,67 @@ export interface Offering {
1288
1469
  */
1289
1470
  export interface Transport {
1290
1471
  /**
1472
+ * @public
1291
1473
  * The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
1292
1474
  */
1293
1475
  CidrAllowList?: string[];
1294
1476
  /**
1477
+ * @public
1295
1478
  * The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
1296
1479
  */
1297
1480
  MaxBitrate?: number;
1298
1481
  /**
1482
+ * @public
1299
1483
  * The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
1300
1484
  */
1301
1485
  MaxLatency?: number;
1302
1486
  /**
1487
+ * @public
1303
1488
  * The size of the buffer (in milliseconds) to use to sync incoming source data.
1304
1489
  */
1305
1490
  MaxSyncBuffer?: number;
1306
1491
  /**
1492
+ * @public
1307
1493
  * The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
1308
1494
  */
1309
1495
  MinLatency?: number;
1310
1496
  /**
1497
+ * @public
1311
1498
  * The protocol that is used by the source or output.
1312
1499
  */
1313
1500
  Protocol: Protocol | string | undefined;
1314
1501
  /**
1502
+ * @public
1315
1503
  * The remote ID for the Zixi-pull stream.
1316
1504
  */
1317
1505
  RemoteId?: string;
1318
1506
  /**
1507
+ * @public
1319
1508
  * The port that the flow uses to send outbound requests to initiate connection with the sender.
1320
1509
  */
1321
1510
  SenderControlPort?: number;
1322
1511
  /**
1512
+ * @public
1323
1513
  * The IP address that the flow communicates with to initiate connection with the sender.
1324
1514
  */
1325
1515
  SenderIpAddress?: string;
1326
1516
  /**
1517
+ * @public
1327
1518
  * The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
1328
1519
  */
1329
1520
  SmoothingLatency?: number;
1330
1521
  /**
1522
+ * @public
1331
1523
  * Source IP or domain name for SRT-caller protocol.
1332
1524
  */
1333
1525
  SourceListenerAddress?: string;
1334
1526
  /**
1527
+ * @public
1335
1528
  * Source port for SRT-caller protocol.
1336
1529
  */
1337
1530
  SourceListenerPort?: number;
1338
1531
  /**
1532
+ * @public
1339
1533
  * The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
1340
1534
  */
1341
1535
  StreamId?: string;
@@ -1346,62 +1540,77 @@ export interface Transport {
1346
1540
  */
1347
1541
  export interface Output {
1348
1542
  /**
1543
+ * @public
1349
1544
  * Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
1350
1545
  */
1351
1546
  DataTransferSubscriberFeePercent?: number;
1352
1547
  /**
1548
+ * @public
1353
1549
  * A description of the output.
1354
1550
  */
1355
1551
  Description?: string;
1356
1552
  /**
1553
+ * @public
1357
1554
  * The address where you want to send the output.
1358
1555
  */
1359
1556
  Destination?: string;
1360
1557
  /**
1558
+ * @public
1361
1559
  * The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
1362
1560
  */
1363
1561
  Encryption?: Encryption;
1364
1562
  /**
1563
+ * @public
1365
1564
  * The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.
1366
1565
  */
1367
1566
  EntitlementArn?: string;
1368
1567
  /**
1568
+ * @public
1369
1569
  * The IP address that the receiver requires in order to establish a connection with the flow. For public networking, the ListenerAddress is represented by the elastic IP address of the flow. For private networking, the ListenerAddress is represented by the elastic network interface IP address of the VPC. This field applies only to outputs that use the Zixi pull or SRT listener protocol.
1370
1570
  */
1371
1571
  ListenerAddress?: string;
1372
1572
  /**
1573
+ * @public
1373
1574
  * The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input.
1374
1575
  */
1375
1576
  MediaLiveInputArn?: string;
1376
1577
  /**
1578
+ * @public
1377
1579
  * The configuration for each media stream that is associated with the output.
1378
1580
  */
1379
1581
  MediaStreamOutputConfigurations?: MediaStreamOutputConfiguration[];
1380
1582
  /**
1583
+ * @public
1381
1584
  * The name of the output. This value must be unique within the current flow.
1382
1585
  */
1383
1586
  Name: string | undefined;
1384
1587
  /**
1588
+ * @public
1385
1589
  * The ARN of the output.
1386
1590
  */
1387
1591
  OutputArn: string | undefined;
1388
1592
  /**
1593
+ * @public
1389
1594
  * The port to use when content is distributed to this output.
1390
1595
  */
1391
1596
  Port?: number;
1392
1597
  /**
1598
+ * @public
1393
1599
  * Attributes related to the transport stream that are used in the output.
1394
1600
  */
1395
1601
  Transport?: Transport;
1396
1602
  /**
1603
+ * @public
1397
1604
  * The name of the VPC interface attachment to use for this output.
1398
1605
  */
1399
1606
  VpcInterfaceAttachment?: VpcInterfaceAttachment;
1400
1607
  /**
1608
+ * @public
1401
1609
  * The ARN of the bridge that added this output.
1402
1610
  */
1403
1611
  BridgeArn?: string;
1404
1612
  /**
1613
+ * @public
1405
1614
  * The bridge output ports currently in use.
1406
1615
  */
1407
1616
  BridgePorts?: number[];
@@ -1426,54 +1635,67 @@ export type ReservationState = (typeof ReservationState)[keyof typeof Reservatio
1426
1635
  */
1427
1636
  export interface Reservation {
1428
1637
  /**
1638
+ * @public
1429
1639
  * The type of currency that is used for billing. The currencyCode used for your reservation is US dollars.
1430
1640
  */
1431
1641
  CurrencyCode: string | undefined;
1432
1642
  /**
1643
+ * @public
1433
1644
  * The length of time that this reservation is active. MediaConnect defines this value in the offering.
1434
1645
  */
1435
1646
  Duration: number | undefined;
1436
1647
  /**
1648
+ * @public
1437
1649
  * The unit of measurement for the duration of the reservation. MediaConnect defines this value in the offering.
1438
1650
  */
1439
1651
  DurationUnits: DurationUnits | string | undefined;
1440
1652
  /**
1653
+ * @public
1441
1654
  * The day and time that this reservation expires. This value is calculated based on the start date and time that you set and the offering's duration.
1442
1655
  */
1443
1656
  End: string | undefined;
1444
1657
  /**
1658
+ * @public
1445
1659
  * The Amazon Resource Name (ARN) that MediaConnect assigns to the offering.
1446
1660
  */
1447
1661
  OfferingArn: string | undefined;
1448
1662
  /**
1663
+ * @public
1449
1664
  * A description of the offering. MediaConnect defines this value in the offering.
1450
1665
  */
1451
1666
  OfferingDescription: string | undefined;
1452
1667
  /**
1668
+ * @public
1453
1669
  * The cost of a single unit. This value, in combination with priceUnits, makes up the rate. MediaConnect defines this value in the offering.
1454
1670
  */
1455
1671
  PricePerUnit: string | undefined;
1456
1672
  /**
1673
+ * @public
1457
1674
  * The unit of measurement that is used for billing. This value, in combination with pricePerUnit, makes up the rate. MediaConnect defines this value in the offering.
1458
1675
  */
1459
1676
  PriceUnits: PriceUnits | string | undefined;
1460
1677
  /**
1678
+ * @public
1461
1679
  * The Amazon Resource Name (ARN) that MediaConnect assigns to the reservation when you purchase an offering.
1462
1680
  */
1463
1681
  ReservationArn: string | undefined;
1464
1682
  /**
1683
+ * @public
1465
1684
  * The name that you assigned to the reservation when you purchased the offering.
1466
1685
  */
1467
1686
  ReservationName: string | undefined;
1468
1687
  /**
1688
+ * @public
1469
1689
  * The status of your reservation.
1470
1690
  */
1471
1691
  ReservationState: ReservationState | string | undefined;
1472
1692
  /**
1693
+ * @public
1473
1694
  * A definition of the amount of outbound bandwidth that you would be reserving if you purchase the offering. MediaConnect defines the values that make up the resourceSpecification in the offering.
1474
1695
  */
1475
1696
  ResourceSpecification: ResourceSpecification | undefined;
1476
1697
  /**
1698
+ * @public
1477
1699
  * The day and time that the reservation becomes active. You set this value when you purchase the offering.
1478
1700
  */
1479
1701
  Start: string | undefined;
@@ -1484,10 +1706,12 @@ export interface Reservation {
1484
1706
  */
1485
1707
  export interface SetGatewayBridgeSourceRequest {
1486
1708
  /**
1709
+ * @public
1487
1710
  * The ARN of the bridge feeding this flow.
1488
1711
  */
1489
1712
  BridgeArn: string | undefined;
1490
1713
  /**
1714
+ * @public
1491
1715
  * The name of the VPC interface attachment to use for this bridge source.
1492
1716
  */
1493
1717
  VpcInterfaceAttachment?: VpcInterfaceAttachment;
@@ -1498,78 +1722,97 @@ export interface SetGatewayBridgeSourceRequest {
1498
1722
  */
1499
1723
  export interface SetSourceRequest {
1500
1724
  /**
1725
+ * @public
1501
1726
  * The type of encryption that is used on the content ingested from this source. Allowable encryption types: static-key.
1502
1727
  */
1503
1728
  Decryption?: Encryption;
1504
1729
  /**
1730
+ * @public
1505
1731
  * A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
1506
1732
  */
1507
1733
  Description?: string;
1508
1734
  /**
1735
+ * @public
1509
1736
  * 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.
1510
1737
  */
1511
1738
  EntitlementArn?: string;
1512
1739
  /**
1740
+ * @public
1513
1741
  * The port that the flow will be listening on for incoming content.
1514
1742
  */
1515
1743
  IngestPort?: number;
1516
1744
  /**
1745
+ * @public
1517
1746
  * The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
1518
1747
  */
1519
1748
  MaxBitrate?: number;
1520
1749
  /**
1750
+ * @public
1521
1751
  * The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
1522
1752
  */
1523
1753
  MaxLatency?: number;
1524
1754
  /**
1755
+ * @public
1525
1756
  * The size of the buffer (in milliseconds) to use to sync incoming source data.
1526
1757
  */
1527
1758
  MaxSyncBuffer?: number;
1528
1759
  /**
1760
+ * @public
1529
1761
  * The media streams that are associated with the source, and the parameters for those associations.
1530
1762
  */
1531
1763
  MediaStreamSourceConfigurations?: MediaStreamSourceConfigurationRequest[];
1532
1764
  /**
1765
+ * @public
1533
1766
  * The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
1534
1767
  */
1535
1768
  MinLatency?: number;
1536
1769
  /**
1770
+ * @public
1537
1771
  * The name of the source.
1538
1772
  */
1539
1773
  Name?: string;
1540
1774
  /**
1775
+ * @public
1541
1776
  * The protocol that is used by the source.
1542
1777
  */
1543
1778
  Protocol?: Protocol | string;
1544
1779
  /**
1780
+ * @public
1545
1781
  * The port that the flow uses to send outbound requests to initiate connection with the sender.
1546
1782
  */
1547
1783
  SenderControlPort?: number;
1548
1784
  /**
1785
+ * @public
1549
1786
  * The IP address that the flow communicates with to initiate connection with the sender.
1550
1787
  */
1551
1788
  SenderIpAddress?: string;
1552
1789
  /**
1790
+ * @public
1553
1791
  * Source IP or domain name for SRT-caller protocol.
1554
1792
  */
1555
1793
  SourceListenerAddress?: string;
1556
1794
  /**
1795
+ * @public
1557
1796
  * Source port for SRT-caller protocol.
1558
1797
  */
1559
1798
  SourceListenerPort?: number;
1560
1799
  /**
1800
+ * @public
1561
1801
  * The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
1562
1802
  */
1563
1803
  StreamId?: string;
1564
1804
  /**
1805
+ * @public
1565
1806
  * The name of the VPC interface to use for this source.
1566
1807
  */
1567
1808
  VpcInterfaceName?: string;
1568
1809
  /**
1810
+ * @public
1569
1811
  * The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
1570
1812
  */
1571
1813
  WhitelistCidr?: string;
1572
1814
  /**
1815
+ * @public
1573
1816
  * The source configuration for cloud flows receiving a stream from a bridge.
1574
1817
  */
1575
1818
  GatewayBridgeSource?: SetGatewayBridgeSourceRequest;
@@ -1580,10 +1823,12 @@ export interface SetSourceRequest {
1580
1823
  */
1581
1824
  export interface GatewayBridgeSource {
1582
1825
  /**
1826
+ * @public
1583
1827
  * The ARN of the bridge feeding this flow.
1584
1828
  */
1585
1829
  BridgeArn: string | undefined;
1586
1830
  /**
1831
+ * @public
1587
1832
  * The name of the VPC interface attachment to use for this bridge source.
1588
1833
  */
1589
1834
  VpcInterfaceAttachment?: VpcInterfaceAttachment;
@@ -1594,62 +1839,77 @@ export interface GatewayBridgeSource {
1594
1839
  */
1595
1840
  export interface Source {
1596
1841
  /**
1842
+ * @public
1597
1843
  * Percentage from 0-100 of the data transfer cost to be billed to the subscriber.
1598
1844
  */
1599
1845
  DataTransferSubscriberFeePercent?: number;
1600
1846
  /**
1847
+ * @public
1601
1848
  * The type of encryption that is used on the content ingested from this source.
1602
1849
  */
1603
1850
  Decryption?: Encryption;
1604
1851
  /**
1852
+ * @public
1605
1853
  * A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
1606
1854
  */
1607
1855
  Description?: string;
1608
1856
  /**
1857
+ * @public
1609
1858
  * 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.
1610
1859
  */
1611
1860
  EntitlementArn?: string;
1612
1861
  /**
1862
+ * @public
1613
1863
  * The IP address that the flow will be listening on for incoming content.
1614
1864
  */
1615
1865
  IngestIp?: string;
1616
1866
  /**
1867
+ * @public
1617
1868
  * The port that the flow will be listening on for incoming content.
1618
1869
  */
1619
1870
  IngestPort?: number;
1620
1871
  /**
1872
+ * @public
1621
1873
  * The media streams that are associated with the source, and the parameters for those associations.
1622
1874
  */
1623
1875
  MediaStreamSourceConfigurations?: MediaStreamSourceConfiguration[];
1624
1876
  /**
1877
+ * @public
1625
1878
  * The name of the source.
1626
1879
  */
1627
1880
  Name: string | undefined;
1628
1881
  /**
1882
+ * @public
1629
1883
  * The port that the flow uses to send outbound requests to initiate connection with the sender.
1630
1884
  */
1631
1885
  SenderControlPort?: number;
1632
1886
  /**
1887
+ * @public
1633
1888
  * The IP address that the flow communicates with to initiate connection with the sender.
1634
1889
  */
1635
1890
  SenderIpAddress?: string;
1636
1891
  /**
1892
+ * @public
1637
1893
  * The ARN of the source.
1638
1894
  */
1639
1895
  SourceArn: string | undefined;
1640
1896
  /**
1897
+ * @public
1641
1898
  * Attributes related to the transport stream that are used in the source.
1642
1899
  */
1643
1900
  Transport?: Transport;
1644
1901
  /**
1902
+ * @public
1645
1903
  * The name of the VPC interface that is used for this source.
1646
1904
  */
1647
1905
  VpcInterfaceName?: string;
1648
1906
  /**
1907
+ * @public
1649
1908
  * The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
1650
1909
  */
1651
1910
  WhitelistCidr?: string;
1652
1911
  /**
1912
+ * @public
1653
1913
  * The source configuration for cloud flows receiving a stream from a bridge.
1654
1914
  */
1655
1915
  GatewayBridgeSource?: GatewayBridgeSource;
@@ -1672,26 +1932,32 @@ export type NetworkInterfaceType = (typeof NetworkInterfaceType)[keyof typeof Ne
1672
1932
  */
1673
1933
  export interface VpcInterface {
1674
1934
  /**
1935
+ * @public
1675
1936
  * Immutable and has to be a unique against other VpcInterfaces in this Flow.
1676
1937
  */
1677
1938
  Name: string | undefined;
1678
1939
  /**
1940
+ * @public
1679
1941
  * IDs of the network interfaces created in customer's account by MediaConnect.
1680
1942
  */
1681
1943
  NetworkInterfaceIds: string[] | undefined;
1682
1944
  /**
1945
+ * @public
1683
1946
  * The type of network interface.
1684
1947
  */
1685
1948
  NetworkInterfaceType: NetworkInterfaceType | string | undefined;
1686
1949
  /**
1950
+ * @public
1687
1951
  * Role Arn MediaConnect can assumes to create ENIs in customer's account
1688
1952
  */
1689
1953
  RoleArn: string | undefined;
1690
1954
  /**
1955
+ * @public
1691
1956
  * Security Group IDs to be used on ENI.
1692
1957
  */
1693
1958
  SecurityGroupIds: string[] | undefined;
1694
1959
  /**
1960
+ * @public
1695
1961
  * Subnet must be in the AZ of the Flow
1696
1962
  */
1697
1963
  SubnetId: string | undefined;
@@ -1702,22 +1968,27 @@ export interface VpcInterface {
1702
1968
  */
1703
1969
  export interface VpcInterfaceRequest {
1704
1970
  /**
1971
+ * @public
1705
1972
  * The name of the VPC Interface. This value must be unique within the current flow.
1706
1973
  */
1707
1974
  Name: string | undefined;
1708
1975
  /**
1976
+ * @public
1709
1977
  * The type of network interface. If this value is not included in the request, MediaConnect uses ENA as the networkInterfaceType.
1710
1978
  */
1711
1979
  NetworkInterfaceType?: NetworkInterfaceType | string;
1712
1980
  /**
1981
+ * @public
1713
1982
  * Role Arn MediaConnect can assumes to create ENIs in customer's account
1714
1983
  */
1715
1984
  RoleArn: string | undefined;
1716
1985
  /**
1986
+ * @public
1717
1987
  * Security Group IDs to be used on ENI.
1718
1988
  */
1719
1989
  SecurityGroupIds: string[] | undefined;
1720
1990
  /**
1991
+ * @public
1721
1992
  * Subnet must be in the AZ of the Flow
1722
1993
  */
1723
1994
  SubnetId: string | undefined;
@@ -1728,10 +1999,12 @@ export interface VpcInterfaceRequest {
1728
1999
  */
1729
2000
  export interface AddBridgeOutputsRequest {
1730
2001
  /**
2002
+ * @public
1731
2003
  * The ARN of the bridge that you want to update.
1732
2004
  */
1733
2005
  BridgeArn: string | undefined;
1734
2006
  /**
2007
+ * @public
1735
2008
  * The outputs that you want to add to this bridge.
1736
2009
  */
1737
2010
  Outputs: AddBridgeOutputRequest[] | undefined;
@@ -1741,10 +2014,12 @@ export interface AddBridgeOutputsRequest {
1741
2014
  */
1742
2015
  export interface AddBridgeOutputsResponse {
1743
2016
  /**
2017
+ * @public
1744
2018
  * The Amazon Resource Number (ARN) of the bridge.
1745
2019
  */
1746
2020
  BridgeArn?: string;
1747
2021
  /**
2022
+ * @public
1748
2023
  * The outputs that you added to this bridge.
1749
2024
  */
1750
2025
  Outputs?: BridgeOutput[];
@@ -1757,6 +2032,7 @@ export declare class BadRequestException extends __BaseException {
1757
2032
  readonly name: "BadRequestException";
1758
2033
  readonly $fault: "client";
1759
2034
  /**
2035
+ * @public
1760
2036
  * The error message returned by AWS Elemental MediaConnect.
1761
2037
  */
1762
2038
  Message: string | undefined;
@@ -1773,6 +2049,7 @@ export declare class ConflictException extends __BaseException {
1773
2049
  readonly name: "ConflictException";
1774
2050
  readonly $fault: "client";
1775
2051
  /**
2052
+ * @public
1776
2053
  * The error message returned by AWS Elemental MediaConnect.
1777
2054
  */
1778
2055
  Message: string | undefined;
@@ -1789,6 +2066,7 @@ export declare class ForbiddenException extends __BaseException {
1789
2066
  readonly name: "ForbiddenException";
1790
2067
  readonly $fault: "client";
1791
2068
  /**
2069
+ * @public
1792
2070
  * The error message returned by AWS Elemental MediaConnect.
1793
2071
  */
1794
2072
  Message: string | undefined;
@@ -1805,6 +2083,7 @@ export declare class InternalServerErrorException extends __BaseException {
1805
2083
  readonly name: "InternalServerErrorException";
1806
2084
  readonly $fault: "server";
1807
2085
  /**
2086
+ * @public
1808
2087
  * The error message returned by AWS Elemental MediaConnect.
1809
2088
  */
1810
2089
  Message: string | undefined;
@@ -1821,6 +2100,7 @@ export declare class NotFoundException extends __BaseException {
1821
2100
  readonly name: "NotFoundException";
1822
2101
  readonly $fault: "client";
1823
2102
  /**
2103
+ * @public
1824
2104
  * The error message returned by AWS Elemental MediaConnect.
1825
2105
  */
1826
2106
  Message: string | undefined;
@@ -1837,6 +2117,7 @@ export declare class ServiceUnavailableException extends __BaseException {
1837
2117
  readonly name: "ServiceUnavailableException";
1838
2118
  readonly $fault: "server";
1839
2119
  /**
2120
+ * @public
1840
2121
  * The error message returned by AWS Elemental MediaConnect.
1841
2122
  */
1842
2123
  Message: string | undefined;
@@ -1853,6 +2134,7 @@ export declare class TooManyRequestsException extends __BaseException {
1853
2134
  readonly name: "TooManyRequestsException";
1854
2135
  readonly $fault: "client";
1855
2136
  /**
2137
+ * @public
1856
2138
  * The error message returned by AWS Elemental MediaConnect.
1857
2139
  */
1858
2140
  Message: string | undefined;
@@ -1867,10 +2149,12 @@ export declare class TooManyRequestsException extends __BaseException {
1867
2149
  */
1868
2150
  export interface AddBridgeSourcesRequest {
1869
2151
  /**
2152
+ * @public
1870
2153
  * The ARN of the bridge that you want to update.
1871
2154
  */
1872
2155
  BridgeArn: string | undefined;
1873
2156
  /**
2157
+ * @public
1874
2158
  * The sources that you want to add to this bridge.
1875
2159
  */
1876
2160
  Sources: AddBridgeSourceRequest[] | undefined;
@@ -1880,10 +2164,12 @@ export interface AddBridgeSourcesRequest {
1880
2164
  */
1881
2165
  export interface AddBridgeSourcesResponse {
1882
2166
  /**
2167
+ * @public
1883
2168
  * The Amazon Resource Number (ARN) of the bridge.
1884
2169
  */
1885
2170
  BridgeArn?: string;
1886
2171
  /**
2172
+ * @public
1887
2173
  * The sources that you added to this bridge.
1888
2174
  */
1889
2175
  Sources?: BridgeSource[];
@@ -1893,6 +2179,7 @@ export interface AddBridgeSourcesResponse {
1893
2179
  */
1894
2180
  export interface AddEgressGatewayBridgeRequest {
1895
2181
  /**
2182
+ * @public
1896
2183
  * The maximum expected bitrate (in bps).
1897
2184
  */
1898
2185
  MaxBitrate: number | undefined;
@@ -1903,10 +2190,12 @@ export interface AddEgressGatewayBridgeRequest {
1903
2190
  */
1904
2191
  export interface AddFlowMediaStreamsRequest {
1905
2192
  /**
2193
+ * @public
1906
2194
  * The Amazon Resource Name (ARN) of the flow.
1907
2195
  */
1908
2196
  FlowArn: string | undefined;
1909
2197
  /**
2198
+ * @public
1910
2199
  * The media streams that you want to add to the flow.
1911
2200
  */
1912
2201
  MediaStreams: AddMediaStreamRequest[] | undefined;
@@ -1916,10 +2205,12 @@ export interface AddFlowMediaStreamsRequest {
1916
2205
  */
1917
2206
  export interface AddFlowMediaStreamsResponse {
1918
2207
  /**
2208
+ * @public
1919
2209
  * The ARN of the flow that you added media streams to.
1920
2210
  */
1921
2211
  FlowArn?: string;
1922
2212
  /**
2213
+ * @public
1923
2214
  * The media streams that you added to the flow.
1924
2215
  */
1925
2216
  MediaStreams?: MediaStream[];
@@ -1932,6 +2223,7 @@ export declare class AddFlowOutputs420Exception extends __BaseException {
1932
2223
  readonly name: "AddFlowOutputs420Exception";
1933
2224
  readonly $fault: "client";
1934
2225
  /**
2226
+ * @public
1935
2227
  * The error message returned by AWS Elemental MediaConnect.
1936
2228
  */
1937
2229
  Message: string | undefined;
@@ -1946,10 +2238,12 @@ export declare class AddFlowOutputs420Exception extends __BaseException {
1946
2238
  */
1947
2239
  export interface AddFlowOutputsRequest {
1948
2240
  /**
2241
+ * @public
1949
2242
  * The flow that you want to add outputs to.
1950
2243
  */
1951
2244
  FlowArn: string | undefined;
1952
2245
  /**
2246
+ * @public
1953
2247
  * A list of outputs that you want to add.
1954
2248
  */
1955
2249
  Outputs: AddOutputRequest[] | undefined;
@@ -1959,10 +2253,12 @@ export interface AddFlowOutputsRequest {
1959
2253
  */
1960
2254
  export interface AddFlowOutputsResponse {
1961
2255
  /**
2256
+ * @public
1962
2257
  * The ARN of the flow that these outputs were added to.
1963
2258
  */
1964
2259
  FlowArn?: string;
1965
2260
  /**
2261
+ * @public
1966
2262
  * The details of the newly added outputs.
1967
2263
  */
1968
2264
  Outputs?: Output[];
@@ -1973,10 +2269,12 @@ export interface AddFlowOutputsResponse {
1973
2269
  */
1974
2270
  export interface AddFlowSourcesRequest {
1975
2271
  /**
2272
+ * @public
1976
2273
  * The flow that you want to mutate.
1977
2274
  */
1978
2275
  FlowArn: string | undefined;
1979
2276
  /**
2277
+ * @public
1980
2278
  * A list of sources that you want to add.
1981
2279
  */
1982
2280
  Sources: SetSourceRequest[] | undefined;
@@ -1986,10 +2284,12 @@ export interface AddFlowSourcesRequest {
1986
2284
  */
1987
2285
  export interface AddFlowSourcesResponse {
1988
2286
  /**
2287
+ * @public
1989
2288
  * The ARN of the flow that these sources were added to.
1990
2289
  */
1991
2290
  FlowArn?: string;
1992
2291
  /**
2292
+ * @public
1993
2293
  * The details of the newly added sources.
1994
2294
  */
1995
2295
  Sources?: Source[];
@@ -2000,10 +2300,12 @@ export interface AddFlowSourcesResponse {
2000
2300
  */
2001
2301
  export interface AddFlowVpcInterfacesRequest {
2002
2302
  /**
2303
+ * @public
2003
2304
  * The flow that you want to mutate.
2004
2305
  */
2005
2306
  FlowArn: string | undefined;
2006
2307
  /**
2308
+ * @public
2007
2309
  * A list of VPC interfaces that you want to add.
2008
2310
  */
2009
2311
  VpcInterfaces: VpcInterfaceRequest[] | undefined;
@@ -2013,10 +2315,12 @@ export interface AddFlowVpcInterfacesRequest {
2013
2315
  */
2014
2316
  export interface AddFlowVpcInterfacesResponse {
2015
2317
  /**
2318
+ * @public
2016
2319
  * The ARN of the flow that these VPC interfaces were added to.
2017
2320
  */
2018
2321
  FlowArn?: string;
2019
2322
  /**
2323
+ * @public
2020
2324
  * The details of the newly added VPC interfaces.
2021
2325
  */
2022
2326
  VpcInterfaces?: VpcInterface[];
@@ -2026,10 +2330,12 @@ export interface AddFlowVpcInterfacesResponse {
2026
2330
  */
2027
2331
  export interface AddIngressGatewayBridgeRequest {
2028
2332
  /**
2333
+ * @public
2029
2334
  * The maximum expected bitrate (in bps).
2030
2335
  */
2031
2336
  MaxBitrate: number | undefined;
2032
2337
  /**
2338
+ * @public
2033
2339
  * The maximum number of expected outputs.
2034
2340
  */
2035
2341
  MaxOutputs: number | undefined;
@@ -2040,10 +2346,12 @@ export interface AddIngressGatewayBridgeRequest {
2040
2346
  */
2041
2347
  export interface AddMaintenance {
2042
2348
  /**
2349
+ * @public
2043
2350
  * A day of a week when the maintenance will happen. Use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
2044
2351
  */
2045
2352
  MaintenanceDay: MaintenanceDay | string | undefined;
2046
2353
  /**
2354
+ * @public
2047
2355
  * UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
2048
2356
  */
2049
2357
  MaintenanceStartHour: string | undefined;
@@ -2053,10 +2361,12 @@ export interface AddMaintenance {
2053
2361
  */
2054
2362
  export interface EgressGatewayBridge {
2055
2363
  /**
2364
+ * @public
2056
2365
  * The ID of the instance running this bridge.
2057
2366
  */
2058
2367
  InstanceId?: string;
2059
2368
  /**
2369
+ * @public
2060
2370
  * The maximum expected bitrate (in bps) of the egress bridge.
2061
2371
  */
2062
2372
  MaxBitrate: number | undefined;
@@ -2066,14 +2376,17 @@ export interface EgressGatewayBridge {
2066
2376
  */
2067
2377
  export interface IngressGatewayBridge {
2068
2378
  /**
2379
+ * @public
2069
2380
  * The ID of the instance running this bridge.
2070
2381
  */
2071
2382
  InstanceId?: string;
2072
2383
  /**
2384
+ * @public
2073
2385
  * The maximum expected bitrate (in bps) of the ingress bridge.
2074
2386
  */
2075
2387
  MaxBitrate: number | undefined;
2076
2388
  /**
2389
+ * @public
2077
2390
  * The maximum number of outputs on the ingress bridge.
2078
2391
  */
2079
2392
  MaxOutputs: number | undefined;
@@ -2096,6 +2409,7 @@ export type FailoverMode = (typeof FailoverMode)[keyof typeof FailoverMode];
2096
2409
  */
2097
2410
  export interface SourcePriority {
2098
2411
  /**
2412
+ * @public
2099
2413
  * The name of the source you choose as the primary source for this flow.
2100
2414
  */
2101
2415
  PrimarySource?: string;
@@ -2118,14 +2432,17 @@ export type State = (typeof State)[keyof typeof State];
2118
2432
  */
2119
2433
  export interface FailoverConfig {
2120
2434
  /**
2435
+ * @public
2121
2436
  * The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
2122
2437
  */
2123
2438
  FailoverMode?: FailoverMode | string;
2124
2439
  /**
2440
+ * @public
2125
2441
  * Search window time to look for dash-7 packets
2126
2442
  */
2127
2443
  RecoveryWindow?: number;
2128
2444
  /**
2445
+ * @public
2129
2446
  * The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
2130
2447
  */
2131
2448
  SourcePriority?: SourcePriority;
@@ -2137,6 +2454,7 @@ export interface FailoverConfig {
2137
2454
  */
2138
2455
  export interface Bridge {
2139
2456
  /**
2457
+ * @public
2140
2458
  * The Amazon Resource Number (ARN) of the bridge.
2141
2459
  */
2142
2460
  BridgeArn: string | undefined;
@@ -2145,22 +2463,27 @@ export interface Bridge {
2145
2463
  EgressGatewayBridge?: EgressGatewayBridge;
2146
2464
  IngressGatewayBridge?: IngressGatewayBridge;
2147
2465
  /**
2466
+ * @public
2148
2467
  * The name of the bridge.
2149
2468
  */
2150
2469
  Name: string | undefined;
2151
2470
  /**
2471
+ * @public
2152
2472
  * The outputs on this bridge.
2153
2473
  */
2154
2474
  Outputs?: BridgeOutput[];
2155
2475
  /**
2476
+ * @public
2156
2477
  * The placement Amazon Resource Number (ARN) of the bridge.
2157
2478
  */
2158
2479
  PlacementArn: string | undefined;
2159
2480
  /**
2481
+ * @public
2160
2482
  * The settings for source failover.
2161
2483
  */
2162
2484
  SourceFailoverConfig?: FailoverConfig;
2163
2485
  /**
2486
+ * @public
2164
2487
  * The sources on this bridge.
2165
2488
  */
2166
2489
  Sources?: BridgeSource[];
@@ -2197,6 +2520,7 @@ export declare class CreateBridge420Exception extends __BaseException {
2197
2520
  readonly name: "CreateBridge420Exception";
2198
2521
  readonly $fault: "client";
2199
2522
  /**
2523
+ * @public
2200
2524
  * The error message returned by AWS Elemental MediaConnect.
2201
2525
  */
2202
2526
  Message: string | undefined;
@@ -2211,30 +2535,37 @@ export declare class CreateBridge420Exception extends __BaseException {
2211
2535
  */
2212
2536
  export interface CreateBridgeRequest {
2213
2537
  /**
2538
+ * @public
2214
2539
  * Create a bridge with the egress bridge type. An egress bridge is a cloud-to-ground bridge. The content comes from an existing MediaConnect flow and is delivered to your premises.
2215
2540
  */
2216
2541
  EgressGatewayBridge?: AddEgressGatewayBridgeRequest;
2217
2542
  /**
2543
+ * @public
2218
2544
  * Create a bridge with the ingress bridge type. An ingress bridge is a ground-to-cloud bridge. The content originates at your premises and is delivered to the cloud.
2219
2545
  */
2220
2546
  IngressGatewayBridge?: AddIngressGatewayBridgeRequest;
2221
2547
  /**
2548
+ * @public
2222
2549
  * The name of the bridge. This name can not be modified after the bridge is created.
2223
2550
  */
2224
2551
  Name: string | undefined;
2225
2552
  /**
2553
+ * @public
2226
2554
  * The outputs that you want to add to this bridge.
2227
2555
  */
2228
2556
  Outputs?: AddBridgeOutputRequest[];
2229
2557
  /**
2558
+ * @public
2230
2559
  * The bridge placement Amazon Resource Number (ARN).
2231
2560
  */
2232
2561
  PlacementArn: string | undefined;
2233
2562
  /**
2563
+ * @public
2234
2564
  * The settings for source failover.
2235
2565
  */
2236
2566
  SourceFailoverConfig?: FailoverConfig;
2237
2567
  /**
2568
+ * @public
2238
2569
  * The sources that you want to add to this bridge.
2239
2570
  */
2240
2571
  Sources: AddBridgeSourceRequest[] | undefined;
@@ -2244,6 +2575,7 @@ export interface CreateBridgeRequest {
2244
2575
  */
2245
2576
  export interface CreateBridgeResponse {
2246
2577
  /**
2578
+ * @public
2247
2579
  * A Bridge is the connection between your datacenter's Instances and the AWS cloud. A bridge can be used to send video from the AWS cloud to your datacenter or from your datacenter to the AWS cloud.
2248
2580
  */
2249
2581
  Bridge?: Bridge;
@@ -2256,6 +2588,7 @@ export declare class CreateFlow420Exception extends __BaseException {
2256
2588
  readonly name: "CreateFlow420Exception";
2257
2589
  readonly $fault: "client";
2258
2590
  /**
2591
+ * @public
2259
2592
  * The error message returned by AWS Elemental MediaConnect.
2260
2593
  */
2261
2594
  Message: string | undefined;
@@ -2270,39 +2603,48 @@ export declare class CreateFlow420Exception extends __BaseException {
2270
2603
  */
2271
2604
  export interface CreateFlowRequest {
2272
2605
  /**
2606
+ * @public
2273
2607
  * The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region.
2274
2608
  */
2275
2609
  AvailabilityZone?: string;
2276
2610
  /**
2611
+ * @public
2277
2612
  * The entitlements that you want to grant on a flow.
2278
2613
  */
2279
2614
  Entitlements?: GrantEntitlementRequest[];
2280
2615
  /**
2616
+ * @public
2281
2617
  * The media streams that you want to add to the flow. You can associate these media streams with sources and outputs on the flow.
2282
2618
  */
2283
2619
  MediaStreams?: AddMediaStreamRequest[];
2284
2620
  /**
2621
+ * @public
2285
2622
  * The name of the flow.
2286
2623
  */
2287
2624
  Name: string | undefined;
2288
2625
  /**
2626
+ * @public
2289
2627
  * The outputs that you want to add to this flow.
2290
2628
  */
2291
2629
  Outputs?: AddOutputRequest[];
2292
2630
  /**
2631
+ * @public
2293
2632
  * The settings for the source of the flow.
2294
2633
  */
2295
2634
  Source?: SetSourceRequest;
2296
2635
  /**
2636
+ * @public
2297
2637
  * The settings for source failover.
2298
2638
  */
2299
2639
  SourceFailoverConfig?: FailoverConfig;
2300
2640
  Sources?: SetSourceRequest[];
2301
2641
  /**
2642
+ * @public
2302
2643
  * The VPC interfaces you want on the flow.
2303
2644
  */
2304
2645
  VpcInterfaces?: VpcInterfaceRequest[];
2305
2646
  /**
2647
+ * @public
2306
2648
  * Create maintenance setting for a flow
2307
2649
  */
2308
2650
  Maintenance?: AddMaintenance;
@@ -2313,55 +2655,68 @@ export interface CreateFlowRequest {
2313
2655
  */
2314
2656
  export interface Flow {
2315
2657
  /**
2658
+ * @public
2316
2659
  * The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS.
2317
2660
  */
2318
2661
  AvailabilityZone: string | undefined;
2319
2662
  /**
2663
+ * @public
2320
2664
  * A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
2321
2665
  */
2322
2666
  Description?: string;
2323
2667
  /**
2668
+ * @public
2324
2669
  * The IP address from which video will be sent to output destinations.
2325
2670
  */
2326
2671
  EgressIp?: string;
2327
2672
  /**
2673
+ * @public
2328
2674
  * The entitlements in this flow.
2329
2675
  */
2330
2676
  Entitlements: Entitlement[] | undefined;
2331
2677
  /**
2678
+ * @public
2332
2679
  * The Amazon Resource Name (ARN) of the flow.
2333
2680
  */
2334
2681
  FlowArn: string | undefined;
2335
2682
  /**
2683
+ * @public
2336
2684
  * The media streams that are associated with the flow. After you associate a media stream with a source, you can also associate it with outputs on the flow.
2337
2685
  */
2338
2686
  MediaStreams?: MediaStream[];
2339
2687
  /**
2688
+ * @public
2340
2689
  * The name of the flow.
2341
2690
  */
2342
2691
  Name: string | undefined;
2343
2692
  /**
2693
+ * @public
2344
2694
  * The outputs in this flow.
2345
2695
  */
2346
2696
  Outputs: Output[] | undefined;
2347
2697
  /**
2698
+ * @public
2348
2699
  * The settings for the source of the flow.
2349
2700
  */
2350
2701
  Source: Source | undefined;
2351
2702
  /**
2703
+ * @public
2352
2704
  * The settings for source failover.
2353
2705
  */
2354
2706
  SourceFailoverConfig?: FailoverConfig;
2355
2707
  Sources?: Source[];
2356
2708
  /**
2709
+ * @public
2357
2710
  * The current status of the flow.
2358
2711
  */
2359
2712
  Status: Status | string | undefined;
2360
2713
  /**
2714
+ * @public
2361
2715
  * The VPC Interfaces for this flow.
2362
2716
  */
2363
2717
  VpcInterfaces?: VpcInterface[];
2364
2718
  /**
2719
+ * @public
2365
2720
  * The maintenance setting of a flow
2366
2721
  */
2367
2722
  Maintenance?: Maintenance;
@@ -2371,6 +2726,7 @@ export interface Flow {
2371
2726
  */
2372
2727
  export interface CreateFlowResponse {
2373
2728
  /**
2729
+ * @public
2374
2730
  * The settings for a flow, including its source, outputs, and entitlements.
2375
2731
  */
2376
2732
  Flow?: Flow;
@@ -2383,6 +2739,7 @@ export declare class CreateGateway420Exception extends __BaseException {
2383
2739
  readonly name: "CreateGateway420Exception";
2384
2740
  readonly $fault: "client";
2385
2741
  /**
2742
+ * @public
2386
2743
  * The error message returned by AWS Elemental MediaConnect.
2387
2744
  */
2388
2745
  Message: string | undefined;
@@ -2397,14 +2754,17 @@ export declare class CreateGateway420Exception extends __BaseException {
2397
2754
  */
2398
2755
  export interface CreateGatewayRequest {
2399
2756
  /**
2757
+ * @public
2400
2758
  * The range of IP addresses that are allowed to contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
2401
2759
  */
2402
2760
  EgressCidrBlocks: string[] | undefined;
2403
2761
  /**
2762
+ * @public
2404
2763
  * The name of the gateway. This name can not be modified after the gateway is created.
2405
2764
  */
2406
2765
  Name: string | undefined;
2407
2766
  /**
2767
+ * @public
2408
2768
  * The list of networks that you want to add.
2409
2769
  */
2410
2770
  Networks: GatewayNetwork[] | undefined;
@@ -2415,23 +2775,28 @@ export interface CreateGatewayRequest {
2415
2775
  */
2416
2776
  export interface Gateway {
2417
2777
  /**
2778
+ * @public
2418
2779
  * The range of IP addresses that contribute content or initiate output requests for flows communicating with this gateway. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
2419
2780
  */
2420
2781
  EgressCidrBlocks: string[] | undefined;
2421
2782
  /**
2783
+ * @public
2422
2784
  * The Amazon Resource Name (ARN) of the gateway.
2423
2785
  */
2424
2786
  GatewayArn: string | undefined;
2425
2787
  GatewayMessages?: MessageDetail[];
2426
2788
  /**
2789
+ * @public
2427
2790
  * The current status of the gateway.
2428
2791
  */
2429
2792
  GatewayState?: GatewayState | string;
2430
2793
  /**
2794
+ * @public
2431
2795
  * The name of the gateway. This name can not be modified after the gateway is created.
2432
2796
  */
2433
2797
  Name: string | undefined;
2434
2798
  /**
2799
+ * @public
2435
2800
  * The list of networks in the gateway.
2436
2801
  */
2437
2802
  Networks: GatewayNetwork[] | undefined;
@@ -2441,6 +2806,7 @@ export interface Gateway {
2441
2806
  */
2442
2807
  export interface CreateGatewayResponse {
2443
2808
  /**
2809
+ * @public
2444
2810
  * The settings for a gateway, including its networks.
2445
2811
  */
2446
2812
  Gateway?: Gateway;
@@ -2450,6 +2816,7 @@ export interface CreateGatewayResponse {
2450
2816
  */
2451
2817
  export interface DeleteBridgeRequest {
2452
2818
  /**
2819
+ * @public
2453
2820
  * The ARN of the bridge that you want to delete.
2454
2821
  */
2455
2822
  BridgeArn: string | undefined;
@@ -2459,6 +2826,7 @@ export interface DeleteBridgeRequest {
2459
2826
  */
2460
2827
  export interface DeleteBridgeResponse {
2461
2828
  /**
2829
+ * @public
2462
2830
  * The Amazon Resource Number (ARN) of the deleted bridge.
2463
2831
  */
2464
2832
  BridgeArn?: string;
@@ -2468,6 +2836,7 @@ export interface DeleteBridgeResponse {
2468
2836
  */
2469
2837
  export interface DeleteFlowRequest {
2470
2838
  /**
2839
+ * @public
2471
2840
  * The ARN of the flow that you want to delete.
2472
2841
  */
2473
2842
  FlowArn: string | undefined;
@@ -2477,10 +2846,12 @@ export interface DeleteFlowRequest {
2477
2846
  */
2478
2847
  export interface DeleteFlowResponse {
2479
2848
  /**
2849
+ * @public
2480
2850
  * The ARN of the flow that was deleted.
2481
2851
  */
2482
2852
  FlowArn?: string;
2483
2853
  /**
2854
+ * @public
2484
2855
  * The status of the flow when the DeleteFlow process begins.
2485
2856
  */
2486
2857
  Status?: Status | string;
@@ -2490,6 +2861,7 @@ export interface DeleteFlowResponse {
2490
2861
  */
2491
2862
  export interface DeleteGatewayRequest {
2492
2863
  /**
2864
+ * @public
2493
2865
  * The ARN of the gateway that you want to delete.
2494
2866
  */
2495
2867
  GatewayArn: string | undefined;
@@ -2499,6 +2871,7 @@ export interface DeleteGatewayRequest {
2499
2871
  */
2500
2872
  export interface DeleteGatewayResponse {
2501
2873
  /**
2874
+ * @public
2502
2875
  * The Amazon Resource Name (ARN) of the gateway that was deleted.
2503
2876
  */
2504
2877
  GatewayArn?: string;
@@ -2508,10 +2881,12 @@ export interface DeleteGatewayResponse {
2508
2881
  */
2509
2882
  export interface DeregisterGatewayInstanceRequest {
2510
2883
  /**
2884
+ * @public
2511
2885
  * Force the deregistration of an instance. Force will deregister an instance, even if there are bridges running on it.
2512
2886
  */
2513
2887
  Force?: boolean;
2514
2888
  /**
2889
+ * @public
2515
2890
  * The Amazon Resource Name (ARN) of the gateway that contains the instance that you want to deregister.
2516
2891
  */
2517
2892
  GatewayInstanceArn: string | undefined;
@@ -2521,10 +2896,12 @@ export interface DeregisterGatewayInstanceRequest {
2521
2896
  */
2522
2897
  export interface DeregisterGatewayInstanceResponse {
2523
2898
  /**
2899
+ * @public
2524
2900
  * The Amazon Resource Name (ARN) of the instance.
2525
2901
  */
2526
2902
  GatewayInstanceArn?: string;
2527
2903
  /**
2904
+ * @public
2528
2905
  * The status of the instance.
2529
2906
  */
2530
2907
  InstanceState?: InstanceState | string;
@@ -2534,6 +2911,7 @@ export interface DeregisterGatewayInstanceResponse {
2534
2911
  */
2535
2912
  export interface DescribeBridgeRequest {
2536
2913
  /**
2914
+ * @public
2537
2915
  * The ARN of the bridge that you want to describe.
2538
2916
  */
2539
2917
  BridgeArn: string | undefined;
@@ -2543,6 +2921,7 @@ export interface DescribeBridgeRequest {
2543
2921
  */
2544
2922
  export interface DescribeBridgeResponse {
2545
2923
  /**
2924
+ * @public
2546
2925
  * A Bridge is the connection between your datacenter's Instances and the AWS cloud. A bridge can be used to send video from the AWS cloud to your datacenter or from your datacenter to the AWS cloud.
2547
2926
  */
2548
2927
  Bridge?: Bridge;
@@ -2552,6 +2931,7 @@ export interface DescribeBridgeResponse {
2552
2931
  */
2553
2932
  export interface DescribeFlowRequest {
2554
2933
  /**
2934
+ * @public
2555
2935
  * The ARN of the flow that you want to describe.
2556
2936
  */
2557
2937
  FlowArn: string | undefined;
@@ -2562,6 +2942,7 @@ export interface DescribeFlowRequest {
2562
2942
  */
2563
2943
  export interface Messages {
2564
2944
  /**
2945
+ * @public
2565
2946
  * A list of errors that might have been generated from processes on this flow.
2566
2947
  */
2567
2948
  Errors: string[] | undefined;
@@ -2571,10 +2952,12 @@ export interface Messages {
2571
2952
  */
2572
2953
  export interface DescribeFlowResponse {
2573
2954
  /**
2955
+ * @public
2574
2956
  * The settings for a flow, including its source, outputs, and entitlements.
2575
2957
  */
2576
2958
  Flow?: Flow;
2577
2959
  /**
2960
+ * @public
2578
2961
  * Messages that provide the state of the flow.
2579
2962
  */
2580
2963
  Messages?: Messages;
@@ -2584,6 +2967,7 @@ export interface DescribeFlowResponse {
2584
2967
  */
2585
2968
  export interface DescribeGatewayRequest {
2586
2969
  /**
2970
+ * @public
2587
2971
  * The Amazon Resource Name (ARN) of the gateway that you want to describe.
2588
2972
  */
2589
2973
  GatewayArn: string | undefined;
@@ -2593,6 +2977,7 @@ export interface DescribeGatewayRequest {
2593
2977
  */
2594
2978
  export interface DescribeGatewayResponse {
2595
2979
  /**
2980
+ * @public
2596
2981
  * The settings for a gateway, including its networks.
2597
2982
  */
2598
2983
  Gateway?: Gateway;
@@ -2602,6 +2987,7 @@ export interface DescribeGatewayResponse {
2602
2987
  */
2603
2988
  export interface DescribeGatewayInstanceRequest {
2604
2989
  /**
2990
+ * @public
2605
2991
  * The Amazon Resource Name (ARN) of the gateway instance that you want to describe.
2606
2992
  */
2607
2993
  GatewayInstanceArn: string | undefined;
@@ -2612,31 +2998,38 @@ export interface DescribeGatewayInstanceRequest {
2612
2998
  */
2613
2999
  export interface GatewayInstance {
2614
3000
  /**
3001
+ * @public
2615
3002
  * The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance.
2616
3003
  */
2617
3004
  BridgePlacement: BridgePlacement | string | undefined;
2618
3005
  /**
3006
+ * @public
2619
3007
  * The connection state of the instance.
2620
3008
  */
2621
3009
  ConnectionStatus: ConnectionStatus | string | undefined;
2622
3010
  /**
3011
+ * @public
2623
3012
  * The Amazon Resource Name (ARN) of the instance.
2624
3013
  */
2625
3014
  GatewayArn: string | undefined;
2626
3015
  /**
3016
+ * @public
2627
3017
  * The Amazon Resource Name (ARN) of the gateway.
2628
3018
  */
2629
3019
  GatewayInstanceArn: string | undefined;
2630
3020
  /**
3021
+ * @public
2631
3022
  * The managed instance ID generated by the SSM install. This will begin with "mi-".
2632
3023
  */
2633
3024
  InstanceId: string | undefined;
2634
3025
  InstanceMessages?: MessageDetail[];
2635
3026
  /**
3027
+ * @public
2636
3028
  * The status of the instance.
2637
3029
  */
2638
3030
  InstanceState: InstanceState | string | undefined;
2639
3031
  /**
3032
+ * @public
2640
3033
  * The running bridge count.
2641
3034
  */
2642
3035
  RunningBridgeCount: number | undefined;
@@ -2646,6 +3039,7 @@ export interface GatewayInstance {
2646
3039
  */
2647
3040
  export interface DescribeGatewayInstanceResponse {
2648
3041
  /**
3042
+ * @public
2649
3043
  * The settings for an instance in a gateway.
2650
3044
  */
2651
3045
  GatewayInstance?: GatewayInstance;
@@ -2655,6 +3049,7 @@ export interface DescribeGatewayInstanceResponse {
2655
3049
  */
2656
3050
  export interface DescribeOfferingRequest {
2657
3051
  /**
3052
+ * @public
2658
3053
  * The Amazon Resource Name (ARN) of the offering.
2659
3054
  */
2660
3055
  OfferingArn: string | undefined;
@@ -2664,6 +3059,7 @@ export interface DescribeOfferingRequest {
2664
3059
  */
2665
3060
  export interface DescribeOfferingResponse {
2666
3061
  /**
3062
+ * @public
2667
3063
  * A savings plan that reserves a certain amount of outbound bandwidth usage at a discounted rate each month over a period of time.
2668
3064
  */
2669
3065
  Offering?: Offering;
@@ -2673,6 +3069,7 @@ export interface DescribeOfferingResponse {
2673
3069
  */
2674
3070
  export interface DescribeReservationRequest {
2675
3071
  /**
3072
+ * @public
2676
3073
  * The Amazon Resource Name (ARN) of the reservation.
2677
3074
  */
2678
3075
  ReservationArn: string | undefined;
@@ -2682,6 +3079,7 @@ export interface DescribeReservationRequest {
2682
3079
  */
2683
3080
  export interface DescribeReservationResponse {
2684
3081
  /**
3082
+ * @public
2685
3083
  * A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
2686
3084
  */
2687
3085
  Reservation?: Reservation;
@@ -2707,6 +3105,7 @@ export declare class GrantFlowEntitlements420Exception extends __BaseException {
2707
3105
  readonly name: "GrantFlowEntitlements420Exception";
2708
3106
  readonly $fault: "client";
2709
3107
  /**
3108
+ * @public
2710
3109
  * The error message returned by AWS Elemental MediaConnect.
2711
3110
  */
2712
3111
  Message: string | undefined;
@@ -2721,10 +3120,12 @@ export declare class GrantFlowEntitlements420Exception extends __BaseException {
2721
3120
  */
2722
3121
  export interface GrantFlowEntitlementsRequest {
2723
3122
  /**
3123
+ * @public
2724
3124
  * The list of entitlements that you want to grant.
2725
3125
  */
2726
3126
  Entitlements: GrantEntitlementRequest[] | undefined;
2727
3127
  /**
3128
+ * @public
2728
3129
  * The flow that you want to grant entitlements on.
2729
3130
  */
2730
3131
  FlowArn: string | undefined;
@@ -2734,10 +3135,12 @@ export interface GrantFlowEntitlementsRequest {
2734
3135
  */
2735
3136
  export interface GrantFlowEntitlementsResponse {
2736
3137
  /**
3138
+ * @public
2737
3139
  * The entitlements that were just granted.
2738
3140
  */
2739
3141
  Entitlements?: Entitlement[];
2740
3142
  /**
3143
+ * @public
2741
3144
  * The ARN of the flow that these entitlements were granted to.
2742
3145
  */
2743
3146
  FlowArn?: string;
@@ -2747,14 +3150,17 @@ export interface GrantFlowEntitlementsResponse {
2747
3150
  */
2748
3151
  export interface ListBridgesRequest {
2749
3152
  /**
3153
+ * @public
2750
3154
  * Filter the list results to display only the bridges associated with the selected Amazon Resource Name (ARN).
2751
3155
  */
2752
3156
  FilterArn?: string;
2753
3157
  /**
3158
+ * @public
2754
3159
  * The maximum number of results to return per API request. For example, you submit a ListBridges 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.
2755
3160
  */
2756
3161
  MaxResults?: number;
2757
3162
  /**
3163
+ * @public
2758
3164
  * The token that identifies which batch of results that you want to see. For example, you submit a ListBridges 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 ListBridges request a second time and specify the NextToken value.
2759
3165
  */
2760
3166
  NextToken?: string;
@@ -2764,10 +3170,12 @@ export interface ListBridgesRequest {
2764
3170
  */
2765
3171
  export interface ListBridgesResponse {
2766
3172
  /**
3173
+ * @public
2767
3174
  * A list of bridge summaries.
2768
3175
  */
2769
3176
  Bridges?: ListedBridge[];
2770
3177
  /**
3178
+ * @public
2771
3179
  * The token that identifies which batch of results that you want to see. For example, you submit a ListBridges 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 ListBridges request a second time and specify the NextToken value.
2772
3180
  */
2773
3181
  NextToken?: string;
@@ -2777,10 +3185,12 @@ export interface ListBridgesResponse {
2777
3185
  */
2778
3186
  export interface ListEntitlementsRequest {
2779
3187
  /**
3188
+ * @public
2780
3189
  * 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.
2781
3190
  */
2782
3191
  MaxResults?: number;
2783
3192
  /**
3193
+ * @public
2784
3194
  * 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.
2785
3195
  */
2786
3196
  NextToken?: string;
@@ -2790,10 +3200,12 @@ export interface ListEntitlementsRequest {
2790
3200
  */
2791
3201
  export interface ListEntitlementsResponse {
2792
3202
  /**
3203
+ * @public
2793
3204
  * A list of entitlements that have been granted to you from other AWS accounts.
2794
3205
  */
2795
3206
  Entitlements?: ListedEntitlement[];
2796
3207
  /**
3208
+ * @public
2797
3209
  * 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.
2798
3210
  */
2799
3211
  NextToken?: string;
@@ -2803,10 +3215,12 @@ export interface ListEntitlementsResponse {
2803
3215
  */
2804
3216
  export interface ListFlowsRequest {
2805
3217
  /**
3218
+ * @public
2806
3219
  * 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.
2807
3220
  */
2808
3221
  MaxResults?: number;
2809
3222
  /**
3223
+ * @public
2810
3224
  * 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.
2811
3225
  */
2812
3226
  NextToken?: string;
@@ -2816,10 +3230,12 @@ export interface ListFlowsRequest {
2816
3230
  */
2817
3231
  export interface ListFlowsResponse {
2818
3232
  /**
3233
+ * @public
2819
3234
  * A list of flow summaries.
2820
3235
  */
2821
3236
  Flows?: ListedFlow[];
2822
3237
  /**
3238
+ * @public
2823
3239
  * 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.
2824
3240
  */
2825
3241
  NextToken?: string;
@@ -2829,14 +3245,17 @@ export interface ListFlowsResponse {
2829
3245
  */
2830
3246
  export interface ListGatewayInstancesRequest {
2831
3247
  /**
3248
+ * @public
2832
3249
  * Filter the list results to display only the instances associated with the selected Gateway Amazon Resource Name (ARN).
2833
3250
  */
2834
3251
  FilterArn?: string;
2835
3252
  /**
3253
+ * @public
2836
3254
  * The maximum number of results to return per API request. For example, you submit a ListInstances 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.
2837
3255
  */
2838
3256
  MaxResults?: number;
2839
3257
  /**
3258
+ * @public
2840
3259
  * The token that identifies which batch of results that you want to see. For example, you submit a ListInstances 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 ListInstances request a second time and specify the NextToken value.
2841
3260
  */
2842
3261
  NextToken?: string;
@@ -2846,10 +3265,12 @@ export interface ListGatewayInstancesRequest {
2846
3265
  */
2847
3266
  export interface ListGatewayInstancesResponse {
2848
3267
  /**
3268
+ * @public
2849
3269
  * A list of instance summaries.
2850
3270
  */
2851
3271
  Instances?: ListedGatewayInstance[];
2852
3272
  /**
3273
+ * @public
2853
3274
  * The token that identifies which batch of results that you want to see. For example, you submit a ListInstances 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 ListInstances request a second time and specify the NextToken value.
2854
3275
  */
2855
3276
  NextToken?: string;
@@ -2859,10 +3280,12 @@ export interface ListGatewayInstancesResponse {
2859
3280
  */
2860
3281
  export interface ListGatewaysRequest {
2861
3282
  /**
3283
+ * @public
2862
3284
  * The maximum number of results to return per API request. For example, you submit a ListGateways 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.
2863
3285
  */
2864
3286
  MaxResults?: number;
2865
3287
  /**
3288
+ * @public
2866
3289
  * The token that identifies which batch of results that you want to see. For example, you submit a ListGateways 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 ListGateways request a second time and specify the NextToken value.
2867
3290
  */
2868
3291
  NextToken?: string;
@@ -2872,10 +3295,12 @@ export interface ListGatewaysRequest {
2872
3295
  */
2873
3296
  export interface ListGatewaysResponse {
2874
3297
  /**
3298
+ * @public
2875
3299
  * A list of gateway summaries.
2876
3300
  */
2877
3301
  Gateways?: ListedGateway[];
2878
3302
  /**
3303
+ * @public
2879
3304
  * The token that identifies which batch of results that you want to see. For example, you submit a ListGateways 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 ListGateways request a second time and specify the NextToken value.
2880
3305
  */
2881
3306
  NextToken?: string;
@@ -2885,10 +3310,12 @@ export interface ListGatewaysResponse {
2885
3310
  */
2886
3311
  export interface ListOfferingsRequest {
2887
3312
  /**
3313
+ * @public
2888
3314
  * The maximum number of results to return per API request. For example, you submit a ListOfferings 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.
2889
3315
  */
2890
3316
  MaxResults?: number;
2891
3317
  /**
3318
+ * @public
2892
3319
  * The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings 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 ListOfferings request a second time and specify the NextToken value.
2893
3320
  */
2894
3321
  NextToken?: string;
@@ -2898,10 +3325,12 @@ export interface ListOfferingsRequest {
2898
3325
  */
2899
3326
  export interface ListOfferingsResponse {
2900
3327
  /**
3328
+ * @public
2901
3329
  * The token that identifies which batch of results that you want to see. For example, you submit a ListOfferings 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 ListOfferings request a second time and specify the NextToken value.
2902
3330
  */
2903
3331
  NextToken?: string;
2904
3332
  /**
3333
+ * @public
2905
3334
  * A list of offerings that are available to this account in the current AWS Region.
2906
3335
  */
2907
3336
  Offerings?: Offering[];
@@ -2911,10 +3340,12 @@ export interface ListOfferingsResponse {
2911
3340
  */
2912
3341
  export interface ListReservationsRequest {
2913
3342
  /**
3343
+ * @public
2914
3344
  * The maximum number of results to return per API request. For example, you submit a ListReservations 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.
2915
3345
  */
2916
3346
  MaxResults?: number;
2917
3347
  /**
3348
+ * @public
2918
3349
  * The token that identifies which batch of results that you want to see. For example, you submit a ListReservations 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 ListOfferings request a second time and specify the NextToken value.
2919
3350
  */
2920
3351
  NextToken?: string;
@@ -2924,10 +3355,12 @@ export interface ListReservationsRequest {
2924
3355
  */
2925
3356
  export interface ListReservationsResponse {
2926
3357
  /**
3358
+ * @public
2927
3359
  * The token that identifies which batch of results that you want to see. For example, you submit a ListReservations 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 ListReservations request a second time and specify the NextToken value.
2928
3360
  */
2929
3361
  NextToken?: string;
2930
3362
  /**
3363
+ * @public
2931
3364
  * A list of all reservations that have been purchased by this account in the current AWS Region.
2932
3365
  */
2933
3366
  Reservations?: Reservation[];
@@ -2937,6 +3370,7 @@ export interface ListReservationsResponse {
2937
3370
  */
2938
3371
  export interface ListTagsForResourceRequest {
2939
3372
  /**
3373
+ * @public
2940
3374
  * The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource for which to list the tags.
2941
3375
  */
2942
3376
  ResourceArn: string | undefined;
@@ -2946,6 +3380,7 @@ export interface ListTagsForResourceRequest {
2946
3380
  */
2947
3381
  export interface ListTagsForResourceResponse {
2948
3382
  /**
3383
+ * @public
2949
3384
  * 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.
2950
3385
  */
2951
3386
  Tags?: Record<string, string>;
@@ -2956,14 +3391,17 @@ export interface ListTagsForResourceResponse {
2956
3391
  */
2957
3392
  export interface PurchaseOfferingRequest {
2958
3393
  /**
3394
+ * @public
2959
3395
  * The Amazon Resource Name (ARN) of the offering.
2960
3396
  */
2961
3397
  OfferingArn: string | undefined;
2962
3398
  /**
3399
+ * @public
2963
3400
  * The name that you want to use for the reservation.
2964
3401
  */
2965
3402
  ReservationName: string | undefined;
2966
3403
  /**
3404
+ * @public
2967
3405
  * The date and time that you want the reservation to begin, in Coordinated Universal Time (UTC). You can specify any date and time between 12:00am on the first day of the current month to the current time on today's date, inclusive. Specify the start in a 24-hour notation. Use the following format: YYYY-MM-DDTHH:mm:SSZ, where T and Z are literal characters. For example, to specify 11:30pm on March 5, 2020, enter 2020-03-05T23:30:00Z.
2968
3406
  */
2969
3407
  Start: string | undefined;
@@ -2973,6 +3411,7 @@ export interface PurchaseOfferingRequest {
2973
3411
  */
2974
3412
  export interface PurchaseOfferingResponse {
2975
3413
  /**
3414
+ * @public
2976
3415
  * A pricing agreement for a discounted rate for a specific outbound bandwidth that your MediaConnect account will use each month over a specific time period. The discounted rate in the reservation applies to outbound bandwidth for all flows from your account until your account reaches the amount of bandwidth in your reservation. If you use more outbound bandwidth than the agreed upon amount in a single month, the overage is charged at the on-demand rate.
2977
3416
  */
2978
3417
  Reservation?: Reservation;
@@ -2982,10 +3421,12 @@ export interface PurchaseOfferingResponse {
2982
3421
  */
2983
3422
  export interface RemoveBridgeOutputRequest {
2984
3423
  /**
3424
+ * @public
2985
3425
  * The ARN of the bridge that you want to update.
2986
3426
  */
2987
3427
  BridgeArn: string | undefined;
2988
3428
  /**
3429
+ * @public
2989
3430
  * The name of the bridge output that you want to remove.
2990
3431
  */
2991
3432
  OutputName: string | undefined;
@@ -3002,10 +3443,12 @@ export interface RemoveBridgeOutputResponse {
3002
3443
  */
3003
3444
  export interface RemoveBridgeSourceRequest {
3004
3445
  /**
3446
+ * @public
3005
3447
  * The ARN of the bridge that you want to update.
3006
3448
  */
3007
3449
  BridgeArn: string | undefined;
3008
3450
  /**
3451
+ * @public
3009
3452
  * The name of the bridge source that you want to remove.
3010
3453
  */
3011
3454
  SourceName: string | undefined;
@@ -3022,10 +3465,12 @@ export interface RemoveBridgeSourceResponse {
3022
3465
  */
3023
3466
  export interface RemoveFlowMediaStreamRequest {
3024
3467
  /**
3468
+ * @public
3025
3469
  * The Amazon Resource Name (ARN) of the flow.
3026
3470
  */
3027
3471
  FlowArn: string | undefined;
3028
3472
  /**
3473
+ * @public
3029
3474
  * The name of the media stream that you want to remove.
3030
3475
  */
3031
3476
  MediaStreamName: string | undefined;
@@ -3035,10 +3480,12 @@ export interface RemoveFlowMediaStreamRequest {
3035
3480
  */
3036
3481
  export interface RemoveFlowMediaStreamResponse {
3037
3482
  /**
3483
+ * @public
3038
3484
  * The Amazon Resource Name (ARN) of the flow.
3039
3485
  */
3040
3486
  FlowArn?: string;
3041
3487
  /**
3488
+ * @public
3042
3489
  * The name of the media stream that was removed.
3043
3490
  */
3044
3491
  MediaStreamName?: string;
@@ -3048,10 +3495,12 @@ export interface RemoveFlowMediaStreamResponse {
3048
3495
  */
3049
3496
  export interface RemoveFlowOutputRequest {
3050
3497
  /**
3498
+ * @public
3051
3499
  * The flow that you want to remove an output from.
3052
3500
  */
3053
3501
  FlowArn: string | undefined;
3054
3502
  /**
3503
+ * @public
3055
3504
  * The ARN of the output that you want to remove.
3056
3505
  */
3057
3506
  OutputArn: string | undefined;
@@ -3061,10 +3510,12 @@ export interface RemoveFlowOutputRequest {
3061
3510
  */
3062
3511
  export interface RemoveFlowOutputResponse {
3063
3512
  /**
3513
+ * @public
3064
3514
  * The ARN of the flow that is associated with the output you removed.
3065
3515
  */
3066
3516
  FlowArn?: string;
3067
3517
  /**
3518
+ * @public
3068
3519
  * The ARN of the output that was removed.
3069
3520
  */
3070
3521
  OutputArn?: string;
@@ -3074,10 +3525,12 @@ export interface RemoveFlowOutputResponse {
3074
3525
  */
3075
3526
  export interface RemoveFlowSourceRequest {
3076
3527
  /**
3528
+ * @public
3077
3529
  * The flow that you want to remove a source from.
3078
3530
  */
3079
3531
  FlowArn: string | undefined;
3080
3532
  /**
3533
+ * @public
3081
3534
  * The ARN of the source that you want to remove.
3082
3535
  */
3083
3536
  SourceArn: string | undefined;
@@ -3087,10 +3540,12 @@ export interface RemoveFlowSourceRequest {
3087
3540
  */
3088
3541
  export interface RemoveFlowSourceResponse {
3089
3542
  /**
3543
+ * @public
3090
3544
  * The ARN of the flow that is associated with the source you removed.
3091
3545
  */
3092
3546
  FlowArn?: string;
3093
3547
  /**
3548
+ * @public
3094
3549
  * The ARN of the source that was removed.
3095
3550
  */
3096
3551
  SourceArn?: string;
@@ -3100,10 +3555,12 @@ export interface RemoveFlowSourceResponse {
3100
3555
  */
3101
3556
  export interface RemoveFlowVpcInterfaceRequest {
3102
3557
  /**
3558
+ * @public
3103
3559
  * The flow that you want to remove a VPC interface from.
3104
3560
  */
3105
3561
  FlowArn: string | undefined;
3106
3562
  /**
3563
+ * @public
3107
3564
  * The name of the VPC interface that you want to remove.
3108
3565
  */
3109
3566
  VpcInterfaceName: string | undefined;
@@ -3113,14 +3570,17 @@ export interface RemoveFlowVpcInterfaceRequest {
3113
3570
  */
3114
3571
  export interface RemoveFlowVpcInterfaceResponse {
3115
3572
  /**
3573
+ * @public
3116
3574
  * The ARN of the flow that is associated with the VPC interface you removed.
3117
3575
  */
3118
3576
  FlowArn?: string;
3119
3577
  /**
3578
+ * @public
3120
3579
  * IDs of network interfaces associated with the removed VPC interface that Media Connect was unable to remove.
3121
3580
  */
3122
3581
  NonDeletedNetworkInterfaceIds?: string[];
3123
3582
  /**
3583
+ * @public
3124
3584
  * The name of the VPC interface that was removed.
3125
3585
  */
3126
3586
  VpcInterfaceName?: string;
@@ -3130,10 +3590,12 @@ export interface RemoveFlowVpcInterfaceResponse {
3130
3590
  */
3131
3591
  export interface RevokeFlowEntitlementRequest {
3132
3592
  /**
3593
+ * @public
3133
3594
  * The ARN of the entitlement that you want to revoke.
3134
3595
  */
3135
3596
  EntitlementArn: string | undefined;
3136
3597
  /**
3598
+ * @public
3137
3599
  * The flow that you want to revoke an entitlement from.
3138
3600
  */
3139
3601
  FlowArn: string | undefined;
@@ -3143,10 +3605,12 @@ export interface RevokeFlowEntitlementRequest {
3143
3605
  */
3144
3606
  export interface RevokeFlowEntitlementResponse {
3145
3607
  /**
3608
+ * @public
3146
3609
  * The ARN of the entitlement that was revoked.
3147
3610
  */
3148
3611
  EntitlementArn?: string;
3149
3612
  /**
3613
+ * @public
3150
3614
  * The ARN of the flow that the entitlement was revoked from.
3151
3615
  */
3152
3616
  FlowArn?: string;
@@ -3156,6 +3620,7 @@ export interface RevokeFlowEntitlementResponse {
3156
3620
  */
3157
3621
  export interface StartFlowRequest {
3158
3622
  /**
3623
+ * @public
3159
3624
  * The ARN of the flow that you want to start.
3160
3625
  */
3161
3626
  FlowArn: string | undefined;
@@ -3165,10 +3630,12 @@ export interface StartFlowRequest {
3165
3630
  */
3166
3631
  export interface StartFlowResponse {
3167
3632
  /**
3633
+ * @public
3168
3634
  * The ARN of the flow that you started.
3169
3635
  */
3170
3636
  FlowArn?: string;
3171
3637
  /**
3638
+ * @public
3172
3639
  * The status of the flow when the StartFlow process begins.
3173
3640
  */
3174
3641
  Status?: Status | string;
@@ -3178,6 +3645,7 @@ export interface StartFlowResponse {
3178
3645
  */
3179
3646
  export interface StopFlowRequest {
3180
3647
  /**
3648
+ * @public
3181
3649
  * The ARN of the flow that you want to stop.
3182
3650
  */
3183
3651
  FlowArn: string | undefined;
@@ -3187,10 +3655,12 @@ export interface StopFlowRequest {
3187
3655
  */
3188
3656
  export interface StopFlowResponse {
3189
3657
  /**
3658
+ * @public
3190
3659
  * The ARN of the flow that you stopped.
3191
3660
  */
3192
3661
  FlowArn?: string;
3193
3662
  /**
3663
+ * @public
3194
3664
  * The status of the flow when the StopFlow process begins.
3195
3665
  */
3196
3666
  Status?: Status | string;
@@ -3201,10 +3671,12 @@ export interface StopFlowResponse {
3201
3671
  */
3202
3672
  export interface TagResourceRequest {
3203
3673
  /**
3674
+ * @public
3204
3675
  * The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource to which to add tags.
3205
3676
  */
3206
3677
  ResourceArn: string | undefined;
3207
3678
  /**
3679
+ * @public
3208
3680
  * 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.
3209
3681
  */
3210
3682
  Tags: Record<string, string> | undefined;
@@ -3214,10 +3686,12 @@ export interface TagResourceRequest {
3214
3686
  */
3215
3687
  export interface UntagResourceRequest {
3216
3688
  /**
3689
+ * @public
3217
3690
  * The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource from which to delete tags.
3218
3691
  */
3219
3692
  ResourceArn: string | undefined;
3220
3693
  /**
3694
+ * @public
3221
3695
  * The keys of the tags to be removed.
3222
3696
  */
3223
3697
  TagKeys: string[] | undefined;
@@ -3227,6 +3701,7 @@ export interface UntagResourceRequest {
3227
3701
  */
3228
3702
  export interface UpdateEgressGatewayBridgeRequest {
3229
3703
  /**
3704
+ * @public
3230
3705
  * Update an existing egress-type bridge.
3231
3706
  */
3232
3707
  MaxBitrate?: number;
@@ -3236,10 +3711,12 @@ export interface UpdateEgressGatewayBridgeRequest {
3236
3711
  */
3237
3712
  export interface UpdateIngressGatewayBridgeRequest {
3238
3713
  /**
3714
+ * @public
3239
3715
  * The maximum expected bitrate (in bps).
3240
3716
  */
3241
3717
  MaxBitrate?: number;
3242
3718
  /**
3719
+ * @public
3243
3720
  * The maximum number of expected outputs.
3244
3721
  */
3245
3722
  MaxOutputs?: number;
@@ -3250,14 +3727,17 @@ export interface UpdateIngressGatewayBridgeRequest {
3250
3727
  */
3251
3728
  export interface UpdateFailoverConfig {
3252
3729
  /**
3730
+ * @public
3253
3731
  * The type of failover you choose for this flow. MERGE combines the source streams into a single stream, allowing graceful recovery from any single-source loss. FAILOVER allows switching between different streams.
3254
3732
  */
3255
3733
  FailoverMode?: FailoverMode | string;
3256
3734
  /**
3735
+ * @public
3257
3736
  * Recovery window time to look for dash-7 packets
3258
3737
  */
3259
3738
  RecoveryWindow?: number;
3260
3739
  /**
3740
+ * @public
3261
3741
  * The priority you want to assign to a source. You can have a primary stream and a backup stream or two equally prioritized streams.
3262
3742
  */
3263
3743
  SourcePriority?: SourcePriority;
@@ -3269,12 +3749,14 @@ export interface UpdateFailoverConfig {
3269
3749
  */
3270
3750
  export interface UpdateBridgeRequest {
3271
3751
  /**
3752
+ * @public
3272
3753
  * The Amazon Resource Number (ARN) of the bridge that you want to update.
3273
3754
  */
3274
3755
  BridgeArn: string | undefined;
3275
3756
  EgressGatewayBridge?: UpdateEgressGatewayBridgeRequest;
3276
3757
  IngressGatewayBridge?: UpdateIngressGatewayBridgeRequest;
3277
3758
  /**
3759
+ * @public
3278
3760
  * The settings for source failover.
3279
3761
  */
3280
3762
  SourceFailoverConfig?: UpdateFailoverConfig;
@@ -3284,6 +3766,7 @@ export interface UpdateBridgeRequest {
3284
3766
  */
3285
3767
  export interface UpdateBridgeResponse {
3286
3768
  /**
3769
+ * @public
3287
3770
  * A Bridge is the connection between your datacenter's Instances and the AWS cloud. A bridge can be used to send video from the AWS cloud to your datacenter or from your datacenter to the AWS cloud.
3288
3771
  */
3289
3772
  Bridge?: Bridge;
@@ -3294,22 +3777,27 @@ export interface UpdateBridgeResponse {
3294
3777
  */
3295
3778
  export interface UpdateBridgeNetworkOutputRequest {
3296
3779
  /**
3780
+ * @public
3297
3781
  * The network output IP Address.
3298
3782
  */
3299
3783
  IpAddress?: string;
3300
3784
  /**
3785
+ * @public
3301
3786
  * The network output's gateway network name.
3302
3787
  */
3303
3788
  NetworkName?: string;
3304
3789
  /**
3790
+ * @public
3305
3791
  * The network output port.
3306
3792
  */
3307
3793
  Port?: number;
3308
3794
  /**
3795
+ * @public
3309
3796
  * The network output protocol.
3310
3797
  */
3311
3798
  Protocol?: Protocol | string;
3312
3799
  /**
3800
+ * @public
3313
3801
  * The network output TTL.
3314
3802
  */
3315
3803
  Ttl?: number;
@@ -3320,14 +3808,17 @@ export interface UpdateBridgeNetworkOutputRequest {
3320
3808
  */
3321
3809
  export interface UpdateBridgeOutputRequest {
3322
3810
  /**
3811
+ * @public
3323
3812
  * The ARN of the bridge that you want to update.
3324
3813
  */
3325
3814
  BridgeArn: string | undefined;
3326
3815
  /**
3816
+ * @public
3327
3817
  * Update an existing network output.
3328
3818
  */
3329
3819
  NetworkOutput?: UpdateBridgeNetworkOutputRequest;
3330
3820
  /**
3821
+ * @public
3331
3822
  * The name of the bridge output that you want to update.
3332
3823
  */
3333
3824
  OutputName: string | undefined;
@@ -3337,10 +3828,12 @@ export interface UpdateBridgeOutputRequest {
3337
3828
  */
3338
3829
  export interface UpdateBridgeOutputResponse {
3339
3830
  /**
3831
+ * @public
3340
3832
  * The Amazon Resource Number (ARN) of the bridge.
3341
3833
  */
3342
3834
  BridgeArn?: string;
3343
3835
  /**
3836
+ * @public
3344
3837
  * The output that you updated.
3345
3838
  */
3346
3839
  Output?: BridgeOutput;
@@ -3351,10 +3844,12 @@ export interface UpdateBridgeOutputResponse {
3351
3844
  */
3352
3845
  export interface UpdateBridgeFlowSourceRequest {
3353
3846
  /**
3847
+ * @public
3354
3848
  * The ARN of the cloud flow to use as a source of this bridge.
3355
3849
  */
3356
3850
  FlowArn?: string;
3357
3851
  /**
3852
+ * @public
3358
3853
  * The name of the VPC interface attachment to use for this source.
3359
3854
  */
3360
3855
  FlowVpcInterfaceAttachment?: VpcInterfaceAttachment;
@@ -3365,18 +3860,22 @@ export interface UpdateBridgeFlowSourceRequest {
3365
3860
  */
3366
3861
  export interface UpdateBridgeNetworkSourceRequest {
3367
3862
  /**
3863
+ * @public
3368
3864
  * The network source multicast IP.
3369
3865
  */
3370
3866
  MulticastIp?: string;
3371
3867
  /**
3868
+ * @public
3372
3869
  * The network source's gateway network name.
3373
3870
  */
3374
3871
  NetworkName?: string;
3375
3872
  /**
3873
+ * @public
3376
3874
  * The network source port.
3377
3875
  */
3378
3876
  Port?: number;
3379
3877
  /**
3878
+ * @public
3380
3879
  * The network source protocol.
3381
3880
  */
3382
3881
  Protocol?: Protocol | string;
@@ -3387,18 +3886,22 @@ export interface UpdateBridgeNetworkSourceRequest {
3387
3886
  */
3388
3887
  export interface UpdateBridgeSourceRequest {
3389
3888
  /**
3889
+ * @public
3390
3890
  * The ARN of the bridge that you want to update.
3391
3891
  */
3392
3892
  BridgeArn: string | undefined;
3393
3893
  /**
3894
+ * @public
3394
3895
  * Update the flow source of the bridge.
3395
3896
  */
3396
3897
  FlowSource?: UpdateBridgeFlowSourceRequest;
3397
3898
  /**
3899
+ * @public
3398
3900
  * Update the network source of the bridge.
3399
3901
  */
3400
3902
  NetworkSource?: UpdateBridgeNetworkSourceRequest;
3401
3903
  /**
3904
+ * @public
3402
3905
  * The name of the source that you want to update.
3403
3906
  */
3404
3907
  SourceName: string | undefined;
@@ -3408,10 +3911,12 @@ export interface UpdateBridgeSourceRequest {
3408
3911
  */
3409
3912
  export interface UpdateBridgeSourceResponse {
3410
3913
  /**
3914
+ * @public
3411
3915
  * The Amazon Resource Number (ARN) of the bridge.
3412
3916
  */
3413
3917
  BridgeArn?: string;
3414
3918
  /**
3919
+ * @public
3415
3920
  * The bridge's source.
3416
3921
  */
3417
3922
  Source?: BridgeSource;
@@ -3422,6 +3927,7 @@ export interface UpdateBridgeSourceResponse {
3422
3927
  */
3423
3928
  export interface UpdateBridgeStateRequest {
3424
3929
  /**
3930
+ * @public
3425
3931
  * The ARN of the bridge that you want to update.
3426
3932
  */
3427
3933
  BridgeArn: string | undefined;
@@ -3432,10 +3938,12 @@ export interface UpdateBridgeStateRequest {
3432
3938
  */
3433
3939
  export interface UpdateBridgeStateResponse {
3434
3940
  /**
3941
+ * @public
3435
3942
  * The Amazon Resource Number (ARN) of the bridge.
3436
3943
  */
3437
3944
  BridgeArn?: string;
3438
3945
  /**
3946
+ * @public
3439
3947
  * The state of the bridge. ACTIVE or STANDBY.
3440
3948
  */
3441
3949
  DesiredState?: DesiredState | string;
@@ -3446,14 +3954,17 @@ export interface UpdateBridgeStateResponse {
3446
3954
  */
3447
3955
  export interface UpdateMaintenance {
3448
3956
  /**
3957
+ * @public
3449
3958
  * A day of a week when the maintenance will happen. use Monday/Tuesday/Wednesday/Thursday/Friday/Saturday/Sunday.
3450
3959
  */
3451
3960
  MaintenanceDay?: MaintenanceDay | string;
3452
3961
  /**
3962
+ * @public
3453
3963
  * A scheduled date in ISO UTC format when the maintenance will happen. Use YYYY-MM-DD format. Example: 2021-01-30.
3454
3964
  */
3455
3965
  MaintenanceScheduledDate?: string;
3456
3966
  /**
3967
+ * @public
3457
3968
  * UTC time when the maintenance will happen. Use 24-hour HH:MM format. Minutes must be 00. Example: 13:00. The default value is 02:00.
3458
3969
  */
3459
3970
  MaintenanceStartHour?: string;
@@ -3464,14 +3975,17 @@ export interface UpdateMaintenance {
3464
3975
  */
3465
3976
  export interface UpdateFlowRequest {
3466
3977
  /**
3978
+ * @public
3467
3979
  * The flow that you want to update.
3468
3980
  */
3469
3981
  FlowArn: string | undefined;
3470
3982
  /**
3983
+ * @public
3471
3984
  * The settings for source failover.
3472
3985
  */
3473
3986
  SourceFailoverConfig?: UpdateFailoverConfig;
3474
3987
  /**
3988
+ * @public
3475
3989
  * Update maintenance setting for a flow
3476
3990
  */
3477
3991
  Maintenance?: UpdateMaintenance;
@@ -3481,6 +3995,7 @@ export interface UpdateFlowRequest {
3481
3995
  */
3482
3996
  export interface UpdateFlowResponse {
3483
3997
  /**
3998
+ * @public
3484
3999
  * The settings for a flow, including its source, outputs, and entitlements.
3485
4000
  */
3486
4001
  Flow?: Flow;
@@ -3491,38 +4006,47 @@ export interface UpdateFlowResponse {
3491
4006
  */
3492
4007
  export interface UpdateEncryption {
3493
4008
  /**
4009
+ * @public
3494
4010
  * The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).
3495
4011
  */
3496
4012
  Algorithm?: Algorithm | string;
3497
4013
  /**
4014
+ * @public
3498
4015
  * A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption.
3499
4016
  */
3500
4017
  ConstantInitializationVector?: string;
3501
4018
  /**
4019
+ * @public
3502
4020
  * The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.
3503
4021
  */
3504
4022
  DeviceId?: string;
3505
4023
  /**
4024
+ * @public
3506
4025
  * The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key).
3507
4026
  */
3508
4027
  KeyType?: KeyType | string;
3509
4028
  /**
4029
+ * @public
3510
4030
  * The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption.
3511
4031
  */
3512
4032
  Region?: string;
3513
4033
  /**
4034
+ * @public
3514
4035
  * An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption.
3515
4036
  */
3516
4037
  ResourceId?: string;
3517
4038
  /**
4039
+ * @public
3518
4040
  * The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity).
3519
4041
  */
3520
4042
  RoleArn?: string;
3521
4043
  /**
4044
+ * @public
3522
4045
  * The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption.
3523
4046
  */
3524
4047
  SecretArn?: string;
3525
4048
  /**
4049
+ * @public
3526
4050
  * The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption.
3527
4051
  */
3528
4052
  Url?: string;
@@ -3533,26 +4057,32 @@ export interface UpdateEncryption {
3533
4057
  */
3534
4058
  export interface UpdateFlowEntitlementRequest {
3535
4059
  /**
4060
+ * @public
3536
4061
  * 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.
3537
4062
  */
3538
4063
  Description?: string;
3539
4064
  /**
4065
+ * @public
3540
4066
  * The type of encryption that will be used on the output associated with this entitlement. Allowable encryption types: static-key, speke.
3541
4067
  */
3542
4068
  Encryption?: UpdateEncryption;
3543
4069
  /**
4070
+ * @public
3544
4071
  * The ARN of the entitlement that you want to update.
3545
4072
  */
3546
4073
  EntitlementArn: string | undefined;
3547
4074
  /**
4075
+ * @public
3548
4076
  * An indication of whether you want to enable the entitlement to allow access, or disable it to stop streaming content to the subscriber’s flow temporarily. If you don’t specify the entitlementStatus field in your request, MediaConnect leaves the value unchanged.
3549
4077
  */
3550
4078
  EntitlementStatus?: EntitlementStatus | string;
3551
4079
  /**
4080
+ * @public
3552
4081
  * The flow that is associated with the entitlement that you want to update.
3553
4082
  */
3554
4083
  FlowArn: string | undefined;
3555
4084
  /**
4085
+ * @public
3556
4086
  * 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.
3557
4087
  */
3558
4088
  Subscribers?: string[];
@@ -3562,10 +4092,12 @@ export interface UpdateFlowEntitlementRequest {
3562
4092
  */
3563
4093
  export interface UpdateFlowEntitlementResponse {
3564
4094
  /**
4095
+ * @public
3565
4096
  * The new configuration of the entitlement that you updated.
3566
4097
  */
3567
4098
  Entitlement?: Entitlement;
3568
4099
  /**
4100
+ * @public
3569
4101
  * The ARN of the flow that this entitlement was granted on.
3570
4102
  */
3571
4103
  FlowArn?: string;
@@ -3576,30 +4108,37 @@ export interface UpdateFlowEntitlementResponse {
3576
4108
  */
3577
4109
  export interface UpdateFlowMediaStreamRequest {
3578
4110
  /**
4111
+ * @public
3579
4112
  * The attributes that you want to assign to the media stream.
3580
4113
  */
3581
4114
  Attributes?: MediaStreamAttributesRequest;
3582
4115
  /**
4116
+ * @public
3583
4117
  * The sample rate (in Hz) for the stream. If the media stream type is video or ancillary data, set this value to 90000. If the media stream type is audio, set this value to either 48000 or 96000.
3584
4118
  */
3585
4119
  ClockRate?: number;
3586
4120
  /**
4121
+ * @public
3587
4122
  * Description
3588
4123
  */
3589
4124
  Description?: string;
3590
4125
  /**
4126
+ * @public
3591
4127
  * The Amazon Resource Name (ARN) of the flow.
3592
4128
  */
3593
4129
  FlowArn: string | undefined;
3594
4130
  /**
4131
+ * @public
3595
4132
  * The name of the media stream that you want to update.
3596
4133
  */
3597
4134
  MediaStreamName: string | undefined;
3598
4135
  /**
4136
+ * @public
3599
4137
  * The type of media stream.
3600
4138
  */
3601
4139
  MediaStreamType?: MediaStreamType | string;
3602
4140
  /**
4141
+ * @public
3603
4142
  * The resolution of the video.
3604
4143
  */
3605
4144
  VideoFormat?: string;
@@ -3609,10 +4148,12 @@ export interface UpdateFlowMediaStreamRequest {
3609
4148
  */
3610
4149
  export interface UpdateFlowMediaStreamResponse {
3611
4150
  /**
4151
+ * @public
3612
4152
  * The ARN of the flow that is associated with the media stream that you updated.
3613
4153
  */
3614
4154
  FlowArn?: string;
3615
4155
  /**
4156
+ * @public
3616
4157
  * The media stream that you updated.
3617
4158
  */
3618
4159
  MediaStream?: MediaStream;
@@ -3623,70 +4164,87 @@ export interface UpdateFlowMediaStreamResponse {
3623
4164
  */
3624
4165
  export interface UpdateFlowOutputRequest {
3625
4166
  /**
4167
+ * @public
3626
4168
  * The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
3627
4169
  */
3628
4170
  CidrAllowList?: string[];
3629
4171
  /**
4172
+ * @public
3630
4173
  * A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user.
3631
4174
  */
3632
4175
  Description?: string;
3633
4176
  /**
4177
+ * @public
3634
4178
  * The IP address where you want to send the output.
3635
4179
  */
3636
4180
  Destination?: string;
3637
4181
  /**
4182
+ * @public
3638
4183
  * The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key). Allowable encryption types: static-key.
3639
4184
  */
3640
4185
  Encryption?: UpdateEncryption;
3641
4186
  /**
4187
+ * @public
3642
4188
  * The flow that is associated with the output that you want to update.
3643
4189
  */
3644
4190
  FlowArn: string | undefined;
3645
4191
  /**
4192
+ * @public
3646
4193
  * The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
3647
4194
  */
3648
4195
  MaxLatency?: number;
3649
4196
  /**
4197
+ * @public
3650
4198
  * The media streams that are associated with the output, and the parameters for those associations.
3651
4199
  */
3652
4200
  MediaStreamOutputConfigurations?: MediaStreamOutputConfigurationRequest[];
3653
4201
  /**
4202
+ * @public
3654
4203
  * The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
3655
4204
  */
3656
4205
  MinLatency?: number;
3657
4206
  /**
4207
+ * @public
3658
4208
  * The ARN of the output that you want to update.
3659
4209
  */
3660
4210
  OutputArn: string | undefined;
3661
4211
  /**
4212
+ * @public
3662
4213
  * The port to use when content is distributed to this output.
3663
4214
  */
3664
4215
  Port?: number;
3665
4216
  /**
4217
+ * @public
3666
4218
  * The protocol to use for the output.
3667
4219
  */
3668
4220
  Protocol?: Protocol | string;
3669
4221
  /**
4222
+ * @public
3670
4223
  * The remote ID for the Zixi-pull stream.
3671
4224
  */
3672
4225
  RemoteId?: string;
3673
4226
  /**
4227
+ * @public
3674
4228
  * The port that the flow uses to send outbound requests to initiate connection with the sender.
3675
4229
  */
3676
4230
  SenderControlPort?: number;
3677
4231
  /**
4232
+ * @public
3678
4233
  * The IP address that the flow communicates with to initiate connection with the sender.
3679
4234
  */
3680
4235
  SenderIpAddress?: string;
3681
4236
  /**
4237
+ * @public
3682
4238
  * The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.
3683
4239
  */
3684
4240
  SmoothingLatency?: number;
3685
4241
  /**
4242
+ * @public
3686
4243
  * The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
3687
4244
  */
3688
4245
  StreamId?: string;
3689
4246
  /**
4247
+ * @public
3690
4248
  * The name of the VPC interface attachment to use for this output.
3691
4249
  */
3692
4250
  VpcInterfaceAttachment?: VpcInterfaceAttachment;
@@ -3696,10 +4254,12 @@ export interface UpdateFlowOutputRequest {
3696
4254
  */
3697
4255
  export interface UpdateFlowOutputResponse {
3698
4256
  /**
4257
+ * @public
3699
4258
  * The ARN of the flow that is associated with the updated output.
3700
4259
  */
3701
4260
  FlowArn?: string;
3702
4261
  /**
4262
+ * @public
3703
4263
  * The new settings of the output that you updated.
3704
4264
  */
3705
4265
  Output?: Output;
@@ -3710,10 +4270,12 @@ export interface UpdateFlowOutputResponse {
3710
4270
  */
3711
4271
  export interface UpdateGatewayBridgeSourceRequest {
3712
4272
  /**
4273
+ * @public
3713
4274
  * The ARN of the bridge feeding this flow.
3714
4275
  */
3715
4276
  BridgeArn?: string;
3716
4277
  /**
4278
+ * @public
3717
4279
  * The name of the VPC interface attachment to use for this bridge source.
3718
4280
  */
3719
4281
  VpcInterfaceAttachment?: VpcInterfaceAttachment;
@@ -3724,82 +4286,102 @@ export interface UpdateGatewayBridgeSourceRequest {
3724
4286
  */
3725
4287
  export interface UpdateFlowSourceRequest {
3726
4288
  /**
4289
+ * @public
3727
4290
  * The type of encryption used on the content ingested from this source. Allowable encryption types: static-key.
3728
4291
  */
3729
4292
  Decryption?: UpdateEncryption;
3730
4293
  /**
4294
+ * @public
3731
4295
  * A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account.
3732
4296
  */
3733
4297
  Description?: string;
3734
4298
  /**
4299
+ * @public
3735
4300
  * 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.
3736
4301
  */
3737
4302
  EntitlementArn?: string;
3738
4303
  /**
4304
+ * @public
3739
4305
  * The flow that is associated with the source that you want to update.
3740
4306
  */
3741
4307
  FlowArn: string | undefined;
3742
4308
  /**
4309
+ * @public
3743
4310
  * The port that the flow will be listening on for incoming content.
3744
4311
  */
3745
4312
  IngestPort?: number;
3746
4313
  /**
4314
+ * @public
3747
4315
  * The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.
3748
4316
  */
3749
4317
  MaxBitrate?: number;
3750
4318
  /**
4319
+ * @public
3751
4320
  * The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.
3752
4321
  */
3753
4322
  MaxLatency?: number;
3754
4323
  /**
4324
+ * @public
3755
4325
  * The size of the buffer (in milliseconds) to use to sync incoming source data.
3756
4326
  */
3757
4327
  MaxSyncBuffer?: number;
3758
4328
  /**
4329
+ * @public
3759
4330
  * The media streams that are associated with the source, and the parameters for those associations.
3760
4331
  */
3761
4332
  MediaStreamSourceConfigurations?: MediaStreamSourceConfigurationRequest[];
3762
4333
  /**
4334
+ * @public
3763
4335
  * The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender’s minimum latency and the receiver’s minimum latency.
3764
4336
  */
3765
4337
  MinLatency?: number;
3766
4338
  /**
4339
+ * @public
3767
4340
  * The protocol that is used by the source.
3768
4341
  */
3769
4342
  Protocol?: Protocol | string;
3770
4343
  /**
4344
+ * @public
3771
4345
  * The port that the flow uses to send outbound requests to initiate connection with the sender.
3772
4346
  */
3773
4347
  SenderControlPort?: number;
3774
4348
  /**
4349
+ * @public
3775
4350
  * The IP address that the flow communicates with to initiate connection with the sender.
3776
4351
  */
3777
4352
  SenderIpAddress?: string;
3778
4353
  /**
4354
+ * @public
3779
4355
  * The ARN of the source that you want to update.
3780
4356
  */
3781
4357
  SourceArn: string | undefined;
3782
4358
  /**
4359
+ * @public
3783
4360
  * Source IP or domain name for SRT-caller protocol.
3784
4361
  */
3785
4362
  SourceListenerAddress?: string;
3786
4363
  /**
4364
+ * @public
3787
4365
  * Source port for SRT-caller protocol.
3788
4366
  */
3789
4367
  SourceListenerPort?: number;
3790
4368
  /**
4369
+ * @public
3791
4370
  * The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams.
3792
4371
  */
3793
4372
  StreamId?: string;
3794
4373
  /**
4374
+ * @public
3795
4375
  * The name of the VPC interface to use for this source.
3796
4376
  */
3797
4377
  VpcInterfaceName?: string;
3798
4378
  /**
4379
+ * @public
3799
4380
  * The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.
3800
4381
  */
3801
4382
  WhitelistCidr?: string;
3802
4383
  /**
4384
+ * @public
3803
4385
  * The source configuration for cloud flows receiving a stream from a bridge.
3804
4386
  */
3805
4387
  GatewayBridgeSource?: UpdateGatewayBridgeSourceRequest;
@@ -3809,10 +4391,12 @@ export interface UpdateFlowSourceRequest {
3809
4391
  */
3810
4392
  export interface UpdateFlowSourceResponse {
3811
4393
  /**
4394
+ * @public
3812
4395
  * The ARN of the flow that you want to update.
3813
4396
  */
3814
4397
  FlowArn?: string;
3815
4398
  /**
4399
+ * @public
3816
4400
  * The settings for the source of the flow.
3817
4401
  */
3818
4402
  Source?: Source;
@@ -3823,10 +4407,12 @@ export interface UpdateFlowSourceResponse {
3823
4407
  */
3824
4408
  export interface UpdateGatewayInstanceRequest {
3825
4409
  /**
4410
+ * @public
3826
4411
  * The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance.
3827
4412
  */
3828
4413
  BridgePlacement?: BridgePlacement | string;
3829
4414
  /**
4415
+ * @public
3830
4416
  * The Amazon Resource Name (ARN) of the instance that you want to update.
3831
4417
  */
3832
4418
  GatewayInstanceArn: string | undefined;
@@ -3836,10 +4422,12 @@ export interface UpdateGatewayInstanceRequest {
3836
4422
  */
3837
4423
  export interface UpdateGatewayInstanceResponse {
3838
4424
  /**
4425
+ * @public
3839
4426
  * The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be added to this instance.
3840
4427
  */
3841
4428
  BridgePlacement?: BridgePlacement | string;
3842
4429
  /**
4430
+ * @public
3843
4431
  * The Amazon Resource Name (ARN) of the instance.
3844
4432
  */
3845
4433
  GatewayInstanceArn?: string;