transcribeservice.d.ts
66.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class TranscribeService extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: TranscribeService.Types.ClientConfiguration)
config: Config & TranscribeService.Types.ClientConfiguration;
/**
* Creates a new custom vocabulary that you can use to change how Amazon Transcribe Medical transcribes your audio file.
*/
createMedicalVocabulary(params: TranscribeService.Types.CreateMedicalVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.CreateMedicalVocabularyResponse) => void): Request<TranscribeService.Types.CreateMedicalVocabularyResponse, AWSError>;
/**
* Creates a new custom vocabulary that you can use to change how Amazon Transcribe Medical transcribes your audio file.
*/
createMedicalVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.CreateMedicalVocabularyResponse) => void): Request<TranscribeService.Types.CreateMedicalVocabularyResponse, AWSError>;
/**
* Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
*/
createVocabulary(params: TranscribeService.Types.CreateVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.CreateVocabularyResponse) => void): Request<TranscribeService.Types.CreateVocabularyResponse, AWSError>;
/**
* Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.
*/
createVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.CreateVocabularyResponse) => void): Request<TranscribeService.Types.CreateVocabularyResponse, AWSError>;
/**
* Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
*/
createVocabularyFilter(params: TranscribeService.Types.CreateVocabularyFilterRequest, callback?: (err: AWSError, data: TranscribeService.Types.CreateVocabularyFilterResponse) => void): Request<TranscribeService.Types.CreateVocabularyFilterResponse, AWSError>;
/**
* Creates a new vocabulary filter that you can use to filter words, such as profane words, from the output of a transcription job.
*/
createVocabularyFilter(callback?: (err: AWSError, data: TranscribeService.Types.CreateVocabularyFilterResponse) => void): Request<TranscribeService.Types.CreateVocabularyFilterResponse, AWSError>;
/**
* Deletes a transcription job generated by Amazon Transcribe Medical and any related information.
*/
deleteMedicalTranscriptionJob(params: TranscribeService.Types.DeleteMedicalTranscriptionJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a transcription job generated by Amazon Transcribe Medical and any related information.
*/
deleteMedicalTranscriptionJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a vocabulary from Amazon Transcribe Medical.
*/
deleteMedicalVocabulary(params: TranscribeService.Types.DeleteMedicalVocabularyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a vocabulary from Amazon Transcribe Medical.
*/
deleteMedicalVocabulary(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
*/
deleteTranscriptionJob(params: TranscribeService.Types.DeleteTranscriptionJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.
*/
deleteTranscriptionJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a vocabulary from Amazon Transcribe.
*/
deleteVocabulary(params: TranscribeService.Types.DeleteVocabularyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a vocabulary from Amazon Transcribe.
*/
deleteVocabulary(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a vocabulary filter.
*/
deleteVocabularyFilter(params: TranscribeService.Types.DeleteVocabularyFilterRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a vocabulary filter.
*/
deleteVocabularyFilter(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You find the results of the completed job in the TranscriptFileUri field.
*/
getMedicalTranscriptionJob(params: TranscribeService.Types.GetMedicalTranscriptionJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetMedicalTranscriptionJobResponse) => void): Request<TranscribeService.Types.GetMedicalTranscriptionJobResponse, AWSError>;
/**
* Returns information about a transcription job from Amazon Transcribe Medical. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You find the results of the completed job in the TranscriptFileUri field.
*/
getMedicalTranscriptionJob(callback?: (err: AWSError, data: TranscribeService.Types.GetMedicalTranscriptionJobResponse) => void): Request<TranscribeService.Types.GetMedicalTranscriptionJobResponse, AWSError>;
/**
* Retrieve information about a medical vocabulary.
*/
getMedicalVocabulary(params: TranscribeService.Types.GetMedicalVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetMedicalVocabularyResponse) => void): Request<TranscribeService.Types.GetMedicalVocabularyResponse, AWSError>;
/**
* Retrieve information about a medical vocabulary.
*/
getMedicalVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.GetMedicalVocabularyResponse) => void): Request<TranscribeService.Types.GetMedicalVocabularyResponse, AWSError>;
/**
* Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri.
*/
getTranscriptionJob(params: TranscribeService.Types.GetTranscriptionJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetTranscriptionJobResponse) => void): Request<TranscribeService.Types.GetTranscriptionJobResponse, AWSError>;
/**
* Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri.
*/
getTranscriptionJob(callback?: (err: AWSError, data: TranscribeService.Types.GetTranscriptionJobResponse) => void): Request<TranscribeService.Types.GetTranscriptionJobResponse, AWSError>;
/**
* Gets information about a vocabulary.
*/
getVocabulary(params: TranscribeService.Types.GetVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetVocabularyResponse) => void): Request<TranscribeService.Types.GetVocabularyResponse, AWSError>;
/**
* Gets information about a vocabulary.
*/
getVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.GetVocabularyResponse) => void): Request<TranscribeService.Types.GetVocabularyResponse, AWSError>;
/**
* Returns information about a vocabulary filter.
*/
getVocabularyFilter(params: TranscribeService.Types.GetVocabularyFilterRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetVocabularyFilterResponse) => void): Request<TranscribeService.Types.GetVocabularyFilterResponse, AWSError>;
/**
* Returns information about a vocabulary filter.
*/
getVocabularyFilter(callback?: (err: AWSError, data: TranscribeService.Types.GetVocabularyFilterResponse) => void): Request<TranscribeService.Types.GetVocabularyFilterResponse, AWSError>;
/**
* Lists medical transcription jobs with a specified status or substring that matches their names.
*/
listMedicalTranscriptionJobs(params: TranscribeService.Types.ListMedicalTranscriptionJobsRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListMedicalTranscriptionJobsResponse) => void): Request<TranscribeService.Types.ListMedicalTranscriptionJobsResponse, AWSError>;
/**
* Lists medical transcription jobs with a specified status or substring that matches their names.
*/
listMedicalTranscriptionJobs(callback?: (err: AWSError, data: TranscribeService.Types.ListMedicalTranscriptionJobsResponse) => void): Request<TranscribeService.Types.ListMedicalTranscriptionJobsResponse, AWSError>;
/**
* Returns a list of vocabularies that match the specified criteria. You get the entire list of vocabularies if you don't enter a value in any of the request parameters.
*/
listMedicalVocabularies(params: TranscribeService.Types.ListMedicalVocabulariesRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListMedicalVocabulariesResponse) => void): Request<TranscribeService.Types.ListMedicalVocabulariesResponse, AWSError>;
/**
* Returns a list of vocabularies that match the specified criteria. You get the entire list of vocabularies if you don't enter a value in any of the request parameters.
*/
listMedicalVocabularies(callback?: (err: AWSError, data: TranscribeService.Types.ListMedicalVocabulariesResponse) => void): Request<TranscribeService.Types.ListMedicalVocabulariesResponse, AWSError>;
/**
* Lists transcription jobs with the specified status.
*/
listTranscriptionJobs(params: TranscribeService.Types.ListTranscriptionJobsRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListTranscriptionJobsResponse) => void): Request<TranscribeService.Types.ListTranscriptionJobsResponse, AWSError>;
/**
* Lists transcription jobs with the specified status.
*/
listTranscriptionJobs(callback?: (err: AWSError, data: TranscribeService.Types.ListTranscriptionJobsResponse) => void): Request<TranscribeService.Types.ListTranscriptionJobsResponse, AWSError>;
/**
* Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
*/
listVocabularies(params: TranscribeService.Types.ListVocabulariesRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListVocabulariesResponse) => void): Request<TranscribeService.Types.ListVocabulariesResponse, AWSError>;
/**
* Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.
*/
listVocabularies(callback?: (err: AWSError, data: TranscribeService.Types.ListVocabulariesResponse) => void): Request<TranscribeService.Types.ListVocabulariesResponse, AWSError>;
/**
* Gets information about vocabulary filters.
*/
listVocabularyFilters(params: TranscribeService.Types.ListVocabularyFiltersRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListVocabularyFiltersResponse) => void): Request<TranscribeService.Types.ListVocabularyFiltersResponse, AWSError>;
/**
* Gets information about vocabulary filters.
*/
listVocabularyFilters(callback?: (err: AWSError, data: TranscribeService.Types.ListVocabularyFiltersResponse) => void): Request<TranscribeService.Types.ListVocabularyFiltersResponse, AWSError>;
/**
* Start a batch job to transcribe medical speech to text.
*/
startMedicalTranscriptionJob(params: TranscribeService.Types.StartMedicalTranscriptionJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.StartMedicalTranscriptionJobResponse) => void): Request<TranscribeService.Types.StartMedicalTranscriptionJobResponse, AWSError>;
/**
* Start a batch job to transcribe medical speech to text.
*/
startMedicalTranscriptionJob(callback?: (err: AWSError, data: TranscribeService.Types.StartMedicalTranscriptionJobResponse) => void): Request<TranscribeService.Types.StartMedicalTranscriptionJobResponse, AWSError>;
/**
* Starts an asynchronous job to transcribe speech to text.
*/
startTranscriptionJob(params: TranscribeService.Types.StartTranscriptionJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.StartTranscriptionJobResponse) => void): Request<TranscribeService.Types.StartTranscriptionJobResponse, AWSError>;
/**
* Starts an asynchronous job to transcribe speech to text.
*/
startTranscriptionJob(callback?: (err: AWSError, data: TranscribeService.Types.StartTranscriptionJobResponse) => void): Request<TranscribeService.Types.StartTranscriptionJobResponse, AWSError>;
/**
* Updates an existing vocabulary with new values in a different text file. The UpdateMedicalVocabulary operation overwrites all of the existing information with the values that you provide in the request.
*/
updateMedicalVocabulary(params: TranscribeService.Types.UpdateMedicalVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.UpdateMedicalVocabularyResponse) => void): Request<TranscribeService.Types.UpdateMedicalVocabularyResponse, AWSError>;
/**
* Updates an existing vocabulary with new values in a different text file. The UpdateMedicalVocabulary operation overwrites all of the existing information with the values that you provide in the request.
*/
updateMedicalVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.UpdateMedicalVocabularyResponse) => void): Request<TranscribeService.Types.UpdateMedicalVocabularyResponse, AWSError>;
/**
* Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.
*/
updateVocabulary(params: TranscribeService.Types.UpdateVocabularyRequest, callback?: (err: AWSError, data: TranscribeService.Types.UpdateVocabularyResponse) => void): Request<TranscribeService.Types.UpdateVocabularyResponse, AWSError>;
/**
* Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.
*/
updateVocabulary(callback?: (err: AWSError, data: TranscribeService.Types.UpdateVocabularyResponse) => void): Request<TranscribeService.Types.UpdateVocabularyResponse, AWSError>;
/**
* Updates a vocabulary filter with a new list of filtered words.
*/
updateVocabularyFilter(params: TranscribeService.Types.UpdateVocabularyFilterRequest, callback?: (err: AWSError, data: TranscribeService.Types.UpdateVocabularyFilterResponse) => void): Request<TranscribeService.Types.UpdateVocabularyFilterResponse, AWSError>;
/**
* Updates a vocabulary filter with a new list of filtered words.
*/
updateVocabularyFilter(callback?: (err: AWSError, data: TranscribeService.Types.UpdateVocabularyFilterResponse) => void): Request<TranscribeService.Types.UpdateVocabularyFilterResponse, AWSError>;
}
declare namespace TranscribeService {
export type Boolean = boolean;
export interface ContentRedaction {
/**
* Request parameter that defines the entities to be redacted. The only accepted value is PII.
*/
RedactionType: RedactionType;
/**
* The output transcript file stored in either the default S3 bucket or in a bucket you specify. When you choose redacted Amazon Transcribe outputs only the redacted transcript. When you choose redacted_and_unredacted Amazon Transcribe outputs both the redacted and unredacted transcripts.
*/
RedactionOutput: RedactionOutput;
}
export interface CreateMedicalVocabularyRequest {
/**
* The name of the custom vocabulary. This case-sensitive name must be unique within an AWS account. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.
*/
VocabularyName: VocabularyName;
/**
* The language code used for the entries within your custom vocabulary. The language code of your custom vocabulary must match the language code of your transcription job. US English (en-US) is the only language code available for Amazon Transcribe Medical.
*/
LanguageCode: LanguageCode;
/**
* The Amazon S3 location of the text file you use to define your custom vocabulary. The URI must be in the same AWS region as the API endpoint you're calling. Enter information about your VocabularyFileUri in the following format: https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> This is an example of a vocabulary file uri location in Amazon S3: https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide. For more information about custom vocabularies, see Medical Custom Vocabularies.
*/
VocabularyFileUri: Uri;
}
export interface CreateMedicalVocabularyResponse {
/**
* The name of the vocabulary. The name must be unique within an AWS account. It is also case-sensitive.
*/
VocabularyName?: VocabularyName;
/**
* The language code you chose to describe the entries in your custom vocabulary. US English (en-US) is the only valid language code for Amazon Transcribe Medical.
*/
LanguageCode?: LanguageCode;
/**
* The processing state of your custom vocabulary in Amazon Transcribe Medical. If the state is READY you can use the vocabulary in a StartMedicalTranscriptionJob request.
*/
VocabularyState?: VocabularyState;
/**
* The date and time you created the vocabulary.
*/
LastModifiedTime?: DateTime;
/**
* If the VocabularyState field is FAILED, this field contains information about why the job failed.
*/
FailureReason?: FailureReason;
}
export interface CreateVocabularyFilterRequest {
/**
* The vocabulary filter name. The name must be unique within the account that contains it.If you try to create a vocabulary filter with the same name as a previous vocabulary filter you will receive a ConflictException error.
*/
VocabularyFilterName: VocabularyFilterName;
/**
* The language code of the words in the vocabulary filter. All words in the filter must be in the same language. The vocabulary filter can only be used with transcription jobs in the specified language.
*/
LanguageCode: LanguageCode;
/**
* The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies. If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.
*/
Words?: Words;
/**
* The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies. The specified file must be less than 50 KB of UTF-8 characters. If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.
*/
VocabularyFilterFileUri?: Uri;
}
export interface CreateVocabularyFilterResponse {
/**
* The name of the vocabulary filter.
*/
VocabularyFilterName?: VocabularyFilterName;
/**
* The language code of the words in the collection.
*/
LanguageCode?: LanguageCode;
/**
* The date and time that the vocabulary filter was modified.
*/
LastModifiedTime?: DateTime;
}
export interface CreateVocabularyRequest {
/**
* The name of the vocabulary. The name must be unique within an AWS account. The name is case-sensitive. If you try to create a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.
*/
VocabularyName: VocabularyName;
/**
* The language code of the vocabulary entries.
*/
LanguageCode: LanguageCode;
/**
* An array of strings that contains the vocabulary entries.
*/
Phrases?: Phrases;
/**
* The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide. For more information about custom vocabularies, see Custom Vocabularies.
*/
VocabularyFileUri?: Uri;
}
export interface CreateVocabularyResponse {
/**
* The name of the vocabulary.
*/
VocabularyName?: VocabularyName;
/**
* The language code of the vocabulary entries.
*/
LanguageCode?: LanguageCode;
/**
* The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.
*/
VocabularyState?: VocabularyState;
/**
* The date and time that the vocabulary was created.
*/
LastModifiedTime?: DateTime;
/**
* If the VocabularyState field is FAILED, this field contains information about why the job failed.
*/
FailureReason?: FailureReason;
}
export type DataAccessRoleArn = string;
export type DateTime = Date;
export interface DeleteMedicalTranscriptionJobRequest {
/**
* The name you provide to the DeleteMedicalTranscriptionJob object to delete a transcription job.
*/
MedicalTranscriptionJobName: TranscriptionJobName;
}
export interface DeleteMedicalVocabularyRequest {
/**
* The name of the vocabulary you are choosing to delete.
*/
VocabularyName: VocabularyName;
}
export interface DeleteTranscriptionJobRequest {
/**
* The name of the transcription job to be deleted.
*/
TranscriptionJobName: TranscriptionJobName;
}
export interface DeleteVocabularyFilterRequest {
/**
* The name of the vocabulary filter to remove.
*/
VocabularyFilterName: VocabularyFilterName;
}
export interface DeleteVocabularyRequest {
/**
* The name of the vocabulary to delete.
*/
VocabularyName: VocabularyName;
}
export type FailureReason = string;
export interface GetMedicalTranscriptionJobRequest {
/**
* The name of the medical transcription job.
*/
MedicalTranscriptionJobName: TranscriptionJobName;
}
export interface GetMedicalTranscriptionJobResponse {
/**
* An object that contains the results of the medical transcription job.
*/
MedicalTranscriptionJob?: MedicalTranscriptionJob;
}
export interface GetMedicalVocabularyRequest {
/**
* The name of the vocabulary you are trying to get information about. The value you enter for this request is case-sensitive.
*/
VocabularyName: VocabularyName;
}
export interface GetMedicalVocabularyResponse {
/**
* The valid name that Amazon Transcribe Medical returns.
*/
VocabularyName?: VocabularyName;
/**
* The valid language code returned for your vocabulary entries.
*/
LanguageCode?: LanguageCode;
/**
* The processing state of the vocabulary.
*/
VocabularyState?: VocabularyState;
/**
* The date and time the vocabulary was last modified with a text file different from what was previously used.
*/
LastModifiedTime?: DateTime;
/**
* If the VocabularyState is FAILED, this field contains information about why the job failed.
*/
FailureReason?: FailureReason;
/**
* The Amazon S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. You can download your vocabulary from the URI for a limited time.
*/
DownloadUri?: Uri;
}
export interface GetTranscriptionJobRequest {
/**
* The name of the job.
*/
TranscriptionJobName: TranscriptionJobName;
}
export interface GetTranscriptionJobResponse {
/**
* An object that contains the results of the transcription job.
*/
TranscriptionJob?: TranscriptionJob;
}
export interface GetVocabularyFilterRequest {
/**
* The name of the vocabulary filter for which to return information.
*/
VocabularyFilterName: VocabularyFilterName;
}
export interface GetVocabularyFilterResponse {
/**
* The name of the vocabulary filter.
*/
VocabularyFilterName?: VocabularyFilterName;
/**
* The language code of the words in the vocabulary filter.
*/
LanguageCode?: LanguageCode;
/**
* The date and time that the contents of the vocabulary filter were updated.
*/
LastModifiedTime?: DateTime;
/**
* The URI of the list of words in the vocabulary filter. You can use this URI to get the list of words.
*/
DownloadUri?: Uri;
}
export interface GetVocabularyRequest {
/**
* The name of the vocabulary to return information about. The name is case-sensitive.
*/
VocabularyName: VocabularyName;
}
export interface GetVocabularyResponse {
/**
* The name of the vocabulary to return.
*/
VocabularyName?: VocabularyName;
/**
* The language code of the vocabulary entries.
*/
LanguageCode?: LanguageCode;
/**
* The processing state of the vocabulary.
*/
VocabularyState?: VocabularyState;
/**
* The date and time that the vocabulary was last modified.
*/
LastModifiedTime?: DateTime;
/**
* If the VocabularyState field is FAILED, this field contains information about why the job failed.
*/
FailureReason?: FailureReason;
/**
* The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.
*/
DownloadUri?: Uri;
}
export interface JobExecutionSettings {
/**
* Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception. If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
*/
AllowDeferredExecution?: Boolean;
/**
* The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well. If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
*/
DataAccessRoleArn?: DataAccessRoleArn;
}
export type KMSKeyId = string;
export type LanguageCode = "en-US"|"es-US"|"en-AU"|"fr-CA"|"en-GB"|"de-DE"|"pt-BR"|"fr-FR"|"it-IT"|"ko-KR"|"es-ES"|"en-IN"|"hi-IN"|"ar-SA"|"ru-RU"|"zh-CN"|"nl-NL"|"id-ID"|"ta-IN"|"fa-IR"|"en-IE"|"en-AB"|"en-WL"|"pt-PT"|"te-IN"|"tr-TR"|"de-CH"|"he-IL"|"ms-MY"|"ja-JP"|"ar-AE"|string;
export interface ListMedicalTranscriptionJobsRequest {
/**
* When specified, returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don't specify a status, Amazon Transcribe Medical returns all transcription jobs ordered by creation date.
*/
Status?: TranscriptionJobStatus;
/**
* When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
*/
JobNameContains?: TranscriptionJobName;
/**
* If you a receive a truncated result in the previous request of ListMedicalTranscriptionJobs, include NextToken to fetch the next set of jobs.
*/
NextToken?: NextToken;
/**
* The maximum number of medical transcription jobs to return in the response. IF there are fewer results in the list, this response contains only the actual results.
*/
MaxResults?: MaxResults;
}
export interface ListMedicalTranscriptionJobsResponse {
/**
* The requested status of the medical transcription jobs returned.
*/
Status?: TranscriptionJobStatus;
/**
* The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the ListMedicalTranscriptionJobs operation to return in the next page of jobs.
*/
NextToken?: NextToken;
/**
* A list of objects containing summary information for a transcription job.
*/
MedicalTranscriptionJobSummaries?: MedicalTranscriptionJobSummaries;
}
export interface ListMedicalVocabulariesRequest {
/**
* If the result of your previous request to ListMedicalVocabularies was truncated, include the NextToken to fetch the next set of jobs.
*/
NextToken?: NextToken;
/**
* The maximum number of vocabularies to return in the response.
*/
MaxResults?: MaxResults;
/**
* When specified, only returns vocabularies with the VocabularyState equal to the specified vocabulary state.
*/
StateEquals?: VocabularyState;
/**
* Returns vocabularies in the list whose name contains the specified string. The search is case-insensitive, ListMedicalVocabularies returns both "vocabularyname" and "VocabularyName" in the response list.
*/
NameContains?: VocabularyName;
}
export interface ListMedicalVocabulariesResponse {
/**
* The requested vocabulary state.
*/
Status?: VocabularyState;
/**
* The ListMedicalVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the ListMedicalVocabularies operation to return the next page of jobs.
*/
NextToken?: NextToken;
/**
* A list of objects that describe the vocabularies that match the search criteria in the request.
*/
Vocabularies?: Vocabularies;
}
export interface ListTranscriptionJobsRequest {
/**
* When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.
*/
Status?: TranscriptionJobStatus;
/**
* When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
*/
JobNameContains?: TranscriptionJobName;
/**
* If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.
*/
NextToken?: NextToken;
/**
* The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.
*/
MaxResults?: MaxResults;
}
export interface ListTranscriptionJobsResponse {
/**
* The requested status of the jobs returned.
*/
Status?: TranscriptionJobStatus;
/**
* The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListTranscriptionJobs operation to return in the next page of jobs.
*/
NextToken?: NextToken;
/**
* A list of objects containing summary information for a transcription job.
*/
TranscriptionJobSummaries?: TranscriptionJobSummaries;
}
export interface ListVocabulariesRequest {
/**
* If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.
*/
NextToken?: NextToken;
/**
* The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.
*/
MaxResults?: MaxResults;
/**
* When specified, only returns vocabularies with the VocabularyState field equal to the specified state.
*/
StateEquals?: VocabularyState;
/**
* When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, ListVocabularies returns both "vocabularyname" and "VocabularyName" in the response list.
*/
NameContains?: VocabularyName;
}
export interface ListVocabulariesResponse {
/**
* The requested vocabulary state.
*/
Status?: VocabularyState;
/**
* The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListVocabularies operation to return in the next page of jobs.
*/
NextToken?: NextToken;
/**
* A list of objects that describe the vocabularies that match the search criteria in the request.
*/
Vocabularies?: Vocabularies;
}
export interface ListVocabularyFiltersRequest {
/**
* If the result of the previous request to ListVocabularyFilters was truncated, include the NextToken to fetch the next set of collections.
*/
NextToken?: NextToken;
/**
* The maximum number of filters to return in the response. If there are fewer results in the list, this response contains only the actual results.
*/
MaxResults?: MaxResults;
/**
* Filters the response so that it only contains vocabulary filters whose name contains the specified string.
*/
NameContains?: VocabularyFilterName;
}
export interface ListVocabularyFiltersResponse {
/**
* The ListVocabularyFilters operation returns a page of collections at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListVocabularyFilters operation to return in the next page of jobs.
*/
NextToken?: NextToken;
/**
* The list of vocabulary filters. It contains at most MaxResults number of filters. If there are more filters, call the ListVocabularyFilters operation again with the NextToken parameter in the request set to the value of the NextToken field in the response.
*/
VocabularyFilters?: VocabularyFilters;
}
export type MaxAlternatives = number;
export type MaxResults = number;
export type MaxSpeakers = number;
export interface Media {
/**
* The S3 object location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is: For example: For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.
*/
MediaFileUri?: Uri;
}
export type MediaFormat = "mp3"|"mp4"|"wav"|"flac"|string;
export type MediaSampleRateHertz = number;
export interface MedicalTranscript {
/**
* The S3 object location of the medical transcript. Use this URI to access the medical transcript. This URI points to the S3 bucket you created to store the medical transcript.
*/
TranscriptFileUri?: Uri;
}
export interface MedicalTranscriptionJob {
/**
* The name for a given medical transcription job.
*/
MedicalTranscriptionJobName?: TranscriptionJobName;
/**
* The completion status of a medical transcription job.
*/
TranscriptionJobStatus?: TranscriptionJobStatus;
/**
* The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a BadRequestException error.
*/
LanguageCode?: LanguageCode;
/**
* The sample rate, in Hertz, of the source audio containing medical information. If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleHertz blank and let Amazon Transcribe Medical determine the sample rate.
*/
MediaSampleRateHertz?: MediaSampleRateHertz;
/**
* The format of the input media file.
*/
MediaFormat?: MediaFormat;
Media?: Media;
/**
* An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.
*/
Transcript?: MedicalTranscript;
/**
* A timestamp that shows when the job started processing.
*/
StartTime?: DateTime;
/**
* A timestamp that shows when the job was created.
*/
CreationTime?: DateTime;
/**
* A timestamp that shows when the job was completed.
*/
CompletionTime?: DateTime;
/**
* If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed. The FailureReason field contains one of the following values: Unsupported media format- The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values. The media format provided does not match the detected media format- The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure the two values match. Invalid sample rate for audio file- The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8000 and 48000 Hertz. The sample rate provided does not match the detected sample rate- The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match. Invalid file size: file size too large- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see Guidlines and Quotas in the Amazon Transcribe Medical Guide Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference
*/
FailureReason?: FailureReason;
/**
* Object that contains object.
*/
Settings?: MedicalTranscriptionSetting;
/**
* The medical specialty of any clinicians providing a dictation or having a conversation. PRIMARYCARE is the only available setting for this object. This specialty enables you to generate transcriptions for the following medical fields: Family Medicine
*/
Specialty?: Specialty;
/**
* The type of speech in the transcription job. CONVERSATION is generally used for patient-physician dialogues. DICTATION is the setting for physicians speaking their notes after seeing a patient. For more information, see how-it-works-med
*/
Type?: Type;
}
export type MedicalTranscriptionJobSummaries = MedicalTranscriptionJobSummary[];
export interface MedicalTranscriptionJobSummary {
/**
* The name of a medical transcription job.
*/
MedicalTranscriptionJobName?: TranscriptionJobName;
/**
* A timestamp that shows when the medical transcription job was created.
*/
CreationTime?: DateTime;
/**
* A timestamp that shows when the job began processing.
*/
StartTime?: DateTime;
/**
* A timestamp that shows when the job was completed.
*/
CompletionTime?: DateTime;
/**
* The language of the transcript in the source audio file.
*/
LanguageCode?: LanguageCode;
/**
* The status of the medical transcription job.
*/
TranscriptionJobStatus?: TranscriptionJobStatus;
/**
* If the TranscriptionJobStatus field is FAILED, a description of the error.
*/
FailureReason?: FailureReason;
/**
* Indicates the location of the transcription job's output. The CUSTOMER_BUCKET is the S3 location provided in the OutputBucketName field when the
*/
OutputLocationType?: OutputLocationType;
/**
* The medical specialty of the transcription job. Primary care is the only valid value.
*/
Specialty?: Specialty;
/**
* The speech of the clinician in the input audio.
*/
Type?: Type;
}
export interface MedicalTranscriptionSetting {
/**
* Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recongition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels in the MaxSpeakerLabels field. You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
*/
ShowSpeakerLabels?: Boolean;
/**
* The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
*/
MaxSpeakerLabels?: MaxSpeakers;
/**
* Instructs Amazon Transcribe Medical to process each audio channel separately and then merge the transcription output of each channel into a single transcription. Amazon Transcribe Medical also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of item. The alternative transcriptions also come with confidence scores provided by Amazon Transcribe Medical. You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException
*/
ChannelIdentification?: Boolean;
/**
* Determines whether alternative transcripts are generated along with the transcript that has the highest confidence. If you set ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
*/
ShowAlternatives?: Boolean;
/**
* The maximum number of alternatives that you tell the service to return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
*/
MaxAlternatives?: MaxAlternatives;
/**
* The name of the vocabulary to use when processing a medical transcription job.
*/
VocabularyName?: VocabularyName;
}
export type NextToken = string;
export type OutputBucketName = string;
export type OutputLocationType = "CUSTOMER_BUCKET"|"SERVICE_BUCKET"|string;
export type Phrase = string;
export type Phrases = Phrase[];
export type RedactionOutput = "redacted"|"redacted_and_unredacted"|string;
export type RedactionType = "PII"|string;
export interface Settings {
/**
* The name of a vocabulary to use when processing the transcription job.
*/
VocabularyName?: VocabularyName;
/**
* Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field. You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
*/
ShowSpeakerLabels?: Boolean;
/**
* The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers are identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
*/
MaxSpeakerLabels?: MaxSpeakers;
/**
* Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription. Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription. You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.
*/
ChannelIdentification?: Boolean;
/**
* Determines whether the transcription contains alternative transcriptions. If you set the ShowAlternatives field to true, you must also set the maximum number of alternatives to return in the MaxAlternatives field.
*/
ShowAlternatives?: Boolean;
/**
* The number of alternative transcriptions that the service should return. If you specify the MaxAlternatives field, you must set the ShowAlternatives field to true.
*/
MaxAlternatives?: MaxAlternatives;
/**
* The name of the vocabulary filter to use when transcribing the audio. The filter that you specify must have the same language code as the transcription job.
*/
VocabularyFilterName?: VocabularyFilterName;
/**
* Set to mask to remove filtered text from the transcript and replace it with three asterisks ("***") as placeholder text. Set to remove to remove filtered text from the transcript without using placeholder text.
*/
VocabularyFilterMethod?: VocabularyFilterMethod;
}
export type Specialty = "PRIMARYCARE"|string;
export interface StartMedicalTranscriptionJobRequest {
/**
* The name of the medical transcription job. You can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account. If you try to create a medical transcription job with the same name as a previous medical transcription job you will receive a ConflictException error.
*/
MedicalTranscriptionJobName: TranscriptionJobName;
/**
* The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException error.
*/
LanguageCode: LanguageCode;
/**
* The sample rate, in Hertz, of the audio track in the input media file. If you do not specify the media sample rate, Amazon Transcribe Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe Medical determine the sample rate.
*/
MediaSampleRateHertz?: MediaSampleRateHertz;
/**
* The audio format of the input media file.
*/
MediaFormat?: MediaFormat;
Media: Media;
/**
* The Amazon S3 location where the transcription is stored. You must set OutputBucketName for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe Medical to put files in the bucket. For more information, see Permissions Required for IAM User Roles. You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
*/
OutputBucketName: OutputBucketName;
/**
* The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartMedicalTranscriptionJob operation must have permission to use the specified KMS key. You use either of the following to identify a KMS key in the current account: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" KMS Key Alias: "alias/ExampleAlias" You can use either of the following to identify a KMS key in the current account or another account: Amazon Resource Name (ARN) of a KMS key in the current account or another account: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab" ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias" If you don't specify an encryption key, the output of the medical transcription job is encrypted with the default Amazon S3 key (SSE-S3). If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
*/
OutputEncryptionKMSKeyId?: KMSKeyId;
/**
* Optional settings for the medical transcription job.
*/
Settings?: MedicalTranscriptionSetting;
/**
* The medical specialty of any clinician speaking in the input media.
*/
Specialty: Specialty;
/**
* The type of speech in the input audio. CONVERSATION refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION refers to single-speaker dictated speech, e.g., for clinical notes.
*/
Type: Type;
}
export interface StartMedicalTranscriptionJobResponse {
/**
* A batch job submitted to transcribe medical speech to text.
*/
MedicalTranscriptionJob?: MedicalTranscriptionJob;
}
export interface StartTranscriptionJobRequest {
/**
* The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account. If you try to create a transcription job with the same name as a previous transcription job you will receive a ConflictException error.
*/
TranscriptionJobName: TranscriptionJobName;
/**
* The language code for the language used in the input media file.
*/
LanguageCode: LanguageCode;
/**
* The sample rate, in Hertz, of the audio track in the input media file. If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.
*/
MediaSampleRateHertz?: MediaSampleRateHertz;
/**
* The format of the input media file.
*/
MediaFormat?: MediaFormat;
/**
* An object that describes the input media for a transcription job.
*/
Media: Media;
/**
* The location where the transcription is stored. If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles. You can specify an AWS Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.
*/
OutputBucketName?: OutputBucketName;
/**
* The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key. You can use either of the following to identify a KMS key in the current account: KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab" KMS Key Alias: "alias/ExampleAlias" You can use either of the following to identify a KMS key in the current account or another account: Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab" ARN of a KMS Key Alias: "arn:aws:kms:region:account ID:alias/ExampleAlias" If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3). If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.
*/
OutputEncryptionKMSKeyId?: KMSKeyId;
/**
* A Settings object that provides optional settings for a transcription job.
*/
Settings?: Settings;
/**
* Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.
*/
JobExecutionSettings?: JobExecutionSettings;
/**
* An object that contains the request parameters for content redaction.
*/
ContentRedaction?: ContentRedaction;
}
export interface StartTranscriptionJobResponse {
/**
* An object containing details of the asynchronous transcription job.
*/
TranscriptionJob?: TranscriptionJob;
}
export interface Transcript {
/**
* The S3 object location of the the transcript. Use this URI to access the transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
*/
TranscriptFileUri?: Uri;
/**
* The S3 object location of the redacted transcript. Use this URI to access the redacated transcript. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcript in Amazon Transcribe, this is a shareable URL that provides secure access to that location.
*/
RedactedTranscriptFileUri?: Uri;
}
export interface TranscriptionJob {
/**
* The name of the transcription job.
*/
TranscriptionJobName?: TranscriptionJobName;
/**
* The status of the transcription job.
*/
TranscriptionJobStatus?: TranscriptionJobStatus;
/**
* The language code for the input speech.
*/
LanguageCode?: LanguageCode;
/**
* The sample rate, in Hertz, of the audio track in the input media file.
*/
MediaSampleRateHertz?: MediaSampleRateHertz;
/**
* The format of the input media file.
*/
MediaFormat?: MediaFormat;
/**
* An object that describes the input media for the transcription job.
*/
Media?: Media;
/**
* An object that describes the output of the transcription job.
*/
Transcript?: Transcript;
/**
* A timestamp that shows with the job was started processing.
*/
StartTime?: DateTime;
/**
* A timestamp that shows when the job was created.
*/
CreationTime?: DateTime;
/**
* A timestamp that shows when the job was completed.
*/
CompletionTime?: DateTime;
/**
* If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed. The FailureReason field can contain one of the following values: Unsupported media format - The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values. The media format provided does not match the detected media format - The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure that the two values match. Invalid sample rate for audio file - The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8000 and 48000 Hertz. The sample rate provided does not match the detected sample rate - The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match. Invalid file size: file size too large - The size of your audio file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide. Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference.
*/
FailureReason?: FailureReason;
/**
* Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.
*/
Settings?: Settings;
/**
* Provides information about how a transcription job is executed.
*/
JobExecutionSettings?: JobExecutionSettings;
/**
* An object that describes content redaction settings for the transcription job.
*/
ContentRedaction?: ContentRedaction;
}
export type TranscriptionJobName = string;
export type TranscriptionJobStatus = "QUEUED"|"IN_PROGRESS"|"FAILED"|"COMPLETED"|string;
export type TranscriptionJobSummaries = TranscriptionJobSummary[];
export interface TranscriptionJobSummary {
/**
* The name of the transcription job.
*/
TranscriptionJobName?: TranscriptionJobName;
/**
* A timestamp that shows when the job was created.
*/
CreationTime?: DateTime;
/**
* A timestamp that shows when the job started processing.
*/
StartTime?: DateTime;
/**
* A timestamp that shows when the job was completed.
*/
CompletionTime?: DateTime;
/**
* The language code for the input speech.
*/
LanguageCode?: LanguageCode;
/**
* The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.
*/
TranscriptionJobStatus?: TranscriptionJobStatus;
/**
* If the TranscriptionJobStatus field is FAILED, a description of the error.
*/
FailureReason?: FailureReason;
/**
* Indicates the location of the output of the transcription job. If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation. If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field.
*/
OutputLocationType?: OutputLocationType;
/**
* The content redaction settings of the transcription job.
*/
ContentRedaction?: ContentRedaction;
}
export type Type = "CONVERSATION"|"DICTATION"|string;
export interface UpdateMedicalVocabularyRequest {
/**
* The name of the vocabulary to update. The name is case-sensitive. If you try to update a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.
*/
VocabularyName: VocabularyName;
/**
* The language code of the entries in the updated vocabulary. US English (en-US) is the only valid language code in Amazon Transcribe Medical.
*/
LanguageCode: LanguageCode;
/**
* The Amazon S3 location of the text file containing the definition of the custom vocabulary. The URI must be in the same AWS region as the API endpoint you are calling. You can see the fields you need to enter for you Amazon S3 location in the example URI here: https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey> For example: https://s3.us-east-1.amazonaws.com/AWSDOC-EXAMPLE-BUCKET/vocab.txt For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide. For more information about custom vocabularies in Amazon Transcribe Medical, see Medical Custom Vocabularies.
*/
VocabularyFileUri?: Uri;
}
export interface UpdateMedicalVocabularyResponse {
/**
* The name of the updated vocabulary.
*/
VocabularyName?: VocabularyName;
/**
* The language code for the text file used to update the custom vocabulary. US English (en-US) is the only language supported in Amazon Transcribe Medical.
*/
LanguageCode?: LanguageCode;
/**
* The date and time the vocabulary was updated.
*/
LastModifiedTime?: DateTime;
/**
* The processing state of the update to the vocabulary. When the VocabularyState field is READY the vocabulary is ready to be used in a StartMedicalTranscriptionJob request.
*/
VocabularyState?: VocabularyState;
}
export interface UpdateVocabularyFilterRequest {
/**
* The name of the vocabulary filter to update. If you try to update a vocabulary filter with the same name as a previous vocabulary filter you will receive a ConflictException error.
*/
VocabularyFilterName: VocabularyFilterName;
/**
* The words to use in the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies. If you provide a list of words in the Words parameter, you can't use the VocabularyFilterFileUri parameter.
*/
Words?: Words;
/**
* The Amazon S3 location of a text file used as input to create the vocabulary filter. Only use characters from the character set defined for custom vocabularies. For a list of character sets, see Character Sets for Custom Vocabularies. The specified file must be less than 50 KB of UTF-8 characters. If you provide the location of a list of words in the VocabularyFilterFileUri parameter, you can't use the Words parameter.
*/
VocabularyFilterFileUri?: Uri;
}
export interface UpdateVocabularyFilterResponse {
/**
* The name of the updated vocabulary filter.
*/
VocabularyFilterName?: VocabularyFilterName;
/**
* The language code of the words in the vocabulary filter.
*/
LanguageCode?: LanguageCode;
/**
* The date and time that the vocabulary filter was updated.
*/
LastModifiedTime?: DateTime;
}
export interface UpdateVocabularyRequest {
/**
* The name of the vocabulary to update. The name is case-sensitive. If you try to update a vocabulary with the same name as a previous vocabulary you will receive a ConflictException error.
*/
VocabularyName: VocabularyName;
/**
* The language code of the vocabulary entries.
*/
LanguageCode: LanguageCode;
/**
* An array of strings containing the vocabulary entries.
*/
Phrases?: Phrases;
/**
* The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is For example: For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide. For more information about custom vocabularies, see Custom Vocabularies.
*/
VocabularyFileUri?: Uri;
}
export interface UpdateVocabularyResponse {
/**
* The name of the vocabulary that was updated.
*/
VocabularyName?: VocabularyName;
/**
* The language code of the vocabulary entries.
*/
LanguageCode?: LanguageCode;
/**
* The date and time that the vocabulary was updated.
*/
LastModifiedTime?: DateTime;
/**
* The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.
*/
VocabularyState?: VocabularyState;
}
export type Uri = string;
export type Vocabularies = VocabularyInfo[];
export interface VocabularyFilterInfo {
/**
* The name of the vocabulary filter. The name must be unique in the account that holds the filter.
*/
VocabularyFilterName?: VocabularyFilterName;
/**
* The language code of the words in the vocabulary filter.
*/
LanguageCode?: LanguageCode;
/**
* The date and time that the vocabulary was last updated.
*/
LastModifiedTime?: DateTime;
}
export type VocabularyFilterMethod = "remove"|"mask"|string;
export type VocabularyFilterName = string;
export type VocabularyFilters = VocabularyFilterInfo[];
export interface VocabularyInfo {
/**
* The name of the vocabulary.
*/
VocabularyName?: VocabularyName;
/**
* The language code of the vocabulary entries.
*/
LanguageCode?: LanguageCode;
/**
* The date and time that the vocabulary was last modified.
*/
LastModifiedTime?: DateTime;
/**
* The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.
*/
VocabularyState?: VocabularyState;
}
export type VocabularyName = string;
export type VocabularyState = "PENDING"|"READY"|"FAILED"|string;
export type Word = string;
export type Words = Word[];
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2017-10-26"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the TranscribeService client.
*/
export import Types = TranscribeService;
}
export = TranscribeService;