@aws-sdk/client-chime-sdk-media-pipelines 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.
@@ -20,6 +20,7 @@ export type ActiveSpeakerPosition = (typeof ActiveSpeakerPosition)[keyof typeof
20
20
  */
21
21
  export interface ActiveSpeakerOnlyConfiguration {
22
22
  /**
23
+ * @public
23
24
  * <p>The position of the <code>ActiveSpeakerOnly</code> video tile.</p>
24
25
  */
25
26
  ActiveSpeakerPosition?: ActiveSpeakerPosition | string;
@@ -90,19 +91,23 @@ export type ContentRedactionOutput = (typeof ContentRedactionOutput)[keyof typeo
90
91
  */
91
92
  export interface PostCallAnalyticsSettings {
92
93
  /**
94
+ * @public
93
95
  * <p>The URL of the Amazon S3 bucket that contains the post-call data.</p>
94
96
  */
95
97
  OutputLocation: string | undefined;
96
98
  /**
99
+ * @public
97
100
  * <p>The ARN of the role used by Amazon Web Services Transcribe to upload your post call analysis. For more information, see
98
101
  * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html">Post-call analytics with real-time transcriptions</a> in the <i>Amazon Transcribe Developer Guide</i>.</p>
99
102
  */
100
103
  DataAccessRoleArn: string | undefined;
101
104
  /**
105
+ * @public
102
106
  * <p>The content redaction output settings for a post-call analysis task.</p>
103
107
  */
104
108
  ContentRedactionOutput?: ContentRedactionOutput | string;
105
109
  /**
110
+ * @public
106
111
  * <p>The ID of the KMS (Key Management Service) key used to encrypt the output.</p>
107
112
  */
108
113
  OutputEncryptionKMSKeyId?: string;
@@ -127,10 +132,12 @@ export type VocabularyFilterMethod = (typeof VocabularyFilterMethod)[keyof typeo
127
132
  */
128
133
  export interface AmazonTranscribeCallAnalyticsProcessorConfiguration {
129
134
  /**
135
+ * @public
130
136
  * <p>The language code in the configuration.</p>
131
137
  */
132
138
  LanguageCode: CallAnalyticsLanguageCode | string | undefined;
133
139
  /**
140
+ * @public
134
141
  * <p>Specifies the name of the custom vocabulary to use when processing a transcription. Note
135
142
  * that vocabulary names are case sensitive.</p>
136
143
  * <p>If the language of the specified custom vocabulary doesn't match the language identified in your media, the custom vocabulary is not applied to your transcription.</p>
@@ -139,6 +146,7 @@ export interface AmazonTranscribeCallAnalyticsProcessorConfiguration {
139
146
  */
140
147
  VocabularyName?: string;
141
148
  /**
149
+ * @public
142
150
  * <p>Specifies the name of the custom vocabulary filter to use when processing a
143
151
  * transcription. Note that vocabulary filter names are case sensitive.</p>
144
152
  * <p>If the language of the specified custom vocabulary filter doesn't match the language identified in your media, the vocabulary filter is not applied to your transcription.</p>
@@ -148,6 +156,7 @@ export interface AmazonTranscribeCallAnalyticsProcessorConfiguration {
148
156
  */
149
157
  VocabularyFilterName?: string;
150
158
  /**
159
+ * @public
151
160
  * <p>Specifies how to apply a vocabulary filter to a transcript.</p>
152
161
  * <p>To replace words with <b>***</b>, choose <code>mask</code>.</p>
153
162
  * <p>To delete words, choose <code>remove</code>.</p>
@@ -155,6 +164,7 @@ export interface AmazonTranscribeCallAnalyticsProcessorConfiguration {
155
164
  */
156
165
  VocabularyFilterMethod?: VocabularyFilterMethod | string;
157
166
  /**
167
+ * @public
158
168
  * <p>Specifies the name of the custom language model to use when processing a transcription.
159
169
  * Note that language model names are case sensitive.</p>
160
170
  * <p>The language of the specified language model must match the language code specified
@@ -164,12 +174,14 @@ export interface AmazonTranscribeCallAnalyticsProcessorConfiguration {
164
174
  */
165
175
  LanguageModelName?: string;
166
176
  /**
177
+ * @public
167
178
  * <p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.
168
179
  * For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result stabilization</a>
169
180
  * in the <i>Amazon Transcribe Developer Guide</i>.</p>
170
181
  */
171
182
  EnablePartialResultsStabilization?: boolean;
172
183
  /**
184
+ * @public
173
185
  * <p>Specifies the level of stability to use when you enable partial results stabilization
174
186
  * (<code>EnablePartialResultsStabilization</code>).</p>
175
187
  * <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
@@ -178,6 +190,7 @@ export interface AmazonTranscribeCallAnalyticsProcessorConfiguration {
178
190
  */
179
191
  PartialResultsStability?: PartialResultsStability | string;
180
192
  /**
193
+ * @public
181
194
  * <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
182
195
  * <p>Content identification is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio segment.</p>
183
196
  * <p>You can’t set <code>ContentIdentificationType</code> and <code>ContentRedactionType</code> in the same request. If you do, your request returns a <code>BadRequestException</code>.</p>
@@ -186,6 +199,7 @@ export interface AmazonTranscribeCallAnalyticsProcessorConfiguration {
186
199
  */
187
200
  ContentIdentificationType?: ContentType | string;
188
201
  /**
202
+ * @public
189
203
  * <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
190
204
  * <p>Content redaction is performed at the segment level; PII specified in <code>PiiEntityTypes</code> is redacted upon complete transcription of an audio segment.</p>
191
205
  * <p>You can’t set <code>ContentRedactionType</code> and <code>ContentIdentificationType</code> in the same request. If you do, your request returns a <code>BadRequestException</code>.</p>
@@ -194,6 +208,7 @@ export interface AmazonTranscribeCallAnalyticsProcessorConfiguration {
194
208
  */
195
209
  ContentRedactionType?: ContentType | string;
196
210
  /**
211
+ * @public
197
212
  * <p>Specifies the types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select <code>ALL</code>.</p>
198
213
  * <p>To include <code>PiiEntityTypes</code> in your Call Analytics request, you must also include <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>, but you can't include both. </p>
199
214
  * <p>Values must be comma-separated and can include: <code>ADDRESS</code>, <code>BANK_ACCOUNT_NUMBER</code>, <code>BANK_ROUTING</code>, <code>CREDIT_DEBIT_CVV</code>,
@@ -203,14 +218,17 @@ export interface AmazonTranscribeCallAnalyticsProcessorConfiguration {
203
218
  */
204
219
  PiiEntityTypes?: string;
205
220
  /**
221
+ * @public
206
222
  * <p>If true, <code>UtteranceEvents</code> with <code>IsPartial: true</code> are filtered out of the insights target.</p>
207
223
  */
208
224
  FilterPartialResults?: boolean;
209
225
  /**
226
+ * @public
210
227
  * <p>The settings for a post-call analysis task in an analytics configuration.</p>
211
228
  */
212
229
  PostCallAnalyticsSettings?: PostCallAnalyticsSettings;
213
230
  /**
231
+ * @public
214
232
  * <p>By default, all <code>CategoryEvents</code> are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target. </p>
215
233
  */
216
234
  CallAnalyticsStreamCategories?: string[];
@@ -221,6 +239,7 @@ export interface AmazonTranscribeCallAnalyticsProcessorConfiguration {
221
239
  */
222
240
  export interface AmazonTranscribeProcessorConfiguration {
223
241
  /**
242
+ * @public
224
243
  * <p>The language code that represents the language spoken in your audio.</p>
225
244
  * <p>If you're unsure of the language spoken in your audio, consider using
226
245
  * <code>IdentifyLanguage</code> to enable automatic language identification.</p>
@@ -229,33 +248,39 @@ export interface AmazonTranscribeProcessorConfiguration {
229
248
  */
230
249
  LanguageCode?: CallAnalyticsLanguageCode | string;
231
250
  /**
251
+ * @public
232
252
  * <p>The name of the custom vocabulary that you specified in your Call Analytics
233
253
  * request.</p>
234
254
  * <p>Length Constraints: Minimum length of 1. Maximum length of 200.</p>
235
255
  */
236
256
  VocabularyName?: string;
237
257
  /**
258
+ * @public
238
259
  * <p>The name of the custom vocabulary filter that you specified in your Call Analytics
239
260
  * request.</p>
240
261
  * <p>Length Constraints: Minimum length of 1. Maximum length of 200.</p>
241
262
  */
242
263
  VocabularyFilterName?: string;
243
264
  /**
265
+ * @public
244
266
  * <p>The vocabulary filtering method used in your Call Analytics transcription.</p>
245
267
  */
246
268
  VocabularyFilterMethod?: VocabularyFilterMethod | string;
247
269
  /**
270
+ * @public
248
271
  * <p>Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.</p>
249
272
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers (diarization)</a> in the <i>Amazon Transcribe Developer Guide</i>.</p>
250
273
  */
251
274
  ShowSpeakerLabel?: boolean;
252
275
  /**
276
+ * @public
253
277
  * <p>Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.</p>
254
278
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization">Partial-result stabilization</a>
255
279
  * in the <i>Amazon Transcribe Developer Guide</i>.</p>
256
280
  */
257
281
  EnablePartialResultsStabilization?: boolean;
258
282
  /**
283
+ * @public
259
284
  * <p>The level of stability to use when you enable partial results stabilization
260
285
  * (<code>EnablePartialResultsStabilization</code>).</p>
261
286
  * <p>Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.</p>
@@ -264,6 +289,7 @@ export interface AmazonTranscribeProcessorConfiguration {
264
289
  */
265
290
  PartialResultsStability?: PartialResultsStability | string;
266
291
  /**
292
+ * @public
267
293
  * <p>Labels all personally identifiable information (PII) identified in your transcript.</p>
268
294
  * <p>Content identification is performed at the segment level; PII specified in
269
295
  * <code>PiiEntityTypes</code> is flagged upon complete transcription of an audio
@@ -276,6 +302,7 @@ export interface AmazonTranscribeProcessorConfiguration {
276
302
  */
277
303
  ContentIdentificationType?: ContentType | string;
278
304
  /**
305
+ * @public
279
306
  * <p>Redacts all personally identifiable information (PII) identified in your transcript.</p>
280
307
  * <p>Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.</p>
281
308
  * <p>You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a <code>BadRequestException</code>.</p>
@@ -284,6 +311,7 @@ export interface AmazonTranscribeProcessorConfiguration {
284
311
  */
285
312
  ContentRedactionType?: ContentType | string;
286
313
  /**
314
+ * @public
287
315
  * <p>The types of personally identifiable information (PII) to redact from a transcript. You
288
316
  * can include as many types as you'd like, or you can select <code>ALL</code>.</p>
289
317
  * <p>To include <code>PiiEntityTypes</code> in your Call Analytics request, you must also include <code>ContentIdentificationType</code> or <code>ContentRedactionType</code>, but you can't include both.</p>
@@ -294,6 +322,7 @@ export interface AmazonTranscribeProcessorConfiguration {
294
322
  */
295
323
  PiiEntityTypes?: string;
296
324
  /**
325
+ * @public
297
326
  * <p>The name of the custom language model that you want to use when processing your
298
327
  * transcription. Note that language model names are case sensitive.</p>
299
328
  * <p>The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the custom language model isn't applied.
@@ -302,26 +331,32 @@ export interface AmazonTranscribeProcessorConfiguration {
302
331
  */
303
332
  LanguageModelName?: string;
304
333
  /**
334
+ * @public
305
335
  * <p>If true, <code>TranscriptEvents</code> with <code>IsPartial: true</code> are filtered out of the insights target.</p>
306
336
  */
307
337
  FilterPartialResults?: boolean;
308
338
  /**
339
+ * @public
309
340
  * <p>Turns language identification on or off.</p>
310
341
  */
311
342
  IdentifyLanguage?: boolean;
312
343
  /**
344
+ * @public
313
345
  * <p>The language options for the transcription, such as automatic language detection.</p>
314
346
  */
315
347
  LanguageOptions?: string;
316
348
  /**
349
+ * @public
317
350
  * <p>The preferred language for the transcription.</p>
318
351
  */
319
352
  PreferredLanguage?: CallAnalyticsLanguageCode | string;
320
353
  /**
354
+ * @public
321
355
  * <p>The names of the custom vocabulary or vocabularies used during transcription.</p>
322
356
  */
323
357
  VocabularyNames?: string;
324
358
  /**
359
+ * @public
325
360
  * <p>The names of the custom vocabulary filter or filters using during transcription.</p>
326
361
  */
327
362
  VocabularyFilterNames?: string;
@@ -343,6 +378,7 @@ export type AudioArtifactsConcatenationState = (typeof AudioArtifactsConcatenati
343
378
  */
344
379
  export interface AudioConcatenationConfiguration {
345
380
  /**
381
+ * @public
346
382
  * <p>Enables or disables the configuration object.</p>
347
383
  */
348
384
  State: AudioArtifactsConcatenationState | string | undefined;
@@ -367,6 +403,7 @@ export type ArtifactsConcatenationState = (typeof ArtifactsConcatenationState)[k
367
403
  */
368
404
  export interface CompositedVideoConcatenationConfiguration {
369
405
  /**
406
+ * @public
370
407
  * <p>Enables or disables the configuration object.</p>
371
408
  */
372
409
  State: ArtifactsConcatenationState | string | undefined;
@@ -378,6 +415,7 @@ export interface CompositedVideoConcatenationConfiguration {
378
415
  */
379
416
  export interface ContentConcatenationConfiguration {
380
417
  /**
418
+ * @public
381
419
  * <p>Enables or disables the configuration object.</p>
382
420
  */
383
421
  State: ArtifactsConcatenationState | string | undefined;
@@ -388,6 +426,7 @@ export interface ContentConcatenationConfiguration {
388
426
  */
389
427
  export interface DataChannelConcatenationConfiguration {
390
428
  /**
429
+ * @public
391
430
  * <p>Enables or disables the configuration object.</p>
392
431
  */
393
432
  State: ArtifactsConcatenationState | string | undefined;
@@ -398,6 +437,7 @@ export interface DataChannelConcatenationConfiguration {
398
437
  */
399
438
  export interface MeetingEventsConcatenationConfiguration {
400
439
  /**
440
+ * @public
401
441
  * <p>Enables or disables the configuration object.</p>
402
442
  */
403
443
  State: ArtifactsConcatenationState | string | undefined;
@@ -408,6 +448,7 @@ export interface MeetingEventsConcatenationConfiguration {
408
448
  */
409
449
  export interface TranscriptionMessagesConcatenationConfiguration {
410
450
  /**
451
+ * @public
411
452
  * <p>Enables or disables the configuration object.</p>
412
453
  */
413
454
  State: ArtifactsConcatenationState | string | undefined;
@@ -418,6 +459,7 @@ export interface TranscriptionMessagesConcatenationConfiguration {
418
459
  */
419
460
  export interface VideoConcatenationConfiguration {
420
461
  /**
462
+ * @public
421
463
  * <p>Enables or disables the configuration object.</p>
422
464
  */
423
465
  State: ArtifactsConcatenationState | string | undefined;
@@ -428,30 +470,37 @@ export interface VideoConcatenationConfiguration {
428
470
  */
429
471
  export interface ArtifactsConcatenationConfiguration {
430
472
  /**
473
+ * @public
431
474
  * <p>The configuration for the audio artifacts concatenation.</p>
432
475
  */
433
476
  Audio: AudioConcatenationConfiguration | undefined;
434
477
  /**
478
+ * @public
435
479
  * <p>The configuration for the video artifacts concatenation.</p>
436
480
  */
437
481
  Video: VideoConcatenationConfiguration | undefined;
438
482
  /**
483
+ * @public
439
484
  * <p>The configuration for the content artifacts concatenation.</p>
440
485
  */
441
486
  Content: ContentConcatenationConfiguration | undefined;
442
487
  /**
488
+ * @public
443
489
  * <p>The configuration for the data channel artifacts concatenation.</p>
444
490
  */
445
491
  DataChannel: DataChannelConcatenationConfiguration | undefined;
446
492
  /**
493
+ * @public
447
494
  * <p>The configuration for the transcription messages artifacts concatenation.</p>
448
495
  */
449
496
  TranscriptionMessages: TranscriptionMessagesConcatenationConfiguration | undefined;
450
497
  /**
498
+ * @public
451
499
  * <p>The configuration for the meeting events artifacts concatenation.</p>
452
500
  */
453
501
  MeetingEvents: MeetingEventsConcatenationConfiguration | undefined;
454
502
  /**
503
+ * @public
455
504
  * <p>The configuration for the composited video artifacts concatenation.</p>
456
505
  */
457
506
  CompositedVideo: CompositedVideoConcatenationConfiguration | undefined;
@@ -475,6 +524,7 @@ export type AudioMuxType = (typeof AudioMuxType)[keyof typeof AudioMuxType];
475
524
  */
476
525
  export interface AudioArtifactsConfiguration {
477
526
  /**
527
+ * @public
478
528
  * <p>The MUX type of the audio artifact configuration object.</p>
479
529
  */
480
530
  MuxType: AudioMuxType | string | undefined;
@@ -535,18 +585,22 @@ export type HorizontalTilePosition = (typeof HorizontalTilePosition)[keyof typeo
535
585
  */
536
586
  export interface HorizontalLayoutConfiguration {
537
587
  /**
588
+ * @public
538
589
  * <p>Sets the automatic ordering of the video tiles.</p>
539
590
  */
540
591
  TileOrder?: TileOrder | string;
541
592
  /**
593
+ * @public
542
594
  * <p>Sets the position of horizontal tiles.</p>
543
595
  */
544
596
  TilePosition?: HorizontalTilePosition | string;
545
597
  /**
598
+ * @public
546
599
  * <p>The maximum number of video tiles to display.</p>
547
600
  */
548
601
  TileCount?: number;
549
602
  /**
603
+ * @public
550
604
  * <p>Sets the aspect ratio of the video tiles, such as 16:9.</p>
551
605
  */
552
606
  TileAspectRatio?: string;
@@ -571,6 +625,7 @@ export type PresenterPosition = (typeof PresenterPosition)[keyof typeof Presente
571
625
  */
572
626
  export interface PresenterOnlyConfiguration {
573
627
  /**
628
+ * @public
574
629
  * <p>Defines the position of the presenter video tile. Default: <code>TopRight</code>.</p>
575
630
  */
576
631
  PresenterPosition?: PresenterPosition | string;
@@ -593,18 +648,22 @@ export type VerticalTilePosition = (typeof VerticalTilePosition)[keyof typeof Ve
593
648
  */
594
649
  export interface VerticalLayoutConfiguration {
595
650
  /**
651
+ * @public
596
652
  * <p>Sets the automatic ordering of the video tiles.</p>
597
653
  */
598
654
  TileOrder?: TileOrder | string;
599
655
  /**
656
+ * @public
600
657
  * <p>Sets the position of vertical tiles.</p>
601
658
  */
602
659
  TilePosition?: VerticalTilePosition | string;
603
660
  /**
661
+ * @public
604
662
  * <p>The maximum number of tiles to display.</p>
605
663
  */
606
664
  TileCount?: number;
607
665
  /**
666
+ * @public
608
667
  * <p>Sets the aspect ratio of the video tiles, such as 16:9.</p>
609
668
  */
610
669
  TileAspectRatio?: string;
@@ -647,18 +706,22 @@ export type HighlightColor = (typeof HighlightColor)[keyof typeof HighlightColor
647
706
  */
648
707
  export interface VideoAttribute {
649
708
  /**
709
+ * @public
650
710
  * <p>Sets the corner radius of all video tiles.</p>
651
711
  */
652
712
  CornerRadius?: number;
653
713
  /**
714
+ * @public
654
715
  * <p>Defines the border color of all video tiles.</p>
655
716
  */
656
717
  BorderColor?: BorderColor | string;
657
718
  /**
719
+ * @public
658
720
  * <p>Defines the highlight color for the active video tile.</p>
659
721
  */
660
722
  HighlightColor?: HighlightColor | string;
661
723
  /**
724
+ * @public
662
725
  * <p>Defines the border thickness for all video tiles.</p>
663
726
  */
664
727
  BorderThickness?: number;
@@ -669,30 +732,37 @@ export interface VideoAttribute {
669
732
  */
670
733
  export interface GridViewConfiguration {
671
734
  /**
735
+ * @public
672
736
  * <p>Defines the layout of the video tiles when content sharing is enabled.</p>
673
737
  */
674
738
  ContentShareLayout: ContentShareLayoutOption | string | undefined;
675
739
  /**
740
+ * @public
676
741
  * <p>Defines the configuration options for a presenter only video tile.</p>
677
742
  */
678
743
  PresenterOnlyConfiguration?: PresenterOnlyConfiguration;
679
744
  /**
745
+ * @public
680
746
  * <p>The configuration settings for an <code>ActiveSpeakerOnly</code> video tile.</p>
681
747
  */
682
748
  ActiveSpeakerOnlyConfiguration?: ActiveSpeakerOnlyConfiguration;
683
749
  /**
750
+ * @public
684
751
  * <p>The configuration settings for a horizontal layout.</p>
685
752
  */
686
753
  HorizontalLayoutConfiguration?: HorizontalLayoutConfiguration;
687
754
  /**
755
+ * @public
688
756
  * <p>The configuration settings for a vertical layout.</p>
689
757
  */
690
758
  VerticalLayoutConfiguration?: VerticalLayoutConfiguration;
691
759
  /**
760
+ * @public
692
761
  * <p>The attribute settings for the video tiles.</p>
693
762
  */
694
763
  VideoAttribute?: VideoAttribute;
695
764
  /**
765
+ * @public
696
766
  * <p>The orientation setting, horizontal or vertical.</p>
697
767
  */
698
768
  CanvasOrientation?: CanvasOrientation | string;
@@ -726,14 +796,17 @@ export type ResolutionOption = (typeof ResolutionOption)[keyof typeof Resolution
726
796
  */
727
797
  export interface CompositedVideoArtifactsConfiguration {
728
798
  /**
799
+ * @public
729
800
  * <p>The layout setting, such as <code>GridView</code> in the configuration object.</p>
730
801
  */
731
802
  Layout?: LayoutOption | string;
732
803
  /**
804
+ * @public
733
805
  * <p>The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.</p>
734
806
  */
735
807
  Resolution?: ResolutionOption | string;
736
808
  /**
809
+ * @public
737
810
  * <p>The <code>GridView</code> configuration setting.</p>
738
811
  */
739
812
  GridViewConfiguration: GridViewConfiguration | undefined;
@@ -767,10 +840,12 @@ export type ArtifactsState = (typeof ArtifactsState)[keyof typeof ArtifactsState
767
840
  */
768
841
  export interface ContentArtifactsConfiguration {
769
842
  /**
843
+ * @public
770
844
  * <p>Indicates whether the content artifact is enabled or disabled.</p>
771
845
  */
772
846
  State: ArtifactsState | string | undefined;
773
847
  /**
848
+ * @public
774
849
  * <p>The MUX type of the artifact configuration.</p>
775
850
  */
776
851
  MuxType?: ContentMuxType | string;
@@ -792,10 +867,12 @@ export type VideoMuxType = (typeof VideoMuxType)[keyof typeof VideoMuxType];
792
867
  */
793
868
  export interface VideoArtifactsConfiguration {
794
869
  /**
870
+ * @public
795
871
  * <p>Indicates whether the video artifact is enabled or disabled.</p>
796
872
  */
797
873
  State: ArtifactsState | string | undefined;
798
874
  /**
875
+ * @public
799
876
  * <p>The MUX type of the video artifact configuration object.</p>
800
877
  */
801
878
  MuxType?: VideoMuxType | string;
@@ -806,18 +883,22 @@ export interface VideoArtifactsConfiguration {
806
883
  */
807
884
  export interface ArtifactsConfiguration {
808
885
  /**
886
+ * @public
809
887
  * <p>The configuration for the audio artifacts.</p>
810
888
  */
811
889
  Audio: AudioArtifactsConfiguration | undefined;
812
890
  /**
891
+ * @public
813
892
  * <p>The configuration for the video artifacts.</p>
814
893
  */
815
894
  Video: VideoArtifactsConfiguration | undefined;
816
895
  /**
896
+ * @public
817
897
  * <p>The configuration for the content artifacts.</p>
818
898
  */
819
899
  Content: ContentArtifactsConfiguration | undefined;
820
900
  /**
901
+ * @public
821
902
  * <p>Enables video compositing.</p>
822
903
  */
823
904
  CompositedVideo?: CompositedVideoArtifactsConfiguration;
@@ -861,6 +942,7 @@ export declare class BadRequestException extends __BaseException {
861
942
  Code?: ErrorCode | string;
862
943
  Message?: string;
863
944
  /**
945
+ * @public
864
946
  * <p>The request ID associated with the call responsible for the exception.</p>
865
947
  */
866
948
  RequestId?: string;
@@ -887,10 +969,12 @@ export type ParticipantRole = (typeof ParticipantRole)[keyof typeof ParticipantR
887
969
  */
888
970
  export interface ChannelDefinition {
889
971
  /**
972
+ * @public
890
973
  * <p>The channel ID.</p>
891
974
  */
892
975
  ChannelId: number | undefined;
893
976
  /**
977
+ * @public
894
978
  * <p>Specifies whether the audio in a channel belongs to the <code>AGENT</code> or <code>CUSTOMER</code>.</p>
895
979
  */
896
980
  ParticipantRole?: ParticipantRole | string;
@@ -902,10 +986,12 @@ export interface ChannelDefinition {
902
986
  */
903
987
  export interface SelectedVideoStreams {
904
988
  /**
989
+ * @public
905
990
  * <p>The attendee IDs of the streams selected for a media pipeline. </p>
906
991
  */
907
992
  AttendeeIds?: string[];
908
993
  /**
994
+ * @public
909
995
  * <p>The external user IDs of the streams selected for a media pipeline.</p>
910
996
  */
911
997
  ExternalUserIds?: string[];
@@ -916,6 +1002,7 @@ export interface SelectedVideoStreams {
916
1002
  */
917
1003
  export interface SourceConfiguration {
918
1004
  /**
1005
+ * @public
919
1006
  * <p>The selected video streams for a specified media pipeline. The number
920
1007
  * of video streams can't exceed 25.</p>
921
1008
  */
@@ -927,10 +1014,12 @@ export interface SourceConfiguration {
927
1014
  */
928
1015
  export interface ChimeSdkMeetingConfiguration {
929
1016
  /**
1017
+ * @public
930
1018
  * <p>The source configuration for a specified media pipeline.</p>
931
1019
  */
932
1020
  SourceConfiguration?: SourceConfiguration;
933
1021
  /**
1022
+ * @public
934
1023
  * <p>The configuration for the artifacts in an Amazon Chime SDK meeting.</p>
935
1024
  */
936
1025
  ArtifactsConfiguration?: ArtifactsConfiguration;
@@ -963,10 +1052,12 @@ export type MediaPipelineSourceType = (typeof MediaPipelineSourceType)[keyof typ
963
1052
  */
964
1053
  export interface Tag {
965
1054
  /**
1055
+ * @public
966
1056
  * <p>The key half of a tag.</p>
967
1057
  */
968
1058
  Key: string | undefined;
969
1059
  /**
1060
+ * @public
970
1061
  * <p>The value half of a tag.</p>
971
1062
  */
972
1063
  Value: string | undefined;
@@ -976,32 +1067,39 @@ export interface Tag {
976
1067
  */
977
1068
  export interface CreateMediaCapturePipelineRequest {
978
1069
  /**
1070
+ * @public
979
1071
  * <p>Source type from which the media artifacts are captured. A Chime SDK Meeting is the only
980
1072
  * supported source.</p>
981
1073
  */
982
1074
  SourceType: MediaPipelineSourceType | string | undefined;
983
1075
  /**
1076
+ * @public
984
1077
  * <p>ARN of the source from which the media artifacts are captured.</p>
985
1078
  */
986
1079
  SourceArn: string | undefined;
987
1080
  /**
1081
+ * @public
988
1082
  * <p>Destination type to which the media artifacts are saved. You must use an S3 bucket.</p>
989
1083
  */
990
1084
  SinkType: MediaPipelineSinkType | string | undefined;
991
1085
  /**
1086
+ * @public
992
1087
  * <p>The ARN of the sink type.</p>
993
1088
  */
994
1089
  SinkArn: string | undefined;
995
1090
  /**
1091
+ * @public
996
1092
  * <p>The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.</p>
997
1093
  */
998
1094
  ClientRequestToken?: string;
999
1095
  /**
1096
+ * @public
1000
1097
  * <p>The configuration for a specified media pipeline. <code>SourceType</code> must
1001
1098
  * be <code>ChimeSdkMeeting</code>.</p>
1002
1099
  */
1003
1100
  ChimeSdkMeetingConfiguration?: ChimeSdkMeetingConfiguration;
1004
1101
  /**
1102
+ * @public
1005
1103
  * <p>The tag key-value pairs.</p>
1006
1104
  */
1007
1105
  Tags?: Tag[];
@@ -1029,44 +1127,54 @@ export type MediaPipelineStatus = (typeof MediaPipelineStatus)[keyof typeof Medi
1029
1127
  */
1030
1128
  export interface MediaCapturePipeline {
1031
1129
  /**
1130
+ * @public
1032
1131
  * <p>The ID of a media pipeline.</p>
1033
1132
  */
1034
1133
  MediaPipelineId?: string;
1035
1134
  /**
1135
+ * @public
1036
1136
  * <p>The ARN of the media capture pipeline</p>
1037
1137
  */
1038
1138
  MediaPipelineArn?: string;
1039
1139
  /**
1140
+ * @public
1040
1141
  * <p>Source type from which media artifacts are saved. You must use
1041
1142
  * <code>ChimeMeeting</code>.</p>
1042
1143
  */
1043
1144
  SourceType?: MediaPipelineSourceType | string;
1044
1145
  /**
1146
+ * @public
1045
1147
  * <p>ARN of the source from which the media artifacts are saved.</p>
1046
1148
  */
1047
1149
  SourceArn?: string;
1048
1150
  /**
1151
+ * @public
1049
1152
  * <p>The status of the media pipeline.</p>
1050
1153
  */
1051
1154
  Status?: MediaPipelineStatus | string;
1052
1155
  /**
1156
+ * @public
1053
1157
  * <p>Destination type to which the media artifacts are saved. You must use an S3
1054
1158
  * Bucket.</p>
1055
1159
  */
1056
1160
  SinkType?: MediaPipelineSinkType | string;
1057
1161
  /**
1162
+ * @public
1058
1163
  * <p>ARN of the destination to which the media artifacts are saved.</p>
1059
1164
  */
1060
1165
  SinkArn?: string;
1061
1166
  /**
1167
+ * @public
1062
1168
  * <p>The time at which the pipeline was created, in ISO 8601 format.</p>
1063
1169
  */
1064
1170
  CreatedTimestamp?: Date;
1065
1171
  /**
1172
+ * @public
1066
1173
  * <p>The time at which the pipeline was updated, in ISO 8601 format.</p>
1067
1174
  */
1068
1175
  UpdatedTimestamp?: Date;
1069
1176
  /**
1177
+ * @public
1070
1178
  * <p>The configuration for a specified media pipeline. <code>SourceType</code> must
1071
1179
  * be <code>ChimeSdkMeeting</code>.</p>
1072
1180
  */
@@ -1077,6 +1185,7 @@ export interface MediaCapturePipeline {
1077
1185
  */
1078
1186
  export interface CreateMediaCapturePipelineResponse {
1079
1187
  /**
1188
+ * @public
1080
1189
  * <p>A media pipeline object, the ID, source type, source ARN, sink type, and sink
1081
1190
  * ARN of a media pipeline object.</p>
1082
1191
  */
@@ -1092,6 +1201,7 @@ export declare class ForbiddenException extends __BaseException {
1092
1201
  Code?: ErrorCode | string;
1093
1202
  Message?: string;
1094
1203
  /**
1204
+ * @public
1095
1205
  * <p>The request id associated with the call responsible for the exception.</p>
1096
1206
  */
1097
1207
  RequestId?: string;
@@ -1110,6 +1220,7 @@ export declare class ResourceLimitExceededException extends __BaseException {
1110
1220
  Code?: ErrorCode | string;
1111
1221
  Message?: string;
1112
1222
  /**
1223
+ * @public
1113
1224
  * <p>The request ID associated with the call responsible for the exception.</p>
1114
1225
  */
1115
1226
  RequestId?: string;
@@ -1128,6 +1239,7 @@ export declare class ServiceFailureException extends __BaseException {
1128
1239
  Code?: ErrorCode | string;
1129
1240
  Message?: string;
1130
1241
  /**
1242
+ * @public
1131
1243
  * <p>The request ID associated with the call responsible for the exception.</p>
1132
1244
  */
1133
1245
  RequestId?: string;
@@ -1146,6 +1258,7 @@ export declare class ServiceUnavailableException extends __BaseException {
1146
1258
  Code?: ErrorCode | string;
1147
1259
  Message?: string;
1148
1260
  /**
1261
+ * @public
1149
1262
  * <p>The request ID associated with the call responsible for the exception.</p>
1150
1263
  */
1151
1264
  RequestId?: string;
@@ -1164,6 +1277,7 @@ export declare class ThrottledClientException extends __BaseException {
1164
1277
  Code?: ErrorCode | string;
1165
1278
  Message?: string;
1166
1279
  /**
1280
+ * @public
1167
1281
  * <p>The request ID associated with the call responsible for the exception.</p>
1168
1282
  */
1169
1283
  RequestId?: string;
@@ -1182,6 +1296,7 @@ export declare class UnauthorizedClientException extends __BaseException {
1182
1296
  Code?: ErrorCode | string;
1183
1297
  Message?: string;
1184
1298
  /**
1299
+ * @public
1185
1300
  * <p>The request ID associated with the call responsible for the exception.</p>
1186
1301
  */
1187
1302
  RequestId?: string;
@@ -1196,6 +1311,7 @@ export declare class UnauthorizedClientException extends __BaseException {
1196
1311
  */
1197
1312
  export interface S3BucketSinkConfiguration {
1198
1313
  /**
1314
+ * @public
1199
1315
  * <p>The destination URL of the S3 bucket.</p>
1200
1316
  */
1201
1317
  Destination: string | undefined;
@@ -1217,10 +1333,12 @@ export type ConcatenationSinkType = (typeof ConcatenationSinkType)[keyof typeof
1217
1333
  */
1218
1334
  export interface ConcatenationSink {
1219
1335
  /**
1336
+ * @public
1220
1337
  * <p>The type of data sink in the configuration object.</p>
1221
1338
  */
1222
1339
  Type: ConcatenationSinkType | string | undefined;
1223
1340
  /**
1341
+ * @public
1224
1342
  * <p>The configuration settings for an Amazon S3 bucket sink.</p>
1225
1343
  */
1226
1344
  S3BucketSinkConfiguration: S3BucketSinkConfiguration | undefined;
@@ -1232,6 +1350,7 @@ export interface ConcatenationSink {
1232
1350
  */
1233
1351
  export interface ChimeSdkMeetingConcatenationConfiguration {
1234
1352
  /**
1353
+ * @public
1235
1354
  * <p>The configuration for the artifacts in an Amazon Chime SDK meeting concatenation.</p>
1236
1355
  */
1237
1356
  ArtifactsConfiguration: ArtifactsConcatenationConfiguration | undefined;
@@ -1242,10 +1361,12 @@ export interface ChimeSdkMeetingConcatenationConfiguration {
1242
1361
  */
1243
1362
  export interface MediaCapturePipelineSourceConfiguration {
1244
1363
  /**
1364
+ * @public
1245
1365
  * <p>The media pipeline ARN in the configuration object of a media capture pipeline.</p>
1246
1366
  */
1247
1367
  MediaPipelineArn: string | undefined;
1248
1368
  /**
1369
+ * @public
1249
1370
  * <p>The meeting configuration settings in a media capture pipeline configuration object. </p>
1250
1371
  */
1251
1372
  ChimeSdkMeetingConfiguration: ChimeSdkMeetingConcatenationConfiguration | undefined;
@@ -1267,10 +1388,12 @@ export type ConcatenationSourceType = (typeof ConcatenationSourceType)[keyof typ
1267
1388
  */
1268
1389
  export interface ConcatenationSource {
1269
1390
  /**
1391
+ * @public
1270
1392
  * <p>The type of concatenation source in a configuration object.</p>
1271
1393
  */
1272
1394
  Type: ConcatenationSourceType | string | undefined;
1273
1395
  /**
1396
+ * @public
1274
1397
  * <p>The concatenation settings for the media pipeline in a configuration object.</p>
1275
1398
  */
1276
1399
  MediaCapturePipelineSourceConfiguration: MediaCapturePipelineSourceConfiguration | undefined;
@@ -1280,19 +1403,23 @@ export interface ConcatenationSource {
1280
1403
  */
1281
1404
  export interface CreateMediaConcatenationPipelineRequest {
1282
1405
  /**
1406
+ * @public
1283
1407
  * <p>An object that specifies the sources for the media concatenation pipeline.</p>
1284
1408
  */
1285
1409
  Sources: ConcatenationSource[] | undefined;
1286
1410
  /**
1411
+ * @public
1287
1412
  * <p>An object that specifies the data sinks for the media concatenation pipeline.</p>
1288
1413
  */
1289
1414
  Sinks: ConcatenationSink[] | undefined;
1290
1415
  /**
1416
+ * @public
1291
1417
  * <p>The unique identifier for the client request. The token makes the API request
1292
1418
  * idempotent. Use a unique token for each media concatenation pipeline request.</p>
1293
1419
  */
1294
1420
  ClientRequestToken?: string;
1295
1421
  /**
1422
+ * @public
1296
1423
  * <p>The tags associated with the media concatenation pipeline.</p>
1297
1424
  */
1298
1425
  Tags?: Tag[];
@@ -1303,30 +1430,37 @@ export interface CreateMediaConcatenationPipelineRequest {
1303
1430
  */
1304
1431
  export interface MediaConcatenationPipeline {
1305
1432
  /**
1433
+ * @public
1306
1434
  * <p>The ID of the media pipeline being concatenated.</p>
1307
1435
  */
1308
1436
  MediaPipelineId?: string;
1309
1437
  /**
1438
+ * @public
1310
1439
  * <p>The ARN of the media pipeline that you specify in the <code>SourceConfiguration</code> object.</p>
1311
1440
  */
1312
1441
  MediaPipelineArn?: string;
1313
1442
  /**
1443
+ * @public
1314
1444
  * <p>The data sources being concatenated.</p>
1315
1445
  */
1316
1446
  Sources?: ConcatenationSource[];
1317
1447
  /**
1448
+ * @public
1318
1449
  * <p>The data sinks of the concatenation pipeline.</p>
1319
1450
  */
1320
1451
  Sinks?: ConcatenationSink[];
1321
1452
  /**
1453
+ * @public
1322
1454
  * <p>The status of the concatenation pipeline.</p>
1323
1455
  */
1324
1456
  Status?: MediaPipelineStatus | string;
1325
1457
  /**
1458
+ * @public
1326
1459
  * <p>The time at which the concatenation pipeline was created.</p>
1327
1460
  */
1328
1461
  CreatedTimestamp?: Date;
1329
1462
  /**
1463
+ * @public
1330
1464
  * <p>The time at which the concatenation pipeline was last updated.</p>
1331
1465
  */
1332
1466
  UpdatedTimestamp?: Date;
@@ -1336,6 +1470,7 @@ export interface MediaConcatenationPipeline {
1336
1470
  */
1337
1471
  export interface CreateMediaConcatenationPipelineResponse {
1338
1472
  /**
1473
+ * @public
1339
1474
  * <p>A media concatenation pipeline object, the ID, source type, <code>MediaPipelineARN</code>, and sink of a
1340
1475
  * media concatenation pipeline object.</p>
1341
1476
  */
@@ -1359,10 +1494,12 @@ export type FragmentSelectorType = (typeof FragmentSelectorType)[keyof typeof Fr
1359
1494
  */
1360
1495
  export interface TimestampRange {
1361
1496
  /**
1497
+ * @public
1362
1498
  * <p>The starting timestamp for the specified range.</p>
1363
1499
  */
1364
1500
  StartTimestamp: Date | undefined;
1365
1501
  /**
1502
+ * @public
1366
1503
  * <p>The ending timestamp for the specified range.</p>
1367
1504
  */
1368
1505
  EndTimestamp: Date | undefined;
@@ -1390,11 +1527,13 @@ export interface TimestampRange {
1390
1527
  */
1391
1528
  export interface FragmentSelector {
1392
1529
  /**
1530
+ * @public
1393
1531
  * <p>The origin of the timestamps to use, <code>Server</code> or <code>Producer</code>. For more information, see
1394
1532
  * <a href="kinesisvideostreams/latest/dg/API_dataplane_StartSelector.html#KinesisVideo-Type-dataplane_StartSelector-StartSelectorType">StartSelectorType</a> in the <i>Amazon Kinesis Video Streams Developer Guide</i>.</p>
1395
1533
  */
1396
1534
  FragmentSelectorType: FragmentSelectorType | string | undefined;
1397
1535
  /**
1536
+ * @public
1398
1537
  * <p>The range of timestamps to return.</p>
1399
1538
  */
1400
1539
  TimestampRange: TimestampRange | undefined;
@@ -1405,6 +1544,7 @@ export interface FragmentSelector {
1405
1544
  */
1406
1545
  export interface RecordingStreamConfiguration {
1407
1546
  /**
1547
+ * @public
1408
1548
  * <p>The ARN of the recording stream.</p>
1409
1549
  */
1410
1550
  StreamArn?: string;
@@ -1415,10 +1555,12 @@ export interface RecordingStreamConfiguration {
1415
1555
  */
1416
1556
  export interface KinesisVideoStreamRecordingSourceRuntimeConfiguration {
1417
1557
  /**
1558
+ * @public
1418
1559
  * <p>The stream or streams to be recorded.</p>
1419
1560
  */
1420
1561
  Streams: RecordingStreamConfiguration[] | undefined;
1421
1562
  /**
1563
+ * @public
1422
1564
  * <p>Describes the timestamp range and timestamp origin of a range of fragments in the Kinesis video stream.</p>
1423
1565
  */
1424
1566
  FragmentSelector: FragmentSelector | undefined;
@@ -1440,10 +1582,12 @@ export type MediaEncoding = (typeof MediaEncoding)[keyof typeof MediaEncoding];
1440
1582
  */
1441
1583
  export interface StreamChannelDefinition {
1442
1584
  /**
1585
+ * @public
1443
1586
  * <p>The number of channels in a streaming channel.</p>
1444
1587
  */
1445
1588
  NumberOfChannels: number | undefined;
1446
1589
  /**
1590
+ * @public
1447
1591
  * <p>The definitions of the channels in a streaming channel.</p>
1448
1592
  */
1449
1593
  ChannelDefinitions?: ChannelDefinition[];
@@ -1454,14 +1598,17 @@ export interface StreamChannelDefinition {
1454
1598
  */
1455
1599
  export interface StreamConfiguration {
1456
1600
  /**
1601
+ * @public
1457
1602
  * <p>The ARN of the stream.</p>
1458
1603
  */
1459
1604
  StreamArn: string | undefined;
1460
1605
  /**
1606
+ * @public
1461
1607
  * <p>The unique identifier of the fragment to begin processing.</p>
1462
1608
  */
1463
1609
  FragmentNumber?: string;
1464
1610
  /**
1611
+ * @public
1465
1612
  * <p>The streaming channel definition in the stream configuration.</p>
1466
1613
  */
1467
1614
  StreamChannelDefinition: StreamChannelDefinition | undefined;
@@ -1472,15 +1619,18 @@ export interface StreamConfiguration {
1472
1619
  */
1473
1620
  export interface KinesisVideoStreamSourceRuntimeConfiguration {
1474
1621
  /**
1622
+ * @public
1475
1623
  * <p>The streams in the source runtime configuration of a Kinesis video stream.</p>
1476
1624
  */
1477
1625
  Streams: StreamConfiguration[] | undefined;
1478
1626
  /**
1627
+ * @public
1479
1628
  * <p>Specifies the encoding of your input audio. Supported format: PCM (only signed 16-bit little-endian audio formats, which does not include WAV)</p>
1480
1629
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> in the <i>Amazon Transcribe Developer Guide</i>.</p>
1481
1630
  */
1482
1631
  MediaEncoding: MediaEncoding | string | undefined;
1483
1632
  /**
1633
+ * @public
1484
1634
  * <p>The sample rate of the input audio (in hertz). Low-quality audio, such as telephone
1485
1635
  * audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to
1486
1636
  * 48,000 Hz. Note that the sample rate you specify must match that of your audio.</p>
@@ -1506,10 +1656,12 @@ export type RecordingFileFormat = (typeof RecordingFileFormat)[keyof typeof Reco
1506
1656
  */
1507
1657
  export interface S3RecordingSinkRuntimeConfiguration {
1508
1658
  /**
1659
+ * @public
1509
1660
  * <p>The URI of the S3 bucket used as the sink.</p>
1510
1661
  */
1511
1662
  Destination: string | undefined;
1512
1663
  /**
1664
+ * @public
1513
1665
  * <p>The file format for the media files sent to the Amazon S3 bucket.</p>
1514
1666
  */
1515
1667
  RecordingFileFormat: RecordingFileFormat | string | undefined;
@@ -1519,31 +1671,38 @@ export interface S3RecordingSinkRuntimeConfiguration {
1519
1671
  */
1520
1672
  export interface CreateMediaInsightsPipelineRequest {
1521
1673
  /**
1674
+ * @public
1522
1675
  * <p>The ARN of the pipeline's configuration.</p>
1523
1676
  */
1524
1677
  MediaInsightsPipelineConfigurationArn: string | undefined;
1525
1678
  /**
1679
+ * @public
1526
1680
  * <p>The runtime configuration for the Kinesis video stream source of the media insights
1527
1681
  * pipeline.</p>
1528
1682
  */
1529
1683
  KinesisVideoStreamSourceRuntimeConfiguration?: KinesisVideoStreamSourceRuntimeConfiguration;
1530
1684
  /**
1685
+ * @public
1531
1686
  * <p>The runtime metadata for the media insights pipeline. Consists of a key-value map of strings.</p>
1532
1687
  */
1533
1688
  MediaInsightsRuntimeMetadata?: Record<string, string>;
1534
1689
  /**
1690
+ * @public
1535
1691
  * <p>The runtime configuration for the Kinesis video recording stream source.</p>
1536
1692
  */
1537
1693
  KinesisVideoStreamRecordingSourceRuntimeConfiguration?: KinesisVideoStreamRecordingSourceRuntimeConfiguration;
1538
1694
  /**
1695
+ * @public
1539
1696
  * <p>The runtime configuration for the S3 recording sink. If specified, the settings in this structure override any settings in <code>S3RecordingSinkConfiguration</code>.</p>
1540
1697
  */
1541
1698
  S3RecordingSinkRuntimeConfiguration?: S3RecordingSinkRuntimeConfiguration;
1542
1699
  /**
1700
+ * @public
1543
1701
  * <p>The tags assigned to the media insights pipeline.</p>
1544
1702
  */
1545
1703
  Tags?: Tag[];
1546
1704
  /**
1705
+ * @public
1547
1706
  * <p>The unique identifier for the media insights pipeline request.</p>
1548
1707
  */
1549
1708
  ClientRequestToken?: string;
@@ -1554,38 +1713,47 @@ export interface CreateMediaInsightsPipelineRequest {
1554
1713
  */
1555
1714
  export interface MediaInsightsPipeline {
1556
1715
  /**
1716
+ * @public
1557
1717
  * <p>The ID of a media insights pipeline.</p>
1558
1718
  */
1559
1719
  MediaPipelineId?: string;
1560
1720
  /**
1721
+ * @public
1561
1722
  * <p>The ARN of a media insights pipeline.</p>
1562
1723
  */
1563
1724
  MediaPipelineArn?: string;
1564
1725
  /**
1726
+ * @public
1565
1727
  * <p>The ARN of a media insight pipeline's configuration settings.</p>
1566
1728
  */
1567
1729
  MediaInsightsPipelineConfigurationArn?: string;
1568
1730
  /**
1731
+ * @public
1569
1732
  * <p>The status of a media insights pipeline.</p>
1570
1733
  */
1571
1734
  Status?: MediaPipelineStatus | string;
1572
1735
  /**
1736
+ * @public
1573
1737
  * <p>The configuration settings for a Kinesis runtime video stream in a media insights pipeline.</p>
1574
1738
  */
1575
1739
  KinesisVideoStreamSourceRuntimeConfiguration?: KinesisVideoStreamSourceRuntimeConfiguration;
1576
1740
  /**
1741
+ * @public
1577
1742
  * <p>The runtime metadata of a media insights pipeline.</p>
1578
1743
  */
1579
1744
  MediaInsightsRuntimeMetadata?: Record<string, string>;
1580
1745
  /**
1746
+ * @public
1581
1747
  * <p>The runtime configuration settings for a Kinesis recording video stream in a media insights pipeline.</p>
1582
1748
  */
1583
1749
  KinesisVideoStreamRecordingSourceRuntimeConfiguration?: KinesisVideoStreamRecordingSourceRuntimeConfiguration;
1584
1750
  /**
1751
+ * @public
1585
1752
  * <p>The runtime configuration of the Amazon S3 bucket that stores recordings in a media insights pipeline.</p>
1586
1753
  */
1587
1754
  S3RecordingSinkRuntimeConfiguration?: S3RecordingSinkRuntimeConfiguration;
1588
1755
  /**
1756
+ * @public
1589
1757
  * <p>The time at which the media insights pipeline was created.</p>
1590
1758
  */
1591
1759
  CreatedTimestamp?: Date;
@@ -1595,6 +1763,7 @@ export interface MediaInsightsPipeline {
1595
1763
  */
1596
1764
  export interface CreateMediaInsightsPipelineResponse {
1597
1765
  /**
1766
+ * @public
1598
1767
  * <p>The media insights pipeline object.</p>
1599
1768
  */
1600
1769
  MediaInsightsPipeline: MediaInsightsPipeline | undefined;
@@ -1609,6 +1778,7 @@ export declare class NotFoundException extends __BaseException {
1609
1778
  Code?: ErrorCode | string;
1610
1779
  Message?: string;
1611
1780
  /**
1781
+ * @public
1612
1782
  * <p>The request ID associated with the call responsible for the exception.</p>
1613
1783
  */
1614
1784
  RequestId?: string;
@@ -1623,6 +1793,7 @@ export declare class NotFoundException extends __BaseException {
1623
1793
  */
1624
1794
  export interface KinesisDataStreamSinkConfiguration {
1625
1795
  /**
1796
+ * @public
1626
1797
  * <p>The ARN of the sink.</p>
1627
1798
  */
1628
1799
  InsightsTarget?: string;
@@ -1633,6 +1804,7 @@ export interface KinesisDataStreamSinkConfiguration {
1633
1804
  */
1634
1805
  export interface LambdaFunctionSinkConfiguration {
1635
1806
  /**
1807
+ * @public
1636
1808
  * <p>The ARN of the sink.</p>
1637
1809
  */
1638
1810
  InsightsTarget?: string;
@@ -1643,10 +1815,12 @@ export interface LambdaFunctionSinkConfiguration {
1643
1815
  */
1644
1816
  export interface S3RecordingSinkConfiguration {
1645
1817
  /**
1818
+ * @public
1646
1819
  * <p>The default URI of the Amazon S3 bucket used as the recording sink.</p>
1647
1820
  */
1648
1821
  Destination?: string;
1649
1822
  /**
1823
+ * @public
1650
1824
  * <p>The default file format for the media files sent to the Amazon S3 bucket.</p>
1651
1825
  */
1652
1826
  RecordingFileFormat?: RecordingFileFormat | string;
@@ -1657,6 +1831,7 @@ export interface S3RecordingSinkConfiguration {
1657
1831
  */
1658
1832
  export interface SnsTopicSinkConfiguration {
1659
1833
  /**
1834
+ * @public
1660
1835
  * <p>The ARN of the SNS sink.</p>
1661
1836
  */
1662
1837
  InsightsTarget?: string;
@@ -1667,6 +1842,7 @@ export interface SnsTopicSinkConfiguration {
1667
1842
  */
1668
1843
  export interface SqsQueueSinkConfiguration {
1669
1844
  /**
1845
+ * @public
1670
1846
  * <p>The ARN of the SQS sink.</p>
1671
1847
  */
1672
1848
  InsightsTarget?: string;
@@ -1707,10 +1883,12 @@ export type VoiceAnalyticsConfigurationStatus = (typeof VoiceAnalyticsConfigurat
1707
1883
  */
1708
1884
  export interface VoiceAnalyticsProcessorConfiguration {
1709
1885
  /**
1886
+ * @public
1710
1887
  * <p>The status of the speaker search task.</p>
1711
1888
  */
1712
1889
  SpeakerSearchStatus?: VoiceAnalyticsConfigurationStatus | string;
1713
1890
  /**
1891
+ * @public
1714
1892
  * <p>The status of the voice tone analysis task.</p>
1715
1893
  */
1716
1894
  VoiceToneAnalysisStatus?: VoiceAnalyticsConfigurationStatus | string;
@@ -1721,39 +1899,48 @@ export interface VoiceAnalyticsProcessorConfiguration {
1721
1899
  */
1722
1900
  export interface MediaInsightsPipelineConfigurationElement {
1723
1901
  /**
1902
+ * @public
1724
1903
  * <p>The element type.</p>
1725
1904
  */
1726
1905
  Type: MediaInsightsPipelineConfigurationElementType | string | undefined;
1727
1906
  /**
1907
+ * @public
1728
1908
  * <p>The analytics configuration settings for transcribing audio in a media insights pipeline configuration element.</p>
1729
1909
  */
1730
1910
  AmazonTranscribeCallAnalyticsProcessorConfiguration?: AmazonTranscribeCallAnalyticsProcessorConfiguration;
1731
1911
  /**
1912
+ * @public
1732
1913
  * <p>The transcription processor configuration settings in a media insights pipeline
1733
1914
  * configuration element.</p>
1734
1915
  */
1735
1916
  AmazonTranscribeProcessorConfiguration?: AmazonTranscribeProcessorConfiguration;
1736
1917
  /**
1918
+ * @public
1737
1919
  * <p>The configuration settings for the Kinesis Data Stream Sink in a media insights pipeline configuration element.</p>
1738
1920
  */
1739
1921
  KinesisDataStreamSinkConfiguration?: KinesisDataStreamSinkConfiguration;
1740
1922
  /**
1923
+ * @public
1741
1924
  * <p>The configuration settings for the Amazon S3 recording bucket in a media insights pipeline configuration element.</p>
1742
1925
  */
1743
1926
  S3RecordingSinkConfiguration?: S3RecordingSinkConfiguration;
1744
1927
  /**
1928
+ * @public
1745
1929
  * <p>The voice analytics configuration settings in a media insights pipeline configuration element.</p>
1746
1930
  */
1747
1931
  VoiceAnalyticsProcessorConfiguration?: VoiceAnalyticsProcessorConfiguration;
1748
1932
  /**
1933
+ * @public
1749
1934
  * <p>The configuration settings for the Amazon Web Services Lambda sink in a media insights pipeline configuration element.</p>
1750
1935
  */
1751
1936
  LambdaFunctionSinkConfiguration?: LambdaFunctionSinkConfiguration;
1752
1937
  /**
1938
+ * @public
1753
1939
  * <p>The configuration settings for an SQS queue sink in a media insights pipeline configuration element.</p>
1754
1940
  */
1755
1941
  SqsQueueSinkConfiguration?: SqsQueueSinkConfiguration;
1756
1942
  /**
1943
+ * @public
1757
1944
  * <p>The configuration settings for an SNS topic sink in a media insights pipeline configuration element.</p>
1758
1945
  */
1759
1946
  SnsTopicSinkConfiguration?: SnsTopicSinkConfiguration;
@@ -1764,6 +1951,7 @@ export interface MediaInsightsPipelineConfigurationElement {
1764
1951
  */
1765
1952
  export interface IssueDetectionConfiguration {
1766
1953
  /**
1954
+ * @public
1767
1955
  * <p>The name of the issue detection rule.</p>
1768
1956
  */
1769
1957
  RuleName: string | undefined;
@@ -1774,14 +1962,17 @@ export interface IssueDetectionConfiguration {
1774
1962
  */
1775
1963
  export interface KeywordMatchConfiguration {
1776
1964
  /**
1965
+ * @public
1777
1966
  * <p>The name of the keyword match rule.</p>
1778
1967
  */
1779
1968
  RuleName: string | undefined;
1780
1969
  /**
1970
+ * @public
1781
1971
  * <p>The keywords or phrases that you want to match.</p>
1782
1972
  */
1783
1973
  Keywords: string[] | undefined;
1784
1974
  /**
1975
+ * @public
1785
1976
  * <p>Matches keywords or phrases on their presence or absence. If set to <code>TRUE</code>, the rule matches when all
1786
1977
  * the specified keywords or phrases are absent. Default: <code>FALSE</code>.</p>
1787
1978
  */
@@ -1804,14 +1995,17 @@ export type SentimentType = (typeof SentimentType)[keyof typeof SentimentType];
1804
1995
  */
1805
1996
  export interface SentimentConfiguration {
1806
1997
  /**
1998
+ * @public
1807
1999
  * <p>The name of the rule in the sentiment configuration.</p>
1808
2000
  */
1809
2001
  RuleName: string | undefined;
1810
2002
  /**
2003
+ * @public
1811
2004
  * <p>The type of sentiment, <code>POSITIVE</code>, <code>NEGATIVE</code>, or <code>NEUTRAL</code>.</p>
1812
2005
  */
1813
2006
  SentimentType: SentimentType | string | undefined;
1814
2007
  /**
2008
+ * @public
1815
2009
  * <p>Specifies the analysis interval.</p>
1816
2010
  */
1817
2011
  TimePeriod: number | undefined;
@@ -1835,18 +2029,22 @@ export type RealTimeAlertRuleType = (typeof RealTimeAlertRuleType)[keyof typeof
1835
2029
  */
1836
2030
  export interface RealTimeAlertRule {
1837
2031
  /**
2032
+ * @public
1838
2033
  * <p>The type of alert rule.</p>
1839
2034
  */
1840
2035
  Type: RealTimeAlertRuleType | string | undefined;
1841
2036
  /**
2037
+ * @public
1842
2038
  * <p>Specifies the settings for matching the keywords in a real-time alert rule.</p>
1843
2039
  */
1844
2040
  KeywordMatchConfiguration?: KeywordMatchConfiguration;
1845
2041
  /**
2042
+ * @public
1846
2043
  * <p>Specifies the settings for predicting sentiment in a real-time alert rule.</p>
1847
2044
  */
1848
2045
  SentimentConfiguration?: SentimentConfiguration;
1849
2046
  /**
2047
+ * @public
1850
2048
  * <p>Specifies the issue detection settings for a real-time alert rule.</p>
1851
2049
  */
1852
2050
  IssueDetectionConfiguration?: IssueDetectionConfiguration;
@@ -1857,10 +2055,12 @@ export interface RealTimeAlertRule {
1857
2055
  */
1858
2056
  export interface RealTimeAlertConfiguration {
1859
2057
  /**
2058
+ * @public
1860
2059
  * <p>Turns off real-time alerts.</p>
1861
2060
  */
1862
2061
  Disabled?: boolean;
1863
2062
  /**
2063
+ * @public
1864
2064
  * <p>The rules in the alert. Rules specify the words or phrases that you want to be notified about.</p>
1865
2065
  */
1866
2066
  Rules?: RealTimeAlertRule[];
@@ -1870,28 +2070,34 @@ export interface RealTimeAlertConfiguration {
1870
2070
  */
1871
2071
  export interface CreateMediaInsightsPipelineConfigurationRequest {
1872
2072
  /**
2073
+ * @public
1873
2074
  * <p>The name of the media insights pipeline configuration.</p>
1874
2075
  */
1875
2076
  MediaInsightsPipelineConfigurationName: string | undefined;
1876
2077
  /**
2078
+ * @public
1877
2079
  * <p>The ARN of the role used by the service to access Amazon Web Services resources,
1878
2080
  * including <code>Transcribe</code> and <code>Transcribe Call Analytics</code>, on the
1879
2081
  * caller’s behalf.</p>
1880
2082
  */
1881
2083
  ResourceAccessRoleArn: string | undefined;
1882
2084
  /**
2085
+ * @public
1883
2086
  * <p>The configuration settings for the real-time alerts in a media insights pipeline configuration.</p>
1884
2087
  */
1885
2088
  RealTimeAlertConfiguration?: RealTimeAlertConfiguration;
1886
2089
  /**
2090
+ * @public
1887
2091
  * <p>The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream.</p>
1888
2092
  */
1889
2093
  Elements: MediaInsightsPipelineConfigurationElement[] | undefined;
1890
2094
  /**
2095
+ * @public
1891
2096
  * <p>The tags assigned to the media insights pipeline configuration.</p>
1892
2097
  */
1893
2098
  Tags?: Tag[];
1894
2099
  /**
2100
+ * @public
1895
2101
  * <p>The unique identifier for the media insights pipeline configuration request.</p>
1896
2102
  */
1897
2103
  ClientRequestToken?: string;
@@ -1902,34 +2108,42 @@ export interface CreateMediaInsightsPipelineConfigurationRequest {
1902
2108
  */
1903
2109
  export interface MediaInsightsPipelineConfiguration {
1904
2110
  /**
2111
+ * @public
1905
2112
  * <p>The name of the configuration.</p>
1906
2113
  */
1907
2114
  MediaInsightsPipelineConfigurationName?: string;
1908
2115
  /**
2116
+ * @public
1909
2117
  * <p>The ARN of the configuration.</p>
1910
2118
  */
1911
2119
  MediaInsightsPipelineConfigurationArn?: string;
1912
2120
  /**
2121
+ * @public
1913
2122
  * <p>The ARN of the role used by the service to access Amazon Web Services resources.</p>
1914
2123
  */
1915
2124
  ResourceAccessRoleArn?: string;
1916
2125
  /**
2126
+ * @public
1917
2127
  * <p>Lists the rules that trigger a real-time alert.</p>
1918
2128
  */
1919
2129
  RealTimeAlertConfiguration?: RealTimeAlertConfiguration;
1920
2130
  /**
2131
+ * @public
1921
2132
  * <p>The elements in the configuration.</p>
1922
2133
  */
1923
2134
  Elements?: MediaInsightsPipelineConfigurationElement[];
1924
2135
  /**
2136
+ * @public
1925
2137
  * <p>The ID of the configuration.</p>
1926
2138
  */
1927
2139
  MediaInsightsPipelineConfigurationId?: string;
1928
2140
  /**
2141
+ * @public
1929
2142
  * <p>The time at which the configuration was created.</p>
1930
2143
  */
1931
2144
  CreatedTimestamp?: Date;
1932
2145
  /**
2146
+ * @public
1933
2147
  * <p>The time at which the configuration was last updated.</p>
1934
2148
  */
1935
2149
  UpdatedTimestamp?: Date;
@@ -1939,6 +2153,7 @@ export interface MediaInsightsPipelineConfiguration {
1939
2153
  */
1940
2154
  export interface CreateMediaInsightsPipelineConfigurationResponse {
1941
2155
  /**
2156
+ * @public
1942
2157
  * <p>The configuration settings for the media insights pipeline.</p>
1943
2158
  */
1944
2159
  MediaInsightsPipelineConfiguration?: MediaInsightsPipelineConfiguration;
@@ -1949,14 +2164,17 @@ export interface CreateMediaInsightsPipelineConfigurationResponse {
1949
2164
  */
1950
2165
  export interface LiveConnectorRTMPConfiguration {
1951
2166
  /**
2167
+ * @public
1952
2168
  * <p>The URL of the RTMP configuration.</p>
1953
2169
  */
1954
2170
  Url: string | undefined;
1955
2171
  /**
2172
+ * @public
1956
2173
  * <p>The audio channels set for the RTMP configuration</p>
1957
2174
  */
1958
2175
  AudioChannels?: AudioChannelsOption | string;
1959
2176
  /**
2177
+ * @public
1960
2178
  * <p>The audio sample rate set for the RTMP configuration. Default: 48000.</p>
1961
2179
  */
1962
2180
  AudioSampleRate?: string;
@@ -1978,10 +2196,12 @@ export type LiveConnectorSinkType = (typeof LiveConnectorSinkType)[keyof typeof
1978
2196
  */
1979
2197
  export interface LiveConnectorSinkConfiguration {
1980
2198
  /**
2199
+ * @public
1981
2200
  * <p>The sink configuration's sink type.</p>
1982
2201
  */
1983
2202
  SinkType: LiveConnectorSinkType | string | undefined;
1984
2203
  /**
2204
+ * @public
1985
2205
  * <p>The sink configuration's RTMP configuration settings.</p>
1986
2206
  */
1987
2207
  RTMPConfiguration: LiveConnectorRTMPConfiguration | undefined;
@@ -2004,18 +2224,22 @@ export type LiveConnectorMuxType = (typeof LiveConnectorMuxType)[keyof typeof Li
2004
2224
  */
2005
2225
  export interface ChimeSdkMeetingLiveConnectorConfiguration {
2006
2226
  /**
2227
+ * @public
2007
2228
  * <p>The configuration object's Chime SDK meeting ARN.</p>
2008
2229
  */
2009
2230
  Arn: string | undefined;
2010
2231
  /**
2232
+ * @public
2011
2233
  * <p>The configuration object's multiplex type.</p>
2012
2234
  */
2013
2235
  MuxType: LiveConnectorMuxType | string | undefined;
2014
2236
  /**
2237
+ * @public
2015
2238
  * <p>The media pipeline's composited video.</p>
2016
2239
  */
2017
2240
  CompositedVideo?: CompositedVideoArtifactsConfiguration;
2018
2241
  /**
2242
+ * @public
2019
2243
  * <p>The source configuration settings of the media pipeline's configuration object.</p>
2020
2244
  */
2021
2245
  SourceConfiguration?: SourceConfiguration;
@@ -2037,10 +2261,12 @@ export type LiveConnectorSourceType = (typeof LiveConnectorSourceType)[keyof typ
2037
2261
  */
2038
2262
  export interface LiveConnectorSourceConfiguration {
2039
2263
  /**
2264
+ * @public
2040
2265
  * <p>The source configuration's media source type.</p>
2041
2266
  */
2042
2267
  SourceType: LiveConnectorSourceType | string | undefined;
2043
2268
  /**
2269
+ * @public
2044
2270
  * <p>The configuration settings of the connector pipeline.</p>
2045
2271
  */
2046
2272
  ChimeSdkMeetingLiveConnectorConfiguration: ChimeSdkMeetingLiveConnectorConfiguration | undefined;
@@ -2050,18 +2276,22 @@ export interface LiveConnectorSourceConfiguration {
2050
2276
  */
2051
2277
  export interface CreateMediaLiveConnectorPipelineRequest {
2052
2278
  /**
2279
+ * @public
2053
2280
  * <p>The media live connector pipeline's data sources.</p>
2054
2281
  */
2055
2282
  Sources: LiveConnectorSourceConfiguration[] | undefined;
2056
2283
  /**
2284
+ * @public
2057
2285
  * <p>The media live connector pipeline's data sinks.</p>
2058
2286
  */
2059
2287
  Sinks: LiveConnectorSinkConfiguration[] | undefined;
2060
2288
  /**
2289
+ * @public
2061
2290
  * <p>The token assigned to the client making the request.</p>
2062
2291
  */
2063
2292
  ClientRequestToken?: string;
2064
2293
  /**
2294
+ * @public
2065
2295
  * <p>The tags associated with the media live connector pipeline.</p>
2066
2296
  */
2067
2297
  Tags?: Tag[];
@@ -2072,30 +2302,37 @@ export interface CreateMediaLiveConnectorPipelineRequest {
2072
2302
  */
2073
2303
  export interface MediaLiveConnectorPipeline {
2074
2304
  /**
2305
+ * @public
2075
2306
  * <p>The connector pipeline's data sources.</p>
2076
2307
  */
2077
2308
  Sources?: LiveConnectorSourceConfiguration[];
2078
2309
  /**
2310
+ * @public
2079
2311
  * <p>The connector pipeline's data sinks.</p>
2080
2312
  */
2081
2313
  Sinks?: LiveConnectorSinkConfiguration[];
2082
2314
  /**
2315
+ * @public
2083
2316
  * <p>The connector pipeline's ID.</p>
2084
2317
  */
2085
2318
  MediaPipelineId?: string;
2086
2319
  /**
2320
+ * @public
2087
2321
  * <p>The connector pipeline's ARN.</p>
2088
2322
  */
2089
2323
  MediaPipelineArn?: string;
2090
2324
  /**
2325
+ * @public
2091
2326
  * <p>The connector pipeline's status.</p>
2092
2327
  */
2093
2328
  Status?: MediaPipelineStatus | string;
2094
2329
  /**
2330
+ * @public
2095
2331
  * <p>The time at which the connector pipeline was created.</p>
2096
2332
  */
2097
2333
  CreatedTimestamp?: Date;
2098
2334
  /**
2335
+ * @public
2099
2336
  * <p>The time at which the connector pipeline was last updated.</p>
2100
2337
  */
2101
2338
  UpdatedTimestamp?: Date;
@@ -2105,6 +2342,7 @@ export interface MediaLiveConnectorPipeline {
2105
2342
  */
2106
2343
  export interface CreateMediaLiveConnectorPipelineResponse {
2107
2344
  /**
2345
+ * @public
2108
2346
  * <p>The new media live connector pipeline.</p>
2109
2347
  */
2110
2348
  MediaLiveConnectorPipeline?: MediaLiveConnectorPipeline;
@@ -2114,6 +2352,7 @@ export interface CreateMediaLiveConnectorPipelineResponse {
2114
2352
  */
2115
2353
  export interface DeleteMediaCapturePipelineRequest {
2116
2354
  /**
2355
+ * @public
2117
2356
  * <p>The ID of the media pipeline being deleted. </p>
2118
2357
  */
2119
2358
  MediaPipelineId: string | undefined;
@@ -2129,6 +2368,7 @@ export declare class ConflictException extends __BaseException {
2129
2368
  Code?: ErrorCode | string;
2130
2369
  Message?: string;
2131
2370
  /**
2371
+ * @public
2132
2372
  * <p>The request ID associated with the call responsible for the exception.</p>
2133
2373
  */
2134
2374
  RequestId?: string;
@@ -2142,6 +2382,7 @@ export declare class ConflictException extends __BaseException {
2142
2382
  */
2143
2383
  export interface DeleteMediaInsightsPipelineConfigurationRequest {
2144
2384
  /**
2385
+ * @public
2145
2386
  * <p>The unique identifier of the resource to be deleted. Valid values include the name and ARN of the media insights pipeline configuration.</p>
2146
2387
  */
2147
2388
  Identifier: string | undefined;
@@ -2151,6 +2392,7 @@ export interface DeleteMediaInsightsPipelineConfigurationRequest {
2151
2392
  */
2152
2393
  export interface DeleteMediaPipelineRequest {
2153
2394
  /**
2395
+ * @public
2154
2396
  * <p>The ID of the media pipeline to delete.</p>
2155
2397
  */
2156
2398
  MediaPipelineId: string | undefined;
@@ -2160,6 +2402,7 @@ export interface DeleteMediaPipelineRequest {
2160
2402
  */
2161
2403
  export interface GetMediaCapturePipelineRequest {
2162
2404
  /**
2405
+ * @public
2163
2406
  * <p>The ID of the pipeline that you want to get.</p>
2164
2407
  */
2165
2408
  MediaPipelineId: string | undefined;
@@ -2169,6 +2412,7 @@ export interface GetMediaCapturePipelineRequest {
2169
2412
  */
2170
2413
  export interface GetMediaCapturePipelineResponse {
2171
2414
  /**
2415
+ * @public
2172
2416
  * <p>The media pipeline object.</p>
2173
2417
  */
2174
2418
  MediaCapturePipeline?: MediaCapturePipeline;
@@ -2178,6 +2422,7 @@ export interface GetMediaCapturePipelineResponse {
2178
2422
  */
2179
2423
  export interface GetMediaInsightsPipelineConfigurationRequest {
2180
2424
  /**
2425
+ * @public
2181
2426
  * <p>The unique identifier of the requested resource. Valid values include the name and ARN of the media insights pipeline configuration.</p>
2182
2427
  */
2183
2428
  Identifier: string | undefined;
@@ -2187,6 +2432,7 @@ export interface GetMediaInsightsPipelineConfigurationRequest {
2187
2432
  */
2188
2433
  export interface GetMediaInsightsPipelineConfigurationResponse {
2189
2434
  /**
2435
+ * @public
2190
2436
  * <p>The requested media insights pipeline configuration.</p>
2191
2437
  */
2192
2438
  MediaInsightsPipelineConfiguration?: MediaInsightsPipelineConfiguration;
@@ -2196,6 +2442,7 @@ export interface GetMediaInsightsPipelineConfigurationResponse {
2196
2442
  */
2197
2443
  export interface GetMediaPipelineRequest {
2198
2444
  /**
2445
+ * @public
2199
2446
  * <p>The ID of the pipeline that you want to get.</p>
2200
2447
  */
2201
2448
  MediaPipelineId: string | undefined;
@@ -2206,18 +2453,22 @@ export interface GetMediaPipelineRequest {
2206
2453
  */
2207
2454
  export interface MediaPipeline {
2208
2455
  /**
2456
+ * @public
2209
2457
  * <p>A pipeline that enables users to capture audio and video.</p>
2210
2458
  */
2211
2459
  MediaCapturePipeline?: MediaCapturePipeline;
2212
2460
  /**
2461
+ * @public
2213
2462
  * <p>The connector pipeline of the media pipeline.</p>
2214
2463
  */
2215
2464
  MediaLiveConnectorPipeline?: MediaLiveConnectorPipeline;
2216
2465
  /**
2466
+ * @public
2217
2467
  * <p>The media concatenation pipeline in a media pipeline.</p>
2218
2468
  */
2219
2469
  MediaConcatenationPipeline?: MediaConcatenationPipeline;
2220
2470
  /**
2471
+ * @public
2221
2472
  * <p>The media insights pipeline of a media pipeline.</p>
2222
2473
  */
2223
2474
  MediaInsightsPipeline?: MediaInsightsPipeline;
@@ -2227,6 +2478,7 @@ export interface MediaPipeline {
2227
2478
  */
2228
2479
  export interface GetMediaPipelineResponse {
2229
2480
  /**
2481
+ * @public
2230
2482
  * <p>The media pipeline object.</p>
2231
2483
  */
2232
2484
  MediaPipeline?: MediaPipeline;
@@ -2236,10 +2488,12 @@ export interface GetMediaPipelineResponse {
2236
2488
  */
2237
2489
  export interface ListMediaCapturePipelinesRequest {
2238
2490
  /**
2491
+ * @public
2239
2492
  * <p>The token used to retrieve the next page of results.</p>
2240
2493
  */
2241
2494
  NextToken?: string;
2242
2495
  /**
2496
+ * @public
2243
2497
  * <p>The maximum number of results to return in a single call. Valid Range: 1 - 99.</p>
2244
2498
  */
2245
2499
  MaxResults?: number;
@@ -2250,10 +2504,12 @@ export interface ListMediaCapturePipelinesRequest {
2250
2504
  */
2251
2505
  export interface MediaCapturePipelineSummary {
2252
2506
  /**
2507
+ * @public
2253
2508
  * <p>The ID of the media pipeline in the summary.</p>
2254
2509
  */
2255
2510
  MediaPipelineId?: string;
2256
2511
  /**
2512
+ * @public
2257
2513
  * <p>The ARN of the media pipeline in the summary.</p>
2258
2514
  */
2259
2515
  MediaPipelineArn?: string;
@@ -2263,10 +2519,12 @@ export interface MediaCapturePipelineSummary {
2263
2519
  */
2264
2520
  export interface ListMediaCapturePipelinesResponse {
2265
2521
  /**
2522
+ * @public
2266
2523
  * <p>The media pipeline objects in the list.</p>
2267
2524
  */
2268
2525
  MediaCapturePipelines?: MediaCapturePipelineSummary[];
2269
2526
  /**
2527
+ * @public
2270
2528
  * <p>The token used to retrieve the next page of results. </p>
2271
2529
  */
2272
2530
  NextToken?: string;
@@ -2276,10 +2534,12 @@ export interface ListMediaCapturePipelinesResponse {
2276
2534
  */
2277
2535
  export interface ListMediaInsightsPipelineConfigurationsRequest {
2278
2536
  /**
2537
+ * @public
2279
2538
  * <p>The token used to return the next page of results.</p>
2280
2539
  */
2281
2540
  NextToken?: string;
2282
2541
  /**
2542
+ * @public
2283
2543
  * <p>The maximum number of results to return in a single call.</p>
2284
2544
  */
2285
2545
  MaxResults?: number;
@@ -2290,14 +2550,17 @@ export interface ListMediaInsightsPipelineConfigurationsRequest {
2290
2550
  */
2291
2551
  export interface MediaInsightsPipelineConfigurationSummary {
2292
2552
  /**
2553
+ * @public
2293
2554
  * <p>The name of the media insights pipeline configuration.</p>
2294
2555
  */
2295
2556
  MediaInsightsPipelineConfigurationName?: string;
2296
2557
  /**
2558
+ * @public
2297
2559
  * <p>The ID of the media insights pipeline configuration.</p>
2298
2560
  */
2299
2561
  MediaInsightsPipelineConfigurationId?: string;
2300
2562
  /**
2563
+ * @public
2301
2564
  * <p>The ARN of the media insights pipeline configuration.</p>
2302
2565
  */
2303
2566
  MediaInsightsPipelineConfigurationArn?: string;
@@ -2307,10 +2570,12 @@ export interface MediaInsightsPipelineConfigurationSummary {
2307
2570
  */
2308
2571
  export interface ListMediaInsightsPipelineConfigurationsResponse {
2309
2572
  /**
2573
+ * @public
2310
2574
  * <p>The requested list of media insights pipeline configurations.</p>
2311
2575
  */
2312
2576
  MediaInsightsPipelineConfigurations?: MediaInsightsPipelineConfigurationSummary[];
2313
2577
  /**
2578
+ * @public
2314
2579
  * <p>The token used to return the next page of results. </p>
2315
2580
  */
2316
2581
  NextToken?: string;
@@ -2320,10 +2585,12 @@ export interface ListMediaInsightsPipelineConfigurationsResponse {
2320
2585
  */
2321
2586
  export interface ListMediaPipelinesRequest {
2322
2587
  /**
2588
+ * @public
2323
2589
  * <p>The token used to retrieve the next page of results.</p>
2324
2590
  */
2325
2591
  NextToken?: string;
2326
2592
  /**
2593
+ * @public
2327
2594
  * <p>The maximum number of results to return in a single call. Valid Range: 1 - 99.</p>
2328
2595
  */
2329
2596
  MaxResults?: number;
@@ -2334,10 +2601,12 @@ export interface ListMediaPipelinesRequest {
2334
2601
  */
2335
2602
  export interface MediaPipelineSummary {
2336
2603
  /**
2604
+ * @public
2337
2605
  * <p>The ID of the media pipeline in the summary.</p>
2338
2606
  */
2339
2607
  MediaPipelineId?: string;
2340
2608
  /**
2609
+ * @public
2341
2610
  * <p>The ARN of the media pipeline in the summary.</p>
2342
2611
  */
2343
2612
  MediaPipelineArn?: string;
@@ -2347,10 +2616,12 @@ export interface MediaPipelineSummary {
2347
2616
  */
2348
2617
  export interface ListMediaPipelinesResponse {
2349
2618
  /**
2619
+ * @public
2350
2620
  * <p>The media pipeline objects in the list.</p>
2351
2621
  */
2352
2622
  MediaPipelines?: MediaPipelineSummary[];
2353
2623
  /**
2624
+ * @public
2354
2625
  * <p>The token used to retrieve the next page of results. </p>
2355
2626
  */
2356
2627
  NextToken?: string;
@@ -2360,6 +2631,7 @@ export interface ListMediaPipelinesResponse {
2360
2631
  */
2361
2632
  export interface ListTagsForResourceRequest {
2362
2633
  /**
2634
+ * @public
2363
2635
  * <p>The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's region, resource ID, and pipeline ID.</p>
2364
2636
  */
2365
2637
  ResourceARN: string | undefined;
@@ -2369,6 +2641,7 @@ export interface ListTagsForResourceRequest {
2369
2641
  */
2370
2642
  export interface ListTagsForResourceResponse {
2371
2643
  /**
2644
+ * @public
2372
2645
  * <p>The tags associated with the specified media pipeline.</p>
2373
2646
  */
2374
2647
  Tags?: Tag[];
@@ -2378,10 +2651,12 @@ export interface ListTagsForResourceResponse {
2378
2651
  */
2379
2652
  export interface TagResourceRequest {
2380
2653
  /**
2654
+ * @public
2381
2655
  * <p>The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's endpoint region, resource ID, and pipeline ID.</p>
2382
2656
  */
2383
2657
  ResourceARN: string | undefined;
2384
2658
  /**
2659
+ * @public
2385
2660
  * <p>The tags associated with the specified media pipeline.</p>
2386
2661
  */
2387
2662
  Tags: Tag[] | undefined;
@@ -2396,10 +2671,12 @@ export interface TagResourceResponse {
2396
2671
  */
2397
2672
  export interface UntagResourceRequest {
2398
2673
  /**
2674
+ * @public
2399
2675
  * <p>The ARN of the pipeline that you want to untag.</p>
2400
2676
  */
2401
2677
  ResourceARN: string | undefined;
2402
2678
  /**
2679
+ * @public
2403
2680
  * <p>The key/value pairs in the tag that you want to remove.</p>
2404
2681
  */
2405
2682
  TagKeys: string[] | undefined;
@@ -2414,18 +2691,22 @@ export interface UntagResourceResponse {
2414
2691
  */
2415
2692
  export interface UpdateMediaInsightsPipelineConfigurationRequest {
2416
2693
  /**
2694
+ * @public
2417
2695
  * <p>The unique identifier for the resource to be updated. Valid values include the name and ARN of the media insights pipeline configuration.</p>
2418
2696
  */
2419
2697
  Identifier: string | undefined;
2420
2698
  /**
2699
+ * @public
2421
2700
  * <p>The ARN of the role used by the service to access Amazon Web Services resources.</p>
2422
2701
  */
2423
2702
  ResourceAccessRoleArn: string | undefined;
2424
2703
  /**
2704
+ * @public
2425
2705
  * <p>The configuration settings for real-time alerts for the media insights pipeline.</p>
2426
2706
  */
2427
2707
  RealTimeAlertConfiguration?: RealTimeAlertConfiguration;
2428
2708
  /**
2709
+ * @public
2429
2710
  * <p>The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream..</p>
2430
2711
  */
2431
2712
  Elements: MediaInsightsPipelineConfigurationElement[] | undefined;
@@ -2435,6 +2716,7 @@ export interface UpdateMediaInsightsPipelineConfigurationRequest {
2435
2716
  */
2436
2717
  export interface UpdateMediaInsightsPipelineConfigurationResponse {
2437
2718
  /**
2719
+ * @public
2438
2720
  * <p>The updated configuration settings.</p>
2439
2721
  */
2440
2722
  MediaInsightsPipelineConfiguration?: MediaInsightsPipelineConfiguration;
@@ -2456,10 +2738,12 @@ export type MediaPipelineStatusUpdate = (typeof MediaPipelineStatusUpdate)[keyof
2456
2738
  */
2457
2739
  export interface UpdateMediaInsightsPipelineStatusRequest {
2458
2740
  /**
2741
+ * @public
2459
2742
  * <p>The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.</p>
2460
2743
  */
2461
2744
  Identifier: string | undefined;
2462
2745
  /**
2746
+ * @public
2463
2747
  * <p>The requested status of the media insights pipeline.</p>
2464
2748
  */
2465
2749
  UpdateStatus: MediaPipelineStatusUpdate | string | undefined;