@aws-sdk/client-transcribe 3.533.0 → 3.540.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 (97) hide show
  1. package/dist-cjs/endpoint/endpointResolver.js +4 -2
  2. package/dist-cjs/index.js +0 -3
  3. package/dist-es/endpoint/endpointResolver.js +3 -1
  4. package/dist-es/index.js +0 -1
  5. package/dist-types/Transcribe.d.ts +10 -1
  6. package/dist-types/TranscribeClient.d.ts +1 -1
  7. package/dist-types/commands/CreateCallAnalyticsCategoryCommand.d.ts +2 -1
  8. package/dist-types/commands/CreateLanguageModelCommand.d.ts +2 -1
  9. package/dist-types/commands/CreateMedicalVocabularyCommand.d.ts +2 -1
  10. package/dist-types/commands/CreateVocabularyCommand.d.ts +2 -1
  11. package/dist-types/commands/CreateVocabularyFilterCommand.d.ts +2 -1
  12. package/dist-types/commands/DeleteCallAnalyticsCategoryCommand.d.ts +2 -1
  13. package/dist-types/commands/DeleteCallAnalyticsJobCommand.d.ts +2 -1
  14. package/dist-types/commands/DeleteLanguageModelCommand.d.ts +2 -1
  15. package/dist-types/commands/DeleteMedicalScribeJobCommand.d.ts +2 -1
  16. package/dist-types/commands/DeleteMedicalTranscriptionJobCommand.d.ts +2 -1
  17. package/dist-types/commands/DeleteMedicalVocabularyCommand.d.ts +2 -1
  18. package/dist-types/commands/DeleteTranscriptionJobCommand.d.ts +2 -1
  19. package/dist-types/commands/DeleteVocabularyCommand.d.ts +2 -1
  20. package/dist-types/commands/DeleteVocabularyFilterCommand.d.ts +2 -1
  21. package/dist-types/commands/DescribeLanguageModelCommand.d.ts +2 -1
  22. package/dist-types/commands/GetCallAnalyticsCategoryCommand.d.ts +2 -1
  23. package/dist-types/commands/GetCallAnalyticsJobCommand.d.ts +2 -1
  24. package/dist-types/commands/GetMedicalScribeJobCommand.d.ts +2 -1
  25. package/dist-types/commands/GetMedicalTranscriptionJobCommand.d.ts +2 -1
  26. package/dist-types/commands/GetMedicalVocabularyCommand.d.ts +2 -1
  27. package/dist-types/commands/GetTranscriptionJobCommand.d.ts +2 -1
  28. package/dist-types/commands/GetVocabularyCommand.d.ts +2 -1
  29. package/dist-types/commands/GetVocabularyFilterCommand.d.ts +2 -1
  30. package/dist-types/commands/ListCallAnalyticsCategoriesCommand.d.ts +2 -1
  31. package/dist-types/commands/ListCallAnalyticsJobsCommand.d.ts +2 -1
  32. package/dist-types/commands/ListLanguageModelsCommand.d.ts +2 -1
  33. package/dist-types/commands/ListMedicalScribeJobsCommand.d.ts +2 -1
  34. package/dist-types/commands/ListMedicalTranscriptionJobsCommand.d.ts +2 -1
  35. package/dist-types/commands/ListMedicalVocabulariesCommand.d.ts +2 -1
  36. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  37. package/dist-types/commands/ListTranscriptionJobsCommand.d.ts +2 -1
  38. package/dist-types/commands/ListVocabulariesCommand.d.ts +2 -1
  39. package/dist-types/commands/ListVocabularyFiltersCommand.d.ts +2 -1
  40. package/dist-types/commands/StartCallAnalyticsJobCommand.d.ts +2 -1
  41. package/dist-types/commands/StartMedicalScribeJobCommand.d.ts +2 -1
  42. package/dist-types/commands/StartMedicalTranscriptionJobCommand.d.ts +2 -1
  43. package/dist-types/commands/StartTranscriptionJobCommand.d.ts +2 -1
  44. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  45. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  46. package/dist-types/commands/UpdateCallAnalyticsCategoryCommand.d.ts +2 -1
  47. package/dist-types/commands/UpdateMedicalVocabularyCommand.d.ts +2 -1
  48. package/dist-types/commands/UpdateVocabularyCommand.d.ts +2 -1
  49. package/dist-types/commands/UpdateVocabularyFilterCommand.d.ts +2 -1
  50. package/dist-types/index.d.ts +0 -1
  51. package/dist-types/models/models_0.d.ts +496 -496
  52. package/dist-types/ts3.4/Transcribe.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/CreateCallAnalyticsCategoryCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/CreateLanguageModelCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/CreateMedicalVocabularyCommand.d.ts +9 -0
  56. package/dist-types/ts3.4/commands/CreateVocabularyCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/CreateVocabularyFilterCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/DeleteCallAnalyticsCategoryCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/DeleteCallAnalyticsJobCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/DeleteLanguageModelCommand.d.ts +9 -0
  61. package/dist-types/ts3.4/commands/DeleteMedicalScribeJobCommand.d.ts +9 -0
  62. package/dist-types/ts3.4/commands/DeleteMedicalTranscriptionJobCommand.d.ts +9 -0
  63. package/dist-types/ts3.4/commands/DeleteMedicalVocabularyCommand.d.ts +9 -0
  64. package/dist-types/ts3.4/commands/DeleteTranscriptionJobCommand.d.ts +9 -0
  65. package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +9 -0
  66. package/dist-types/ts3.4/commands/DeleteVocabularyFilterCommand.d.ts +9 -0
  67. package/dist-types/ts3.4/commands/DescribeLanguageModelCommand.d.ts +9 -0
  68. package/dist-types/ts3.4/commands/GetCallAnalyticsCategoryCommand.d.ts +9 -0
  69. package/dist-types/ts3.4/commands/GetCallAnalyticsJobCommand.d.ts +9 -0
  70. package/dist-types/ts3.4/commands/GetMedicalScribeJobCommand.d.ts +9 -0
  71. package/dist-types/ts3.4/commands/GetMedicalTranscriptionJobCommand.d.ts +9 -0
  72. package/dist-types/ts3.4/commands/GetMedicalVocabularyCommand.d.ts +9 -0
  73. package/dist-types/ts3.4/commands/GetTranscriptionJobCommand.d.ts +9 -0
  74. package/dist-types/ts3.4/commands/GetVocabularyCommand.d.ts +9 -0
  75. package/dist-types/ts3.4/commands/GetVocabularyFilterCommand.d.ts +9 -0
  76. package/dist-types/ts3.4/commands/ListCallAnalyticsCategoriesCommand.d.ts +9 -0
  77. package/dist-types/ts3.4/commands/ListCallAnalyticsJobsCommand.d.ts +9 -0
  78. package/dist-types/ts3.4/commands/ListLanguageModelsCommand.d.ts +9 -0
  79. package/dist-types/ts3.4/commands/ListMedicalScribeJobsCommand.d.ts +9 -0
  80. package/dist-types/ts3.4/commands/ListMedicalTranscriptionJobsCommand.d.ts +9 -0
  81. package/dist-types/ts3.4/commands/ListMedicalVocabulariesCommand.d.ts +9 -0
  82. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  83. package/dist-types/ts3.4/commands/ListTranscriptionJobsCommand.d.ts +9 -0
  84. package/dist-types/ts3.4/commands/ListVocabulariesCommand.d.ts +9 -0
  85. package/dist-types/ts3.4/commands/ListVocabularyFiltersCommand.d.ts +9 -0
  86. package/dist-types/ts3.4/commands/StartCallAnalyticsJobCommand.d.ts +9 -0
  87. package/dist-types/ts3.4/commands/StartMedicalScribeJobCommand.d.ts +9 -0
  88. package/dist-types/ts3.4/commands/StartMedicalTranscriptionJobCommand.d.ts +9 -0
  89. package/dist-types/ts3.4/commands/StartTranscriptionJobCommand.d.ts +9 -0
  90. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  91. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  92. package/dist-types/ts3.4/commands/UpdateCallAnalyticsCategoryCommand.d.ts +9 -0
  93. package/dist-types/ts3.4/commands/UpdateMedicalVocabularyCommand.d.ts +9 -0
  94. package/dist-types/ts3.4/commands/UpdateVocabularyCommand.d.ts +9 -0
  95. package/dist-types/ts3.4/commands/UpdateVocabularyFilterCommand.d.ts +9 -0
  96. package/dist-types/ts3.4/index.d.ts +0 -1
  97. package/package.json +40 -40
@@ -1,7 +1,6 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { TranscribeServiceException as __BaseException } from "./TranscribeServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>A time range, in milliseconds, between two points in your media file.</p>
6
5
  * <p>You can use <code>StartTime</code> and <code>EndTime</code> to search a custom
7
6
  * segment. For example, setting <code>StartTime</code> to 10000 and <code>EndTime</code>
@@ -16,41 +15,42 @@ import { TranscribeServiceException as __BaseException } from "./TranscribeServi
16
15
  * media file to the 50,000 millisecond mark. You can use <code>First</code> and
17
16
  * <code>Last</code> independently of each other.</p>
18
17
  * <p>If you prefer to use percentage instead of milliseconds, see .</p>
18
+ * @public
19
19
  */
20
20
  export interface AbsoluteTimeRange {
21
21
  /**
22
- * @public
23
22
  * <p>The time, in milliseconds, when Amazon Transcribe starts searching for the specified
24
23
  * criteria in your audio. If you include <code>StartTime</code> in your request, you must
25
24
  * also include <code>EndTime</code>.</p>
25
+ * @public
26
26
  */
27
27
  StartTime?: number;
28
28
  /**
29
- * @public
30
29
  * <p>The time, in milliseconds, when Amazon Transcribe stops searching for the specified
31
30
  * criteria in your audio. If you include <code>EndTime</code> in your request, you must
32
31
  * also include <code>StartTime</code>.</p>
32
+ * @public
33
33
  */
34
34
  EndTime?: number;
35
35
  /**
36
- * @public
37
36
  * <p>The time, in milliseconds, from the start of your media file until the specified value.
38
37
  * Amazon Transcribe searches for your specified criteria in this time segment.</p>
38
+ * @public
39
39
  */
40
40
  First?: number;
41
41
  /**
42
- * @public
43
42
  * <p>The time, in milliseconds, from the specified value until the end of your media file.
44
43
  * Amazon Transcribe searches for your specified criteria in this time segment.</p>
44
+ * @public
45
45
  */
46
46
  Last?: number;
47
47
  }
48
48
  /**
49
- * @public
50
49
  * <p>Your request didn't pass one or more validation tests. This can occur when the entity
51
50
  * you're trying to delete doesn't exist or if it's in a non-terminal state (such as
52
51
  * <code>IN PROGRESS</code>). See the exception message field for more
53
52
  * information.</p>
53
+ * @public
54
54
  */
55
55
  export declare class BadRequestException extends __BaseException {
56
56
  readonly name: "BadRequestException";
@@ -100,22 +100,22 @@ export declare const ParticipantRole: {
100
100
  */
101
101
  export type ParticipantRole = (typeof ParticipantRole)[keyof typeof ParticipantRole];
102
102
  /**
103
- * @public
104
103
  * <p>Makes it possible to specify which speaker is on which channel. For example, if your
105
104
  * agent is the first participant to speak, you would set <code>ChannelId</code> to
106
105
  * <code>0</code> (to indicate the first channel) and <code>ParticipantRole</code> to
107
106
  * <code>AGENT</code> (to indicate that it's the agent speaking).</p>
107
+ * @public
108
108
  */
109
109
  export interface ChannelDefinition {
110
110
  /**
111
- * @public
112
111
  * <p>Specify the audio channel you want to define.</p>
112
+ * @public
113
113
  */
114
114
  ChannelId?: number;
115
115
  /**
116
- * @public
117
116
  * <p>Specify the speaker you want to define. Omitting this parameter is equivalent to
118
117
  * specifying both participants.</p>
118
+ * @public
119
119
  */
120
120
  ParticipantRole?: ParticipantRole;
121
121
  }
@@ -233,16 +233,15 @@ export declare const LanguageCode: {
233
233
  */
234
234
  export type LanguageCode = (typeof LanguageCode)[keyof typeof LanguageCode];
235
235
  /**
236
- * @public
237
236
  * <p>Describes the Amazon S3 location of the media file you want to use in your
238
237
  * request.</p>
239
238
  * <p>For information on supported media formats, refer to the <code>MediaFormat</code>
240
239
  * parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
241
240
  * in the Amazon S3 Developer Guide.</p>
241
+ * @public
242
242
  */
243
243
  export interface Media {
244
244
  /**
245
- * @public
246
245
  * <p>The Amazon S3 location of the media file you want to transcribe. For
247
246
  * example:</p>
248
247
  * <ul>
@@ -260,10 +259,10 @@ export interface Media {
260
259
  * <p>Note that the Amazon S3 bucket that contains your input media must be located
261
260
  * in the same Amazon Web Services Region where you're making your transcription
262
261
  * request.</p>
262
+ * @public
263
263
  */
264
264
  MediaFileUri?: string;
265
265
  /**
266
- * @public
267
266
  * <p>The Amazon S3 location of the media file you want to redact. For
268
267
  * example:</p>
269
268
  * <ul>
@@ -287,6 +286,7 @@ export interface Media {
287
286
  * redacted transcript. It is only supported for Call Analytics
288
287
  * (<code>StartCallAnalyticsJob</code>) transcription requests.</p>
289
288
  * </important>
289
+ * @public
290
290
  */
291
291
  RedactedMediaFileUri?: string;
292
292
  }
@@ -354,24 +354,23 @@ export declare const RedactionType: {
354
354
  */
355
355
  export type RedactionType = (typeof RedactionType)[keyof typeof RedactionType];
356
356
  /**
357
- * @public
358
357
  * <p>Makes it possible to redact or flag specified personally identifiable information (PII) in
359
358
  * your transcript. If you use <code>ContentRedaction</code>, you must also include the
360
359
  * sub-parameters: <code>RedactionOutput</code> and <code>RedactionType</code>. You can
361
360
  * optionally include <code>PiiEntityTypes</code> to choose which types of PII you want to
362
361
  * redact.</p>
362
+ * @public
363
363
  */
364
364
  export interface ContentRedaction {
365
365
  /**
366
- * @public
367
366
  * <p>Specify the category of information you want to redact; <code>PII</code> (personally
368
367
  * identifiable information) is the only valid value. You can use <code>PiiEntityTypes</code> to
369
368
  * choose which types of PII you want to redact. If you do not include <code>PiiEntityTypes</code> in
370
369
  * your request, all PII is redacted.</p>
370
+ * @public
371
371
  */
372
372
  RedactionType: RedactionType | undefined;
373
373
  /**
374
- * @public
375
374
  * <p>Specify if you want only a redacted transcript, or if you want a redacted and an
376
375
  * unredacted transcript.</p>
377
376
  * <p>When you choose <code>redacted</code>
@@ -379,19 +378,19 @@ export interface ContentRedaction {
379
378
  * <p>When you choose <code>redacted_and_unredacted</code>
380
379
  * Amazon Transcribe creates a redacted and an unredacted transcript (as two separate
381
380
  * files).</p>
381
+ * @public
382
382
  */
383
383
  RedactionOutput: RedactionOutput | undefined;
384
384
  /**
385
- * @public
386
385
  * <p>Specify which types of personally identifiable information (PII) you want to redact in
387
386
  * your transcript. You can include as many types as you'd like, or you can select
388
387
  * <code>ALL</code>. If you do not include <code>PiiEntityTypes</code> in your request, all PII is
389
388
  * redacted.</p>
389
+ * @public
390
390
  */
391
391
  PiiEntityTypes?: PiiEntityType[];
392
392
  }
393
393
  /**
394
- * @public
395
394
  * <p>If using automatic language identification in your request and you want to apply a
396
395
  * custom language model, a custom vocabulary, or a custom vocabulary filter, include
397
396
  * <code>LanguageIdSettings</code> with the relevant sub-parameters
@@ -420,20 +419,20 @@ export interface ContentRedaction {
420
419
  * instead the <code></code> parameter with the
421
420
  * <code>VocabularyName</code> or <code>VocabularyFilterName</code> (or both)
422
421
  * sub-parameter.</p>
422
+ * @public
423
423
  */
424
424
  export interface LanguageIdSettings {
425
425
  /**
426
- * @public
427
426
  * <p>The name of the custom vocabulary you want to use when processing your transcription
428
427
  * job. Custom vocabulary names are case sensitive.</p>
429
428
  * <p>The language of the specified custom vocabulary must match the language code that you
430
429
  * specify in your transcription request. If the languages do not match, the custom
431
430
  * vocabulary isn't applied. There are no errors or warnings associated with a language
432
431
  * mismatch.</p>
432
+ * @public
433
433
  */
434
434
  VocabularyName?: string;
435
435
  /**
436
- * @public
437
436
  * <p>The name of the custom vocabulary filter you want to use when processing your
438
437
  * transcription job. Custom vocabulary filter names are case sensitive.</p>
439
438
  * <p>The language of the specified custom vocabulary filter must match the language code
@@ -442,32 +441,33 @@ export interface LanguageIdSettings {
442
441
  * language mismatch.</p>
443
442
  * <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
444
443
  * also include <code>VocabularyFilterMethod</code>.</p>
444
+ * @public
445
445
  */
446
446
  VocabularyFilterName?: string;
447
447
  /**
448
- * @public
449
448
  * <p>The name of the custom language model you want to use when processing your
450
449
  * transcription job. Note that custom language model names are case sensitive.</p>
451
450
  * <p>The language of the specified custom language model must match the language code that
452
451
  * you specify in your transcription request. If the languages do not match, the custom
453
452
  * language model isn't applied. There are no errors or warnings associated with a language
454
453
  * mismatch.</p>
454
+ * @public
455
455
  */
456
456
  LanguageModelName?: string;
457
457
  }
458
458
  /**
459
- * @public
460
459
  * <p>Contains <code>GenerateAbstractiveSummary</code>, which is a required parameter if you
461
460
  * want to enable Generative call summarization in your Call Analytics request.</p>
461
+ * @public
462
462
  */
463
463
  export interface Summarization {
464
464
  /**
465
- * @public
466
465
  * <p>Enables Generative call summarization in your Call Analytics request</p>
467
466
  * <p>Generative call summarization provides a summary of the transcript including important
468
467
  * components discussed in the conversation.</p>
469
468
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-enable-summarization.html">Enabling generative call
470
469
  * summarization</a>.</p>
470
+ * @public
471
471
  */
472
472
  GenerateAbstractiveSummary: boolean | undefined;
473
473
  }
@@ -485,55 +485,54 @@ export declare const VocabularyFilterMethod: {
485
485
  */
486
486
  export type VocabularyFilterMethod = (typeof VocabularyFilterMethod)[keyof typeof VocabularyFilterMethod];
487
487
  /**
488
- * @public
489
488
  * <p>Provides additional optional settings for your request, including content redaction,
490
489
  * automatic language identification; allows you to apply custom language models, custom
491
490
  * vocabulary filters, and custom vocabularies.</p>
491
+ * @public
492
492
  */
493
493
  export interface CallAnalyticsJobSettings {
494
494
  /**
495
- * @public
496
495
  * <p>The name of the custom vocabulary you want to include in your Call Analytics
497
496
  * transcription request. Custom vocabulary names are case sensitive.</p>
497
+ * @public
498
498
  */
499
499
  VocabularyName?: string;
500
500
  /**
501
- * @public
502
501
  * <p>The name of the custom vocabulary filter you want to include in your Call Analytics
503
502
  * transcription request. Custom vocabulary filter names are case sensitive.</p>
504
503
  * <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
505
504
  * also include <code>VocabularyFilterMethod</code>.</p>
505
+ * @public
506
506
  */
507
507
  VocabularyFilterName?: string;
508
508
  /**
509
- * @public
510
509
  * <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
511
510
  * <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
512
511
  * <p>To delete words, choose <code>remove</code>.</p>
513
512
  * <p>To flag words without changing them, choose <code>tag</code>.</p>
513
+ * @public
514
514
  */
515
515
  VocabularyFilterMethod?: VocabularyFilterMethod;
516
516
  /**
517
- * @public
518
517
  * <p>The name of the custom language model you want to use when processing your Call
519
518
  * Analytics job. Note that custom language model names are case sensitive.</p>
520
519
  * <p>The language of the specified custom language model must match the language code that
521
520
  * you specify in your transcription request. If the languages do not match, the custom
522
521
  * language model isn't applied. There are no errors or warnings associated with a language
523
522
  * mismatch.</p>
523
+ * @public
524
524
  */
525
525
  LanguageModelName?: string;
526
526
  /**
527
- * @public
528
527
  * <p>Makes it possible to redact or flag specified personally identifiable information (PII) in
529
528
  * your transcript. If you use <code>ContentRedaction</code>, you must also include the
530
529
  * sub-parameters: <code>RedactionOutput</code> and <code>RedactionType</code>. You can
531
530
  * optionally include <code>PiiEntityTypes</code> to choose which types of PII you want to
532
531
  * redact.</p>
532
+ * @public
533
533
  */
534
534
  ContentRedaction?: ContentRedaction;
535
535
  /**
536
- * @public
537
536
  * <p>You can specify two or more language codes that represent the languages you think may
538
537
  * be present in your media. Including more than five is not recommended. If you're unsure
539
538
  * what languages are present, do not include this parameter.</p>
@@ -542,10 +541,10 @@ export interface CallAnalyticsJobSettings {
542
541
  * languages</a> table.</p>
543
542
  * <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file
544
543
  * must be encoded at a sample rate of 16,000 Hz or higher.</p>
544
+ * @public
545
545
  */
546
546
  LanguageOptions?: LanguageCode[];
547
547
  /**
548
- * @public
549
548
  * <p>If using automatic language identification in your request and you want to apply a
550
549
  * custom language model, a custom vocabulary, or a custom vocabulary filter, include
551
550
  * <code>LanguageIdSettings</code> with the relevant sub-parameters
@@ -572,23 +571,23 @@ export interface CallAnalyticsJobSettings {
572
571
  * <code>VocabularyFilterName</code> sub-parameters.</p>
573
572
  * <p>For a list of languages supported with Call Analytics, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages and
574
573
  * language-specific features</a>.</p>
574
+ * @public
575
575
  */
576
576
  LanguageIdSettings?: Partial<Record<LanguageCode, LanguageIdSettings>>;
577
577
  /**
578
- * @public
579
578
  * <p>Contains <code>GenerateAbstractiveSummary</code>, which is a required parameter if you
580
579
  * want to enable Generative call summarization in your Call Analytics request.</p>
580
+ * @public
581
581
  */
582
582
  Summarization?: Summarization;
583
583
  }
584
584
  /**
585
- * @public
586
585
  * <p>Provides you with the Amazon S3 URI you can use to access your
587
586
  * transcript.</p>
587
+ * @public
588
588
  */
589
589
  export interface Transcript {
590
590
  /**
591
- * @public
592
591
  * <p>The Amazon S3 location of your transcript. You can use this URI to access or
593
592
  * download your transcript.</p>
594
593
  * <p>If you included <code>OutputBucketName</code> in your transcription job request, this
@@ -604,10 +603,10 @@ export interface Transcript {
604
603
  * URI by running a <code>GetTranscriptionJob</code> or
605
604
  * <code>ListTranscriptionJob</code> request.</p>
606
605
  * </note>
606
+ * @public
607
607
  */
608
608
  TranscriptFileUri?: string;
609
609
  /**
610
- * @public
611
610
  * <p>The Amazon S3 location of your redacted transcript. You can use this URI to
612
611
  * access or download your transcript.</p>
613
612
  * <p>If you included <code>OutputBucketName</code> in your transcription job request, this
@@ -623,11 +622,11 @@ export interface Transcript {
623
622
  * URI by running a <code>GetTranscriptionJob</code> or
624
623
  * <code>ListTranscriptionJob</code> request.</p>
625
624
  * </note>
625
+ * @public
626
626
  */
627
627
  RedactedTranscriptFileUri?: string;
628
628
  }
629
629
  /**
630
- * @public
631
630
  * <p>Provides detailed information about a Call Analytics job.</p>
632
631
  * <p>To view the job's status, refer to <code>CallAnalyticsJobStatus</code>. If the status
633
632
  * is <code>COMPLETED</code>, the job is finished. You can find your completed transcript
@@ -640,82 +639,82 @@ export interface Transcript {
640
639
  * <p>If you chose to redact the audio in your media file, you can find your redacted media
641
640
  * file at the location specified in the <code>RedactedMediaFileUri</code> field of your
642
641
  * response.</p>
642
+ * @public
643
643
  */
644
644
  export interface CallAnalyticsJob {
645
645
  /**
646
- * @public
647
646
  * <p>The name of the Call Analytics job. Job names are case sensitive and must be unique
648
647
  * within an Amazon Web Services account.</p>
648
+ * @public
649
649
  */
650
650
  CallAnalyticsJobName?: string;
651
651
  /**
652
- * @public
653
652
  * <p>Provides the status of the specified Call Analytics job.</p>
654
653
  * <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
655
654
  * results at the location specified in <code>TranscriptFileUri</code> (or
656
655
  * <code>RedactedTranscriptFileUri</code>, if you requested transcript redaction). If
657
656
  * the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
658
657
  * your transcription job failed.</p>
658
+ * @public
659
659
  */
660
660
  CallAnalyticsJobStatus?: CallAnalyticsJobStatus;
661
661
  /**
662
- * @public
663
662
  * <p>The language code used to create your Call Analytics job. For a list of supported
664
663
  * languages and their associated language codes, refer to the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a>
665
664
  * table.</p>
666
665
  * <p>If you do not know the language spoken in your media file, you can omit this field and
667
666
  * let Amazon Transcribe automatically identify the language of your media. To improve the
668
667
  * accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.</p>
668
+ * @public
669
669
  */
670
670
  LanguageCode?: LanguageCode;
671
671
  /**
672
- * @public
673
672
  * <p>The sample rate, in hertz, of the audio track in your input media file.</p>
673
+ * @public
674
674
  */
675
675
  MediaSampleRateHertz?: number;
676
676
  /**
677
- * @public
678
677
  * <p>The format of the input media file.</p>
678
+ * @public
679
679
  */
680
680
  MediaFormat?: MediaFormat;
681
681
  /**
682
- * @public
683
682
  * <p>Provides the Amazon S3 location of the media file you used in your Call
684
683
  * Analytics request.</p>
684
+ * @public
685
685
  */
686
686
  Media?: Media;
687
687
  /**
688
- * @public
689
688
  * <p>Provides you with the Amazon S3 URI you can use to access your
690
689
  * transcript.</p>
690
+ * @public
691
691
  */
692
692
  Transcript?: Transcript;
693
693
  /**
694
- * @public
695
694
  * <p>The date and time the specified Call Analytics job began processing.</p>
696
695
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
697
696
  * example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
698
697
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
698
+ * @public
699
699
  */
700
700
  StartTime?: Date;
701
701
  /**
702
- * @public
703
702
  * <p>The date and time the specified Call Analytics job request was made.</p>
704
703
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
705
704
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
706
705
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
706
+ * @public
707
707
  */
708
708
  CreationTime?: Date;
709
709
  /**
710
- * @public
711
710
  * <p>The date and time the specified Call Analytics job finished processing.</p>
712
711
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
713
712
  * example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
714
713
  * that started processing at 12:33 PM UTC-7 on May 4, 2022.</p>
714
+ * @public
715
715
  */
716
716
  CompletionTime?: Date;
717
717
  /**
718
- * @public
719
718
  * <p>If <code>CallAnalyticsJobStatus</code> is <code>FAILED</code>,
720
719
  * <code>FailureReason</code> contains information about why the Call Analytics job
721
720
  * request failed.</p>
@@ -765,90 +764,91 @@ export interface CallAnalyticsJob {
765
764
  * quotas</a>.</p>
766
765
  * </li>
767
766
  * </ul>
767
+ * @public
768
768
  */
769
769
  FailureReason?: string;
770
770
  /**
771
- * @public
772
771
  * <p>The Amazon Resource Name (ARN) you included in your request.</p>
772
+ * @public
773
773
  */
774
774
  DataAccessRoleArn?: string;
775
775
  /**
776
- * @public
777
776
  * <p>The confidence score associated with the language identified in your media
778
777
  * file.</p>
779
778
  * <p>Confidence scores are values between 0 and 1; a larger value indicates a higher
780
779
  * probability that the identified language correctly matches the language spoken in your
781
780
  * media.</p>
781
+ * @public
782
782
  */
783
783
  IdentifiedLanguageScore?: number;
784
784
  /**
785
- * @public
786
785
  * <p>Provides information on any additional settings that were included in your request.
787
786
  * Additional settings include content redaction and language identification
788
787
  * settings.</p>
788
+ * @public
789
789
  */
790
790
  Settings?: CallAnalyticsJobSettings;
791
791
  /**
792
- * @public
793
792
  * <p>Indicates which speaker is on which channel.</p>
793
+ * @public
794
794
  */
795
795
  ChannelDefinitions?: ChannelDefinition[];
796
796
  }
797
797
  /**
798
- * @public
799
798
  * <p>Provides detailed information about a specific Call Analytics job.</p>
799
+ * @public
800
800
  */
801
801
  export interface CallAnalyticsJobSummary {
802
802
  /**
803
- * @public
804
803
  * <p>The name of the Call Analytics job. Job names are case sensitive and must be unique
805
804
  * within an Amazon Web Services account.</p>
805
+ * @public
806
806
  */
807
807
  CallAnalyticsJobName?: string;
808
808
  /**
809
- * @public
810
809
  * <p>The date and time the specified Call Analytics job request was made.</p>
811
810
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
812
811
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
813
812
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
813
+ * @public
814
814
  */
815
815
  CreationTime?: Date;
816
816
  /**
817
- * @public
818
817
  * <p>The date and time your Call Analytics job began processing.</p>
819
818
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
820
819
  * example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
821
820
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
821
+ * @public
822
822
  */
823
823
  StartTime?: Date;
824
824
  /**
825
- * @public
826
825
  * <p>The date and time the specified Call Analytics job finished processing.</p>
827
826
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
828
827
  * example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
829
828
  * that started processing at 12:33 PM UTC-7 on May 4, 2022.</p>
829
+ * @public
830
830
  */
831
831
  CompletionTime?: Date;
832
832
  /**
833
- * @public
834
833
  * <p>The language code used to create your Call Analytics transcription.</p>
834
+ * @public
835
835
  */
836
836
  LanguageCode?: LanguageCode;
837
837
  /**
838
- * @public
839
838
  * <p>Provides the status of your Call Analytics job.</p>
840
839
  * <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
841
840
  * results at the location specified in <code>TranscriptFileUri</code> (or
842
841
  * <code>RedactedTranscriptFileUri</code>, if you requested transcript redaction). If
843
842
  * the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
844
843
  * your transcription job failed.</p>
844
+ * @public
845
845
  */
846
846
  CallAnalyticsJobStatus?: CallAnalyticsJobStatus;
847
847
  /**
848
- * @public
849
848
  * <p>If <code>CallAnalyticsJobStatus</code> is <code>FAILED</code>,
850
849
  * <code>FailureReason</code> contains information about why the Call Analytics job
851
850
  * failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
851
+ * @public
852
852
  */
853
853
  FailureReason?: string;
854
854
  }
@@ -865,7 +865,6 @@ export declare const InputType: {
865
865
  */
866
866
  export type InputType = (typeof InputType)[keyof typeof InputType];
867
867
  /**
868
- * @public
869
868
  * <p>A time range, in percentage, between two points in your media file.</p>
870
869
  * <p>You can use <code>StartPercentage</code> and <code>EndPercentage</code> to search a
871
870
  * custom segment. For example, setting <code>StartPercentage</code> to 10 and
@@ -878,37 +877,37 @@ export type InputType = (typeof InputType)[keyof typeof InputType];
878
877
  * only searches for your specified criteria in the audio contained in the first 10 percent
879
878
  * of the media file.</p>
880
879
  * <p>If you prefer to use milliseconds instead of percentage, see .</p>
880
+ * @public
881
881
  */
882
882
  export interface RelativeTimeRange {
883
883
  /**
884
- * @public
885
884
  * <p>The time, in percentage, when Amazon Transcribe starts searching for the specified
886
885
  * criteria in your media file. If you include <code>StartPercentage</code> in your
887
886
  * request, you must also include <code>EndPercentage</code>.</p>
887
+ * @public
888
888
  */
889
889
  StartPercentage?: number;
890
890
  /**
891
- * @public
892
891
  * <p>The time, in percentage, when Amazon Transcribe stops searching for the specified
893
892
  * criteria in your media file. If you include <code>EndPercentage</code> in your request,
894
893
  * you must also include <code>StartPercentage</code>.</p>
894
+ * @public
895
895
  */
896
896
  EndPercentage?: number;
897
897
  /**
898
- * @public
899
898
  * <p>The time, in percentage, from the start of your media file until the specified value.
900
899
  * Amazon Transcribe searches for your specified criteria in this time segment.</p>
900
+ * @public
901
901
  */
902
902
  First?: number;
903
903
  /**
904
- * @public
905
904
  * <p>The time, in percentage, from the specified value until the end of your media file.
906
905
  * Amazon Transcribe searches for your specified criteria in this time segment.</p>
906
+ * @public
907
907
  */
908
908
  Last?: number;
909
909
  }
910
910
  /**
911
- * @public
912
911
  * <p>Flag the presence or absence of interruptions in your Call Analytics transcription
913
912
  * output.</p>
914
913
  * <p>Rules using <code>InterruptionFilter</code> are designed to match:</p>
@@ -928,41 +927,41 @@ export interface RelativeTimeRange {
928
927
  * </ul>
929
928
  * <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch">Rule criteria for post-call
930
929
  * categories</a> for usage examples.</p>
930
+ * @public
931
931
  */
932
932
  export interface InterruptionFilter {
933
933
  /**
934
- * @public
935
934
  * <p>Specify the duration of the interruptions in milliseconds. For example, you can flag
936
935
  * speech that contains more than 10,000 milliseconds of interruptions.</p>
936
+ * @public
937
937
  */
938
938
  Threshold?: number;
939
939
  /**
940
- * @public
941
940
  * <p>Specify the interrupter that you want to flag. Omitting this parameter is equivalent
942
941
  * to specifying both participants.</p>
942
+ * @public
943
943
  */
944
944
  ParticipantRole?: ParticipantRole;
945
945
  /**
946
- * @public
947
946
  * <p>Makes it possible to specify a time range (in milliseconds) in your audio, during
948
947
  * which you want to search for an interruption. See for more detail.</p>
948
+ * @public
949
949
  */
950
950
  AbsoluteTimeRange?: AbsoluteTimeRange;
951
951
  /**
952
- * @public
953
952
  * <p>Makes it possible to specify a time range (in percentage) in your media file, during
954
953
  * which you want to search for an interruption. See for more detail.</p>
954
+ * @public
955
955
  */
956
956
  RelativeTimeRange?: RelativeTimeRange;
957
957
  /**
958
- * @public
959
958
  * <p>Set to <code>TRUE</code> to flag speech that does not contain interruptions. Set to
960
959
  * <code>FALSE</code> to flag speech that contains interruptions.</p>
960
+ * @public
961
961
  */
962
962
  Negate?: boolean;
963
963
  }
964
964
  /**
965
- * @public
966
965
  * <p>Flag the presence or absence of periods of silence in your Call Analytics
967
966
  * transcription output.</p>
968
967
  * <p>Rules using <code>NonTalkTimeFilter</code> are designed to match:</p>
@@ -976,30 +975,31 @@ export interface InterruptionFilter {
976
975
  * </ul>
977
976
  * <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch">Rule criteria for post-call
978
977
  * categories</a> for usage examples.</p>
978
+ * @public
979
979
  */
980
980
  export interface NonTalkTimeFilter {
981
981
  /**
982
- * @public
983
982
  * <p>Specify the duration, in milliseconds, of the period of silence that you want to flag.
984
983
  * For example, you can flag a silent period that lasts 30,000 milliseconds.</p>
984
+ * @public
985
985
  */
986
986
  Threshold?: number;
987
987
  /**
988
- * @public
989
988
  * <p>Makes it possible to specify a time range (in milliseconds) in your audio, during
990
989
  * which you want to search for a period of silence. See for more detail.</p>
990
+ * @public
991
991
  */
992
992
  AbsoluteTimeRange?: AbsoluteTimeRange;
993
993
  /**
994
- * @public
995
994
  * <p>Makes it possible to specify a time range (in percentage) in your media file, during
996
995
  * which you want to search for a period of silence. See for more detail.</p>
996
+ * @public
997
997
  */
998
998
  RelativeTimeRange?: RelativeTimeRange;
999
999
  /**
1000
- * @public
1001
1000
  * <p>Set to <code>TRUE</code> to flag periods of speech. Set to <code>FALSE</code> to flag
1002
1001
  * periods of silence</p>
1002
+ * @public
1003
1003
  */
1004
1004
  Negate?: boolean;
1005
1005
  }
@@ -1018,7 +1018,6 @@ export declare const SentimentValue: {
1018
1018
  */
1019
1019
  export type SentimentValue = (typeof SentimentValue)[keyof typeof SentimentValue];
1020
1020
  /**
1021
- * @public
1022
1021
  * <p>Flag the presence or absence of specific sentiments detected in your Call Analytics
1023
1022
  * transcription output.</p>
1024
1023
  * <p>Rules using <code>SentimentFilter</code> are designed to match:</p>
@@ -1042,36 +1041,37 @@ export type SentimentValue = (typeof SentimentValue)[keyof typeof SentimentValue
1042
1041
  * </ul>
1043
1042
  * <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch">Rule criteria for post-call
1044
1043
  * categories</a> for usage examples.</p>
1044
+ * @public
1045
1045
  */
1046
1046
  export interface SentimentFilter {
1047
1047
  /**
1048
- * @public
1049
1048
  * <p>Specify the sentiments that you want to flag.</p>
1049
+ * @public
1050
1050
  */
1051
1051
  Sentiments: SentimentValue[] | undefined;
1052
1052
  /**
1053
- * @public
1054
1053
  * <p>Makes it possible to specify a time range (in milliseconds) in your audio, during
1055
1054
  * which you want to search for the specified sentiments. See for more detail.</p>
1055
+ * @public
1056
1056
  */
1057
1057
  AbsoluteTimeRange?: AbsoluteTimeRange;
1058
1058
  /**
1059
- * @public
1060
1059
  * <p>Makes it possible to specify a time range (in percentage) in your media file, during
1061
1060
  * which you want to search for the specified sentiments. See for more detail.</p>
1061
+ * @public
1062
1062
  */
1063
1063
  RelativeTimeRange?: RelativeTimeRange;
1064
1064
  /**
1065
- * @public
1066
1065
  * <p>Specify the participant that you want to flag. Omitting this parameter is equivalent
1067
1066
  * to specifying both participants.</p>
1067
+ * @public
1068
1068
  */
1069
1069
  ParticipantRole?: ParticipantRole;
1070
1070
  /**
1071
- * @public
1072
1071
  * <p>Set to <code>TRUE</code> to flag the sentiments that you didn't include in your
1073
1072
  * request. Set to <code>FALSE</code> to flag the sentiments that you specified in your
1074
1073
  * request.</p>
1074
+ * @public
1075
1075
  */
1076
1076
  Negate?: boolean;
1077
1077
  }
@@ -1087,7 +1087,6 @@ export declare const TranscriptFilterType: {
1087
1087
  */
1088
1088
  export type TranscriptFilterType = (typeof TranscriptFilterType)[keyof typeof TranscriptFilterType];
1089
1089
  /**
1090
- * @public
1091
1090
  * <p>Flag the presence or absence of specific words or phrases detected in your Call
1092
1091
  * Analytics transcription output.</p>
1093
1092
  * <p>Rules using <code>TranscriptFilter</code> are designed to match:</p>
@@ -1106,51 +1105,51 @@ export type TranscriptFilterType = (typeof TranscriptFilterType)[keyof typeof Tr
1106
1105
  * <p>See <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch">Rule criteria for post-call
1107
1106
  * categories</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html#tca-rules-stream">Rule criteria for
1108
1107
  * streaming categories</a> for usage examples.</p>
1108
+ * @public
1109
1109
  */
1110
1110
  export interface TranscriptFilter {
1111
1111
  /**
1112
- * @public
1113
1112
  * <p>Flag the presence or absence of an exact match to the phrases that you specify. For
1114
1113
  * example, if you specify the phrase "speak to a manager" as your <code>Targets</code>
1115
1114
  * value, only that exact phrase is flagged.</p>
1116
1115
  * <p>Note that semantic matching is not supported. For example, if your customer says
1117
1116
  * "speak to <i>the</i> manager", instead of "speak to <i>a</i>
1118
1117
  * manager", your content is not flagged.</p>
1118
+ * @public
1119
1119
  */
1120
1120
  TranscriptFilterType: TranscriptFilterType | undefined;
1121
1121
  /**
1122
- * @public
1123
1122
  * <p>Makes it possible to specify a time range (in milliseconds) in your audio, during
1124
1123
  * which you want to search for the specified key words or phrases. See for more detail.</p>
1124
+ * @public
1125
1125
  */
1126
1126
  AbsoluteTimeRange?: AbsoluteTimeRange;
1127
1127
  /**
1128
- * @public
1129
1128
  * <p>Makes it possible to specify a time range (in percentage) in your media file, during
1130
1129
  * which you want to search for the specified key words or phrases. See for more detail.</p>
1130
+ * @public
1131
1131
  */
1132
1132
  RelativeTimeRange?: RelativeTimeRange;
1133
1133
  /**
1134
- * @public
1135
1134
  * <p>Specify the participant that you want to flag. Omitting this parameter is equivalent
1136
1135
  * to specifying both participants.</p>
1136
+ * @public
1137
1137
  */
1138
1138
  ParticipantRole?: ParticipantRole;
1139
1139
  /**
1140
- * @public
1141
1140
  * <p>Set to <code>TRUE</code> to flag the absence of the phrase that you specified in your
1142
1141
  * request. Set to <code>FALSE</code> to flag the presence of the phrase that you specified
1143
1142
  * in your request.</p>
1143
+ * @public
1144
1144
  */
1145
1145
  Negate?: boolean;
1146
1146
  /**
1147
- * @public
1148
1147
  * <p>Specify the phrases that you want to flag.</p>
1148
+ * @public
1149
1149
  */
1150
1150
  Targets: string[] | undefined;
1151
1151
  }
1152
1152
  /**
1153
- * @public
1154
1153
  * <p>A rule is a set of criteria that you can specify to flag an attribute in your Call
1155
1154
  * Analytics output. Rules define a Call Analytics category.</p>
1156
1155
  * <p>Rules can include these parameters: , , , and .</p>
@@ -1159,6 +1158,7 @@ export interface TranscriptFilter {
1159
1158
  * real-time transcriptions</a>.</p>
1160
1159
  * <p>To learn more about Call Analytics, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html">Analyzing call center audio with Call
1161
1160
  * Analytics</a>.</p>
1161
+ * @public
1162
1162
  */
1163
1163
  export type Rule = Rule.InterruptionFilterMember | Rule.NonTalkTimeFilterMember | Rule.SentimentFilterMember | Rule.TranscriptFilterMember | Rule.$UnknownMember;
1164
1164
  /**
@@ -1166,10 +1166,10 @@ export type Rule = Rule.InterruptionFilterMember | Rule.NonTalkTimeFilterMember
1166
1166
  */
1167
1167
  export declare namespace Rule {
1168
1168
  /**
1169
- * @public
1170
1169
  * <p>Flag the presence or absence of periods of silence in your Call Analytics
1171
1170
  * transcription output. Refer to for more
1172
1171
  * detail.</p>
1172
+ * @public
1173
1173
  */
1174
1174
  interface NonTalkTimeFilterMember {
1175
1175
  NonTalkTimeFilter: NonTalkTimeFilter;
@@ -1179,9 +1179,9 @@ export declare namespace Rule {
1179
1179
  $unknown?: never;
1180
1180
  }
1181
1181
  /**
1182
- * @public
1183
1182
  * <p>Flag the presence or absence of interruptions in your Call Analytics transcription
1184
1183
  * output. Refer to for more detail.</p>
1184
+ * @public
1185
1185
  */
1186
1186
  interface InterruptionFilterMember {
1187
1187
  NonTalkTimeFilter?: never;
@@ -1191,10 +1191,10 @@ export declare namespace Rule {
1191
1191
  $unknown?: never;
1192
1192
  }
1193
1193
  /**
1194
- * @public
1195
1194
  * <p>Flag the presence or absence of specific words or phrases in your Call Analytics
1196
1195
  * transcription output. Refer to for more
1197
1196
  * detail.</p>
1197
+ * @public
1198
1198
  */
1199
1199
  interface TranscriptFilterMember {
1200
1200
  NonTalkTimeFilter?: never;
@@ -1204,10 +1204,10 @@ export declare namespace Rule {
1204
1204
  $unknown?: never;
1205
1205
  }
1206
1206
  /**
1207
- * @public
1208
1207
  * <p>Flag the presence or absence of specific sentiments in your Call Analytics
1209
1208
  * transcription output. Refer to for more
1210
1209
  * detail.</p>
1210
+ * @public
1211
1211
  */
1212
1212
  interface SentimentFilterMember {
1213
1213
  NonTalkTimeFilter?: never;
@@ -1236,44 +1236,44 @@ export declare namespace Rule {
1236
1236
  const visit: <T>(value: Rule, visitor: Visitor<T>) => T;
1237
1237
  }
1238
1238
  /**
1239
- * @public
1240
1239
  * <p>Provides you with the properties of the Call Analytics category you specified in your
1241
1240
  * request. This includes the list of rules that define the specified category.</p>
1241
+ * @public
1242
1242
  */
1243
1243
  export interface CategoryProperties {
1244
1244
  /**
1245
- * @public
1246
1245
  * <p>The name of the Call Analytics category. Category names are case sensitive and must be
1247
1246
  * unique within an Amazon Web Services account.</p>
1247
+ * @public
1248
1248
  */
1249
1249
  CategoryName?: string;
1250
1250
  /**
1251
- * @public
1252
1251
  * <p>The rules used to define a Call Analytics category. Each category can have between 1
1253
1252
  * and 20 rules.</p>
1253
+ * @public
1254
1254
  */
1255
1255
  Rules?: Rule[];
1256
1256
  /**
1257
- * @public
1258
1257
  * <p>The date and time the specified Call Analytics category was created.</p>
1259
1258
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
1260
1259
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
1261
1260
  * 4, 2022.</p>
1261
+ * @public
1262
1262
  */
1263
1263
  CreateTime?: Date;
1264
1264
  /**
1265
- * @public
1266
1265
  * <p>The date and time the specified Call Analytics category was last updated.</p>
1267
1266
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
1268
1267
  * example, <code>2022-05-05T12:45:32.691000-07:00</code> represents 12:45 PM UTC-7 on May
1269
1268
  * 5, 2022.</p>
1269
+ * @public
1270
1270
  */
1271
1271
  LastUpdateTime?: Date;
1272
1272
  /**
1273
- * @public
1274
1273
  * <p>The input type associated with the specified category. <code>POST_CALL</code>
1275
1274
  * refers to a category that is applied to batch transcriptions; <code>REAL_TIME</code>
1276
1275
  * refers to a category that is applied to streaming transcriptions.</p>
1276
+ * @public
1277
1277
  */
1278
1278
  InputType?: InputType;
1279
1279
  }
@@ -1295,9 +1295,9 @@ export declare const CLMLanguageCode: {
1295
1295
  */
1296
1296
  export type CLMLanguageCode = (typeof CLMLanguageCode)[keyof typeof CLMLanguageCode];
1297
1297
  /**
1298
- * @public
1299
1298
  * <p>A resource already exists with this name. Resource names must be unique within an
1300
1299
  * Amazon Web Services account.</p>
1300
+ * @public
1301
1301
  */
1302
1302
  export declare class ConflictException extends __BaseException {
1303
1303
  readonly name: "ConflictException";
@@ -1313,24 +1313,23 @@ export declare class ConflictException extends __BaseException {
1313
1313
  */
1314
1314
  export interface CreateCallAnalyticsCategoryRequest {
1315
1315
  /**
1316
- * @public
1317
1316
  * <p>A unique name, chosen by you, for your Call Analytics category. It's helpful to use a
1318
1317
  * detailed naming system that will make sense to you in the future. For example, it's
1319
1318
  * better to use <code>sentiment-positive-last30seconds</code> for a category over a
1320
1319
  * generic name like <code>test-category</code>.</p>
1321
1320
  * <p>Category names are case sensitive.</p>
1321
+ * @public
1322
1322
  */
1323
1323
  CategoryName: string | undefined;
1324
1324
  /**
1325
- * @public
1326
1325
  * <p>Rules define a Call Analytics category. When creating a new category, you must create
1327
1326
  * between 1 and 20 rules for that category. For each rule, you specify a filter you want
1328
1327
  * applied to the attributes of a call. For example, you can choose a sentiment filter that
1329
1328
  * detects if a customer's sentiment was positive during the last 30 seconds of the call.</p>
1329
+ * @public
1330
1330
  */
1331
1331
  Rules: Rule[] | undefined;
1332
1332
  /**
1333
- * @public
1334
1333
  * <p>Choose whether you want to create a real-time or a post-call category for your Call
1335
1334
  * Analytics transcription.</p>
1336
1335
  * <p>Specifying <code>POST_CALL</code> assigns your category to post-call transcriptions;
@@ -1340,6 +1339,7 @@ export interface CreateCallAnalyticsCategoryRequest {
1340
1339
  * categories with this input type cannot be applied to post-call transcriptions.</p>
1341
1340
  * <p>If you do not include <code>InputType</code>, your category is created as a post-call
1342
1341
  * category by default.</p>
1342
+ * @public
1343
1343
  */
1344
1344
  InputType?: InputType;
1345
1345
  }
@@ -1348,16 +1348,16 @@ export interface CreateCallAnalyticsCategoryRequest {
1348
1348
  */
1349
1349
  export interface CreateCallAnalyticsCategoryResponse {
1350
1350
  /**
1351
- * @public
1352
1351
  * <p>Provides you with the properties of your new category, including its associated
1353
1352
  * rules.</p>
1353
+ * @public
1354
1354
  */
1355
1355
  CategoryProperties?: CategoryProperties;
1356
1356
  }
1357
1357
  /**
1358
- * @public
1359
1358
  * <p>There was an internal error. Check the error message, correct the issue, and try your
1360
1359
  * request again.</p>
1360
+ * @public
1361
1361
  */
1362
1362
  export declare class InternalFailureException extends __BaseException {
1363
1363
  readonly name: "InternalFailureException";
@@ -1369,9 +1369,9 @@ export declare class InternalFailureException extends __BaseException {
1369
1369
  constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
1370
1370
  }
1371
1371
  /**
1372
- * @public
1373
1372
  * <p>You've either sent too many requests or your input file is too long. Wait before
1374
1373
  * retrying your request, or use a smaller file and try your request again.</p>
1374
+ * @public
1375
1375
  */
1376
1376
  export declare class LimitExceededException extends __BaseException {
1377
1377
  readonly name: "LimitExceededException";
@@ -1383,34 +1383,33 @@ export declare class LimitExceededException extends __BaseException {
1383
1383
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
1384
1384
  }
1385
1385
  /**
1386
- * @public
1387
1386
  * <p>Contains the Amazon S3 location of the training data you want to use to create
1388
1387
  * a new custom language model, and permissions to access this location.</p>
1389
1388
  * <p>When using <code>InputDataConfig</code>, you must include these sub-parameters:
1390
1389
  * <code>S3Uri</code> and <code>DataAccessRoleArn</code>. You can optionally include
1391
1390
  * <code>TuningDataS3Uri</code>.</p>
1391
+ * @public
1392
1392
  */
1393
1393
  export interface InputDataConfig {
1394
1394
  /**
1395
- * @public
1396
1395
  * <p>The Amazon S3 location (URI) of the text files you want to use to train your
1397
1396
  * custom language model.</p>
1398
1397
  * <p>Here's an example URI path:
1399
1398
  * <code>s3://DOC-EXAMPLE-BUCKET/my-model-training-data/</code>
1400
1399
  * </p>
1400
+ * @public
1401
1401
  */
1402
1402
  S3Uri: string | undefined;
1403
1403
  /**
1404
- * @public
1405
1404
  * <p>The Amazon S3 location (URI) of the text files you want to use to tune your
1406
1405
  * custom language model.</p>
1407
1406
  * <p>Here's an example URI path:
1408
1407
  * <code>s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/</code>
1409
1408
  * </p>
1409
+ * @public
1410
1410
  */
1411
1411
  TuningDataS3Uri?: string;
1412
1412
  /**
1413
- * @public
1414
1413
  * <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
1415
1414
  * access the Amazon S3 bucket that contains your input files. If the role that you
1416
1415
  * specify doesn’t have the appropriate permissions to access the specified Amazon S3
@@ -1420,31 +1419,32 @@ export interface InputDataConfig {
1420
1419
  * <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
1421
1420
  * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
1422
1421
  * ARNs</a>.</p>
1422
+ * @public
1423
1423
  */
1424
1424
  DataAccessRoleArn: string | undefined;
1425
1425
  }
1426
1426
  /**
1427
- * @public
1428
1427
  * <p>Adds metadata, in the form of a key:value pair, to the specified resource.</p>
1429
1428
  * <p>For example, you could add the tag <code>Department:Sales</code> to a resource to
1430
1429
  * indicate that it pertains to your organization's sales department. You can also use tags
1431
1430
  * for tag-based access control.</p>
1432
1431
  * <p>To learn more about tagging, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging resources</a>.</p>
1432
+ * @public
1433
1433
  */
1434
1434
  export interface Tag {
1435
1435
  /**
1436
- * @public
1437
1436
  * <p>The first part of a key:value pair that forms a tag associated with a given resource.
1438
1437
  * For example, in the tag <code>Department:Sales</code>, the key is 'Department'.</p>
1438
+ * @public
1439
1439
  */
1440
1440
  Key: string | undefined;
1441
1441
  /**
1442
- * @public
1443
1442
  * <p>The second part of a key:value pair that forms a tag associated with a given resource.
1444
1443
  * For example, in the tag <code>Department:Sales</code>, the value is 'Sales'.</p>
1445
1444
  * <p>Note that you can set the value of a tag to an empty string, but you can't set the
1446
1445
  * value of a tag to null. Omitting the tag value is the same as using an empty
1447
1446
  * string.</p>
1447
+ * @public
1448
1448
  */
1449
1449
  Value: string | undefined;
1450
1450
  }
@@ -1453,7 +1453,6 @@ export interface Tag {
1453
1453
  */
1454
1454
  export interface CreateLanguageModelRequest {
1455
1455
  /**
1456
- * @public
1457
1456
  * <p>The language code that represents the language of your model. Each custom language
1458
1457
  * model must contain terms in only one language, and the language you select for your
1459
1458
  * custom language model must match the language of your training and tuning data.</p>
@@ -1464,29 +1463,29 @@ export interface CreateLanguageModelRequest {
1464
1463
  * the model. For example, if you create a custom language model using US English
1465
1464
  * (<code>en-US</code>), you can only apply this model to files that contain English
1466
1465
  * audio.</p>
1466
+ * @public
1467
1467
  */
1468
1468
  LanguageCode: CLMLanguageCode | undefined;
1469
1469
  /**
1470
- * @public
1471
1470
  * <p>The Amazon Transcribe standard language model, or base model, used to create your
1472
1471
  * custom language model. Amazon Transcribe offers two options for base models: Wideband
1473
1472
  * and Narrowband.</p>
1474
1473
  * <p>If the audio you want to transcribe has a sample rate of 16,000 Hz or greater, choose
1475
1474
  * <code>WideBand</code>. To transcribe audio with a sample rate less than 16,000 Hz,
1476
1475
  * choose <code>NarrowBand</code>.</p>
1476
+ * @public
1477
1477
  */
1478
1478
  BaseModelName: BaseModelName | undefined;
1479
1479
  /**
1480
- * @public
1481
1480
  * <p>A unique name, chosen by you, for your custom language model.</p>
1482
1481
  * <p>This name is case sensitive, cannot contain spaces, and must be unique within an
1483
1482
  * Amazon Web Services account. If you try to create a new custom language model with
1484
1483
  * the same name as an existing custom language model, you get a
1485
1484
  * <code>ConflictException</code> error.</p>
1485
+ * @public
1486
1486
  */
1487
1487
  ModelName: string | undefined;
1488
1488
  /**
1489
- * @public
1490
1489
  * <p>Contains the Amazon S3 location of the training data you want to use to create
1491
1490
  * a new custom language model, and permissions to access this location.</p>
1492
1491
  * <p>When using <code>InputDataConfig</code>, you must include these sub-parameters:
@@ -1496,14 +1495,15 @@ export interface CreateLanguageModelRequest {
1496
1495
  * optionally include <code>TuningDataS3Uri</code>, which is the Amazon S3 location
1497
1496
  * of your tuning data. If you specify different Amazon S3 locations for training
1498
1497
  * and tuning data, the ARN you use must have permissions to access both locations.</p>
1498
+ * @public
1499
1499
  */
1500
1500
  InputDataConfig: InputDataConfig | undefined;
1501
1501
  /**
1502
- * @public
1503
1502
  * <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
1504
1503
  * language model at the time you create this new model.</p>
1505
1504
  * <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
1506
1505
  * resources</a>.</p>
1506
+ * @public
1507
1507
  */
1508
1508
  Tags?: Tag[];
1509
1509
  }
@@ -1525,32 +1525,32 @@ export type ModelStatus = (typeof ModelStatus)[keyof typeof ModelStatus];
1525
1525
  */
1526
1526
  export interface CreateLanguageModelResponse {
1527
1527
  /**
1528
- * @public
1529
1528
  * <p>The language code you selected for your custom language model.</p>
1529
+ * @public
1530
1530
  */
1531
1531
  LanguageCode?: CLMLanguageCode;
1532
1532
  /**
1533
- * @public
1534
1533
  * <p>The Amazon Transcribe standard language model, or base model, you specified when
1535
1534
  * creating your custom language model.</p>
1535
+ * @public
1536
1536
  */
1537
1537
  BaseModelName?: BaseModelName;
1538
1538
  /**
1539
- * @public
1540
1539
  * <p>The name of your custom language model.</p>
1540
+ * @public
1541
1541
  */
1542
1542
  ModelName?: string;
1543
1543
  /**
1544
- * @public
1545
1544
  * <p>Lists your data access role ARN (Amazon Resource Name) and the Amazon S3
1546
1545
  * locations you provided for your training (<code>S3Uri</code>) and tuning
1547
1546
  * (<code>TuningDataS3Uri</code>) data.</p>
1547
+ * @public
1548
1548
  */
1549
1549
  InputDataConfig?: InputDataConfig;
1550
1550
  /**
1551
- * @public
1552
1551
  * <p>The status of your custom language model. When the status displays as
1553
1552
  * <code>COMPLETED</code>, your model is ready to use.</p>
1553
+ * @public
1554
1554
  */
1555
1555
  ModelStatus?: ModelStatus;
1556
1556
  }
@@ -1559,36 +1559,36 @@ export interface CreateLanguageModelResponse {
1559
1559
  */
1560
1560
  export interface CreateMedicalVocabularyRequest {
1561
1561
  /**
1562
- * @public
1563
1562
  * <p>A unique name, chosen by you, for your new custom medical vocabulary.</p>
1564
1563
  * <p>This name is case sensitive, cannot contain spaces, and must be unique within an
1565
1564
  * Amazon Web Services account. If you try to create a new custom medical vocabulary
1566
1565
  * with the same name as an existing custom medical vocabulary, you get a
1567
1566
  * <code>ConflictException</code> error.</p>
1567
+ * @public
1568
1568
  */
1569
1569
  VocabularyName: string | undefined;
1570
1570
  /**
1571
- * @public
1572
1571
  * <p>The language code that represents the language of the entries in your custom
1573
1572
  * vocabulary. US English (<code>en-US</code>) is the only language supported with Amazon Transcribe Medical.</p>
1573
+ * @public
1574
1574
  */
1575
1575
  LanguageCode: LanguageCode | undefined;
1576
1576
  /**
1577
- * @public
1578
1577
  * <p>The Amazon S3 location (URI) of the text file that contains your custom
1579
1578
  * medical vocabulary. The URI must be in the same Amazon Web Services Region as the
1580
1579
  * resource you're calling.</p>
1581
1580
  * <p>Here's an example URI path:
1582
1581
  * <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt</code>
1583
1582
  * </p>
1583
+ * @public
1584
1584
  */
1585
1585
  VocabularyFileUri: string | undefined;
1586
1586
  /**
1587
- * @public
1588
1587
  * <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
1589
1588
  * medical vocabulary at the time you create this new custom vocabulary.</p>
1590
1589
  * <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
1591
1590
  * resources</a>.</p>
1591
+ * @public
1592
1592
  */
1593
1593
  Tags?: Tag[];
1594
1594
  }
@@ -1610,37 +1610,37 @@ export type VocabularyState = (typeof VocabularyState)[keyof typeof VocabularySt
1610
1610
  */
1611
1611
  export interface CreateMedicalVocabularyResponse {
1612
1612
  /**
1613
- * @public
1614
1613
  * <p>The name you chose for your custom medical vocabulary.</p>
1614
+ * @public
1615
1615
  */
1616
1616
  VocabularyName?: string;
1617
1617
  /**
1618
- * @public
1619
1618
  * <p>The language code you selected for your custom medical vocabulary. US English
1620
1619
  * (<code>en-US</code>) is the only language supported with Amazon Transcribe
1621
1620
  * Medical.</p>
1621
+ * @public
1622
1622
  */
1623
1623
  LanguageCode?: LanguageCode;
1624
1624
  /**
1625
- * @public
1626
1625
  * <p>The processing state of your custom medical vocabulary. If the state is
1627
1626
  * <code>READY</code>, you can use the custom vocabulary in a
1628
1627
  * <code>StartMedicalTranscriptionJob</code> request.</p>
1628
+ * @public
1629
1629
  */
1630
1630
  VocabularyState?: VocabularyState;
1631
1631
  /**
1632
- * @public
1633
1632
  * <p>The date and time you created your custom medical vocabulary.</p>
1634
1633
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
1635
1634
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
1636
1635
  * 4, 2022.</p>
1636
+ * @public
1637
1637
  */
1638
1638
  LastModifiedTime?: Date;
1639
1639
  /**
1640
- * @public
1641
1640
  * <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code>
1642
1641
  * contains information about why the medical transcription job request failed. See also:
1643
1642
  * <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
1643
+ * @public
1644
1644
  */
1645
1645
  FailureReason?: string;
1646
1646
  }
@@ -1649,16 +1649,15 @@ export interface CreateMedicalVocabularyResponse {
1649
1649
  */
1650
1650
  export interface CreateVocabularyRequest {
1651
1651
  /**
1652
- * @public
1653
1652
  * <p>A unique name, chosen by you, for your new custom vocabulary.</p>
1654
1653
  * <p>This name is case sensitive, cannot contain spaces, and must be unique within an
1655
1654
  * Amazon Web Services account. If you try to create a new custom vocabulary with the
1656
1655
  * same name as an existing custom vocabulary, you get a <code>ConflictException</code>
1657
1656
  * error.</p>
1657
+ * @public
1658
1658
  */
1659
1659
  VocabularyName: string | undefined;
1660
1660
  /**
1661
- * @public
1662
1661
  * <p>The language code that represents the language of the entries in your custom
1663
1662
  * vocabulary. Each custom vocabulary must contain terms in only one language.</p>
1664
1663
  * <p>A custom vocabulary can only be used to transcribe files in the same language as the
@@ -1667,10 +1666,10 @@ export interface CreateVocabularyRequest {
1667
1666
  * contain English audio.</p>
1668
1667
  * <p>For a list of supported languages and their associated language codes, refer to the
1669
1668
  * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
1669
+ * @public
1670
1670
  */
1671
1671
  LanguageCode: LanguageCode | undefined;
1672
1672
  /**
1673
- * @public
1674
1673
  * <p>Use this parameter if you want to create your custom vocabulary by including all
1675
1674
  * desired terms, as comma-separated values, within your request. The other option for
1676
1675
  * creating your custom vocabulary is to save your entries in a text file and upload them
@@ -1682,10 +1681,10 @@ export interface CreateVocabularyRequest {
1682
1681
  * specific language. If you use unsupported characters, your custom vocabulary filter
1683
1682
  * request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
1684
1683
  * Vocabularies</a> to get the character set for your language.</p>
1684
+ * @public
1685
1685
  */
1686
1686
  Phrases?: string[];
1687
1687
  /**
1688
- * @public
1689
1688
  * <p>The Amazon S3 location of the text file that contains your custom vocabulary.
1690
1689
  * The URI must be located in the same Amazon Web Services Region as the resource you're
1691
1690
  * calling.</p>
@@ -1694,18 +1693,18 @@ export interface CreateVocabularyRequest {
1694
1693
  * </p>
1695
1694
  * <p>Note that if you include <code>VocabularyFileUri</code> in your request, you cannot
1696
1695
  * use the <code>Phrases</code> flag; you must choose one or the other.</p>
1696
+ * @public
1697
1697
  */
1698
1698
  VocabularyFileUri?: string;
1699
1699
  /**
1700
- * @public
1701
1700
  * <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
1702
1701
  * vocabulary at the time you create this new custom vocabulary.</p>
1703
1702
  * <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
1704
1703
  * resources</a>.</p>
1704
+ * @public
1705
1705
  */
1706
1706
  Tags?: Tag[];
1707
1707
  /**
1708
- * @public
1709
1708
  * <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
1710
1709
  * access the Amazon S3 bucket that contains your input files (in this case, your custom
1711
1710
  * vocabulary). If the role that you specify doesn’t have the appropriate permissions to access
@@ -1715,6 +1714,7 @@ export interface CreateVocabularyRequest {
1715
1714
  * <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
1716
1715
  * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
1717
1716
  * ARNs</a>.</p>
1717
+ * @public
1718
1718
  */
1719
1719
  DataAccessRoleArn?: string;
1720
1720
  }
@@ -1723,35 +1723,35 @@ export interface CreateVocabularyRequest {
1723
1723
  */
1724
1724
  export interface CreateVocabularyResponse {
1725
1725
  /**
1726
- * @public
1727
1726
  * <p>The name you chose for your custom vocabulary.</p>
1727
+ * @public
1728
1728
  */
1729
1729
  VocabularyName?: string;
1730
1730
  /**
1731
- * @public
1732
1731
  * <p>The language code you selected for your custom vocabulary.</p>
1732
+ * @public
1733
1733
  */
1734
1734
  LanguageCode?: LanguageCode;
1735
1735
  /**
1736
- * @public
1737
1736
  * <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
1738
1737
  * you can use the custom vocabulary in a <code>StartTranscriptionJob</code>
1739
1738
  * request.</p>
1739
+ * @public
1740
1740
  */
1741
1741
  VocabularyState?: VocabularyState;
1742
1742
  /**
1743
- * @public
1744
1743
  * <p>The date and time you created your custom vocabulary.</p>
1745
1744
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
1746
1745
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
1747
1746
  * 4, 2022.</p>
1747
+ * @public
1748
1748
  */
1749
1749
  LastModifiedTime?: Date;
1750
1750
  /**
1751
- * @public
1752
1751
  * <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code>
1753
1752
  * contains information about why the custom vocabulary request failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common
1754
1753
  * Errors</a>.</p>
1754
+ * @public
1755
1755
  */
1756
1756
  FailureReason?: string;
1757
1757
  }
@@ -1760,16 +1760,15 @@ export interface CreateVocabularyResponse {
1760
1760
  */
1761
1761
  export interface CreateVocabularyFilterRequest {
1762
1762
  /**
1763
- * @public
1764
1763
  * <p>A unique name, chosen by you, for your new custom vocabulary filter.</p>
1765
1764
  * <p>This name is case sensitive, cannot contain spaces, and must be unique within an
1766
1765
  * Amazon Web Services account. If you try to create a new custom vocabulary filter with
1767
1766
  * the same name as an existing custom vocabulary filter, you get a
1768
1767
  * <code>ConflictException</code> error.</p>
1768
+ * @public
1769
1769
  */
1770
1770
  VocabularyFilterName: string | undefined;
1771
1771
  /**
1772
- * @public
1773
1772
  * <p>The language code that represents the language of the entries in your vocabulary
1774
1773
  * filter. Each custom vocabulary filter must contain terms in only one language.</p>
1775
1774
  * <p>A custom vocabulary filter can only be used to transcribe files in the same language
@@ -1778,10 +1777,10 @@ export interface CreateVocabularyFilterRequest {
1778
1777
  * audio.</p>
1779
1778
  * <p>For a list of supported languages and their associated language codes, refer to the
1780
1779
  * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
1780
+ * @public
1781
1781
  */
1782
1782
  LanguageCode: LanguageCode | undefined;
1783
1783
  /**
1784
- * @public
1785
1784
  * <p>Use this parameter if you want to create your custom vocabulary filter by including
1786
1785
  * all desired terms, as comma-separated values, within your request. The other option for
1787
1786
  * creating your vocabulary filter is to save your entries in a text file and upload them
@@ -1793,10 +1792,10 @@ export interface CreateVocabularyFilterRequest {
1793
1792
  * specific language. If you use unsupported characters, your custom vocabulary filter
1794
1793
  * request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
1795
1794
  * Vocabularies</a> to get the character set for your language.</p>
1795
+ * @public
1796
1796
  */
1797
1797
  Words?: string[];
1798
1798
  /**
1799
- * @public
1800
1799
  * <p>The Amazon S3 location of the text file that contains your custom vocabulary
1801
1800
  * filter terms. The URI must be located in the same Amazon Web Services Region as the
1802
1801
  * resource you're calling.</p>
@@ -1805,18 +1804,18 @@ export interface CreateVocabularyFilterRequest {
1805
1804
  * </p>
1806
1805
  * <p>Note that if you include <code>VocabularyFilterFileUri</code> in your request, you
1807
1806
  * cannot use <code>Words</code>; you must choose one or the other.</p>
1807
+ * @public
1808
1808
  */
1809
1809
  VocabularyFilterFileUri?: string;
1810
1810
  /**
1811
- * @public
1812
1811
  * <p>Adds one or more custom tags, each in the form of a key:value pair, to a new custom
1813
1812
  * vocabulary filter at the time you create this new vocabulary filter.</p>
1814
1813
  * <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
1815
1814
  * resources</a>.</p>
1815
+ * @public
1816
1816
  */
1817
1817
  Tags?: Tag[];
1818
1818
  /**
1819
- * @public
1820
1819
  * <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
1821
1820
  * access the Amazon S3 bucket that contains your input files (in this case, your custom
1822
1821
  * vocabulary filter). If the role that you specify doesn’t have the appropriate permissions to access
@@ -1826,6 +1825,7 @@ export interface CreateVocabularyFilterRequest {
1826
1825
  * <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
1827
1826
  * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
1828
1827
  * ARNs</a>.</p>
1828
+ * @public
1829
1829
  */
1830
1830
  DataAccessRoleArn?: string;
1831
1831
  }
@@ -1834,21 +1834,21 @@ export interface CreateVocabularyFilterRequest {
1834
1834
  */
1835
1835
  export interface CreateVocabularyFilterResponse {
1836
1836
  /**
1837
- * @public
1838
1837
  * <p>The name you chose for your custom vocabulary filter.</p>
1838
+ * @public
1839
1839
  */
1840
1840
  VocabularyFilterName?: string;
1841
1841
  /**
1842
- * @public
1843
1842
  * <p>The language code you selected for your custom vocabulary filter.</p>
1843
+ * @public
1844
1844
  */
1845
1845
  LanguageCode?: LanguageCode;
1846
1846
  /**
1847
- * @public
1848
1847
  * <p>The date and time you created your custom vocabulary filter.</p>
1849
1848
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
1850
1849
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
1851
1850
  * 4, 2022.</p>
1851
+ * @public
1852
1852
  */
1853
1853
  LastModifiedTime?: Date;
1854
1854
  }
@@ -1857,9 +1857,9 @@ export interface CreateVocabularyFilterResponse {
1857
1857
  */
1858
1858
  export interface DeleteCallAnalyticsCategoryRequest {
1859
1859
  /**
1860
- * @public
1861
1860
  * <p>The name of the Call Analytics category you want to delete. Category names are case
1862
1861
  * sensitive.</p>
1862
+ * @public
1863
1863
  */
1864
1864
  CategoryName: string | undefined;
1865
1865
  }
@@ -1869,9 +1869,9 @@ export interface DeleteCallAnalyticsCategoryRequest {
1869
1869
  export interface DeleteCallAnalyticsCategoryResponse {
1870
1870
  }
1871
1871
  /**
1872
- * @public
1873
1872
  * <p>We can't find the requested resource. Check that the specified name is correct and try
1874
1873
  * your request again.</p>
1874
+ * @public
1875
1875
  */
1876
1876
  export declare class NotFoundException extends __BaseException {
1877
1877
  readonly name: "NotFoundException";
@@ -1887,9 +1887,9 @@ export declare class NotFoundException extends __BaseException {
1887
1887
  */
1888
1888
  export interface DeleteCallAnalyticsJobRequest {
1889
1889
  /**
1890
- * @public
1891
1890
  * <p>The name of the Call Analytics job you want to delete. Job names are case
1892
1891
  * sensitive.</p>
1892
+ * @public
1893
1893
  */
1894
1894
  CallAnalyticsJobName: string | undefined;
1895
1895
  }
@@ -1903,9 +1903,9 @@ export interface DeleteCallAnalyticsJobResponse {
1903
1903
  */
1904
1904
  export interface DeleteLanguageModelRequest {
1905
1905
  /**
1906
- * @public
1907
1906
  * <p>The name of the custom language model you want to delete. Model names are case
1908
1907
  * sensitive.</p>
1908
+ * @public
1909
1909
  */
1910
1910
  ModelName: string | undefined;
1911
1911
  }
@@ -1914,9 +1914,9 @@ export interface DeleteLanguageModelRequest {
1914
1914
  */
1915
1915
  export interface DeleteMedicalScribeJobRequest {
1916
1916
  /**
1917
- * @public
1918
1917
  * <p>The name of the Medical Scribe job you want to delete. Job names are case
1919
1918
  * sensitive.</p>
1919
+ * @public
1920
1920
  */
1921
1921
  MedicalScribeJobName: string | undefined;
1922
1922
  }
@@ -1925,9 +1925,9 @@ export interface DeleteMedicalScribeJobRequest {
1925
1925
  */
1926
1926
  export interface DeleteMedicalTranscriptionJobRequest {
1927
1927
  /**
1928
- * @public
1929
1928
  * <p>The name of the medical transcription job you want to delete. Job names are case
1930
1929
  * sensitive.</p>
1930
+ * @public
1931
1931
  */
1932
1932
  MedicalTranscriptionJobName: string | undefined;
1933
1933
  }
@@ -1936,9 +1936,9 @@ export interface DeleteMedicalTranscriptionJobRequest {
1936
1936
  */
1937
1937
  export interface DeleteMedicalVocabularyRequest {
1938
1938
  /**
1939
- * @public
1940
1939
  * <p>The name of the custom medical vocabulary you want to delete. Custom medical
1941
1940
  * vocabulary names are case sensitive.</p>
1941
+ * @public
1942
1942
  */
1943
1943
  VocabularyName: string | undefined;
1944
1944
  }
@@ -1947,9 +1947,9 @@ export interface DeleteMedicalVocabularyRequest {
1947
1947
  */
1948
1948
  export interface DeleteTranscriptionJobRequest {
1949
1949
  /**
1950
- * @public
1951
1950
  * <p>The name of the transcription job you want to delete. Job names are case
1952
1951
  * sensitive.</p>
1952
+ * @public
1953
1953
  */
1954
1954
  TranscriptionJobName: string | undefined;
1955
1955
  }
@@ -1958,9 +1958,9 @@ export interface DeleteTranscriptionJobRequest {
1958
1958
  */
1959
1959
  export interface DeleteVocabularyRequest {
1960
1960
  /**
1961
- * @public
1962
1961
  * <p>The name of the custom vocabulary you want to delete. Custom vocabulary names are case
1963
1962
  * sensitive.</p>
1963
+ * @public
1964
1964
  */
1965
1965
  VocabularyName: string | undefined;
1966
1966
  }
@@ -1969,9 +1969,9 @@ export interface DeleteVocabularyRequest {
1969
1969
  */
1970
1970
  export interface DeleteVocabularyFilterRequest {
1971
1971
  /**
1972
- * @public
1973
1972
  * <p>The name of the custom vocabulary filter you want to delete. Custom vocabulary filter
1974
1973
  * names are case sensitive.</p>
1974
+ * @public
1975
1975
  */
1976
1976
  VocabularyFilterName: string | undefined;
1977
1977
  }
@@ -1980,14 +1980,13 @@ export interface DeleteVocabularyFilterRequest {
1980
1980
  */
1981
1981
  export interface DescribeLanguageModelRequest {
1982
1982
  /**
1983
- * @public
1984
1983
  * <p>The name of the custom language model you want information about. Model names are case
1985
1984
  * sensitive.</p>
1985
+ * @public
1986
1986
  */
1987
1987
  ModelName: string | undefined;
1988
1988
  }
1989
1989
  /**
1990
- * @public
1991
1990
  * <p>Provides information about a custom language model, including:</p>
1992
1991
  * <ul>
1993
1992
  * <li>
@@ -2015,55 +2014,55 @@ export interface DescribeLanguageModelRequest {
2015
2014
  * <p>Any available upgrades for the base model</p>
2016
2015
  * </li>
2017
2016
  * </ul>
2017
+ * @public
2018
2018
  */
2019
2019
  export interface LanguageModel {
2020
2020
  /**
2021
- * @public
2022
2021
  * <p>A unique name, chosen by you, for your custom language model.</p>
2023
2022
  * <p>This name is case sensitive, cannot contain spaces, and must be unique within an
2024
2023
  * Amazon Web Services account.</p>
2024
+ * @public
2025
2025
  */
2026
2026
  ModelName?: string;
2027
2027
  /**
2028
- * @public
2029
2028
  * <p>The date and time the specified custom language model was created.</p>
2030
2029
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
2031
2030
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
2032
2031
  * 4, 2022.</p>
2032
+ * @public
2033
2033
  */
2034
2034
  CreateTime?: Date;
2035
2035
  /**
2036
- * @public
2037
2036
  * <p>The date and time the specified custom language model was last modified.</p>
2038
2037
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
2039
2038
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
2040
2039
  * 4, 2022.</p>
2040
+ * @public
2041
2041
  */
2042
2042
  LastModifiedTime?: Date;
2043
2043
  /**
2044
- * @public
2045
2044
  * <p>The language code used to create your custom language model. Each custom language
2046
2045
  * model must contain terms in only one language, and the language you select for your
2047
2046
  * custom language model must match the language of your training and tuning data.</p>
2048
2047
  * <p>For a list of supported languages and their associated language codes, refer to the
2049
2048
  * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table. Note that US English (<code>en-US</code>) is
2050
2049
  * the only language supported with Amazon Transcribe Medical.</p>
2050
+ * @public
2051
2051
  */
2052
2052
  LanguageCode?: CLMLanguageCode;
2053
2053
  /**
2054
- * @public
2055
2054
  * <p>The Amazon Transcribe standard language model, or base model, used to create your
2056
2055
  * custom language model.</p>
2056
+ * @public
2057
2057
  */
2058
2058
  BaseModelName?: BaseModelName;
2059
2059
  /**
2060
- * @public
2061
2060
  * <p>The status of the specified custom language model. When the status displays as
2062
2061
  * <code>COMPLETED</code> the model is ready for use.</p>
2062
+ * @public
2063
2063
  */
2064
2064
  ModelStatus?: ModelStatus;
2065
2065
  /**
2066
- * @public
2067
2066
  * <p>Shows if a more current base model is available for use with the specified custom
2068
2067
  * language model.</p>
2069
2068
  * <p>If <code>false</code>, your custom language model is using the most up-to-date base
@@ -2073,20 +2072,21 @@ export interface LanguageModel {
2073
2072
  * <p>Note that to update a base model, you must recreate the custom language model using
2074
2073
  * the new base model. Base model upgrades for existing custom language models are not
2075
2074
  * supported.</p>
2075
+ * @public
2076
2076
  */
2077
2077
  UpgradeAvailability?: boolean;
2078
2078
  /**
2079
- * @public
2080
2079
  * <p>If <code>ModelStatus</code> is <code>FAILED</code>, <code>FailureReason</code>
2081
2080
  * contains information about why the custom language model request failed. See also:
2082
2081
  * <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
2082
+ * @public
2083
2083
  */
2084
2084
  FailureReason?: string;
2085
2085
  /**
2086
- * @public
2087
2086
  * <p>The Amazon S3 location of the input files used to train and tune your custom
2088
2087
  * language model, in addition to the data access role ARN (Amazon Resource Name) that has
2089
2088
  * permissions to access these data.</p>
2089
+ * @public
2090
2090
  */
2091
2091
  InputDataConfig?: InputDataConfig;
2092
2092
  }
@@ -2095,7 +2095,6 @@ export interface LanguageModel {
2095
2095
  */
2096
2096
  export interface DescribeLanguageModelResponse {
2097
2097
  /**
2098
- * @public
2099
2098
  * <p>Provides information about the specified custom language model.</p>
2100
2099
  * <p>This parameter also shows if the base language model you used to create your custom
2101
2100
  * language model has been updated. If Amazon Transcribe has updated the base model, you
@@ -2103,6 +2102,7 @@ export interface DescribeLanguageModelResponse {
2103
2102
  * <p>If you tried to create a new custom language model and the request wasn't successful,
2104
2103
  * you can use this <code>DescribeLanguageModel</code> to help identify the reason for this
2105
2104
  * failure.</p>
2105
+ * @public
2106
2106
  */
2107
2107
  LanguageModel?: LanguageModel;
2108
2108
  }
@@ -2111,9 +2111,9 @@ export interface DescribeLanguageModelResponse {
2111
2111
  */
2112
2112
  export interface GetCallAnalyticsCategoryRequest {
2113
2113
  /**
2114
- * @public
2115
2114
  * <p>The name of the Call Analytics category you want information about. Category names are
2116
2115
  * case sensitive.</p>
2116
+ * @public
2117
2117
  */
2118
2118
  CategoryName: string | undefined;
2119
2119
  }
@@ -2122,9 +2122,9 @@ export interface GetCallAnalyticsCategoryRequest {
2122
2122
  */
2123
2123
  export interface GetCallAnalyticsCategoryResponse {
2124
2124
  /**
2125
- * @public
2126
2125
  * <p>Provides you with the properties of the Call Analytics category you specified in your
2127
2126
  * <code>GetCallAnalyticsCategory</code> request.</p>
2127
+ * @public
2128
2128
  */
2129
2129
  CategoryProperties?: CategoryProperties;
2130
2130
  }
@@ -2133,9 +2133,9 @@ export interface GetCallAnalyticsCategoryResponse {
2133
2133
  */
2134
2134
  export interface GetCallAnalyticsJobRequest {
2135
2135
  /**
2136
- * @public
2137
2136
  * <p>The name of the Call Analytics job you want information about. Job names are case
2138
2137
  * sensitive.</p>
2138
+ * @public
2139
2139
  */
2140
2140
  CallAnalyticsJobName: string | undefined;
2141
2141
  }
@@ -2144,9 +2144,9 @@ export interface GetCallAnalyticsJobRequest {
2144
2144
  */
2145
2145
  export interface GetCallAnalyticsJobResponse {
2146
2146
  /**
2147
- * @public
2148
2147
  * <p>Provides detailed information about the specified Call Analytics job, including job
2149
2148
  * status and, if applicable, failure reason.</p>
2149
+ * @public
2150
2150
  */
2151
2151
  CallAnalyticsJob?: CallAnalyticsJob;
2152
2152
  }
@@ -2155,9 +2155,9 @@ export interface GetCallAnalyticsJobResponse {
2155
2155
  */
2156
2156
  export interface GetMedicalScribeJobRequest {
2157
2157
  /**
2158
- * @public
2159
2158
  * <p>The name of the Medical Scribe job you want information about. Job names are
2160
2159
  * case sensitive.</p>
2160
+ * @public
2161
2161
  */
2162
2162
  MedicalScribeJobName: string | undefined;
2163
2163
  }
@@ -2174,22 +2174,22 @@ export declare const MedicalScribeParticipantRole: {
2174
2174
  */
2175
2175
  export type MedicalScribeParticipantRole = (typeof MedicalScribeParticipantRole)[keyof typeof MedicalScribeParticipantRole];
2176
2176
  /**
2177
- * @public
2178
2177
  * <p>Indicates which speaker is on which channel. The options are
2179
2178
  * <code>CLINICIAN</code> and <code>PATIENT</code>
2180
2179
  * </p>
2180
+ * @public
2181
2181
  */
2182
2182
  export interface MedicalScribeChannelDefinition {
2183
2183
  /**
2184
- * @public
2185
2184
  * <p>Specify the audio channel you want to define.</p>
2185
+ * @public
2186
2186
  */
2187
2187
  ChannelId: number | undefined;
2188
2188
  /**
2189
- * @public
2190
2189
  * <p>Specify the participant that you want to flag.
2191
2190
  * The options are <code>CLINICIAN</code> and <code>PATIENT</code>
2192
2191
  * </p>
2192
+ * @public
2193
2193
  */
2194
2194
  ParticipantRole: MedicalScribeParticipantRole | undefined;
2195
2195
  }
@@ -2219,25 +2219,24 @@ export declare const MedicalScribeJobStatus: {
2219
2219
  */
2220
2220
  export type MedicalScribeJobStatus = (typeof MedicalScribeJobStatus)[keyof typeof MedicalScribeJobStatus];
2221
2221
  /**
2222
- * @public
2223
2222
  * <p>The location of the output of your Medical Scribe job.
2224
2223
  * <code>ClinicalDocumentUri</code> holds the Amazon S3 URI for the Clinical Document
2225
2224
  * and <code>TranscriptFileUri</code> holds the Amazon S3 URI for the Transcript.</p>
2225
+ * @public
2226
2226
  */
2227
2227
  export interface MedicalScribeOutput {
2228
2228
  /**
2229
- * @public
2230
2229
  * <p>Holds the Amazon S3 URI for the Transcript.</p>
2230
+ * @public
2231
2231
  */
2232
2232
  TranscriptFileUri: string | undefined;
2233
2233
  /**
2234
- * @public
2235
2234
  * <p>Holds the Amazon S3 URI for the Clinical Document.</p>
2235
+ * @public
2236
2236
  */
2237
2237
  ClinicalDocumentUri: string | undefined;
2238
2238
  }
2239
2239
  /**
2240
- * @public
2241
2240
  * <p>Makes it possible to control how your Medical Scribe job is processed using a
2242
2241
  * <code>MedicalScribeSettings</code> object. Specify <code>ChannelIdentification</code> if
2243
2242
  * <code>ChannelDefinitions</code> are set. Enabled <code>ShowSpeakerLabels</code> if <code>ChannelIdentification</code>
@@ -2246,61 +2245,61 @@ export interface MedicalScribeOutput {
2246
2245
  * to specify a vocabulary or vocabulary filter or both using <code>VocabularyName</code>, <code>VocabularyFilterName</code>.
2247
2246
  * <code>VocabularyFilterMethod</code> must be specified if <code>VocabularyFilterName</code> is set.
2248
2247
  * </p>
2248
+ * @public
2249
2249
  */
2250
2250
  export interface MedicalScribeSettings {
2251
2251
  /**
2252
- * @public
2253
2252
  * <p>Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker
2254
2253
  * partitioning labels the speech from individual speakers in your media file.</p>
2255
2254
  * <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
2256
2255
  * <code>MaxSpeakerLabels</code>.</p>
2257
2256
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers
2258
2257
  * (diarization)</a>.</p>
2258
+ * @public
2259
2259
  */
2260
2260
  ShowSpeakerLabels?: boolean;
2261
2261
  /**
2262
- * @public
2263
2262
  * <p>Specify the maximum number of speakers you want to partition in your media.</p>
2264
2263
  * <p>Note that if your media contains more speakers than the specified number, multiple
2265
2264
  * speakers are treated as a single speaker.</p>
2266
2265
  * <p>If you specify the <code>MaxSpeakerLabels</code> field, you must set the
2267
2266
  * <code>ShowSpeakerLabels</code> field to true.</p>
2267
+ * @public
2268
2268
  */
2269
2269
  MaxSpeakerLabels?: number;
2270
2270
  /**
2271
- * @public
2272
2271
  * <p>Enables channel identification in multi-channel audio.</p>
2273
2272
  * <p>Channel identification transcribes the audio on each channel independently, then
2274
2273
  * appends the output for each channel into one transcript.</p>
2275
2274
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
2276
2275
  * audio</a>.</p>
2276
+ * @public
2277
2277
  */
2278
2278
  ChannelIdentification?: boolean;
2279
2279
  /**
2280
- * @public
2281
2280
  * <p>The name of the custom vocabulary you want to include in your Medical Scribe
2282
2281
  * request. Custom vocabulary names are case sensitive.</p>
2282
+ * @public
2283
2283
  */
2284
2284
  VocabularyName?: string;
2285
2285
  /**
2286
- * @public
2287
2286
  * <p>The name of the custom vocabulary filter you want to include in your Medical Scribe
2288
2287
  * request. Custom vocabulary filter names are case sensitive.</p>
2289
2288
  * <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
2290
2289
  * also include <code>VocabularyFilterMethod</code>.</p>
2290
+ * @public
2291
2291
  */
2292
2292
  VocabularyFilterName?: string;
2293
2293
  /**
2294
- * @public
2295
2294
  * <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
2296
2295
  * <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
2297
2296
  * <p>To delete words, choose <code>remove</code>.</p>
2298
2297
  * <p>To flag words without changing them, choose <code>tag</code>.</p>
2298
+ * @public
2299
2299
  */
2300
2300
  VocabularyFilterMethod?: VocabularyFilterMethod;
2301
2301
  }
2302
2302
  /**
2303
- * @public
2304
2303
  * <p>Provides detailed information about a Medical Scribe job.</p>
2305
2304
  * <p>To view the status of the specified Medical Scribe job, check the
2306
2305
  * <code>MedicalScribeJobStatus</code> field. If the status is <code>COMPLETED</code>,
@@ -2308,78 +2307,78 @@ export interface MedicalScribeSettings {
2308
2307
  * <code>MedicalScribeOutput</code>. If the status is <code>FAILED</code>,
2309
2308
  * <code>FailureReason</code> provides details on why your Medical Scribe job
2310
2309
  * failed.</p>
2310
+ * @public
2311
2311
  */
2312
2312
  export interface MedicalScribeJob {
2313
2313
  /**
2314
- * @public
2315
2314
  * <p>The name of the Medical Scribe job. Job names are case sensitive and must be
2316
2315
  * unique within an Amazon Web Services account.</p>
2316
+ * @public
2317
2317
  */
2318
2318
  MedicalScribeJobName?: string;
2319
2319
  /**
2320
- * @public
2321
2320
  * <p>Provides the status of the specified Medical Scribe job.</p>
2322
2321
  * <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
2323
2322
  * results at the location specified in <code>MedicalScribeOutput</code> If
2324
2323
  * the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
2325
2324
  * your Medical Scribe job failed.</p>
2325
+ * @public
2326
2326
  */
2327
2327
  MedicalScribeJobStatus?: MedicalScribeJobStatus;
2328
2328
  /**
2329
- * @public
2330
2329
  * <p>The language code used to create your Medical Scribe job. US English
2331
2330
  * (<code>en-US</code>) is the only supported language for Medical Scribe jobs. </p>
2331
+ * @public
2332
2332
  */
2333
2333
  LanguageCode?: MedicalScribeLanguageCode;
2334
2334
  /**
2335
- * @public
2336
2335
  * <p>Describes the Amazon S3 location of the media file you want to use in your
2337
2336
  * request.</p>
2338
2337
  * <p>For information on supported media formats, refer to the <code>MediaFormat</code>
2339
2338
  * parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
2340
2339
  * in the Amazon S3 Developer Guide.</p>
2340
+ * @public
2341
2341
  */
2342
2342
  Media?: Media;
2343
2343
  /**
2344
- * @public
2345
2344
  * <p>The location of the output of your Medical Scribe job.
2346
2345
  * <code>ClinicalDocumentUri</code> holds the Amazon S3 URI for the Clinical Document
2347
2346
  * and <code>TranscriptFileUri</code> holds the Amazon S3 URI for the Transcript.</p>
2347
+ * @public
2348
2348
  */
2349
2349
  MedicalScribeOutput?: MedicalScribeOutput;
2350
2350
  /**
2351
- * @public
2352
2351
  * <p>The date and time your Medical Scribe job began processing.</p>
2353
2352
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
2354
2353
  * example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a Medical Scribe job
2355
2354
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
2355
+ * @public
2356
2356
  */
2357
2357
  StartTime?: Date;
2358
2358
  /**
2359
- * @public
2360
2359
  * <p>The date and time the specified Medical Scribe job request was made.</p>
2361
2360
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
2362
2361
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a Medical Scribe job
2363
2362
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
2363
+ * @public
2364
2364
  */
2365
2365
  CreationTime?: Date;
2366
2366
  /**
2367
- * @public
2368
2367
  * <p>The date and time the specified Medical Scribe job finished processing.</p>
2369
2368
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
2370
2369
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a Medical Scribe job
2371
2370
  * that finished processing at 12:32 PM UTC-7 on May 4, 2022.</p>
2371
+ * @public
2372
2372
  */
2373
2373
  CompletionTime?: Date;
2374
2374
  /**
2375
- * @public
2376
2375
  * <p>If <code>MedicalScribeJobStatus</code> is <code>FAILED</code>,
2377
2376
  * <code>FailureReason</code> contains information about why the transcription job
2378
2377
  * failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
2378
+ * @public
2379
2379
  */
2380
2380
  FailureReason?: string;
2381
2381
  /**
2382
- * @public
2383
2382
  * <p>Makes it possible to control how your Medical Scribe job is processed using a
2384
2383
  * <code>MedicalScribeSettings</code> object. Specify <code>ChannelIdentification</code> if
2385
2384
  * <code>ChannelDefinitions</code> are set. Enabled <code>ShowSpeakerLabels</code> if <code>ChannelIdentification</code>
@@ -2388,10 +2387,10 @@ export interface MedicalScribeJob {
2388
2387
  * to specify a vocabulary or vocabulary filter or both using <code>VocabularyName</code>, <code>VocabularyFilterName</code>.
2389
2388
  * <code>VocabularyFilterMethod</code> must be specified if <code>VocabularyFilterName</code> is set.
2390
2389
  * </p>
2390
+ * @public
2391
2391
  */
2392
2392
  Settings?: MedicalScribeSettings;
2393
2393
  /**
2394
- * @public
2395
2394
  * <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
2396
2395
  * access the Amazon S3 bucket that contains your input files,
2397
2396
  * write to the output bucket, and use your KMS key if supplied.
@@ -2401,10 +2400,10 @@ export interface MedicalScribeJob {
2401
2400
  * <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
2402
2401
  * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
2403
2402
  * ARNs</a>.</p>
2403
+ * @public
2404
2404
  */
2405
2405
  DataAccessRoleArn?: string;
2406
2406
  /**
2407
- * @public
2408
2407
  * <p>Makes it possible to specify which speaker is on which channel. For example, if the clinician
2409
2408
  * is the first participant to speak, you would set <code>ChannelId</code> of the first <code>ChannelDefinition</code>
2410
2409
  * in the list to <code>0</code> (to indicate the first channel) and <code>ParticipantRole</code> to
@@ -2413,13 +2412,14 @@ export interface MedicalScribeJob {
2413
2412
  * <code>1</code> (to indicate the second channel) and <code>ParticipantRole</code> to
2414
2413
  * <code>PATIENT</code> (to indicate that it's the patient speaking).
2415
2414
  * </p>
2415
+ * @public
2416
2416
  */
2417
2417
  ChannelDefinitions?: MedicalScribeChannelDefinition[];
2418
2418
  /**
2419
- * @public
2420
2419
  * <p>Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.</p>
2421
2420
  * <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
2422
2421
  * resources</a>.</p>
2422
+ * @public
2423
2423
  */
2424
2424
  Tags?: Tag[];
2425
2425
  }
@@ -2428,9 +2428,9 @@ export interface MedicalScribeJob {
2428
2428
  */
2429
2429
  export interface GetMedicalScribeJobResponse {
2430
2430
  /**
2431
- * @public
2432
2431
  * <p>Provides detailed information about the specified Medical Scribe job, including
2433
2432
  * job status and, if applicable, failure reason</p>
2433
+ * @public
2434
2434
  */
2435
2435
  MedicalScribeJob?: MedicalScribeJob;
2436
2436
  }
@@ -2439,9 +2439,9 @@ export interface GetMedicalScribeJobResponse {
2439
2439
  */
2440
2440
  export interface GetMedicalTranscriptionJobRequest {
2441
2441
  /**
2442
- * @public
2443
2442
  * <p>The name of the medical transcription job you want information about. Job names are
2444
2443
  * case sensitive.</p>
2444
+ * @public
2445
2445
  */
2446
2446
  MedicalTranscriptionJobName: string | undefined;
2447
2447
  }
@@ -2457,33 +2457,32 @@ export declare const MedicalContentIdentificationType: {
2457
2457
  */
2458
2458
  export type MedicalContentIdentificationType = (typeof MedicalContentIdentificationType)[keyof typeof MedicalContentIdentificationType];
2459
2459
  /**
2460
- * @public
2461
2460
  * <p>Allows additional optional settings in your request, including channel
2462
2461
  * identification, alternative transcriptions, and speaker partitioning. You can use that to
2463
2462
  * apply custom vocabularies to your medical transcription job.</p>
2463
+ * @public
2464
2464
  */
2465
2465
  export interface MedicalTranscriptionSetting {
2466
2466
  /**
2467
- * @public
2468
2467
  * <p>Enables speaker partitioning (diarization) in your transcription output. Speaker
2469
2468
  * partitioning labels the speech from individual speakers in your media file.</p>
2470
2469
  * <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
2471
2470
  * <code>MaxSpeakerLabels</code>.</p>
2472
2471
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers
2473
2472
  * (diarization)</a>.</p>
2473
+ * @public
2474
2474
  */
2475
2475
  ShowSpeakerLabels?: boolean;
2476
2476
  /**
2477
- * @public
2478
2477
  * <p>Specify the maximum number of speakers you want to partition in your media.</p>
2479
2478
  * <p>Note that if your media contains more speakers than the specified number, multiple
2480
2479
  * speakers are treated as a single speaker.</p>
2481
2480
  * <p>If you specify the <code>MaxSpeakerLabels</code> field, you must set the
2482
2481
  * <code>ShowSpeakerLabels</code> field to true.</p>
2482
+ * @public
2483
2483
  */
2484
2484
  MaxSpeakerLabels?: number;
2485
2485
  /**
2486
- * @public
2487
2486
  * <p>Enables channel identification in multi-channel audio.</p>
2488
2487
  * <p>Channel identification transcribes the audio on each channel independently, then
2489
2488
  * appends the output for each channel into one transcript.</p>
@@ -2492,10 +2491,10 @@ export interface MedicalTranscriptionSetting {
2492
2491
  * by channel.</p>
2493
2492
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
2494
2493
  * audio</a>.</p>
2494
+ * @public
2495
2495
  */
2496
2496
  ChannelIdentification?: boolean;
2497
2497
  /**
2498
- * @public
2499
2498
  * <p>To include alternative transcriptions within your transcription output, include
2500
2499
  * <code>ShowAlternatives</code> in your transcription request.</p>
2501
2500
  * <p>If you include <code>ShowAlternatives</code>, you must also include
@@ -2503,10 +2502,10 @@ export interface MedicalTranscriptionSetting {
2503
2502
  * transcriptions you want Amazon Transcribe Medical to generate.</p>
2504
2503
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
2505
2504
  * transcriptions</a>.</p>
2505
+ * @public
2506
2506
  */
2507
2507
  ShowAlternatives?: boolean;
2508
2508
  /**
2509
- * @public
2510
2509
  * <p>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe
2511
2510
  * Medical to include in your transcript.</p>
2512
2511
  * <p>If you select a number greater than the number of alternative transcriptions generated
@@ -2516,16 +2515,17 @@ export interface MedicalTranscriptionSetting {
2516
2515
  * <code>ShowAlternatives</code> with a value of <code>true</code>.</p>
2517
2516
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
2518
2517
  * transcriptions</a>.</p>
2518
+ * @public
2519
2519
  */
2520
2520
  MaxAlternatives?: number;
2521
2521
  /**
2522
- * @public
2523
2522
  * <p>The name of the custom vocabulary you want to use when processing your medical
2524
2523
  * transcription job. Custom vocabulary names are case sensitive.</p>
2525
2524
  * <p>The language of the specified custom vocabulary must match the language code that you
2526
2525
  * specify in your transcription request. If the languages do not match, the custom
2527
2526
  * vocabulary isn't applied. There are no errors or warnings associated with a language
2528
2527
  * mismatch. US English (<code>en-US</code>) is the only valid language for Amazon Transcribe Medical.</p>
2528
+ * @public
2529
2529
  */
2530
2530
  VocabularyName?: string;
2531
2531
  }
@@ -2541,17 +2541,17 @@ export declare const Specialty: {
2541
2541
  */
2542
2542
  export type Specialty = (typeof Specialty)[keyof typeof Specialty];
2543
2543
  /**
2544
- * @public
2545
2544
  * <p>Provides you with the Amazon S3 URI you can use to access your
2546
2545
  * transcript.</p>
2546
+ * @public
2547
2547
  */
2548
2548
  export interface MedicalTranscript {
2549
2549
  /**
2550
- * @public
2551
2550
  * <p>The Amazon S3 location of your transcript. You can use this URI to access or
2552
2551
  * download your transcript.</p>
2553
2552
  * <p>Note that this is the Amazon S3 location you specified in your request using the
2554
2553
  * <code>OutputBucketName</code> parameter.</p>
2554
+ * @public
2555
2555
  */
2556
2556
  TranscriptFileUri?: string;
2557
2557
  }
@@ -2582,7 +2582,6 @@ export declare const Type: {
2582
2582
  */
2583
2583
  export type Type = (typeof Type)[keyof typeof Type];
2584
2584
  /**
2585
- * @public
2586
2585
  * <p>Provides detailed information about a medical transcription job.</p>
2587
2586
  * <p>To view the status of the specified medical transcription job, check the
2588
2587
  * <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
@@ -2590,81 +2589,81 @@ export type Type = (typeof Type)[keyof typeof Type];
2590
2589
  * <code>TranscriptFileUri</code>. If the status is <code>FAILED</code>,
2591
2590
  * <code>FailureReason</code> provides details on why your transcription job
2592
2591
  * failed.</p>
2592
+ * @public
2593
2593
  */
2594
2594
  export interface MedicalTranscriptionJob {
2595
2595
  /**
2596
- * @public
2597
2596
  * <p>The name of the medical transcription job. Job names are case sensitive and must be
2598
2597
  * unique within an Amazon Web Services account.</p>
2598
+ * @public
2599
2599
  */
2600
2600
  MedicalTranscriptionJobName?: string;
2601
2601
  /**
2602
- * @public
2603
2602
  * <p>Provides the status of the specified medical transcription job.</p>
2604
2603
  * <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
2605
2604
  * results at the location specified in <code>TranscriptFileUri</code>. If the status is
2606
2605
  * <code>FAILED</code>, <code>FailureReason</code> provides details on why your
2607
2606
  * transcription job failed.</p>
2607
+ * @public
2608
2608
  */
2609
2609
  TranscriptionJobStatus?: TranscriptionJobStatus;
2610
2610
  /**
2611
- * @public
2612
2611
  * <p>The language code used to create your medical transcription job. US English
2613
2612
  * (<code>en-US</code>) is the only supported language for medical
2614
2613
  * transcriptions.</p>
2614
+ * @public
2615
2615
  */
2616
2616
  LanguageCode?: LanguageCode;
2617
2617
  /**
2618
- * @public
2619
2618
  * <p>The sample rate, in hertz, of the audio track in your input media file.</p>
2619
+ * @public
2620
2620
  */
2621
2621
  MediaSampleRateHertz?: number;
2622
2622
  /**
2623
- * @public
2624
2623
  * <p>The format of the input media file.</p>
2624
+ * @public
2625
2625
  */
2626
2626
  MediaFormat?: MediaFormat;
2627
2627
  /**
2628
- * @public
2629
2628
  * <p>Describes the Amazon S3 location of the media file you want to use in your
2630
2629
  * request.</p>
2631
2630
  * <p>For information on supported media formats, refer to the <code>MediaFormat</code>
2632
2631
  * parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
2633
2632
  * in the Amazon S3 Developer Guide.</p>
2633
+ * @public
2634
2634
  */
2635
2635
  Media?: Media;
2636
2636
  /**
2637
- * @public
2638
2637
  * <p>Provides you with the Amazon S3 URI you can use to access your
2639
2638
  * transcript.</p>
2639
+ * @public
2640
2640
  */
2641
2641
  Transcript?: MedicalTranscript;
2642
2642
  /**
2643
- * @public
2644
2643
  * <p>The date and time the specified medical transcription job began processing.</p>
2645
2644
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
2646
2645
  * example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
2647
2646
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
2647
+ * @public
2648
2648
  */
2649
2649
  StartTime?: Date;
2650
2650
  /**
2651
- * @public
2652
2651
  * <p>The date and time the specified medical transcription job request was made.</p>
2653
2652
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
2654
2653
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
2655
2654
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
2655
+ * @public
2656
2656
  */
2657
2657
  CreationTime?: Date;
2658
2658
  /**
2659
- * @public
2660
2659
  * <p>The date and time the specified medical transcription job finished processing.</p>
2661
2660
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
2662
2661
  * example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
2663
2662
  * that started processing at 12:33 PM UTC-7 on May 4, 2022.</p>
2663
+ * @public
2664
2664
  */
2665
2665
  CompletionTime?: Date;
2666
2666
  /**
2667
- * @public
2668
2667
  * <p>If <code>TranscriptionJobStatus</code> is <code>FAILED</code>,
2669
2668
  * <code>FailureReason</code> contains information about why the transcription job
2670
2669
  * request failed.</p>
@@ -2714,36 +2713,37 @@ export interface MedicalTranscriptionJob {
2714
2713
  * quotas</a>.</p>
2715
2714
  * </li>
2716
2715
  * </ul>
2716
+ * @public
2717
2717
  */
2718
2718
  FailureReason?: string;
2719
2719
  /**
2720
- * @public
2721
2720
  * <p>Provides information on any additional settings that were included in your request.
2722
2721
  * Additional settings include channel identification, alternative transcriptions, speaker
2723
2722
  * partitioning, custom vocabularies, and custom vocabulary filters.</p>
2723
+ * @public
2724
2724
  */
2725
2725
  Settings?: MedicalTranscriptionSetting;
2726
2726
  /**
2727
- * @public
2728
2727
  * <p>Indicates whether content identification was enabled for your transcription
2729
2728
  * request.</p>
2729
+ * @public
2730
2730
  */
2731
2731
  ContentIdentificationType?: MedicalContentIdentificationType;
2732
2732
  /**
2733
- * @public
2734
2733
  * <p>Describes the medical specialty represented in your media.</p>
2734
+ * @public
2735
2735
  */
2736
2736
  Specialty?: Specialty;
2737
2737
  /**
2738
- * @public
2739
2738
  * <p>Indicates whether the input media is a dictation or a conversation, as specified in
2740
2739
  * the <code>StartMedicalTranscriptionJob</code> request.</p>
2740
+ * @public
2741
2741
  */
2742
2742
  Type?: Type;
2743
2743
  /**
2744
- * @public
2745
2744
  * <p>The tags, each in the form of a key:value pair, assigned to the specified medical
2746
2745
  * transcription job.</p>
2746
+ * @public
2747
2747
  */
2748
2748
  Tags?: Tag[];
2749
2749
  }
@@ -2752,9 +2752,9 @@ export interface MedicalTranscriptionJob {
2752
2752
  */
2753
2753
  export interface GetMedicalTranscriptionJobResponse {
2754
2754
  /**
2755
- * @public
2756
2755
  * <p>Provides detailed information about the specified medical transcription job, including
2757
2756
  * job status and, if applicable, failure reason.</p>
2757
+ * @public
2758
2758
  */
2759
2759
  MedicalTranscriptionJob?: MedicalTranscriptionJob;
2760
2760
  }
@@ -2763,9 +2763,9 @@ export interface GetMedicalTranscriptionJobResponse {
2763
2763
  */
2764
2764
  export interface GetMedicalVocabularyRequest {
2765
2765
  /**
2766
- * @public
2767
2766
  * <p>The name of the custom medical vocabulary you want information about. Custom medical
2768
2767
  * vocabulary names are case sensitive.</p>
2768
+ * @public
2769
2769
  */
2770
2770
  VocabularyName: string | undefined;
2771
2771
  }
@@ -2774,43 +2774,43 @@ export interface GetMedicalVocabularyRequest {
2774
2774
  */
2775
2775
  export interface GetMedicalVocabularyResponse {
2776
2776
  /**
2777
- * @public
2778
2777
  * <p>The name of the custom medical vocabulary you requested information about.</p>
2778
+ * @public
2779
2779
  */
2780
2780
  VocabularyName?: string;
2781
2781
  /**
2782
- * @public
2783
2782
  * <p>The language code you selected for your custom medical vocabulary. US English
2784
2783
  * (<code>en-US</code>) is the only language supported with Amazon Transcribe
2785
2784
  * Medical.</p>
2785
+ * @public
2786
2786
  */
2787
2787
  LanguageCode?: LanguageCode;
2788
2788
  /**
2789
- * @public
2790
2789
  * <p>The processing state of your custom medical vocabulary. If the state is
2791
2790
  * <code>READY</code>, you can use the custom vocabulary in a
2792
2791
  * <code>StartMedicalTranscriptionJob</code> request.</p>
2792
+ * @public
2793
2793
  */
2794
2794
  VocabularyState?: VocabularyState;
2795
2795
  /**
2796
- * @public
2797
2796
  * <p>The date and time the specified custom medical vocabulary was last modified.</p>
2798
2797
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
2799
2798
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
2800
2799
  * 4, 2022.</p>
2800
+ * @public
2801
2801
  */
2802
2802
  LastModifiedTime?: Date;
2803
2803
  /**
2804
- * @public
2805
2804
  * <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code>
2806
2805
  * contains information about why the custom medical vocabulary request failed. See also:
2807
2806
  * <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
2807
+ * @public
2808
2808
  */
2809
2809
  FailureReason?: string;
2810
2810
  /**
2811
- * @public
2812
2811
  * <p>The Amazon S3 location where the specified custom medical vocabulary is stored; use this URI
2813
2812
  * to view or download the custom vocabulary.</p>
2813
+ * @public
2814
2814
  */
2815
2815
  DownloadUri?: string;
2816
2816
  }
@@ -2819,24 +2819,23 @@ export interface GetMedicalVocabularyResponse {
2819
2819
  */
2820
2820
  export interface GetTranscriptionJobRequest {
2821
2821
  /**
2822
- * @public
2823
2822
  * <p>The name of the transcription job you want information about. Job names are case
2824
2823
  * sensitive.</p>
2824
+ * @public
2825
2825
  */
2826
2826
  TranscriptionJobName: string | undefined;
2827
2827
  }
2828
2828
  /**
2829
- * @public
2830
2829
  * <p>Makes it possible to control how your transcription job is processed. Currently, the
2831
2830
  * only <code>JobExecutionSettings</code> modification you can choose is enabling job
2832
2831
  * queueing using the <code>AllowDeferredExecution</code> sub-parameter.</p>
2833
2832
  * <p>If you include <code>JobExecutionSettings</code> in your request, you must also
2834
2833
  * include the sub-parameters: <code>AllowDeferredExecution</code> and
2835
2834
  * <code>DataAccessRoleArn</code>.</p>
2835
+ * @public
2836
2836
  */
2837
2837
  export interface JobExecutionSettings {
2838
2838
  /**
2839
- * @public
2840
2839
  * <p>Makes it possible to enable job queuing when your concurrent request limit is
2841
2840
  * exceeded. When <code>AllowDeferredExecution</code> is set to <code>true</code>,
2842
2841
  * transcription job requests are placed in a queue until the number of jobs falls below
@@ -2845,10 +2844,10 @@ export interface JobExecutionSettings {
2845
2844
  * concurrent request limit, you get a <code>LimitExceededException</code> error.</p>
2846
2845
  * <p>If you include <code>AllowDeferredExecution</code> in your request, you must also
2847
2846
  * include <code>DataAccessRoleArn</code>.</p>
2847
+ * @public
2848
2848
  */
2849
2849
  AllowDeferredExecution?: boolean;
2850
2850
  /**
2851
- * @public
2852
2851
  * <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
2853
2852
  * access the Amazon S3 bucket that contains your input files. If the role that you
2854
2853
  * specify doesn’t have the appropriate permissions to access the specified Amazon S3
@@ -2859,31 +2858,31 @@ export interface JobExecutionSettings {
2859
2858
  * ARNs</a>.</p>
2860
2859
  * <p>Note that if you include <code>DataAccessRoleArn</code> in your request, you must also
2861
2860
  * include <code>AllowDeferredExecution</code>.</p>
2861
+ * @public
2862
2862
  */
2863
2863
  DataAccessRoleArn?: string;
2864
2864
  }
2865
2865
  /**
2866
- * @public
2867
2866
  * <p>Provides information on the speech contained in a discreet utterance when
2868
2867
  * multi-language identification is enabled in your request. This utterance represents a
2869
2868
  * block of speech consisting of one language, preceded or followed by a block of speech in
2870
2869
  * a different language.</p>
2870
+ * @public
2871
2871
  */
2872
2872
  export interface LanguageCodeItem {
2873
2873
  /**
2874
- * @public
2875
2874
  * <p>Provides the language code for each language identified in your media.</p>
2875
+ * @public
2876
2876
  */
2877
2877
  LanguageCode?: LanguageCode;
2878
2878
  /**
2879
- * @public
2880
2879
  * <p>Provides the total time, in seconds, each identified language is spoken in your
2881
2880
  * media.</p>
2881
+ * @public
2882
2882
  */
2883
2883
  DurationInSeconds?: number;
2884
2884
  }
2885
2885
  /**
2886
- * @public
2887
2886
  * <p>Provides the name of the custom language model that was included in the specified
2888
2887
  * transcription job.</p>
2889
2888
  * <p>Only use <code>ModelSettings</code> with the <code>LanguageModelName</code>
@@ -2891,63 +2890,63 @@ export interface LanguageCodeItem {
2891
2890
  * identification (<code></code>). If using
2892
2891
  * <code>LanguageIdSettings</code> in your request, this parameter contains a
2893
2892
  * <code>LanguageModelName</code> sub-parameter.</p>
2893
+ * @public
2894
2894
  */
2895
2895
  export interface ModelSettings {
2896
2896
  /**
2897
- * @public
2898
2897
  * <p>The name of the custom language model you want to use when processing your
2899
2898
  * transcription job. Note that custom language model names are case sensitive.</p>
2900
2899
  * <p>The language of the specified custom language model must match the language code that
2901
2900
  * you specify in your transcription request. If the languages do not match, the custom
2902
2901
  * language model isn't applied. There are no errors or warnings associated with a language
2903
2902
  * mismatch.</p>
2903
+ * @public
2904
2904
  */
2905
2905
  LanguageModelName?: string;
2906
2906
  }
2907
2907
  /**
2908
- * @public
2909
2908
  * <p>Allows additional optional settings in your
2910
2909
  * request, including channel identification, alternative transcriptions, and speaker
2911
2910
  * partitioning. You can use that to apply custom vocabularies to your transcription
2912
2911
  * job.</p>
2912
+ * @public
2913
2913
  */
2914
2914
  export interface Settings {
2915
2915
  /**
2916
- * @public
2917
2916
  * <p>The name of the custom vocabulary you want to use in your transcription job request.
2918
2917
  * This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.</p>
2918
+ * @public
2919
2919
  */
2920
2920
  VocabularyName?: string;
2921
2921
  /**
2922
- * @public
2923
2922
  * <p>Enables speaker partitioning (diarization) in your transcription output. Speaker
2924
2923
  * partitioning labels the speech from individual speakers in your media file.</p>
2925
2924
  * <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
2926
2925
  * <code>MaxSpeakerLabels</code>.</p>
2927
2926
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers
2928
2927
  * (diarization)</a>.</p>
2928
+ * @public
2929
2929
  */
2930
2930
  ShowSpeakerLabels?: boolean;
2931
2931
  /**
2932
- * @public
2933
2932
  * <p>Specify the maximum number of speakers you want to partition in your media.</p>
2934
2933
  * <p>Note that if your media contains more speakers than the specified number, multiple
2935
2934
  * speakers are treated as a single speaker.</p>
2936
2935
  * <p>If you specify the <code>MaxSpeakerLabels</code> field, you must set the
2937
2936
  * <code>ShowSpeakerLabels</code> field to true.</p>
2937
+ * @public
2938
2938
  */
2939
2939
  MaxSpeakerLabels?: number;
2940
2940
  /**
2941
- * @public
2942
2941
  * <p>Enables channel identification in multi-channel audio.</p>
2943
2942
  * <p>Channel identification transcribes the audio on each channel independently, then
2944
2943
  * appends the output for each channel into one transcript.</p>
2945
2944
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
2946
2945
  * audio</a>.</p>
2946
+ * @public
2947
2947
  */
2948
2948
  ChannelIdentification?: boolean;
2949
2949
  /**
2950
- * @public
2951
2950
  * <p>To include alternative transcriptions within your transcription output, include
2952
2951
  * <code>ShowAlternatives</code> in your transcription request.</p>
2953
2952
  * <p>If you have multi-channel audio and do not enable channel identification, your audio
@@ -2958,10 +2957,10 @@ export interface Settings {
2958
2957
  * transcriptions you want Amazon Transcribe to generate.</p>
2959
2958
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
2960
2959
  * transcriptions</a>.</p>
2960
+ * @public
2961
2961
  */
2962
2962
  ShowAlternatives?: boolean;
2963
2963
  /**
2964
- * @public
2965
2964
  * <p>Indicate the maximum number of alternative transcriptions you want Amazon Transcribe
2966
2965
  * to include in your transcript.</p>
2967
2966
  * <p>If you select a number greater than the number of alternative transcriptions generated
@@ -2971,23 +2970,24 @@ export interface Settings {
2971
2970
  * <code>ShowAlternatives</code> with a value of <code>true</code>.</p>
2972
2971
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-alternatives.html">Alternative
2973
2972
  * transcriptions</a>.</p>
2973
+ * @public
2974
2974
  */
2975
2975
  MaxAlternatives?: number;
2976
2976
  /**
2977
- * @public
2978
2977
  * <p>The name of the custom vocabulary filter you want to use in your transcription job
2979
2978
  * request. This name is case sensitive, cannot contain spaces, and must be unique within
2980
2979
  * an Amazon Web Services account.</p>
2981
2980
  * <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
2982
2981
  * also include <code>VocabularyFilterMethod</code>.</p>
2982
+ * @public
2983
2983
  */
2984
2984
  VocabularyFilterName?: string;
2985
2985
  /**
2986
- * @public
2987
2986
  * <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
2988
2987
  * <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
2989
2988
  * <p>To delete words, choose <code>remove</code>.</p>
2990
2989
  * <p>To flag words without changing them, choose <code>tag</code>.</p>
2990
+ * @public
2991
2991
  */
2992
2992
  VocabularyFilterMethod?: VocabularyFilterMethod;
2993
2993
  }
@@ -3004,20 +3004,19 @@ export declare const SubtitleFormat: {
3004
3004
  */
3005
3005
  export type SubtitleFormat = (typeof SubtitleFormat)[keyof typeof SubtitleFormat];
3006
3006
  /**
3007
- * @public
3008
3007
  * <p>Provides information about your subtitle file, including format, start index, and
3009
3008
  * Amazon S3 location.</p>
3009
+ * @public
3010
3010
  */
3011
3011
  export interface SubtitlesOutput {
3012
3012
  /**
3013
- * @public
3014
3013
  * <p>Provides the format of your subtitle files. If your request included both WebVTT
3015
3014
  * (<code>vtt</code>) and SubRip (<code>srt</code>) formats, both formats are
3016
3015
  * shown.</p>
3016
+ * @public
3017
3017
  */
3018
3018
  Formats?: SubtitleFormat[];
3019
3019
  /**
3020
- * @public
3021
3020
  * <p>The Amazon S3 location of your transcript. You can use this URI to access or
3022
3021
  * download your subtitle file. Your subtitle file is stored in the same location as your
3023
3022
  * transcript. If you specified both WebVTT and SubRip subtitle formats, two URIs are
@@ -3035,12 +3034,13 @@ export interface SubtitlesOutput {
3035
3034
  * URI by running a <code>GetTranscriptionJob</code> or
3036
3035
  * <code>ListTranscriptionJob</code> request.</p>
3037
3036
  * </note>
3037
+ * @public
3038
3038
  */
3039
3039
  SubtitleFileUris?: string[];
3040
3040
  /**
3041
- * @public
3042
3041
  * <p>Provides the start index value for your subtitle files. If you did not specify a value
3043
3042
  * in your request, the default value of <code>0</code> is used.</p>
3043
+ * @public
3044
3044
  */
3045
3045
  OutputStartIndex?: number;
3046
3046
  }
@@ -3056,22 +3056,21 @@ export declare const ToxicityCategory: {
3056
3056
  */
3057
3057
  export type ToxicityCategory = (typeof ToxicityCategory)[keyof typeof ToxicityCategory];
3058
3058
  /**
3059
- * @public
3060
3059
  * <p>Contains <code>ToxicityCategories</code>, which is a required parameter if you
3061
3060
  * want to enable toxicity detection (<code>ToxicityDetection</code>) in your transcription
3062
3061
  * request.</p>
3062
+ * @public
3063
3063
  */
3064
3064
  export interface ToxicityDetectionSettings {
3065
3065
  /**
3066
- * @public
3067
3066
  * <p> If you include <code>ToxicityDetection</code> in your transcription request, you
3068
3067
  * must also include <code>ToxicityCategories</code>. The only accepted value for this
3069
3068
  * parameter is <code>ALL</code>.</p>
3069
+ * @public
3070
3070
  */
3071
3071
  ToxicityCategories: ToxicityCategory[] | undefined;
3072
3072
  }
3073
3073
  /**
3074
- * @public
3075
3074
  * <p>Provides detailed information about a transcription job.</p>
3076
3075
  * <p>To view the status of the specified transcription job, check the
3077
3076
  * <code>TranscriptionJobStatus</code> field. If the status is <code>COMPLETED</code>,
@@ -3081,79 +3080,79 @@ export interface ToxicityDetectionSettings {
3081
3080
  * failed.</p>
3082
3081
  * <p>If you enabled content redaction, the redacted transcript can be found at the location
3083
3082
  * specified in <code>RedactedTranscriptFileUri</code>.</p>
3083
+ * @public
3084
3084
  */
3085
3085
  export interface TranscriptionJob {
3086
3086
  /**
3087
- * @public
3088
3087
  * <p>The name of the transcription job. Job names are case sensitive and must be unique
3089
3088
  * within an Amazon Web Services account.</p>
3089
+ * @public
3090
3090
  */
3091
3091
  TranscriptionJobName?: string;
3092
3092
  /**
3093
- * @public
3094
3093
  * <p>Provides the status of the specified transcription job.</p>
3095
3094
  * <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
3096
3095
  * results at the location specified in <code>TranscriptFileUri</code> (or
3097
3096
  * <code>RedactedTranscriptFileUri</code>, if you requested transcript redaction). If
3098
3097
  * the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
3099
3098
  * your transcription job failed.</p>
3099
+ * @public
3100
3100
  */
3101
3101
  TranscriptionJobStatus?: TranscriptionJobStatus;
3102
3102
  /**
3103
- * @public
3104
3103
  * <p>The language code used to create your transcription job. This parameter is used with
3105
3104
  * single-language identification. For multi-language identification requests, refer to the
3106
3105
  * plural version of this parameter, <code>LanguageCodes</code>.</p>
3106
+ * @public
3107
3107
  */
3108
3108
  LanguageCode?: LanguageCode;
3109
3109
  /**
3110
- * @public
3111
3110
  * <p>The sample rate, in hertz, of the audio track in your input media file.</p>
3111
+ * @public
3112
3112
  */
3113
3113
  MediaSampleRateHertz?: number;
3114
3114
  /**
3115
- * @public
3116
3115
  * <p>The format of the input media file.</p>
3116
+ * @public
3117
3117
  */
3118
3118
  MediaFormat?: MediaFormat;
3119
3119
  /**
3120
- * @public
3121
3120
  * <p>Provides the Amazon S3 location of the media file you used in your
3122
3121
  * request.</p>
3122
+ * @public
3123
3123
  */
3124
3124
  Media?: Media;
3125
3125
  /**
3126
- * @public
3127
3126
  * <p>Provides you with the Amazon S3 URI you can use to access your
3128
3127
  * transcript.</p>
3128
+ * @public
3129
3129
  */
3130
3130
  Transcript?: Transcript;
3131
3131
  /**
3132
- * @public
3133
3132
  * <p>The date and time the specified transcription job began processing.</p>
3134
3133
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3135
3134
  * example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
3136
3135
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
3136
+ * @public
3137
3137
  */
3138
3138
  StartTime?: Date;
3139
3139
  /**
3140
- * @public
3141
3140
  * <p>The date and time the specified transcription job request was made.</p>
3142
3141
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3143
3142
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
3144
3143
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
3144
+ * @public
3145
3145
  */
3146
3146
  CreationTime?: Date;
3147
3147
  /**
3148
- * @public
3149
3148
  * <p>The date and time the specified transcription job finished processing.</p>
3150
3149
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3151
3150
  * example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
3152
3151
  * that started processing at 12:33 PM UTC-7 on May 4, 2022.</p>
3152
+ * @public
3153
3153
  */
3154
3154
  CompletionTime?: Date;
3155
3155
  /**
3156
- * @public
3157
3156
  * <p>If <code>TranscriptionJobStatus</code> is <code>FAILED</code>,
3158
3157
  * <code>FailureReason</code> contains information about why the transcription job
3159
3158
  * request failed.</p>
@@ -3203,84 +3202,85 @@ export interface TranscriptionJob {
3203
3202
  * quotas</a>.</p>
3204
3203
  * </li>
3205
3204
  * </ul>
3205
+ * @public
3206
3206
  */
3207
3207
  FailureReason?: string;
3208
3208
  /**
3209
- * @public
3210
3209
  * <p>Provides information on any additional settings that were included in your request.
3211
3210
  * Additional settings include channel identification, alternative transcriptions, speaker
3212
3211
  * partitioning, custom vocabularies, and custom vocabulary filters.</p>
3212
+ * @public
3213
3213
  */
3214
3214
  Settings?: Settings;
3215
3215
  /**
3216
- * @public
3217
3216
  * <p>Provides information on the custom language model you included in your request.</p>
3217
+ * @public
3218
3218
  */
3219
3219
  ModelSettings?: ModelSettings;
3220
3220
  /**
3221
- * @public
3222
3221
  * <p>Provides information about how your transcription job was processed. This parameter
3223
3222
  * shows if your request was queued and what data access role was used.</p>
3223
+ * @public
3224
3224
  */
3225
3225
  JobExecutionSettings?: JobExecutionSettings;
3226
3226
  /**
3227
- * @public
3228
3227
  * <p>Indicates whether redaction was enabled in your transcript.</p>
3228
+ * @public
3229
3229
  */
3230
3230
  ContentRedaction?: ContentRedaction;
3231
3231
  /**
3232
- * @public
3233
3232
  * <p>Indicates whether automatic language identification was enabled (<code>TRUE</code>)
3234
3233
  * for the specified transcription job.</p>
3234
+ * @public
3235
3235
  */
3236
3236
  IdentifyLanguage?: boolean;
3237
3237
  /**
3238
- * @public
3239
3238
  * <p>Indicates whether automatic multi-language identification was enabled
3240
3239
  * (<code>TRUE</code>) for the specified transcription job.</p>
3240
+ * @public
3241
3241
  */
3242
3242
  IdentifyMultipleLanguages?: boolean;
3243
3243
  /**
3244
- * @public
3245
3244
  * <p>Provides the language codes you specified in your request.</p>
3245
+ * @public
3246
3246
  */
3247
3247
  LanguageOptions?: LanguageCode[];
3248
3248
  /**
3249
- * @public
3250
3249
  * <p>The confidence score associated with the language identified in your media
3251
3250
  * file.</p>
3252
3251
  * <p>Confidence scores are values between 0 and 1; a larger value indicates a higher
3253
3252
  * probability that the identified language correctly matches the language spoken in your
3254
3253
  * media.</p>
3254
+ * @public
3255
3255
  */
3256
3256
  IdentifiedLanguageScore?: number;
3257
3257
  /**
3258
- * @public
3259
3258
  * <p>The language codes used to create your transcription job. This parameter is used with
3260
3259
  * multi-language identification. For single-language identification requests, refer to the
3261
3260
  * singular version of this parameter, <code>LanguageCode</code>.</p>
3261
+ * @public
3262
3262
  */
3263
3263
  LanguageCodes?: LanguageCodeItem[];
3264
3264
  /**
3265
- * @public
3266
3265
  * <p>The tags, each in the form of a key:value pair, assigned to the specified
3267
3266
  * transcription job.</p>
3267
+ * @public
3268
3268
  */
3269
3269
  Tags?: Tag[];
3270
3270
  /**
3271
- * @public
3272
3271
  * <p>Indicates whether subtitles were generated with your transcription.</p>
3272
+ * @public
3273
3273
  */
3274
3274
  Subtitles?: SubtitlesOutput;
3275
3275
  /**
3276
- * @public
3277
3276
  * <p>Provides the name and language of all custom language models, custom vocabularies, and
3278
3277
  * custom vocabulary filters that you included in your request.</p>
3278
+ * @public
3279
3279
  */
3280
3280
  LanguageIdSettings?: Partial<Record<LanguageCode, LanguageIdSettings>>;
3281
3281
  /**
3282
- * @public
3283
3282
  * <p>Provides information about the toxicity detection settings applied to your transcription.</p>
3283
+ * @public
3284
3284
  */
3285
3285
  ToxicityDetection?: ToxicityDetectionSettings[];
3286
3286
  }
@@ -3289,9 +3289,9 @@ export interface TranscriptionJob {
3289
3289
  */
3290
3290
  export interface GetTranscriptionJobResponse {
3291
3291
  /**
3292
- * @public
3293
3292
  * <p>Provides detailed information about the specified transcription job, including job
3294
3293
  * status and, if applicable, failure reason.</p>
3294
+ * @public
3295
3295
  */
3296
3296
  TranscriptionJob?: TranscriptionJob;
3297
3297
  }
@@ -3300,9 +3300,9 @@ export interface GetTranscriptionJobResponse {
3300
3300
  */
3301
3301
  export interface GetVocabularyRequest {
3302
3302
  /**
3303
- * @public
3304
3303
  * <p>The name of the custom vocabulary you want information about. Custom vocabulary names
3305
3304
  * are case sensitive.</p>
3305
+ * @public
3306
3306
  */
3307
3307
  VocabularyName: string | undefined;
3308
3308
  }
@@ -3311,41 +3311,41 @@ export interface GetVocabularyRequest {
3311
3311
  */
3312
3312
  export interface GetVocabularyResponse {
3313
3313
  /**
3314
- * @public
3315
3314
  * <p>The name of the custom vocabulary you requested information about.</p>
3315
+ * @public
3316
3316
  */
3317
3317
  VocabularyName?: string;
3318
3318
  /**
3319
- * @public
3320
3319
  * <p>The language code you selected for your custom vocabulary.</p>
3320
+ * @public
3321
3321
  */
3322
3322
  LanguageCode?: LanguageCode;
3323
3323
  /**
3324
- * @public
3325
3324
  * <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
3326
3325
  * you can use the custom vocabulary in a <code>StartTranscriptionJob</code>
3327
3326
  * request.</p>
3327
+ * @public
3328
3328
  */
3329
3329
  VocabularyState?: VocabularyState;
3330
3330
  /**
3331
- * @public
3332
3331
  * <p>The date and time the specified custom vocabulary was last modified.</p>
3333
3332
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3334
3333
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
3335
3334
  * 4, 2022.</p>
3335
+ * @public
3336
3336
  */
3337
3337
  LastModifiedTime?: Date;
3338
3338
  /**
3339
- * @public
3340
3339
  * <p>If <code>VocabularyState</code> is <code>FAILED</code>, <code>FailureReason</code>
3341
3340
  * contains information about why the custom vocabulary request failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common
3342
3341
  * Errors</a>.</p>
3342
+ * @public
3343
3343
  */
3344
3344
  FailureReason?: string;
3345
3345
  /**
3346
- * @public
3347
3346
  * <p>The Amazon S3 location where the custom vocabulary is stored; use this URI to view or
3348
3347
  * download the custom vocabulary.</p>
3348
+ * @public
3349
3349
  */
3350
3350
  DownloadUri?: string;
3351
3351
  }
@@ -3354,9 +3354,9 @@ export interface GetVocabularyResponse {
3354
3354
  */
3355
3355
  export interface GetVocabularyFilterRequest {
3356
3356
  /**
3357
- * @public
3358
3357
  * <p>The name of the custom vocabulary filter you want information about. Custom vocabulary
3359
3358
  * filter names are case sensitive.</p>
3359
+ * @public
3360
3360
  */
3361
3361
  VocabularyFilterName: string | undefined;
3362
3362
  }
@@ -3365,27 +3365,27 @@ export interface GetVocabularyFilterRequest {
3365
3365
  */
3366
3366
  export interface GetVocabularyFilterResponse {
3367
3367
  /**
3368
- * @public
3369
3368
  * <p>The name of the custom vocabulary filter you requested information about.</p>
3369
+ * @public
3370
3370
  */
3371
3371
  VocabularyFilterName?: string;
3372
3372
  /**
3373
- * @public
3374
3373
  * <p>The language code you selected for your custom vocabulary filter.</p>
3374
+ * @public
3375
3375
  */
3376
3376
  LanguageCode?: LanguageCode;
3377
3377
  /**
3378
- * @public
3379
3378
  * <p>The date and time the specified custom vocabulary filter was last modified.</p>
3380
3379
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3381
3380
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
3382
3381
  * 4, 2022.</p>
3382
+ * @public
3383
3383
  */
3384
3384
  LastModifiedTime?: Date;
3385
3385
  /**
3386
- * @public
3387
3386
  * <p>The Amazon S3 location where the custom vocabulary filter is stored; use this
3388
3387
  * URI to view or download the custom vocabulary filter.</p>
3388
+ * @public
3389
3389
  */
3390
3390
  DownloadUri?: string;
3391
3391
  }
@@ -3394,19 +3394,19 @@ export interface GetVocabularyFilterResponse {
3394
3394
  */
3395
3395
  export interface ListCallAnalyticsCategoriesRequest {
3396
3396
  /**
3397
- * @public
3398
3397
  * <p>If your <code>ListCallAnalyticsCategories</code> request returns more results than can
3399
3398
  * be displayed, <code>NextToken</code> is displayed in the response with an associated
3400
3399
  * string. To get the next page of results, copy this string and repeat your request,
3401
3400
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3402
3401
  * to view all your results.</p>
3402
+ * @public
3403
3403
  */
3404
3404
  NextToken?: string;
3405
3405
  /**
3406
- * @public
3407
3406
  * <p>The maximum number of Call Analytics categories to return in each page of results. If
3408
3407
  * there are fewer results than the value that you specify, only the actual results are
3409
3408
  * returned. If you do not specify a value, a default of 5 is used.</p>
3409
+ * @public
3410
3410
  */
3411
3411
  MaxResults?: number;
3412
3412
  }
@@ -3415,18 +3415,18 @@ export interface ListCallAnalyticsCategoriesRequest {
3415
3415
  */
3416
3416
  export interface ListCallAnalyticsCategoriesResponse {
3417
3417
  /**
3418
- * @public
3419
3418
  * <p>If <code>NextToken</code> is present in your response, it indicates that not all
3420
3419
  * results are displayed. To view the next set of results, copy the string associated with
3421
3420
  * the <code>NextToken</code> parameter in your results output, then run your request again
3422
3421
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3423
3422
  * to view all your results.</p>
3423
+ * @public
3424
3424
  */
3425
3425
  NextToken?: string;
3426
3426
  /**
3427
- * @public
3428
3427
  * <p>Provides detailed information about your Call Analytics categories, including all the
3429
3428
  * rules associated with each category.</p>
3429
+ * @public
3430
3430
  */
3431
3431
  Categories?: CategoryProperties[];
3432
3432
  }
@@ -3435,32 +3435,32 @@ export interface ListCallAnalyticsCategoriesResponse {
3435
3435
  */
3436
3436
  export interface ListCallAnalyticsJobsRequest {
3437
3437
  /**
3438
- * @public
3439
3438
  * <p>Returns only Call Analytics jobs with the specified status. Jobs are ordered by
3440
3439
  * creation date, with the newest job first. If you do not include <code>Status</code>, all
3441
3440
  * Call Analytics jobs are returned.</p>
3441
+ * @public
3442
3442
  */
3443
3443
  Status?: CallAnalyticsJobStatus;
3444
3444
  /**
3445
- * @public
3446
3445
  * <p>Returns only the Call Analytics jobs that contain the specified string. The search is
3447
3446
  * not case sensitive.</p>
3447
+ * @public
3448
3448
  */
3449
3449
  JobNameContains?: string;
3450
3450
  /**
3451
- * @public
3452
3451
  * <p>If your <code>ListCallAnalyticsJobs</code> request returns more results than can be
3453
3452
  * displayed, <code>NextToken</code> is displayed in the response with an associated
3454
3453
  * string. To get the next page of results, copy this string and repeat your request,
3455
3454
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3456
3455
  * to view all your results.</p>
3456
+ * @public
3457
3457
  */
3458
3458
  NextToken?: string;
3459
3459
  /**
3460
- * @public
3461
3460
  * <p>The maximum number of Call Analytics jobs to return in each page of results. If there
3462
3461
  * are fewer results than the value that you specify, only the actual results are returned.
3463
3462
  * If you do not specify a value, a default of 5 is used.</p>
3463
+ * @public
3464
3464
  */
3465
3465
  MaxResults?: number;
3466
3466
  }
@@ -3469,23 +3469,23 @@ export interface ListCallAnalyticsJobsRequest {
3469
3469
  */
3470
3470
  export interface ListCallAnalyticsJobsResponse {
3471
3471
  /**
3472
- * @public
3473
3472
  * <p>Lists all Call Analytics jobs that have the status specified in your request. Jobs are
3474
3473
  * ordered by creation date, with the newest job first.</p>
3474
+ * @public
3475
3475
  */
3476
3476
  Status?: CallAnalyticsJobStatus;
3477
3477
  /**
3478
- * @public
3479
3478
  * <p>If <code>NextToken</code> is present in your response, it indicates that not all
3480
3479
  * results are displayed. To view the next set of results, copy the string associated with
3481
3480
  * the <code>NextToken</code> parameter in your results output, then run your request again
3482
3481
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3483
3482
  * to view all your results.</p>
3483
+ * @public
3484
3484
  */
3485
3485
  NextToken?: string;
3486
3486
  /**
3487
- * @public
3488
3487
  * <p>Provides a summary of information about each result.</p>
3488
+ * @public
3489
3489
  */
3490
3490
  CallAnalyticsJobSummaries?: CallAnalyticsJobSummary[];
3491
3491
  }
@@ -3494,32 +3494,32 @@ export interface ListCallAnalyticsJobsResponse {
3494
3494
  */
3495
3495
  export interface ListLanguageModelsRequest {
3496
3496
  /**
3497
- * @public
3498
3497
  * <p>Returns only custom language models with the specified status. Language models are
3499
3498
  * ordered by creation date, with the newest model first. If you do not include
3500
3499
  * <code>StatusEquals</code>, all custom language models are returned.</p>
3500
+ * @public
3501
3501
  */
3502
3502
  StatusEquals?: ModelStatus;
3503
3503
  /**
3504
- * @public
3505
3504
  * <p>Returns only the custom language models that contain the specified string. The search
3506
3505
  * is not case sensitive.</p>
3506
+ * @public
3507
3507
  */
3508
3508
  NameContains?: string;
3509
3509
  /**
3510
- * @public
3511
3510
  * <p>If your <code>ListLanguageModels</code> request returns more results than can be
3512
3511
  * displayed, <code>NextToken</code> is displayed in the response with an associated
3513
3512
  * string. To get the next page of results, copy this string and repeat your request,
3514
3513
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3515
3514
  * to view all your results.</p>
3515
+ * @public
3516
3516
  */
3517
3517
  NextToken?: string;
3518
3518
  /**
3519
- * @public
3520
3519
  * <p>The maximum number of custom language models to return in each page of results. If
3521
3520
  * there are fewer results than the value that you specify, only the actual results are
3522
3521
  * returned. If you do not specify a value, a default of 5 is used.</p>
3522
+ * @public
3523
3523
  */
3524
3524
  MaxResults?: number;
3525
3525
  }
@@ -3528,18 +3528,18 @@ export interface ListLanguageModelsRequest {
3528
3528
  */
3529
3529
  export interface ListLanguageModelsResponse {
3530
3530
  /**
3531
- * @public
3532
3531
  * <p>If <code>NextToken</code> is present in your response, it indicates that not all
3533
3532
  * results are displayed. To view the next set of results, copy the string associated with
3534
3533
  * the <code>NextToken</code> parameter in your results output, then run your request again
3535
3534
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3536
3535
  * to view all your results.</p>
3536
+ * @public
3537
3537
  */
3538
3538
  NextToken?: string;
3539
3539
  /**
3540
- * @public
3541
3540
  * <p>Provides information about the custom language models that match the criteria
3542
3541
  * specified in your request.</p>
3542
+ * @public
3543
3543
  */
3544
3544
  Models?: LanguageModel[];
3545
3545
  }
@@ -3548,90 +3548,90 @@ export interface ListLanguageModelsResponse {
3548
3548
  */
3549
3549
  export interface ListMedicalScribeJobsRequest {
3550
3550
  /**
3551
- * @public
3552
3551
  * <p>Returns only Medical Scribe jobs with the specified status. Jobs are ordered by
3553
3552
  * creation date, with the newest job first. If you do not include <code>Status</code>, all
3554
3553
  * Medical Scribe jobs are returned.</p>
3554
+ * @public
3555
3555
  */
3556
3556
  Status?: MedicalScribeJobStatus;
3557
3557
  /**
3558
- * @public
3559
3558
  * <p>Returns only the Medical Scribe jobs that contain the specified string. The
3560
3559
  * search is not case sensitive.</p>
3560
+ * @public
3561
3561
  */
3562
3562
  JobNameContains?: string;
3563
3563
  /**
3564
- * @public
3565
3564
  * <p>If your <code>ListMedicalScribeJobs</code> request returns more results than
3566
3565
  * can be displayed, <code>NextToken</code> is displayed in the response with an associated
3567
3566
  * string. To get the next page of results, copy this string and repeat your request,
3568
3567
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3569
3568
  * to view all your results.</p>
3569
+ * @public
3570
3570
  */
3571
3571
  NextToken?: string;
3572
3572
  /**
3573
- * @public
3574
3573
  * <p>The maximum number of Medical Scribe jobs to return in each page of results. If
3575
3574
  * there are fewer results than the value that you specify, only the actual results are
3576
3575
  * returned. If you do not specify a value, a default of 5 is used.</p>
3576
+ * @public
3577
3577
  */
3578
3578
  MaxResults?: number;
3579
3579
  }
3580
3580
  /**
3581
- * @public
3582
3581
  * <p>Provides detailed information about a specific Medical Scribe job.</p>
3582
+ * @public
3583
3583
  */
3584
3584
  export interface MedicalScribeJobSummary {
3585
3585
  /**
3586
- * @public
3587
3586
  * <p>The name of the Medical Scribe job. Job names are case sensitive and must be
3588
3587
  * unique within an Amazon Web Services account.</p>
3588
+ * @public
3589
3589
  */
3590
3590
  MedicalScribeJobName?: string;
3591
3591
  /**
3592
- * @public
3593
3592
  * <p>The date and time the specified Medical Scribe job request was made.</p>
3594
3593
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3595
3594
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a Medical Scribe job
3596
3595
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
3596
+ * @public
3597
3597
  */
3598
3598
  CreationTime?: Date;
3599
3599
  /**
3600
- * @public
3601
3600
  * <p>The date and time your Medical Scribe job began processing.</p>
3602
3601
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3603
3602
  * example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a Medical Scribe job
3604
3603
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
3604
+ * @public
3605
3605
  */
3606
3606
  StartTime?: Date;
3607
3607
  /**
3608
- * @public
3609
3608
  * <p>The date and time the specified Medical Scribe job finished processing.</p>
3610
3609
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3611
3610
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a Medical Scribe job
3612
3611
  * that finished processing at 12:32 PM UTC-7 on May 4, 2022.</p>
3612
+ * @public
3613
3613
  */
3614
3614
  CompletionTime?: Date;
3615
3615
  /**
3616
- * @public
3617
3616
  * <p>The language code used to create your Medical Scribe job. US English
3618
3617
  * (<code>en-US</code>) is the only supported language for Medical Scribe jobs. </p>
3618
+ * @public
3619
3619
  */
3620
3620
  LanguageCode?: MedicalScribeLanguageCode;
3621
3621
  /**
3622
- * @public
3623
3622
  * <p>Provides the status of the specified Medical Scribe job.</p>
3624
3623
  * <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
3625
3624
  * results at the location specified in <code>MedicalScribeOutput</code> If
3626
3625
  * the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
3627
3626
  * your Medical Scribe job failed.</p>
3627
+ * @public
3628
3628
  */
3629
3629
  MedicalScribeJobStatus?: MedicalScribeJobStatus;
3630
3630
  /**
3631
- * @public
3632
3631
  * <p>If <code>MedicalScribeJobStatus</code> is <code>FAILED</code>,
3633
3632
  * <code>FailureReason</code> contains information about why the transcription job
3634
3633
  * failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
3634
+ * @public
3635
3635
  */
3636
3636
  FailureReason?: string;
3637
3637
  }
@@ -3640,23 +3640,23 @@ export interface MedicalScribeJobSummary {
3640
3640
  */
3641
3641
  export interface ListMedicalScribeJobsResponse {
3642
3642
  /**
3643
- * @public
3644
3643
  * <p>Lists all Medical Scribe jobs that have the status specified in your request.
3645
3644
  * Jobs are ordered by creation date, with the newest job first.</p>
3645
+ * @public
3646
3646
  */
3647
3647
  Status?: MedicalScribeJobStatus;
3648
3648
  /**
3649
- * @public
3650
3649
  * <p>If <code>NextToken</code> is present in your response, it indicates that not all
3651
3650
  * results are displayed. To view the next set of results, copy the string associated with
3652
3651
  * the <code>NextToken</code> parameter in your results output, then run your request again
3653
3652
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3654
3653
  * to view all your results.</p>
3654
+ * @public
3655
3655
  */
3656
3656
  NextToken?: string;
3657
3657
  /**
3658
- * @public
3659
3658
  * <p>Provides a summary of information about each result.</p>
3659
+ * @public
3660
3660
  */
3661
3661
  MedicalScribeJobSummaries?: MedicalScribeJobSummary[];
3662
3662
  }
@@ -3665,32 +3665,32 @@ export interface ListMedicalScribeJobsResponse {
3665
3665
  */
3666
3666
  export interface ListMedicalTranscriptionJobsRequest {
3667
3667
  /**
3668
- * @public
3669
3668
  * <p>Returns only medical transcription jobs with the specified status. Jobs are ordered by
3670
3669
  * creation date, with the newest job first. If you do not include <code>Status</code>, all
3671
3670
  * medical transcription jobs are returned.</p>
3671
+ * @public
3672
3672
  */
3673
3673
  Status?: TranscriptionJobStatus;
3674
3674
  /**
3675
- * @public
3676
3675
  * <p>Returns only the medical transcription jobs that contain the specified string. The
3677
3676
  * search is not case sensitive.</p>
3677
+ * @public
3678
3678
  */
3679
3679
  JobNameContains?: string;
3680
3680
  /**
3681
- * @public
3682
3681
  * <p>If your <code>ListMedicalTranscriptionJobs</code> request returns more results than
3683
3682
  * can be displayed, <code>NextToken</code> is displayed in the response with an associated
3684
3683
  * string. To get the next page of results, copy this string and repeat your request,
3685
3684
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3686
3685
  * to view all your results.</p>
3686
+ * @public
3687
3687
  */
3688
3688
  NextToken?: string;
3689
3689
  /**
3690
- * @public
3691
3690
  * <p>The maximum number of medical transcription jobs to return in each page of results. If
3692
3691
  * there are fewer results than the value that you specify, only the actual results are
3693
3692
  * returned. If you do not specify a value, a default of 5 is used.</p>
3693
+ * @public
3694
3694
  */
3695
3695
  MaxResults?: number;
3696
3696
  }
@@ -3707,65 +3707,64 @@ export declare const OutputLocationType: {
3707
3707
  */
3708
3708
  export type OutputLocationType = (typeof OutputLocationType)[keyof typeof OutputLocationType];
3709
3709
  /**
3710
- * @public
3711
3710
  * <p>Provides detailed information about a specific medical transcription job.</p>
3711
+ * @public
3712
3712
  */
3713
3713
  export interface MedicalTranscriptionJobSummary {
3714
3714
  /**
3715
- * @public
3716
3715
  * <p>The name of the medical transcription job. Job names are case sensitive and must be
3717
3716
  * unique within an Amazon Web Services account.</p>
3717
+ * @public
3718
3718
  */
3719
3719
  MedicalTranscriptionJobName?: string;
3720
3720
  /**
3721
- * @public
3722
3721
  * <p>The date and time the specified medical transcription job request was made.</p>
3723
3722
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3724
3723
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
3725
3724
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
3725
+ * @public
3726
3726
  */
3727
3727
  CreationTime?: Date;
3728
3728
  /**
3729
- * @public
3730
3729
  * <p>The date and time your medical transcription job began processing.</p>
3731
3730
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3732
3731
  * example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
3733
3732
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
3733
+ * @public
3734
3734
  */
3735
3735
  StartTime?: Date;
3736
3736
  /**
3737
- * @public
3738
3737
  * <p>The date and time the specified medical transcription job finished processing.</p>
3739
3738
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3740
3739
  * example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
3741
3740
  * that started processing at 12:33 PM UTC-7 on May 4, 2022.</p>
3741
+ * @public
3742
3742
  */
3743
3743
  CompletionTime?: Date;
3744
3744
  /**
3745
- * @public
3746
3745
  * <p>The language code used to create your medical transcription. US English
3747
3746
  * (<code>en-US</code>) is the only supported language for medical
3748
3747
  * transcriptions.</p>
3748
+ * @public
3749
3749
  */
3750
3750
  LanguageCode?: LanguageCode;
3751
3751
  /**
3752
- * @public
3753
3752
  * <p>Provides the status of your medical transcription job.</p>
3754
3753
  * <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
3755
3754
  * results at the location specified in <code>TranscriptFileUri</code>. If the status is
3756
3755
  * <code>FAILED</code>, <code>FailureReason</code> provides details on why your
3757
3756
  * transcription job failed.</p>
3757
+ * @public
3758
3758
  */
3759
3759
  TranscriptionJobStatus?: TranscriptionJobStatus;
3760
3760
  /**
3761
- * @public
3762
3761
  * <p>If <code>TranscriptionJobStatus</code> is <code>FAILED</code>,
3763
3762
  * <code>FailureReason</code> contains information about why the transcription job
3764
3763
  * failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
3764
+ * @public
3765
3765
  */
3766
3766
  FailureReason?: string;
3767
3767
  /**
3768
- * @public
3769
3768
  * <p>Indicates where the specified medical transcription output is stored.</p>
3770
3769
  * <p>If the value is <code>CUSTOMER_BUCKET</code>, the location is the Amazon S3
3771
3770
  * bucket you specified using the <code>OutputBucketName</code> parameter in your request. If you also included
@@ -3773,23 +3772,24 @@ export interface MedicalTranscriptionJobSummary {
3773
3772
  * specified in your request.</p>
3774
3773
  * <p>If the value is <code>SERVICE_BUCKET</code>, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the
3775
3774
  * URI shown in the <code>TranscriptFileUri</code> field.</p>
3775
+ * @public
3776
3776
  */
3777
3777
  OutputLocationType?: OutputLocationType;
3778
3778
  /**
3779
- * @public
3780
3779
  * <p>Provides the medical specialty represented in your media.</p>
3780
+ * @public
3781
3781
  */
3782
3782
  Specialty?: Specialty;
3783
3783
  /**
3784
- * @public
3785
3784
  * <p>Labels all personal health information (PHI) identified in your transcript. For more
3786
3785
  * information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html">Identifying personal health information (PHI) in a transcription</a>.</p>
3786
+ * @public
3787
3787
  */
3788
3788
  ContentIdentificationType?: MedicalContentIdentificationType;
3789
3789
  /**
3790
- * @public
3791
3790
  * <p>Indicates whether the input media is a dictation or a conversation, as specified in
3792
3791
  * the <code>StartMedicalTranscriptionJob</code> request.</p>
3792
+ * @public
3793
3793
  */
3794
3794
  Type?: Type;
3795
3795
  }
@@ -3798,23 +3798,23 @@ export interface MedicalTranscriptionJobSummary {
3798
3798
  */
3799
3799
  export interface ListMedicalTranscriptionJobsResponse {
3800
3800
  /**
3801
- * @public
3802
3801
  * <p>Lists all medical transcription jobs that have the status specified in your request.
3803
3802
  * Jobs are ordered by creation date, with the newest job first.</p>
3803
+ * @public
3804
3804
  */
3805
3805
  Status?: TranscriptionJobStatus;
3806
3806
  /**
3807
- * @public
3808
3807
  * <p>If <code>NextToken</code> is present in your response, it indicates that not all
3809
3808
  * results are displayed. To view the next set of results, copy the string associated with
3810
3809
  * the <code>NextToken</code> parameter in your results output, then run your request again
3811
3810
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3812
3811
  * to view all your results.</p>
3812
+ * @public
3813
3813
  */
3814
3814
  NextToken?: string;
3815
3815
  /**
3816
- * @public
3817
3816
  * <p>Provides a summary of information about each result.</p>
3817
+ * @public
3818
3818
  */
3819
3819
  MedicalTranscriptionJobSummaries?: MedicalTranscriptionJobSummary[];
3820
3820
  }
@@ -3823,70 +3823,70 @@ export interface ListMedicalTranscriptionJobsResponse {
3823
3823
  */
3824
3824
  export interface ListMedicalVocabulariesRequest {
3825
3825
  /**
3826
- * @public
3827
3826
  * <p>If your <code>ListMedicalVocabularies</code> request returns more results than can be
3828
3827
  * displayed, <code>NextToken</code> is displayed in the response with an associated
3829
3828
  * string. To get the next page of results, copy this string and repeat your request,
3830
3829
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3831
3830
  * to view all your results.</p>
3831
+ * @public
3832
3832
  */
3833
3833
  NextToken?: string;
3834
3834
  /**
3835
- * @public
3836
3835
  * <p>The maximum number of custom medical vocabularies to return in each page of results.
3837
3836
  * If there are fewer results than the value that you specify, only the actual results are
3838
3837
  * returned. If you do not specify a value, a default of 5 is used.</p>
3838
+ * @public
3839
3839
  */
3840
3840
  MaxResults?: number;
3841
3841
  /**
3842
- * @public
3843
3842
  * <p>Returns only custom medical vocabularies with the specified state. Custom vocabularies
3844
3843
  * are ordered by creation date, with the newest vocabulary first. If you do not include
3845
3844
  * <code>StateEquals</code>, all custom medical vocabularies are returned.</p>
3845
+ * @public
3846
3846
  */
3847
3847
  StateEquals?: VocabularyState;
3848
3848
  /**
3849
- * @public
3850
3849
  * <p>Returns only the custom medical vocabularies that contain the specified string. The
3851
3850
  * search is not case sensitive.</p>
3851
+ * @public
3852
3852
  */
3853
3853
  NameContains?: string;
3854
3854
  }
3855
3855
  /**
3856
- * @public
3857
3856
  * <p>Provides information about a custom vocabulary, including the language of the custom
3858
3857
  * vocabulary, when it was last modified, its name, and the processing state.</p>
3858
+ * @public
3859
3859
  */
3860
3860
  export interface VocabularyInfo {
3861
3861
  /**
3862
- * @public
3863
3862
  * <p>A unique name, chosen by you, for your custom vocabulary. This name is case sensitive,
3864
3863
  * cannot contain spaces, and must be unique within an Amazon Web Services account.</p>
3864
+ * @public
3865
3865
  */
3866
3866
  VocabularyName?: string;
3867
3867
  /**
3868
- * @public
3869
3868
  * <p>The language code used to create your custom vocabulary. Each custom vocabulary must
3870
3869
  * contain terms in only one language.</p>
3871
3870
  * <p>A custom vocabulary can only be used to transcribe files in the same language as the
3872
3871
  * custom vocabulary. For example, if you create a custom vocabulary using US English
3873
3872
  * (<code>en-US</code>), you can only apply this custom vocabulary to files that
3874
3873
  * contain English audio.</p>
3874
+ * @public
3875
3875
  */
3876
3876
  LanguageCode?: LanguageCode;
3877
3877
  /**
3878
- * @public
3879
3878
  * <p>The date and time the specified custom vocabulary was last modified.</p>
3880
3879
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3881
3880
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
3882
3881
  * 4, 2022.</p>
3882
+ * @public
3883
3883
  */
3884
3884
  LastModifiedTime?: Date;
3885
3885
  /**
3886
- * @public
3887
3886
  * <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
3888
3887
  * you can use the custom vocabulary in a <code>StartTranscriptionJob</code>
3889
3888
  * request.</p>
3889
+ * @public
3890
3890
  */
3891
3891
  VocabularyState?: VocabularyState;
3892
3892
  }
@@ -3895,25 +3895,25 @@ export interface VocabularyInfo {
3895
3895
  */
3896
3896
  export interface ListMedicalVocabulariesResponse {
3897
3897
  /**
3898
- * @public
3899
3898
  * <p>Lists all custom medical vocabularies that have the status specified in your request.
3900
3899
  * Custom vocabularies are ordered by creation date, with the newest vocabulary
3901
3900
  * first.</p>
3901
+ * @public
3902
3902
  */
3903
3903
  Status?: VocabularyState;
3904
3904
  /**
3905
- * @public
3906
3905
  * <p>If <code>NextToken</code> is present in your response, it indicates that not all
3907
3906
  * results are displayed. To view the next set of results, copy the string associated with
3908
3907
  * the <code>NextToken</code> parameter in your results output, then run your request again
3909
3908
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3910
3909
  * to view all your results.</p>
3910
+ * @public
3911
3911
  */
3912
3912
  NextToken?: string;
3913
3913
  /**
3914
- * @public
3915
3914
  * <p>Provides information about the custom medical vocabularies that match the criteria
3916
3915
  * specified in your request.</p>
3916
+ * @public
3917
3917
  */
3918
3918
  Vocabularies?: VocabularyInfo[];
3919
3919
  }
@@ -3922,7 +3922,6 @@ export interface ListMedicalVocabulariesResponse {
3922
3922
  */
3923
3923
  export interface ListTagsForResourceRequest {
3924
3924
  /**
3925
- * @public
3926
3925
  * <p>Returns a list of all tags associated with the specified Amazon Resource Name (ARN).
3927
3926
  * ARNs have the format
3928
3927
  * <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</p>
@@ -3932,6 +3931,7 @@ export interface ListTagsForResourceRequest {
3932
3931
  * <code>medical-transcription-job</code>, <code>vocabulary</code>,
3933
3932
  * <code>medical-vocabulary</code>, <code>vocabulary-filter</code>, and
3934
3933
  * <code>language-model</code>.</p>
3934
+ * @public
3935
3935
  */
3936
3936
  ResourceArn: string | undefined;
3937
3937
  }
@@ -3940,14 +3940,14 @@ export interface ListTagsForResourceRequest {
3940
3940
  */
3941
3941
  export interface ListTagsForResourceResponse {
3942
3942
  /**
3943
- * @public
3944
3943
  * <p>The Amazon Resource Name (ARN) specified in your request.</p>
3944
+ * @public
3945
3945
  */
3946
3946
  ResourceArn?: string;
3947
3947
  /**
3948
- * @public
3949
3948
  * <p>Lists all tags associated with the given transcription job, vocabulary, model, or
3950
3949
  * resource.</p>
3950
+ * @public
3951
3951
  */
3952
3952
  Tags?: Tag[];
3953
3953
  }
@@ -3956,94 +3956,93 @@ export interface ListTagsForResourceResponse {
3956
3956
  */
3957
3957
  export interface ListTranscriptionJobsRequest {
3958
3958
  /**
3959
- * @public
3960
3959
  * <p>Returns only transcription jobs with the specified status. Jobs are ordered by
3961
3960
  * creation date, with the newest job first. If you do not include <code>Status</code>, all
3962
3961
  * transcription jobs are returned.</p>
3962
+ * @public
3963
3963
  */
3964
3964
  Status?: TranscriptionJobStatus;
3965
3965
  /**
3966
- * @public
3967
3966
  * <p>Returns only the transcription jobs that contain the specified string. The search is
3968
3967
  * not case sensitive.</p>
3968
+ * @public
3969
3969
  */
3970
3970
  JobNameContains?: string;
3971
3971
  /**
3972
- * @public
3973
3972
  * <p>If your <code>ListTranscriptionJobs</code> request returns more results than can be
3974
3973
  * displayed, <code>NextToken</code> is displayed in the response with an associated
3975
3974
  * string. To get the next page of results, copy this string and repeat your request,
3976
3975
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3977
3976
  * to view all your results.</p>
3977
+ * @public
3978
3978
  */
3979
3979
  NextToken?: string;
3980
3980
  /**
3981
- * @public
3982
3981
  * <p>The maximum number of transcription jobs to return in each page of results. If there
3983
3982
  * are fewer results than the value that you specify, only the actual results are returned.
3984
3983
  * If you do not specify a value, a default of 5 is used.</p>
3984
+ * @public
3985
3985
  */
3986
3986
  MaxResults?: number;
3987
3987
  }
3988
3988
  /**
3989
- * @public
3990
3989
  * <p>Provides detailed information about a specific transcription job.</p>
3990
+ * @public
3991
3991
  */
3992
3992
  export interface TranscriptionJobSummary {
3993
3993
  /**
3994
- * @public
3995
3994
  * <p>The name of the transcription job. Job names are case sensitive and must be unique
3996
3995
  * within an Amazon Web Services account.</p>
3996
+ * @public
3997
3997
  */
3998
3998
  TranscriptionJobName?: string;
3999
3999
  /**
4000
- * @public
4001
4000
  * <p>The date and time the specified transcription job request was made.</p>
4002
4001
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
4003
4002
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a transcription job
4004
4003
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
4004
+ * @public
4005
4005
  */
4006
4006
  CreationTime?: Date;
4007
4007
  /**
4008
- * @public
4009
4008
  * <p>The date and time your transcription job began processing.</p>
4010
4009
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
4011
4010
  * example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a transcription job
4012
4011
  * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
4012
+ * @public
4013
4013
  */
4014
4014
  StartTime?: Date;
4015
4015
  /**
4016
- * @public
4017
4016
  * <p>The date and time the specified transcription job finished processing.</p>
4018
4017
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
4019
4018
  * example, <code>2022-05-04T12:33:13.922000-07:00</code> represents a transcription job
4020
4019
  * that started processing at 12:33 PM UTC-7 on May 4, 2022.</p>
4020
+ * @public
4021
4021
  */
4022
4022
  CompletionTime?: Date;
4023
4023
  /**
4024
- * @public
4025
4024
  * <p>The language code used to create your transcription.</p>
4025
+ * @public
4026
4026
  */
4027
4027
  LanguageCode?: LanguageCode;
4028
4028
  /**
4029
- * @public
4030
4029
  * <p>Provides the status of your transcription job.</p>
4031
4030
  * <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
4032
4031
  * results at the location specified in <code>TranscriptFileUri</code> (or
4033
4032
  * <code>RedactedTranscriptFileUri</code>, if you requested transcript redaction). If
4034
4033
  * the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
4035
4034
  * your transcription job failed.</p>
4035
+ * @public
4036
4036
  */
4037
4037
  TranscriptionJobStatus?: TranscriptionJobStatus;
4038
4038
  /**
4039
- * @public
4040
4039
  * <p>If <code>TranscriptionJobStatus</code> is <code>FAILED</code>,
4041
4040
  * <code>FailureReason</code> contains information about why the transcription job
4042
4041
  * failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
4042
+ * @public
4043
4043
  */
4044
4044
  FailureReason?: string;
4045
4045
  /**
4046
- * @public
4047
4046
  * <p>Indicates where the specified transcription output is stored.</p>
4048
4047
  * <p>If the value is <code>CUSTOMER_BUCKET</code>, the location is the Amazon S3
4049
4048
  * bucket you specified using the <code>OutputBucketName</code> parameter in your request. If you also included
@@ -4052,15 +4051,15 @@ export interface TranscriptionJobSummary {
4052
4051
  * <p>If the value is <code>SERVICE_BUCKET</code>, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the
4053
4052
  * URI shown in the <code>TranscriptFileUri</code> or
4054
4053
  * <code>RedactedTranscriptFileUri</code> field.</p>
4054
+ * @public
4055
4055
  */
4056
4056
  OutputLocationType?: OutputLocationType;
4057
4057
  /**
4058
- * @public
4059
4058
  * <p>The content redaction settings of the transcription job.</p>
4059
+ * @public
4060
4060
  */
4061
4061
  ContentRedaction?: ContentRedaction;
4062
4062
  /**
4063
- * @public
4064
4063
  * <p>Provides the name of the custom language model that was included in the specified
4065
4064
  * transcription job.</p>
4066
4065
  * <p>Only use <code>ModelSettings</code> with the <code>LanguageModelName</code>
@@ -4068,40 +4067,41 @@ export interface TranscriptionJobSummary {
4068
4067
  * identification (<code></code>). If using
4069
4068
  * <code>LanguageIdSettings</code> in your request, this parameter contains a
4070
4069
  * <code>LanguageModelName</code> sub-parameter.</p>
4070
+ * @public
4071
4071
  */
4072
4072
  ModelSettings?: ModelSettings;
4073
4073
  /**
4074
- * @public
4075
4074
  * <p>Indicates whether automatic language identification was enabled (<code>TRUE</code>)
4076
4075
  * for the specified transcription job.</p>
4076
+ * @public
4077
4077
  */
4078
4078
  IdentifyLanguage?: boolean;
4079
4079
  /**
4080
- * @public
4081
4080
  * <p>Indicates whether automatic multi-language identification was enabled
4082
4081
  * (<code>TRUE</code>) for the specified transcription job.</p>
4082
+ * @public
4083
4083
  */
4084
4084
  IdentifyMultipleLanguages?: boolean;
4085
4085
  /**
4086
- * @public
4087
4086
  * <p>The confidence score associated with the language identified in your media
4088
4087
  * file.</p>
4089
4088
  * <p>Confidence scores are values between 0 and 1; a larger value indicates a higher
4090
4089
  * probability that the identified language correctly matches the language spoken in your
4091
4090
  * media.</p>
4091
+ * @public
4092
4092
  */
4093
4093
  IdentifiedLanguageScore?: number;
4094
4094
  /**
4095
- * @public
4096
4095
  * <p>The language codes used to create your transcription job. This parameter is used with
4097
4096
  * multi-language identification. For single-language identification, the singular version
4098
4097
  * of this parameter, <code>LanguageCode</code>, is present.</p>
4098
+ * @public
4099
4099
  */
4100
4100
  LanguageCodes?: LanguageCodeItem[];
4101
4101
  /**
4102
- * @public
4103
4102
  * <p>Indicates whether toxicity detection was enabled for the specified transcription
4104
4103
  * job.</p>
4104
+ * @public
4105
4105
  */
4106
4106
  ToxicityDetection?: ToxicityDetectionSettings[];
4107
4107
  }
@@ -4110,23 +4110,23 @@ export interface TranscriptionJobSummary {
4110
4110
  */
4111
4111
  export interface ListTranscriptionJobsResponse {
4112
4112
  /**
4113
- * @public
4114
4113
  * <p>Lists all transcription jobs that have the status specified in your request. Jobs are
4115
4114
  * ordered by creation date, with the newest job first.</p>
4115
+ * @public
4116
4116
  */
4117
4117
  Status?: TranscriptionJobStatus;
4118
4118
  /**
4119
- * @public
4120
4119
  * <p>If <code>NextToken</code> is present in your response, it indicates that not all
4121
4120
  * results are displayed. To view the next set of results, copy the string associated with
4122
4121
  * the <code>NextToken</code> parameter in your results output, then run your request again
4123
4122
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
4124
4123
  * to view all your results.</p>
4124
+ * @public
4125
4125
  */
4126
4126
  NextToken?: string;
4127
4127
  /**
4128
- * @public
4129
4128
  * <p>Provides a summary of information about each result.</p>
4129
+ * @public
4130
4130
  */
4131
4131
  TranscriptionJobSummaries?: TranscriptionJobSummary[];
4132
4132
  }
@@ -4135,32 +4135,32 @@ export interface ListTranscriptionJobsResponse {
4135
4135
  */
4136
4136
  export interface ListVocabulariesRequest {
4137
4137
  /**
4138
- * @public
4139
4138
  * <p>If your <code>ListVocabularies</code> request returns more results than can be
4140
4139
  * displayed, <code>NextToken</code> is displayed in the response with an associated
4141
4140
  * string. To get the next page of results, copy this string and repeat your request,
4142
4141
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
4143
4142
  * to view all your results.</p>
4143
+ * @public
4144
4144
  */
4145
4145
  NextToken?: string;
4146
4146
  /**
4147
- * @public
4148
4147
  * <p>The maximum number of custom vocabularies to return in each page of results. If there
4149
4148
  * are fewer results than the value that you specify, only the actual results are returned.
4150
4149
  * If you do not specify a value, a default of 5 is used.</p>
4150
+ * @public
4151
4151
  */
4152
4152
  MaxResults?: number;
4153
4153
  /**
4154
- * @public
4155
4154
  * <p>Returns only custom vocabularies with the specified state. Vocabularies are ordered by
4156
4155
  * creation date, with the newest vocabulary first. If you do not include
4157
4156
  * <code>StateEquals</code>, all custom medical vocabularies are returned.</p>
4157
+ * @public
4158
4158
  */
4159
4159
  StateEquals?: VocabularyState;
4160
4160
  /**
4161
- * @public
4162
4161
  * <p>Returns only the custom vocabularies that contain the specified string. The search is
4163
4162
  * not case sensitive.</p>
4163
+ * @public
4164
4164
  */
4165
4165
  NameContains?: string;
4166
4166
  }
@@ -4169,24 +4169,24 @@ export interface ListVocabulariesRequest {
4169
4169
  */
4170
4170
  export interface ListVocabulariesResponse {
4171
4171
  /**
4172
- * @public
4173
4172
  * <p>Lists all custom vocabularies that have the status specified in your request.
4174
4173
  * Vocabularies are ordered by creation date, with the newest vocabulary first.</p>
4174
+ * @public
4175
4175
  */
4176
4176
  Status?: VocabularyState;
4177
4177
  /**
4178
- * @public
4179
4178
  * <p>If <code>NextToken</code> is present in your response, it indicates that not all
4180
4179
  * results are displayed. To view the next set of results, copy the string associated with
4181
4180
  * the <code>NextToken</code> parameter in your results output, then run your request again
4182
4181
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
4183
4182
  * to view all your results.</p>
4183
+ * @public
4184
4184
  */
4185
4185
  NextToken?: string;
4186
4186
  /**
4187
- * @public
4188
4187
  * <p>Provides information about the custom vocabularies that match the criteria specified
4189
4188
  * in your request.</p>
4189
+ * @public
4190
4190
  */
4191
4191
  Vocabularies?: VocabularyInfo[];
4192
4192
  }
@@ -4195,42 +4195,41 @@ export interface ListVocabulariesResponse {
4195
4195
  */
4196
4196
  export interface ListVocabularyFiltersRequest {
4197
4197
  /**
4198
- * @public
4199
4198
  * <p>If your <code>ListVocabularyFilters</code> request returns more results than can be
4200
4199
  * displayed, <code>NextToken</code> is displayed in the response with an associated
4201
4200
  * string. To get the next page of results, copy this string and repeat your request,
4202
4201
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
4203
4202
  * to view all your results.</p>
4203
+ * @public
4204
4204
  */
4205
4205
  NextToken?: string;
4206
4206
  /**
4207
- * @public
4208
4207
  * <p>The maximum number of custom vocabulary filters to return in each page of results. If
4209
4208
  * there are fewer results than the value that you specify, only the actual results are
4210
4209
  * returned. If you do not specify a value, a default of 5 is used.</p>
4210
+ * @public
4211
4211
  */
4212
4212
  MaxResults?: number;
4213
4213
  /**
4214
- * @public
4215
4214
  * <p>Returns only the custom vocabulary filters that contain the specified string. The
4216
4215
  * search is not case sensitive.</p>
4216
+ * @public
4217
4217
  */
4218
4218
  NameContains?: string;
4219
4219
  }
4220
4220
  /**
4221
- * @public
4222
4221
  * <p>Provides information about a custom vocabulary filter, including the language of the
4223
4222
  * filter, when it was last modified, and its name.</p>
4223
+ * @public
4224
4224
  */
4225
4225
  export interface VocabularyFilterInfo {
4226
4226
  /**
4227
- * @public
4228
4227
  * <p>A unique name, chosen by you, for your custom vocabulary filter. This name is case
4229
4228
  * sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.</p>
4229
+ * @public
4230
4230
  */
4231
4231
  VocabularyFilterName?: string;
4232
4232
  /**
4233
- * @public
4234
4233
  * <p>The language code that represents the language of the entries in your vocabulary
4235
4234
  * filter. Each custom vocabulary filter must contain terms in only one language.</p>
4236
4235
  * <p>A custom vocabulary filter can only be used to transcribe files in the same language
@@ -4239,14 +4238,15 @@ export interface VocabularyFilterInfo {
4239
4238
  * audio.</p>
4240
4239
  * <p>For a list of supported languages and their associated language codes, refer to the
4241
4240
  * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
4241
+ * @public
4242
4242
  */
4243
4243
  LanguageCode?: LanguageCode;
4244
4244
  /**
4245
- * @public
4246
4245
  * <p>The date and time the specified custom vocabulary filter was last modified.</p>
4247
4246
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
4248
4247
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
4249
4248
  * 4, 2022.</p>
4249
+ * @public
4250
4250
  */
4251
4251
  LastModifiedTime?: Date;
4252
4252
  }
@@ -4255,18 +4255,18 @@ export interface VocabularyFilterInfo {
4255
4255
  */
4256
4256
  export interface ListVocabularyFiltersResponse {
4257
4257
  /**
4258
- * @public
4259
4258
  * <p>If <code>NextToken</code> is present in your response, it indicates that not all
4260
4259
  * results are displayed. To view the next set of results, copy the string associated with
4261
4260
  * the <code>NextToken</code> parameter in your results output, then run your request again
4262
4261
  * including <code>NextToken</code> with the value of the copied string. Repeat as needed
4263
4262
  * to view all your results.</p>
4263
+ * @public
4264
4264
  */
4265
4265
  NextToken?: string;
4266
4266
  /**
4267
- * @public
4268
4267
  * <p>Provides information about the custom vocabulary filters that match the criteria
4269
4268
  * specified in your request.</p>
4269
+ * @public
4270
4270
  */
4271
4271
  VocabularyFilters?: VocabularyFilterInfo[];
4272
4272
  }
@@ -4275,21 +4275,20 @@ export interface ListVocabularyFiltersResponse {
4275
4275
  */
4276
4276
  export interface StartCallAnalyticsJobRequest {
4277
4277
  /**
4278
- * @public
4279
4278
  * <p>A unique name, chosen by you, for your Call Analytics job.</p>
4280
4279
  * <p>This name is case sensitive, cannot contain spaces, and must be unique within an
4281
4280
  * Amazon Web Services account. If you try to create a new job with the same name as an
4282
4281
  * existing job, you get a <code>ConflictException</code> error.</p>
4282
+ * @public
4283
4283
  */
4284
4284
  CallAnalyticsJobName: string | undefined;
4285
4285
  /**
4286
- * @public
4287
4286
  * <p>Describes the Amazon S3 location of the media file you want to use in your
4288
4287
  * Call Analytics request.</p>
4288
+ * @public
4289
4289
  */
4290
4290
  Media: Media | undefined;
4291
4291
  /**
4292
- * @public
4293
4292
  * <p>The Amazon S3 location where you want your Call Analytics transcription output
4294
4293
  * stored. You can use any of the following formats to specify the output location:</p>
4295
4294
  * <ol>
@@ -4312,10 +4311,10 @@ export interface StartCallAnalyticsJobRequest {
4312
4311
  * <p>If you do not specify <code>OutputLocation</code>, your transcript is placed in a
4313
4312
  * service-managed Amazon S3 bucket and you are provided with a URI to access your
4314
4313
  * transcript.</p>
4314
+ * @public
4315
4315
  */
4316
4316
  OutputLocation?: string;
4317
4317
  /**
4318
- * @public
4319
4318
  * <p>The KMS key you want to use to encrypt your Call Analytics
4320
4319
  * output.</p>
4321
4320
  * <p>If using a key located in the <b>current</b>
@@ -4359,10 +4358,10 @@ export interface StartCallAnalyticsJobRequest {
4359
4358
  * an output location using the <code>OutputLocation</code> parameter.</p>
4360
4359
  * <p>Note that the role making the request must
4361
4360
  * have permission to use the specified KMS key.</p>
4361
+ * @public
4362
4362
  */
4363
4363
  OutputEncryptionKMSKeyId?: string;
4364
4364
  /**
4365
- * @public
4366
4365
  * <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
4367
4366
  * access the Amazon S3 bucket that contains your input files. If the role that you
4368
4367
  * specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.</p>
@@ -4371,20 +4370,21 @@ export interface StartCallAnalyticsJobRequest {
4371
4370
  * <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
4372
4371
  * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
4373
4372
  * ARNs</a>.</p>
4373
+ * @public
4374
4374
  */
4375
4375
  DataAccessRoleArn?: string;
4376
4376
  /**
4377
- * @public
4378
4377
  * <p>Specify additional optional settings in your request, including content redaction; allows you to apply custom language models,
4379
4378
  * vocabulary filters, and custom vocabularies to your Call Analytics job.</p>
4379
+ * @public
4380
4380
  */
4381
4381
  Settings?: CallAnalyticsJobSettings;
4382
4382
  /**
4383
- * @public
4384
4383
  * <p>Makes it possible to specify which speaker is on which channel. For example, if your
4385
4384
  * agent is the first participant to speak, you would set <code>ChannelId</code> to
4386
4385
  * <code>0</code> (to indicate the first channel) and <code>ParticipantRole</code> to
4387
4386
  * <code>AGENT</code> (to indicate that it's the agent speaking).</p>
4387
+ * @public
4388
4388
  */
4389
4389
  ChannelDefinitions?: ChannelDefinition[];
4390
4390
  }
@@ -4393,9 +4393,9 @@ export interface StartCallAnalyticsJobRequest {
4393
4393
  */
4394
4394
  export interface StartCallAnalyticsJobResponse {
4395
4395
  /**
4396
- * @public
4397
4396
  * <p>Provides detailed information about the current Call Analytics job, including job
4398
4397
  * status and, if applicable, failure reason.</p>
4398
+ * @public
4399
4399
  */
4400
4400
  CallAnalyticsJob?: CallAnalyticsJob;
4401
4401
  }
@@ -4404,34 +4404,33 @@ export interface StartCallAnalyticsJobResponse {
4404
4404
  */
4405
4405
  export interface StartMedicalScribeJobRequest {
4406
4406
  /**
4407
- * @public
4408
4407
  * <p>A unique name, chosen by you, for your Medical Scribe job.</p>
4409
4408
  * <p>This name is case sensitive, cannot contain spaces, and must be unique within an
4410
4409
  * Amazon Web Services account. If you try to create a new job with the same name as an
4411
4410
  * existing job, you get a <code>ConflictException</code> error.</p>
4411
+ * @public
4412
4412
  */
4413
4413
  MedicalScribeJobName: string | undefined;
4414
4414
  /**
4415
- * @public
4416
4415
  * <p>Describes the Amazon S3 location of the media file you want to use in your
4417
4416
  * request.</p>
4418
4417
  * <p>For information on supported media formats, refer to the <code>MediaFormat</code>
4419
4418
  * parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
4420
4419
  * in the Amazon S3 Developer Guide.</p>
4420
+ * @public
4421
4421
  */
4422
4422
  Media: Media | undefined;
4423
4423
  /**
4424
- * @public
4425
4424
  * <p>The name of the Amazon S3 bucket where you want your Medical Scribe
4426
4425
  * output stored. Do not include the <code>S3://</code> prefix of the specified
4427
4426
  * bucket.</p>
4428
4427
  * <p>Note that the role specified in the <code>DataAccessRoleArn</code> request parameter
4429
4428
  * must have permission to use the specified location. You
4430
4429
  * can change Amazon S3 permissions using the <a href="https://console.aws.amazon.com/s3">Amazon Web Services Management Console</a>. See also <a href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions Required for IAM User Roles</a>.</p>
4430
+ * @public
4431
4431
  */
4432
4432
  OutputBucketName: string | undefined;
4433
4433
  /**
4434
- * @public
4435
4434
  * <p>The KMS key you want to use to encrypt your Medical Scribe
4436
4435
  * output.</p>
4437
4436
  * <p>If using a key located in the <b>current</b>
@@ -4473,16 +4472,16 @@ export interface StartMedicalScribeJobRequest {
4473
4472
  * Amazon S3 key (SSE-S3).</p>
4474
4473
  * <p>Note that the role specified in the <code>DataAccessRoleArn</code> request parameter
4475
4474
  * must have permission to use the specified KMS key.</p>
4475
+ * @public
4476
4476
  */
4477
4477
  OutputEncryptionKMSKeyId?: string;
4478
4478
  /**
4479
- * @public
4480
4479
  * <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs,
4481
4480
  * that provide an added layer of security for your data. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context">KMS encryption context</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html">Asymmetric keys in KMS</a>.</p>
4481
+ * @public
4482
4482
  */
4483
4483
  KMSEncryptionContext?: Record<string, string>;
4484
4484
  /**
4485
- * @public
4486
4485
  * <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
4487
4486
  * access the Amazon S3 bucket that contains your input files,
4488
4487
  * write to the output bucket, and use your KMS key if supplied.
@@ -4492,10 +4491,10 @@ export interface StartMedicalScribeJobRequest {
4492
4491
  * <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
4493
4492
  * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
4494
4493
  * ARNs</a>.</p>
4494
+ * @public
4495
4495
  */
4496
4496
  DataAccessRoleArn: string | undefined;
4497
4497
  /**
4498
- * @public
4499
4498
  * <p>Makes it possible to control how your Medical Scribe job is processed using a
4500
4499
  * <code>MedicalScribeSettings</code> object. Specify <code>ChannelIdentification</code> if
4501
4500
  * <code>ChannelDefinitions</code> are set. Enabled <code>ShowSpeakerLabels</code> if <code>ChannelIdentification</code>
@@ -4504,10 +4503,10 @@ export interface StartMedicalScribeJobRequest {
4504
4503
  * to specify a vocabulary or vocabulary filter or both using <code>VocabularyName</code>, <code>VocabularyFilterName</code>.
4505
4504
  * <code>VocabularyFilterMethod</code> must be specified if <code>VocabularyFilterName</code> is set.
4506
4505
  * </p>
4506
+ * @public
4507
4507
  */
4508
4508
  Settings: MedicalScribeSettings | undefined;
4509
4509
  /**
4510
- * @public
4511
4510
  * <p>Makes it possible to specify which speaker is on which channel. For example, if the clinician
4512
4511
  * is the first participant to speak, you would set <code>ChannelId</code> of the first <code>ChannelDefinition</code>
4513
4512
  * in the list to <code>0</code> (to indicate the first channel) and <code>ParticipantRole</code> to
@@ -4516,13 +4515,14 @@ export interface StartMedicalScribeJobRequest {
4516
4515
  * <code>1</code> (to indicate the second channel) and <code>ParticipantRole</code> to
4517
4516
  * <code>PATIENT</code> (to indicate that it's the patient speaking).
4518
4517
  * </p>
4518
+ * @public
4519
4519
  */
4520
4520
  ChannelDefinitions?: MedicalScribeChannelDefinition[];
4521
4521
  /**
4522
- * @public
4523
4522
  * <p>Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.</p>
4524
4523
  * <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
4525
4524
  * resources</a>.</p>
4525
+ * @public
4526
4526
  */
4527
4527
  Tags?: Tag[];
4528
4528
  }
@@ -4531,9 +4531,9 @@ export interface StartMedicalScribeJobRequest {
4531
4531
  */
4532
4532
  export interface StartMedicalScribeJobResponse {
4533
4533
  /**
4534
- * @public
4535
4534
  * <p>Provides detailed information about the current Medical Scribe job, including
4536
4535
  * job status and, if applicable, failure reason.</p>
4536
+ * @public
4537
4537
  */
4538
4538
  MedicalScribeJob?: MedicalScribeJob;
4539
4539
  }
@@ -4542,7 +4542,6 @@ export interface StartMedicalScribeJobResponse {
4542
4542
  */
4543
4543
  export interface StartMedicalTranscriptionJobRequest {
4544
4544
  /**
4545
- * @public
4546
4545
  * <p>A unique name, chosen by you, for your medical transcription job. The name that you
4547
4546
  * specify is also used as the default name of your transcription output file. If you want
4548
4547
  * to specify a different name for your transcription output, use the
@@ -4550,42 +4549,42 @@ export interface StartMedicalTranscriptionJobRequest {
4550
4549
  * <p>This name is case sensitive, cannot contain spaces, and must be unique within an
4551
4550
  * Amazon Web Services account. If you try to create a new job with the same name as an
4552
4551
  * existing job, you get a <code>ConflictException</code> error.</p>
4552
+ * @public
4553
4553
  */
4554
4554
  MedicalTranscriptionJobName: string | undefined;
4555
4555
  /**
4556
- * @public
4557
4556
  * <p>The language code that represents the language spoken in the input media file. US
4558
4557
  * English (<code>en-US</code>) is the only valid value for medical transcription jobs. Any
4559
4558
  * other value you enter for language code results in a <code>BadRequestException</code>
4560
4559
  * error.</p>
4560
+ * @public
4561
4561
  */
4562
4562
  LanguageCode: LanguageCode | undefined;
4563
4563
  /**
4564
- * @public
4565
4564
  * <p>The sample rate, in hertz, of the audio track in your input media file.</p>
4566
4565
  * <p>If you do not specify the media sample rate, Amazon Transcribe Medical determines it
4567
4566
  * for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical; if there's a mismatch between the value that you specify and the
4568
4567
  * value detected, your job fails. Therefore, in most cases, it's advised to omit
4569
4568
  * <code>MediaSampleRateHertz</code> and let Amazon Transcribe Medical determine the
4570
4569
  * sample rate.</p>
4570
+ * @public
4571
4571
  */
4572
4572
  MediaSampleRateHertz?: number;
4573
4573
  /**
4574
- * @public
4575
4574
  * <p>Specify the format of your input media file.</p>
4575
+ * @public
4576
4576
  */
4577
4577
  MediaFormat?: MediaFormat;
4578
4578
  /**
4579
- * @public
4580
4579
  * <p>Describes the Amazon S3 location of the media file you want to use in your
4581
4580
  * request.</p>
4582
4581
  * <p>For information on supported media formats, refer to the <code>MediaFormat</code>
4583
4582
  * parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
4584
4583
  * in the Amazon S3 Developer Guide.</p>
4584
+ * @public
4585
4585
  */
4586
4586
  Media: Media | undefined;
4587
4587
  /**
4588
- * @public
4589
4588
  * <p>The name of the Amazon S3 bucket where you want your medical transcription
4590
4589
  * output stored. Do not include the <code>S3://</code> prefix of the specified
4591
4590
  * bucket.</p>
@@ -4599,10 +4598,10 @@ export interface StartMedicalTranscriptionJobRequest {
4599
4598
  * <code>OutputKey</code> to <code>test-files/</code>.</p>
4600
4599
  * <p>Note that Amazon Transcribe must have permission to use the specified location. You
4601
4600
  * can change Amazon S3 permissions using the <a href="https://console.aws.amazon.com/s3">Amazon Web Services Management Console</a>. See also <a href="https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user">Permissions Required for IAM User Roles</a>.</p>
4601
+ * @public
4602
4602
  */
4603
4603
  OutputBucketName: string | undefined;
4604
4604
  /**
4605
- * @public
4606
4605
  * <p>Use in combination with <code>OutputBucketName</code> to specify the output location
4607
4606
  * of your transcript and, optionally, a unique name for your output file. The default name
4608
4607
  * for your transcription output is the same as the name you specified for your medical
@@ -4637,10 +4636,10 @@ export interface StartMedicalTranscriptionJobRequest {
4637
4636
  * </ul>
4638
4637
  * <p>If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,
4639
4638
  * one is created for you.</p>
4639
+ * @public
4640
4640
  */
4641
4641
  OutputKey?: string;
4642
4642
  /**
4643
- * @public
4644
4643
  * <p>The KMS key you want to use to encrypt your medical transcription
4645
4644
  * output.</p>
4646
4645
  * <p>If using a key located in the <b>current</b>
@@ -4684,49 +4683,50 @@ export interface StartMedicalTranscriptionJobRequest {
4684
4683
  * an output location using the <code>OutputLocation</code> parameter.</p>
4685
4684
  * <p>Note that the role making the request must
4686
4685
  * have permission to use the specified KMS key.</p>
4686
+ * @public
4687
4687
  */
4688
4688
  OutputEncryptionKMSKeyId?: string;
4689
4689
  /**
4690
- * @public
4691
4690
  * <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs,
4692
4691
  * that provide an added layer of security for your data. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context">KMS encryption context</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html">Asymmetric keys in KMS</a>.</p>
4692
+ * @public
4693
4693
  */
4694
4694
  KMSEncryptionContext?: Record<string, string>;
4695
4695
  /**
4696
- * @public
4697
4696
  * <p>Specify additional optional settings in your request, including channel
4698
4697
  * identification, alternative transcriptions, and speaker partitioning. You can use that to
4699
4698
  * apply custom vocabularies to your transcription job.</p>
4699
+ * @public
4700
4700
  */
4701
4701
  Settings?: MedicalTranscriptionSetting;
4702
4702
  /**
4703
- * @public
4704
4703
  * <p>Labels all personal health information (PHI) identified in your transcript. For more
4705
4704
  * information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html">Identifying personal health information (PHI) in a transcription</a>.</p>
4705
+ * @public
4706
4706
  */
4707
4707
  ContentIdentificationType?: MedicalContentIdentificationType;
4708
4708
  /**
4709
- * @public
4710
4709
  * <p>Specify the predominant medical specialty represented in your media. For batch
4711
4710
  * transcriptions, <code>PRIMARYCARE</code> is the only valid value. If you require
4712
4711
  * additional specialties, refer to .</p>
4712
+ * @public
4713
4713
  */
4714
4714
  Specialty: Specialty | undefined;
4715
4715
  /**
4716
- * @public
4717
4716
  * <p>Specify whether your input media contains only one person (<code>DICTATION</code>) or
4718
4717
  * contains a conversation between two people (<code>CONVERSATION</code>).</p>
4719
4718
  * <p>For example, <code>DICTATION</code> could be used for a medical professional wanting
4720
4719
  * to transcribe voice memos; <code>CONVERSATION</code> could be used for transcribing the
4721
4720
  * doctor-patient dialogue during the patient's office visit.</p>
4721
+ * @public
4722
4722
  */
4723
4723
  Type: Type | undefined;
4724
4724
  /**
4725
- * @public
4726
4725
  * <p>Adds one or more custom tags, each in the form of a key:value pair, to a new medical
4727
4726
  * transcription job at the time you start this new job.</p>
4728
4727
  * <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
4729
4728
  * resources</a>.</p>
4729
+ * @public
4730
4730
  */
4731
4731
  Tags?: Tag[];
4732
4732
  }
@@ -4735,35 +4735,35 @@ export interface StartMedicalTranscriptionJobRequest {
4735
4735
  */
4736
4736
  export interface StartMedicalTranscriptionJobResponse {
4737
4737
  /**
4738
- * @public
4739
4738
  * <p>Provides detailed information about the current medical transcription job, including
4740
4739
  * job status and, if applicable, failure reason.</p>
4740
+ * @public
4741
4741
  */
4742
4742
  MedicalTranscriptionJob?: MedicalTranscriptionJob;
4743
4743
  }
4744
4744
  /**
4745
- * @public
4746
4745
  * <p>Generate subtitles for your media file with your transcription request.</p>
4747
4746
  * <p>You can choose a start index of 0 or 1, and you can specify either WebVTT or SubRip
4748
4747
  * (or both) as your output format.</p>
4749
4748
  * <p>Note that your subtitle files are placed in the same location as your transcription
4750
4749
  * output.</p>
4750
+ * @public
4751
4751
  */
4752
4752
  export interface Subtitles {
4753
4753
  /**
4754
- * @public
4755
4754
  * <p>Specify the output format for your subtitle file; if you select both WebVTT
4756
4755
  * (<code>vtt</code>) and SubRip (<code>srt</code>) formats, two output files are
4757
4756
  * generated.</p>
4757
+ * @public
4758
4758
  */
4759
4759
  Formats?: SubtitleFormat[];
4760
4760
  /**
4761
- * @public
4762
4761
  * <p>Specify the starting value that is assigned to the first subtitle segment.</p>
4763
4762
  * <p>The default start index for Amazon Transcribe is <code>0</code>, which differs from
4764
4763
  * the more widely used standard of <code>1</code>. If you're uncertain which value to use,
4765
4764
  * we recommend choosing <code>1</code>, as this may improve compatibility with other
4766
4765
  * services.</p>
4766
+ * @public
4767
4767
  */
4768
4768
  OutputStartIndex?: number;
4769
4769
  }
@@ -4772,7 +4772,6 @@ export interface Subtitles {
4772
4772
  */
4773
4773
  export interface StartTranscriptionJobRequest {
4774
4774
  /**
4775
- * @public
4776
4775
  * <p>A unique name, chosen by you, for your transcription job. The name that you specify is
4777
4776
  * also used as the default name of your transcription output file. If you want to specify
4778
4777
  * a different name for your transcription output, use the <code>OutputKey</code>
@@ -4780,10 +4779,10 @@ export interface StartTranscriptionJobRequest {
4780
4779
  * <p>This name is case sensitive, cannot contain spaces, and must be unique within an
4781
4780
  * Amazon Web Services account. If you try to create a new job with the same name as an
4782
4781
  * existing job, you get a <code>ConflictException</code> error.</p>
4782
+ * @public
4783
4783
  */
4784
4784
  TranscriptionJobName: string | undefined;
4785
4785
  /**
4786
- * @public
4787
4786
  * <p>The language code that represents the language spoken in the input media file.</p>
4788
4787
  * <p>If you're unsure of the language spoken in your media file, consider using
4789
4788
  * <code>IdentifyLanguage</code> or <code>IdentifyMultipleLanguages</code> to enable
@@ -4798,30 +4797,30 @@ export interface StartTranscriptionJobRequest {
4798
4797
  * <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media
4799
4798
  * file must be encoded at a sample rate of 16,000 Hz or higher.</p>
4800
4799
  * </note>
4800
+ * @public
4801
4801
  */
4802
4802
  LanguageCode?: LanguageCode;
4803
4803
  /**
4804
- * @public
4805
4804
  * <p>The sample rate, in hertz, of the audio track in your input media file.</p>
4806
4805
  * <p>If you do not specify the media sample rate, Amazon Transcribe determines it for you.
4807
4806
  * If you specify the sample rate, it must match the rate detected by Amazon Transcribe.
4808
4807
  * If there's a mismatch between the value that you specify and the value detected, your
4809
4808
  * job fails. In most cases, you can omit <code>MediaSampleRateHertz</code> and let Amazon Transcribe determine the sample rate.</p>
4809
+ * @public
4810
4810
  */
4811
4811
  MediaSampleRateHertz?: number;
4812
4812
  /**
4813
- * @public
4814
4813
  * <p>Specify the format of your input media file.</p>
4814
+ * @public
4815
4815
  */
4816
4816
  MediaFormat?: MediaFormat;
4817
4817
  /**
4818
- * @public
4819
4818
  * <p>Describes the Amazon S3 location of the media file you want to use in your
4820
4819
  * request.</p>
4820
+ * @public
4821
4821
  */
4822
4822
  Media: Media | undefined;
4823
4823
  /**
4824
- * @public
4825
4824
  * <p>The name of the Amazon S3 bucket where you want your transcription output
4826
4825
  * stored. Do not include the <code>S3://</code> prefix of the specified bucket.</p>
4827
4826
  * <p>If you want your output to go to a sub-folder of this bucket, specify it using the
@@ -4837,10 +4836,10 @@ export interface StartTranscriptionJobRequest {
4837
4836
  * <p>If you do not specify <code>OutputBucketName</code>, your transcript is placed in a
4838
4837
  * service-managed Amazon S3 bucket and you are provided with a URI to access your
4839
4838
  * transcript.</p>
4839
+ * @public
4840
4840
  */
4841
4841
  OutputBucketName?: string;
4842
4842
  /**
4843
- * @public
4844
4843
  * <p>Use in combination with <code>OutputBucketName</code> to specify the output location
4845
4844
  * of your transcript and, optionally, a unique name for your output file. The default name
4846
4845
  * for your transcription output is the same as the name you specified for your
@@ -4875,10 +4874,10 @@ export interface StartTranscriptionJobRequest {
4875
4874
  * </ul>
4876
4875
  * <p>If you specify the name of an Amazon S3 bucket sub-folder that doesn't exist,
4877
4876
  * one is created for you.</p>
4877
+ * @public
4878
4878
  */
4879
4879
  OutputKey?: string;
4880
4880
  /**
4881
- * @public
4882
4881
  * <p>The KMS key you want to use to encrypt your transcription
4883
4882
  * output.</p>
4884
4883
  * <p>If using a key located in the <b>current</b>
@@ -4922,16 +4921,16 @@ export interface StartTranscriptionJobRequest {
4922
4921
  * an output location using the <code>OutputLocation</code> parameter.</p>
4923
4922
  * <p>Note that the role making the request must
4924
4923
  * have permission to use the specified KMS key.</p>
4924
+ * @public
4925
4925
  */
4926
4926
  OutputEncryptionKMSKeyId?: string;
4927
4927
  /**
4928
- * @public
4929
4928
  * <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs,
4930
4929
  * that provide an added layer of security for your data. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context">KMS encryption context</a> and <a href="https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html">Asymmetric keys in KMS</a>.</p>
4930
+ * @public
4931
4931
  */
4932
4932
  KMSEncryptionContext?: Record<string, string>;
4933
4933
  /**
4934
- * @public
4935
4934
  * <p>Specify additional optional settings in your
4936
4935
  * request, including channel identification, alternative transcriptions, speaker
4937
4936
  * partitioning. You can use that to apply custom vocabularies and vocabulary filters.</p>
@@ -4944,38 +4943,38 @@ export interface StartTranscriptionJobRequest {
4944
4943
  * instead the <code></code> parameter with the
4945
4944
  * <code>LanguageModelName</code>, <code>VocabularyName</code> or
4946
4945
  * <code>VocabularyFilterName</code> sub-parameters.</p>
4946
+ * @public
4947
4947
  */
4948
4948
  Settings?: Settings;
4949
4949
  /**
4950
- * @public
4951
4950
  * <p>Specify the custom language model you want to include with your transcription job. If
4952
4951
  * you include <code>ModelSettings</code> in your request, you must include the
4953
4952
  * <code>LanguageModelName</code> sub-parameter.</p>
4954
4953
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html">Custom language
4955
4954
  * models</a>.</p>
4955
+ * @public
4956
4956
  */
4957
4957
  ModelSettings?: ModelSettings;
4958
4958
  /**
4959
- * @public
4960
4959
  * <p>Makes it possible to control how your transcription job is processed. Currently, the
4961
4960
  * only <code>JobExecutionSettings</code> modification you can choose is enabling job
4962
4961
  * queueing using the <code>AllowDeferredExecution</code> sub-parameter.</p>
4963
4962
  * <p>If you include <code>JobExecutionSettings</code> in your request, you must also
4964
4963
  * include the sub-parameters: <code>AllowDeferredExecution</code> and
4965
4964
  * <code>DataAccessRoleArn</code>.</p>
4965
+ * @public
4966
4966
  */
4967
4967
  JobExecutionSettings?: JobExecutionSettings;
4968
4968
  /**
4969
- * @public
4970
4969
  * <p>Makes it possible to redact or flag specified personally identifiable information (PII) in
4971
4970
  * your transcript. If you use <code>ContentRedaction</code>, you must also include the
4972
4971
  * sub-parameters: <code>RedactionOutput</code> and <code>RedactionType</code>. You can
4973
4972
  * optionally include <code>PiiEntityTypes</code> to choose which types of PII you want to redact.
4974
4973
  * If you do not include <code>PiiEntityTypes</code> in your request, all PII is redacted.</p>
4974
+ * @public
4975
4975
  */
4976
4976
  ContentRedaction?: ContentRedaction;
4977
4977
  /**
4978
- * @public
4979
4978
  * <p>Enables automatic language identification in your transcription job request. Use this
4980
4979
  * parameter if your media file contains only one language. If your media contains multiple
4981
4980
  * languages, use <code>IdentifyMultipleLanguages</code> instead.</p>
@@ -4994,10 +4993,10 @@ export interface StartTranscriptionJobRequest {
4994
4993
  * <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your
4995
4994
  * request. If you include more than one of these parameters, your transcription job
4996
4995
  * fails.</p>
4996
+ * @public
4997
4997
  */
4998
4998
  IdentifyLanguage?: boolean;
4999
4999
  /**
5000
- * @public
5001
5000
  * <p>Enables automatic multi-language identification in your transcription job request. Use
5002
5001
  * this parameter if your media file contains more than one language. If your media
5003
5002
  * contains only one language, use <code>IdentifyLanguage</code> instead.</p>
@@ -5015,10 +5014,10 @@ export interface StartTranscriptionJobRequest {
5015
5014
  * <code>IdentifyLanguage</code>, or <code>IdentifyMultipleLanguages</code> in your
5016
5015
  * request. If you include more than one of these parameters, your transcription job
5017
5016
  * fails.</p>
5017
+ * @public
5018
5018
  */
5019
5019
  IdentifyMultipleLanguages?: boolean;
5020
5020
  /**
5021
- * @public
5022
5021
  * <p>You can specify two or more language codes that represent the languages you think may
5023
5022
  * be present in your media. Including more than five is not recommended. If you're unsure
5024
5023
  * what languages are present, do not include this parameter.</p>
@@ -5028,24 +5027,24 @@ export interface StartTranscriptionJobRequest {
5028
5027
  * languages</a>.</p>
5029
5028
  * <p>To transcribe speech in Modern Standard Arabic (<code>ar-SA</code>), your media file
5030
5029
  * must be encoded at a sample rate of 16,000 Hz or higher.</p>
5030
+ * @public
5031
5031
  */
5032
5032
  LanguageOptions?: LanguageCode[];
5033
5033
  /**
5034
- * @public
5035
5034
  * <p>Produces subtitle files for your input media. You can specify WebVTT (*.vtt) and
5036
5035
  * SubRip (*.srt) formats.</p>
5036
+ * @public
5037
5037
  */
5038
5038
  Subtitles?: Subtitles;
5039
5039
  /**
5040
- * @public
5041
5040
  * <p>Adds one or more custom tags, each in the form of a key:value pair, to a new
5042
5041
  * transcription job at the time you start this new job.</p>
5043
5042
  * <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
5044
5043
  * resources</a>.</p>
5044
+ * @public
5045
5045
  */
5046
5046
  Tags?: Tag[];
5047
5047
  /**
5048
- * @public
5049
5048
  * <p>If using automatic language identification in your request and you want to apply a
5050
5049
  * custom language model, a custom vocabulary, or a custom vocabulary filter, include
5051
5050
  * <code>LanguageIdSettings</code> with the relevant sub-parameters
@@ -5074,16 +5073,17 @@ export interface StartTranscriptionJobRequest {
5074
5073
  * instead the <code></code> parameter with the
5075
5074
  * <code>VocabularyName</code> or <code>VocabularyFilterName</code> (or both)
5076
5075
  * sub-parameter.</p>
5076
+ * @public
5077
5077
  */
5078
5078
  LanguageIdSettings?: Partial<Record<LanguageCode, LanguageIdSettings>>;
5079
5079
  /**
5080
- * @public
5081
5080
  * <p>Enables toxic speech detection in your transcript. If you include
5082
5081
  * <code>ToxicityDetection</code> in your request, you must also include
5083
5082
  * <code>ToxicityCategories</code>.</p>
5084
5083
  * <p>For information on the types of toxic speech Amazon Transcribe can detect, see
5085
5084
  * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/toxic-language.html">Detecting toxic
5086
5085
  * speech</a>.</p>
5086
+ * @public
5087
5087
  */
5088
5088
  ToxicityDetection?: ToxicityDetectionSettings[];
5089
5089
  }
@@ -5092,9 +5092,9 @@ export interface StartTranscriptionJobRequest {
5092
5092
  */
5093
5093
  export interface StartTranscriptionJobResponse {
5094
5094
  /**
5095
- * @public
5096
5095
  * <p>Provides detailed information about the current transcription job, including job
5097
5096
  * status and, if applicable, failure reason.</p>
5097
+ * @public
5098
5098
  */
5099
5099
  TranscriptionJob?: TranscriptionJob;
5100
5100
  }
@@ -5103,7 +5103,6 @@ export interface StartTranscriptionJobResponse {
5103
5103
  */
5104
5104
  export interface TagResourceRequest {
5105
5105
  /**
5106
- * @public
5107
5106
  * <p>The Amazon Resource Name (ARN) of the resource you want to tag. ARNs have the format
5108
5107
  * <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</p>
5109
5108
  * <p>For example,
@@ -5112,14 +5111,15 @@ export interface TagResourceRequest {
5112
5111
  * <code>medical-transcription-job</code>, <code>vocabulary</code>,
5113
5112
  * <code>medical-vocabulary</code>, <code>vocabulary-filter</code>, and
5114
5113
  * <code>language-model</code>.</p>
5114
+ * @public
5115
5115
  */
5116
5116
  ResourceArn: string | undefined;
5117
5117
  /**
5118
- * @public
5119
5118
  * <p>Adds one or more custom tags, each in the form of a key:value pair, to the specified
5120
5119
  * resource.</p>
5121
5120
  * <p>To learn more about using tags with Amazon Transcribe, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html">Tagging
5122
5121
  * resources</a>.</p>
5122
+ * @public
5123
5123
  */
5124
5124
  Tags: Tag[] | undefined;
5125
5125
  }
@@ -5133,7 +5133,6 @@ export interface TagResourceResponse {
5133
5133
  */
5134
5134
  export interface UntagResourceRequest {
5135
5135
  /**
5136
- * @public
5137
5136
  * <p>The Amazon Resource Name (ARN) of the Amazon Transcribe resource you want to remove
5138
5137
  * tags from. ARNs have the format
5139
5138
  * <code>arn:partition:service:region:account-id:resource-type/resource-id</code>.</p>
@@ -5143,11 +5142,12 @@ export interface UntagResourceRequest {
5143
5142
  * <code>medical-transcription-job</code>, <code>vocabulary</code>,
5144
5143
  * <code>medical-vocabulary</code>, <code>vocabulary-filter</code>, and
5145
5144
  * <code>language-model</code>.</p>
5145
+ * @public
5146
5146
  */
5147
5147
  ResourceArn: string | undefined;
5148
5148
  /**
5149
- * @public
5150
5149
  * <p>Removes the specified tag keys from the specified Amazon Transcribe resource.</p>
5150
+ * @public
5151
5151
  */
5152
5152
  TagKeys: string[] | undefined;
5153
5153
  }
@@ -5161,23 +5161,23 @@ export interface UntagResourceResponse {
5161
5161
  */
5162
5162
  export interface UpdateCallAnalyticsCategoryRequest {
5163
5163
  /**
5164
- * @public
5165
5164
  * <p>The name of the Call Analytics category you want to update. Category names are case
5166
5165
  * sensitive.</p>
5166
+ * @public
5167
5167
  */
5168
5168
  CategoryName: string | undefined;
5169
5169
  /**
5170
- * @public
5171
5170
  * <p>The rules used for the updated Call Analytics category. The rules you provide in this
5172
5171
  * field replace the ones that are currently being used in the specified category.</p>
5172
+ * @public
5173
5173
  */
5174
5174
  Rules: Rule[] | undefined;
5175
5175
  /**
5176
- * @public
5177
5176
  * <p>Choose whether you want to update a real-time or a post-call category. The
5178
5177
  * input type you specify must match the input type specified when the category was created. For
5179
5178
  * example, if you created a category with the <code>POST_CALL</code> input type, you must
5180
5179
  * use <code>POST_CALL</code> as the input type when updating this category.</p>
5180
+ * @public
5181
5181
  */
5182
5182
  InputType?: InputType;
5183
5183
  }
@@ -5186,9 +5186,9 @@ export interface UpdateCallAnalyticsCategoryRequest {
5186
5186
  */
5187
5187
  export interface UpdateCallAnalyticsCategoryResponse {
5188
5188
  /**
5189
- * @public
5190
5189
  * <p>Provides you with the properties of the Call Analytics category you specified in your
5191
5190
  * <code>UpdateCallAnalyticsCategory</code> request.</p>
5191
+ * @public
5192
5192
  */
5193
5193
  CategoryProperties?: CategoryProperties;
5194
5194
  }
@@ -5197,26 +5197,26 @@ export interface UpdateCallAnalyticsCategoryResponse {
5197
5197
  */
5198
5198
  export interface UpdateMedicalVocabularyRequest {
5199
5199
  /**
5200
- * @public
5201
5200
  * <p>The name of the custom medical vocabulary you want to update. Custom medical
5202
5201
  * vocabulary names are case sensitive.</p>
5202
+ * @public
5203
5203
  */
5204
5204
  VocabularyName: string | undefined;
5205
5205
  /**
5206
- * @public
5207
5206
  * <p>The language code that represents the language of the entries in the custom vocabulary
5208
5207
  * you want to update. US English (<code>en-US</code>) is the only language supported with
5209
5208
  * Amazon Transcribe Medical.</p>
5209
+ * @public
5210
5210
  */
5211
5211
  LanguageCode: LanguageCode | undefined;
5212
5212
  /**
5213
- * @public
5214
5213
  * <p>The Amazon S3 location of the text file that contains your custom medical
5215
5214
  * vocabulary. The URI must be located in the same Amazon Web Services Region as the
5216
5215
  * resource you're calling.</p>
5217
5216
  * <p>Here's an example URI path:
5218
5217
  * <code>s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt</code>
5219
5218
  * </p>
5219
+ * @public
5220
5220
  */
5221
5221
  VocabularyFileUri: string | undefined;
5222
5222
  }
@@ -5225,30 +5225,30 @@ export interface UpdateMedicalVocabularyRequest {
5225
5225
  */
5226
5226
  export interface UpdateMedicalVocabularyResponse {
5227
5227
  /**
5228
- * @public
5229
5228
  * <p>The name of the updated custom medical vocabulary.</p>
5229
+ * @public
5230
5230
  */
5231
5231
  VocabularyName?: string;
5232
5232
  /**
5233
- * @public
5234
5233
  * <p>The language code you selected for your custom medical vocabulary. US English
5235
5234
  * (<code>en-US</code>) is the only language supported with Amazon Transcribe
5236
5235
  * Medical.</p>
5236
+ * @public
5237
5237
  */
5238
5238
  LanguageCode?: LanguageCode;
5239
5239
  /**
5240
- * @public
5241
5240
  * <p>The date and time the specified custom medical vocabulary was last updated.</p>
5242
5241
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
5243
5242
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
5244
5243
  * 4, 2022.</p>
5244
+ * @public
5245
5245
  */
5246
5246
  LastModifiedTime?: Date;
5247
5247
  /**
5248
- * @public
5249
5248
  * <p>The processing state of your custom medical vocabulary. If the state is
5250
5249
  * <code>READY</code>, you can use the custom vocabulary in a
5251
5250
  * <code>StartMedicalTranscriptionJob</code> request.</p>
5251
+ * @public
5252
5252
  */
5253
5253
  VocabularyState?: VocabularyState;
5254
5254
  }
@@ -5257,13 +5257,12 @@ export interface UpdateMedicalVocabularyResponse {
5257
5257
  */
5258
5258
  export interface UpdateVocabularyRequest {
5259
5259
  /**
5260
- * @public
5261
5260
  * <p>The name of the custom vocabulary you want to update. Custom vocabulary names are case
5262
5261
  * sensitive.</p>
5262
+ * @public
5263
5263
  */
5264
5264
  VocabularyName: string | undefined;
5265
5265
  /**
5266
- * @public
5267
5266
  * <p>The language code that represents the language of the entries in the custom vocabulary
5268
5267
  * you want to update. Each custom vocabulary must contain terms in only one
5269
5268
  * language.</p>
@@ -5273,10 +5272,10 @@ export interface UpdateVocabularyRequest {
5273
5272
  * contain English audio.</p>
5274
5273
  * <p>For a list of supported languages and their associated language codes, refer to the
5275
5274
  * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table.</p>
5275
+ * @public
5276
5276
  */
5277
5277
  LanguageCode: LanguageCode | undefined;
5278
5278
  /**
5279
- * @public
5280
5279
  * <p>Use this parameter if you want to update your custom vocabulary by including all
5281
5280
  * desired terms, as comma-separated values, within your request. The other option for
5282
5281
  * updating your custom vocabulary is to save your entries in a text file and upload them
@@ -5288,10 +5287,10 @@ export interface UpdateVocabularyRequest {
5288
5287
  * specific language. If you use unsupported characters, your custom vocabulary filter
5289
5288
  * request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
5290
5289
  * Vocabularies</a> to get the character set for your language.</p>
5290
+ * @public
5291
5291
  */
5292
5292
  Phrases?: string[];
5293
5293
  /**
5294
- * @public
5295
5294
  * <p>The Amazon S3 location of the text file that contains your custom vocabulary.
5296
5295
  * The URI must be located in the same Amazon Web Services Region as the resource you're
5297
5296
  * calling.</p>
@@ -5300,10 +5299,10 @@ export interface UpdateVocabularyRequest {
5300
5299
  * </p>
5301
5300
  * <p>Note that if you include <code>VocabularyFileUri</code> in your request, you cannot
5302
5301
  * use the <code>Phrases</code> flag; you must choose one or the other.</p>
5302
+ * @public
5303
5303
  */
5304
5304
  VocabularyFileUri?: string;
5305
5305
  /**
5306
- * @public
5307
5306
  * <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
5308
5307
  * access the Amazon S3 bucket that contains your input files (in this case, your custom
5309
5308
  * vocabulary). If the role that you specify doesn’t have the appropriate permissions to access
@@ -5313,6 +5312,7 @@ export interface UpdateVocabularyRequest {
5313
5312
  * <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
5314
5313
  * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
5315
5314
  * ARNs</a>.</p>
5315
+ * @public
5316
5316
  */
5317
5317
  DataAccessRoleArn?: string;
5318
5318
  }
@@ -5321,28 +5321,28 @@ export interface UpdateVocabularyRequest {
5321
5321
  */
5322
5322
  export interface UpdateVocabularyResponse {
5323
5323
  /**
5324
- * @public
5325
5324
  * <p>The name of the updated custom vocabulary.</p>
5325
+ * @public
5326
5326
  */
5327
5327
  VocabularyName?: string;
5328
5328
  /**
5329
- * @public
5330
5329
  * <p>The language code you selected for your custom vocabulary.</p>
5330
+ * @public
5331
5331
  */
5332
5332
  LanguageCode?: LanguageCode;
5333
5333
  /**
5334
- * @public
5335
5334
  * <p>The date and time the specified custom vocabulary was last updated.</p>
5336
5335
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
5337
5336
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
5338
5337
  * 4, 2022.</p>
5338
+ * @public
5339
5339
  */
5340
5340
  LastModifiedTime?: Date;
5341
5341
  /**
5342
- * @public
5343
5342
  * <p>The processing state of your custom vocabulary. If the state is <code>READY</code>,
5344
5343
  * you can use the custom vocabulary in a <code>StartTranscriptionJob</code>
5345
5344
  * request.</p>
5345
+ * @public
5346
5346
  */
5347
5347
  VocabularyState?: VocabularyState;
5348
5348
  }
@@ -5351,13 +5351,12 @@ export interface UpdateVocabularyResponse {
5351
5351
  */
5352
5352
  export interface UpdateVocabularyFilterRequest {
5353
5353
  /**
5354
- * @public
5355
5354
  * <p>The name of the custom vocabulary filter you want to update. Custom vocabulary filter
5356
5355
  * names are case sensitive.</p>
5356
+ * @public
5357
5357
  */
5358
5358
  VocabularyFilterName: string | undefined;
5359
5359
  /**
5360
- * @public
5361
5360
  * <p>Use this parameter if you want to update your custom vocabulary filter by including
5362
5361
  * all desired terms, as comma-separated values, within your request. The other option for
5363
5362
  * updating your vocabulary filter is to save your entries in a text file and upload them
@@ -5369,10 +5368,10 @@ export interface UpdateVocabularyFilterRequest {
5369
5368
  * specific language. If you use unsupported characters, your custom vocabulary filter
5370
5369
  * request fails. Refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html">Character Sets for Custom
5371
5370
  * Vocabularies</a> to get the character set for your language.</p>
5371
+ * @public
5372
5372
  */
5373
5373
  Words?: string[];
5374
5374
  /**
5375
- * @public
5376
5375
  * <p>The Amazon S3 location of the text file that contains your custom vocabulary
5377
5376
  * filter terms. The URI must be located in the same Amazon Web Services Region as the
5378
5377
  * resource you're calling.</p>
@@ -5381,10 +5380,10 @@ export interface UpdateVocabularyFilterRequest {
5381
5380
  * </p>
5382
5381
  * <p>Note that if you include <code>VocabularyFilterFileUri</code> in your request, you
5383
5382
  * cannot use <code>Words</code>; you must choose one or the other.</p>
5383
+ * @public
5384
5384
  */
5385
5385
  VocabularyFilterFileUri?: string;
5386
5386
  /**
5387
- * @public
5388
5387
  * <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
5389
5388
  * access the Amazon S3 bucket that contains your input files (in this case, your custom
5390
5389
  * vocabulary filter). If the role that you specify doesn’t have the appropriate permissions to access
@@ -5394,6 +5393,7 @@ export interface UpdateVocabularyFilterRequest {
5394
5393
  * <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
5395
5394
  * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
5396
5395
  * ARNs</a>.</p>
5396
+ * @public
5397
5397
  */
5398
5398
  DataAccessRoleArn?: string;
5399
5399
  }
@@ -5402,21 +5402,21 @@ export interface UpdateVocabularyFilterRequest {
5402
5402
  */
5403
5403
  export interface UpdateVocabularyFilterResponse {
5404
5404
  /**
5405
- * @public
5406
5405
  * <p>The name of the updated custom vocabulary filter.</p>
5406
+ * @public
5407
5407
  */
5408
5408
  VocabularyFilterName?: string;
5409
5409
  /**
5410
- * @public
5411
5410
  * <p>The language code you selected for your custom vocabulary filter.</p>
5411
+ * @public
5412
5412
  */
5413
5413
  LanguageCode?: LanguageCode;
5414
5414
  /**
5415
- * @public
5416
5415
  * <p>The date and time the specified custom vocabulary filter was last updated.</p>
5417
5416
  * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
5418
5417
  * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents 12:32 PM UTC-7 on May
5419
5418
  * 4, 2022.</p>
5419
+ * @public
5420
5420
  */
5421
5421
  LastModifiedTime?: Date;
5422
5422
  }