@aws-sdk/client-transcribe 3.458.0 → 3.459.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 (46) hide show
  1. package/README.md +32 -0
  2. package/dist-cjs/Transcribe.js +8 -0
  3. package/dist-cjs/commands/DeleteMedicalScribeJobCommand.js +51 -0
  4. package/dist-cjs/commands/GetMedicalScribeJobCommand.js +51 -0
  5. package/dist-cjs/commands/ListMedicalScribeJobsCommand.js +51 -0
  6. package/dist-cjs/commands/StartMedicalScribeJobCommand.js +51 -0
  7. package/dist-cjs/commands/index.js +4 -0
  8. package/dist-cjs/models/models_0.js +14 -1
  9. package/dist-cjs/pagination/ListMedicalScribeJobsPaginator.js +29 -0
  10. package/dist-cjs/pagination/index.js +1 -0
  11. package/dist-cjs/protocols/Aws_json1_1.js +242 -2
  12. package/dist-es/Transcribe.js +8 -0
  13. package/dist-es/commands/DeleteMedicalScribeJobCommand.js +47 -0
  14. package/dist-es/commands/GetMedicalScribeJobCommand.js +47 -0
  15. package/dist-es/commands/ListMedicalScribeJobsCommand.js +47 -0
  16. package/dist-es/commands/StartMedicalScribeJobCommand.js +47 -0
  17. package/dist-es/commands/index.js +4 -0
  18. package/dist-es/models/models_0.js +13 -0
  19. package/dist-es/pagination/ListMedicalScribeJobsPaginator.js +25 -0
  20. package/dist-es/pagination/index.js +1 -0
  21. package/dist-es/protocols/Aws_json1_1.js +232 -0
  22. package/dist-types/Transcribe.d.ts +28 -0
  23. package/dist-types/TranscribeClient.d.ts +6 -2
  24. package/dist-types/commands/DeleteMedicalScribeJobCommand.d.ts +87 -0
  25. package/dist-types/commands/GetMedicalScribeJobCommand.d.ts +135 -0
  26. package/dist-types/commands/ListMedicalScribeJobsCommand.d.ts +104 -0
  27. package/dist-types/commands/StartMedicalScribeJobCommand.d.ts +203 -0
  28. package/dist-types/commands/StartMedicalTranscriptionJobCommand.d.ts +1 -1
  29. package/dist-types/commands/StartTranscriptionJobCommand.d.ts +1 -1
  30. package/dist-types/commands/index.d.ts +4 -0
  31. package/dist-types/models/models_0.d.ts +623 -77
  32. package/dist-types/pagination/ListMedicalScribeJobsPaginator.d.ts +7 -0
  33. package/dist-types/pagination/index.d.ts +1 -0
  34. package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
  35. package/dist-types/ts3.4/Transcribe.d.ts +68 -0
  36. package/dist-types/ts3.4/TranscribeClient.d.ts +24 -0
  37. package/dist-types/ts3.4/commands/DeleteMedicalScribeJobCommand.d.ts +37 -0
  38. package/dist-types/ts3.4/commands/GetMedicalScribeJobCommand.d.ts +39 -0
  39. package/dist-types/ts3.4/commands/ListMedicalScribeJobsCommand.d.ts +42 -0
  40. package/dist-types/ts3.4/commands/StartMedicalScribeJobCommand.d.ts +42 -0
  41. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  42. package/dist-types/ts3.4/models/models_0.d.ts +93 -0
  43. package/dist-types/ts3.4/pagination/ListMedicalScribeJobsPaginator.d.ts +11 -0
  44. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  45. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +48 -0
  46. package/package.json +1 -1
@@ -236,7 +236,8 @@ export type LanguageCode = (typeof LanguageCode)[keyof typeof LanguageCode];
236
236
  * @public
237
237
  * <p>Describes the Amazon S3 location of the media file you want to use in your
238
238
  * request.</p>
239
- * <p>For information on supported media formats, refer to the <a href="https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat">MediaFormat</a> parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
239
+ * <p>For information on supported media formats, refer to the <code>MediaFormat</code>
240
+ * parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
240
241
  * in the Amazon S3 Developer Guide.</p>
241
242
  */
242
243
  export interface Media {
@@ -354,17 +355,19 @@ export declare const RedactionType: {
354
355
  export type RedactionType = (typeof RedactionType)[keyof typeof RedactionType];
355
356
  /**
356
357
  * @public
357
- * <p>Makes it possible to redact or flag specified personally identifiable information
358
- * (PII) in your transcript. If you use <code>ContentRedaction</code>, you must also
359
- * include the sub-parameters: <code>PiiEntityTypes</code>, <code>RedactionOutput</code>,
360
- * and <code>RedactionType</code>.</p>
358
+ * <p>Makes it possible to redact or flag specified personally identifiable information (PII) in
359
+ * your transcript. If you use <code>ContentRedaction</code>, you must also include the
360
+ * sub-parameters: <code>RedactionOutput</code> and <code>RedactionType</code>. You can
361
+ * optionally include <code>PiiEntityTypes</code> to choose which types of PII you want to
362
+ * redact.</p>
361
363
  */
362
364
  export interface ContentRedaction {
363
365
  /**
364
366
  * @public
365
367
  * <p>Specify the category of information you want to redact; <code>PII</code> (personally
366
- * identifiable information) is the only valid value. You can use
367
- * <code>PiiEntityTypes</code> to choose which types of PII you want to redact.</p>
368
+ * identifiable information) is the only valid value. You can use <code>PiiEntityTypes</code> to
369
+ * choose which types of PII you want to redact. If you do not include <code>PiiEntityTypes</code> in
370
+ * your request, all PII is redacted.</p>
368
371
  */
369
372
  RedactionType: RedactionType | undefined;
370
373
  /**
@@ -382,7 +385,8 @@ export interface ContentRedaction {
382
385
  * @public
383
386
  * <p>Specify which types of personally identifiable information (PII) you want to redact in
384
387
  * your transcript. You can include as many types as you'd like, or you can select
385
- * <code>ALL</code>.</p>
388
+ * <code>ALL</code>. If you do not include <code>PiiEntityTypes</code> in your request, all PII is
389
+ * redacted.</p>
386
390
  */
387
391
  PiiEntityTypes?: PiiEntityType[];
388
392
  }
@@ -423,7 +427,7 @@ export interface LanguageIdSettings {
423
427
  * <p>The name of the custom vocabulary you want to use when processing your transcription
424
428
  * job. Custom vocabulary names are case sensitive.</p>
425
429
  * <p>The language of the specified custom vocabulary must match the language code that you
426
- * specify in your transcription request. If the languages don't match, the custom
430
+ * specify in your transcription request. If the languages do not match, the custom
427
431
  * vocabulary isn't applied. There are no errors or warnings associated with a language
428
432
  * mismatch.</p>
429
433
  */
@@ -433,7 +437,7 @@ export interface LanguageIdSettings {
433
437
  * <p>The name of the custom vocabulary filter you want to use when processing your
434
438
  * transcription job. Custom vocabulary filter names are case sensitive.</p>
435
439
  * <p>The language of the specified custom vocabulary filter must match the language code
436
- * that you specify in your transcription request. If the languages don't match, the custom
440
+ * that you specify in your transcription request. If the languages do not match, the custom
437
441
  * vocabulary filter isn't applied. There are no errors or warnings associated with a
438
442
  * language mismatch.</p>
439
443
  * <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
@@ -445,7 +449,7 @@ export interface LanguageIdSettings {
445
449
  * <p>The name of the custom language model you want to use when processing your
446
450
  * transcription job. Note that custom language model names are case sensitive.</p>
447
451
  * <p>The language of the specified custom language model must match the language code that
448
- * you specify in your transcription request. If the languages don't match, the custom
452
+ * you specify in your transcription request. If the languages do not match, the custom
449
453
  * language model isn't applied. There are no errors or warnings associated with a language
450
454
  * mismatch.</p>
451
455
  */
@@ -514,17 +518,18 @@ export interface CallAnalyticsJobSettings {
514
518
  * <p>The name of the custom language model you want to use when processing your Call
515
519
  * Analytics job. Note that custom language model names are case sensitive.</p>
516
520
  * <p>The language of the specified custom language model must match the language code that
517
- * you specify in your transcription request. If the languages don't match, the custom
521
+ * you specify in your transcription request. If the languages do not match, the custom
518
522
  * language model isn't applied. There are no errors or warnings associated with a language
519
523
  * mismatch.</p>
520
524
  */
521
525
  LanguageModelName?: string;
522
526
  /**
523
527
  * @public
524
- * <p>Makes it possible to redact or flag specified personally identifiable information
525
- * (PII) in your transcript. If you use <code>ContentRedaction</code>, you must also
526
- * include the sub-parameters: <code>PiiEntityTypes</code>, <code>RedactionOutput</code>,
527
- * and <code>RedactionType</code>.</p>
528
+ * <p>Makes it possible to redact or flag specified personally identifiable information (PII) in
529
+ * your transcript. If you use <code>ContentRedaction</code>, you must also include the
530
+ * sub-parameters: <code>RedactionOutput</code> and <code>RedactionType</code>. You can
531
+ * optionally include <code>PiiEntityTypes</code> to choose which types of PII you want to
532
+ * redact.</p>
528
533
  */
529
534
  ContentRedaction?: ContentRedaction;
530
535
  /**
@@ -658,7 +663,7 @@ export interface CallAnalyticsJob {
658
663
  * <p>The language code used to create your Call Analytics job. For a list of supported
659
664
  * 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>
660
665
  * table.</p>
661
- * <p>If you don't know the language spoken in your media file, you can omit this field and
666
+ * <p>If you do not know the language spoken in your media file, you can omit this field and
662
667
  * let Amazon Transcribe automatically identify the language of your media. To improve the
663
668
  * accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.</p>
664
669
  */
@@ -720,7 +725,7 @@ export interface CallAnalyticsJob {
720
725
  * <p>
721
726
  * <code>Unsupported media format</code>.</p>
722
727
  * <p>The media format specified in <code>MediaFormat</code> isn't valid. Refer to
723
- * <b>MediaFormat</b> for a list of supported
728
+ * refer to the <code>MediaFormat</code> parameter for a list of supported
724
729
  * formats.</p>
725
730
  * </li>
726
731
  * <li>
@@ -749,14 +754,14 @@ export interface CallAnalyticsJob {
749
754
  * <p>
750
755
  * <code>Invalid file size: file size too large</code>.</p>
751
756
  * <p>The size of your media file is larger than what Amazon Transcribe can
752
- * process. For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
757
+ * process. For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe">Service
753
758
  * quotas</a>.</p>
754
759
  * </li>
755
760
  * <li>
756
761
  * <p>
757
762
  * <code>Invalid number of channels: number of channels too large</code>.</p>
758
763
  * <p>Your audio contains more channels than Amazon Transcribe is able to process.
759
- * For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
764
+ * For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe">Service
760
765
  * quotas</a>.</p>
761
766
  * </li>
762
767
  * </ul>
@@ -1453,10 +1458,8 @@ export interface CreateLanguageModelRequest {
1453
1458
  * model must contain terms in only one language, and the language you select for your
1454
1459
  * custom language model must match the language of your training and tuning data.</p>
1455
1460
  * <p>For a list of supported languages and their associated language codes, refer to the
1456
- * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table. Note that
1457
- * US English
1458
- * (<code>en-US</code>) is the only language supported with Amazon Transcribe
1459
- * Medical.</p>
1461
+ * <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 the
1462
+ * only language supported with Amazon Transcribe Medical.</p>
1460
1463
  * <p>A custom language model can only be used to transcribe files in the same language as
1461
1464
  * the model. For example, if you create a custom language model using US English
1462
1465
  * (<code>en-US</code>), you can only apply this model to files that contain English
@@ -1906,6 +1909,17 @@ export interface DeleteLanguageModelRequest {
1906
1909
  */
1907
1910
  ModelName: string | undefined;
1908
1911
  }
1912
+ /**
1913
+ * @public
1914
+ */
1915
+ export interface DeleteMedicalScribeJobRequest {
1916
+ /**
1917
+ * @public
1918
+ * <p>The name of the Medical Scribe job you want to delete. Job names are case
1919
+ * sensitive.</p>
1920
+ */
1921
+ MedicalScribeJobName: string | undefined;
1922
+ }
1909
1923
  /**
1910
1924
  * @public
1911
1925
  */
@@ -2032,7 +2046,7 @@ export interface LanguageModel {
2032
2046
  * model must contain terms in only one language, and the language you select for your
2033
2047
  * custom language model must match the language of your training and tuning data.</p>
2034
2048
  * <p>For a list of supported languages and their associated language codes, refer to the
2035
- * <a href="https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html">Supported languages</a> table. Note that U.S. English (<code>en-US</code>) is
2049
+ * <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
2036
2050
  * the only language supported with Amazon Transcribe Medical.</p>
2037
2051
  */
2038
2052
  LanguageCode?: CLMLanguageCode;
@@ -2136,6 +2150,290 @@ export interface GetCallAnalyticsJobResponse {
2136
2150
  */
2137
2151
  CallAnalyticsJob?: CallAnalyticsJob;
2138
2152
  }
2153
+ /**
2154
+ * @public
2155
+ */
2156
+ export interface GetMedicalScribeJobRequest {
2157
+ /**
2158
+ * @public
2159
+ * <p>The name of the Medical Scribe job you want information about. Job names are
2160
+ * case sensitive.</p>
2161
+ */
2162
+ MedicalScribeJobName: string | undefined;
2163
+ }
2164
+ /**
2165
+ * @public
2166
+ * @enum
2167
+ */
2168
+ export declare const MedicalScribeParticipantRole: {
2169
+ readonly CLINICIAN: "CLINICIAN";
2170
+ readonly PATIENT: "PATIENT";
2171
+ };
2172
+ /**
2173
+ * @public
2174
+ */
2175
+ export type MedicalScribeParticipantRole = (typeof MedicalScribeParticipantRole)[keyof typeof MedicalScribeParticipantRole];
2176
+ /**
2177
+ * @public
2178
+ * <p>Indicates which speaker is on which channel. The options are
2179
+ * <code>CLINICIAN</code> and <code>PATIENT</code>
2180
+ * </p>
2181
+ */
2182
+ export interface MedicalScribeChannelDefinition {
2183
+ /**
2184
+ * @public
2185
+ * <p>Specify the audio channel you want to define.</p>
2186
+ */
2187
+ ChannelId: number | undefined;
2188
+ /**
2189
+ * @public
2190
+ * <p>Specify the participant that you want to flag.
2191
+ * The options are <code>CLINICIAN</code> and <code>PATIENT</code>
2192
+ * </p>
2193
+ */
2194
+ ParticipantRole: MedicalScribeParticipantRole | undefined;
2195
+ }
2196
+ /**
2197
+ * @public
2198
+ * @enum
2199
+ */
2200
+ export declare const MedicalScribeLanguageCode: {
2201
+ readonly EN_US: "en-US";
2202
+ };
2203
+ /**
2204
+ * @public
2205
+ */
2206
+ export type MedicalScribeLanguageCode = (typeof MedicalScribeLanguageCode)[keyof typeof MedicalScribeLanguageCode];
2207
+ /**
2208
+ * @public
2209
+ * @enum
2210
+ */
2211
+ export declare const MedicalScribeJobStatus: {
2212
+ readonly COMPLETED: "COMPLETED";
2213
+ readonly FAILED: "FAILED";
2214
+ readonly IN_PROGRESS: "IN_PROGRESS";
2215
+ readonly QUEUED: "QUEUED";
2216
+ };
2217
+ /**
2218
+ * @public
2219
+ */
2220
+ export type MedicalScribeJobStatus = (typeof MedicalScribeJobStatus)[keyof typeof MedicalScribeJobStatus];
2221
+ /**
2222
+ * @public
2223
+ * <p>The location of the output of your Medical Scribe job.
2224
+ * <code>ClinicalDocumentUri</code> holds the Amazon S3 URI for the Clinical Document
2225
+ * and <code>TranscriptFileUri</code> holds the Amazon S3 URI for the Transcript.</p>
2226
+ */
2227
+ export interface MedicalScribeOutput {
2228
+ /**
2229
+ * @public
2230
+ * <p>Holds the Amazon S3 URI for the Transcript.</p>
2231
+ */
2232
+ TranscriptFileUri: string | undefined;
2233
+ /**
2234
+ * @public
2235
+ * <p>Holds the Amazon S3 URI for the Clinical Document.</p>
2236
+ */
2237
+ ClinicalDocumentUri: string | undefined;
2238
+ }
2239
+ /**
2240
+ * @public
2241
+ * <p>Makes it possible to control how your Medical Scribe job is processed using a
2242
+ * <code>MedicalScribeSettings</code> object. Specify <code>ChannelIdentification</code> if
2243
+ * <code>ChannelDefinitions</code> are set. Enabled <code>ShowSpeakerLabels</code> if <code>ChannelIdentification</code>
2244
+ * and <code>ChannelDefinitions</code> are not set. One and only one of <code>ChannelIdentification</code> and <code>ShowSpeakerLabels</code>
2245
+ * must be set. If <code>ShowSpeakerLabels</code> is set, <code>MaxSpeakerLabels</code> must also be set. Use <code>Settings</code>
2246
+ * to specify a vocabulary or vocabulary filter or both using <code>VocabularyName</code>, <code>VocabularyFilterName</code>.
2247
+ * <code>VocabularyFilterMethod</code> must be specified if <code>VocabularyFilterName</code> is set.
2248
+ * </p>
2249
+ */
2250
+ export interface MedicalScribeSettings {
2251
+ /**
2252
+ * @public
2253
+ * <p>Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker
2254
+ * partitioning labels the speech from individual speakers in your media file.</p>
2255
+ * <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
2256
+ * <code>MaxSpeakerLabels</code>.</p>
2257
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers
2258
+ * (diarization)</a>.</p>
2259
+ */
2260
+ ShowSpeakerLabels?: boolean;
2261
+ /**
2262
+ * @public
2263
+ * <p>Specify the maximum number of speakers you want to partition in your media.</p>
2264
+ * <p>Note that if your media contains more speakers than the specified number, multiple
2265
+ * speakers are treated as a single speaker.</p>
2266
+ * <p>If you specify the <code>MaxSpeakerLabels</code> field, you must set the
2267
+ * <code>ShowSpeakerLabels</code> field to true.</p>
2268
+ */
2269
+ MaxSpeakerLabels?: number;
2270
+ /**
2271
+ * @public
2272
+ * <p>Enables channel identification in multi-channel audio.</p>
2273
+ * <p>Channel identification transcribes the audio on each channel independently, then
2274
+ * appends the output for each channel into one transcript.</p>
2275
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
2276
+ * audio</a>.</p>
2277
+ */
2278
+ ChannelIdentification?: boolean;
2279
+ /**
2280
+ * @public
2281
+ * <p>The name of the custom vocabulary you want to include in your Medical Scribe
2282
+ * request. Custom vocabulary names are case sensitive.</p>
2283
+ */
2284
+ VocabularyName?: string;
2285
+ /**
2286
+ * @public
2287
+ * <p>The name of the custom vocabulary filter you want to include in your Medical Scribe
2288
+ * request. Custom vocabulary filter names are case sensitive.</p>
2289
+ * <p>Note that if you include <code>VocabularyFilterName</code> in your request, you must
2290
+ * also include <code>VocabularyFilterMethod</code>.</p>
2291
+ */
2292
+ VocabularyFilterName?: string;
2293
+ /**
2294
+ * @public
2295
+ * <p>Specify how you want your custom vocabulary filter applied to your transcript.</p>
2296
+ * <p>To replace words with <code>***</code>, choose <code>mask</code>.</p>
2297
+ * <p>To delete words, choose <code>remove</code>.</p>
2298
+ * <p>To flag words without changing them, choose <code>tag</code>.</p>
2299
+ */
2300
+ VocabularyFilterMethod?: VocabularyFilterMethod;
2301
+ }
2302
+ /**
2303
+ * @public
2304
+ * <p>Provides detailed information about a Medical Scribe job.</p>
2305
+ * <p>To view the status of the specified Medical Scribe job, check the
2306
+ * <code>MedicalScribeJobStatus</code> field. If the status is <code>COMPLETED</code>,
2307
+ * the job is finished and you can find the results at the locations specified in
2308
+ * <code>MedicalScribeOutput</code>. If the status is <code>FAILED</code>,
2309
+ * <code>FailureReason</code> provides details on why your Medical Scribe job
2310
+ * failed.</p>
2311
+ */
2312
+ export interface MedicalScribeJob {
2313
+ /**
2314
+ * @public
2315
+ * <p>The name of the Medical Scribe job. Job names are case sensitive and must be
2316
+ * unique within an Amazon Web Services account.</p>
2317
+ */
2318
+ MedicalScribeJobName?: string;
2319
+ /**
2320
+ * @public
2321
+ * <p>Provides the status of the specified Medical Scribe job.</p>
2322
+ * <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
2323
+ * results at the location specified in <code>MedicalScribeOutput</code> If
2324
+ * the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
2325
+ * your Medical Scribe job failed.</p>
2326
+ */
2327
+ MedicalScribeJobStatus?: MedicalScribeJobStatus;
2328
+ /**
2329
+ * @public
2330
+ * <p>The language code used to create your Medical Scribe job. US English
2331
+ * (<code>en-US</code>) is the only supported language for Medical Scribe jobs. </p>
2332
+ */
2333
+ LanguageCode?: MedicalScribeLanguageCode;
2334
+ /**
2335
+ * @public
2336
+ * <p>Describes the Amazon S3 location of the media file you want to use in your
2337
+ * request.</p>
2338
+ * <p>For information on supported media formats, refer to the <code>MediaFormat</code>
2339
+ * parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
2340
+ * in the Amazon S3 Developer Guide.</p>
2341
+ */
2342
+ Media?: Media;
2343
+ /**
2344
+ * @public
2345
+ * <p>The location of the output of your Medical Scribe job.
2346
+ * <code>ClinicalDocumentUri</code> holds the Amazon S3 URI for the Clinical Document
2347
+ * and <code>TranscriptFileUri</code> holds the Amazon S3 URI for the Transcript.</p>
2348
+ */
2349
+ MedicalScribeOutput?: MedicalScribeOutput;
2350
+ /**
2351
+ * @public
2352
+ * <p>The date and time your Medical Scribe job began processing.</p>
2353
+ * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
2354
+ * example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a Medical Scribe job
2355
+ * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
2356
+ */
2357
+ StartTime?: Date;
2358
+ /**
2359
+ * @public
2360
+ * <p>The date and time the specified Medical Scribe job request was made.</p>
2361
+ * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
2362
+ * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a Medical Scribe job
2363
+ * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
2364
+ */
2365
+ CreationTime?: Date;
2366
+ /**
2367
+ * @public
2368
+ * <p>The date and time the specified Medical Scribe job finished processing.</p>
2369
+ * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
2370
+ * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a Medical Scribe job
2371
+ * that finished processing at 12:32 PM UTC-7 on May 4, 2022.</p>
2372
+ */
2373
+ CompletionTime?: Date;
2374
+ /**
2375
+ * @public
2376
+ * <p>If <code>MedicalScribeJobStatus</code> is <code>FAILED</code>,
2377
+ * <code>FailureReason</code> contains information about why the transcription job
2378
+ * failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
2379
+ */
2380
+ FailureReason?: string;
2381
+ /**
2382
+ * @public
2383
+ * <p>Makes it possible to control how your Medical Scribe job is processed using a
2384
+ * <code>MedicalScribeSettings</code> object. Specify <code>ChannelIdentification</code> if
2385
+ * <code>ChannelDefinitions</code> are set. Enabled <code>ShowSpeakerLabels</code> if <code>ChannelIdentification</code>
2386
+ * and <code>ChannelDefinitions</code> are not set. One and only one of <code>ChannelIdentification</code> and <code>ShowSpeakerLabels</code>
2387
+ * must be set. If <code>ShowSpeakerLabels</code> is set, <code>MaxSpeakerLabels</code> must also be set. Use <code>Settings</code>
2388
+ * to specify a vocabulary or vocabulary filter or both using <code>VocabularyName</code>, <code>VocabularyFilterName</code>.
2389
+ * <code>VocabularyFilterMethod</code> must be specified if <code>VocabularyFilterName</code> is set.
2390
+ * </p>
2391
+ */
2392
+ Settings?: MedicalScribeSettings;
2393
+ /**
2394
+ * @public
2395
+ * <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
2396
+ * access the Amazon S3 bucket that contains your input files,
2397
+ * write to the output bucket, and use your KMS key if supplied.
2398
+ * If the role that you specify doesn’t have the appropriate permissions your request fails.</p>
2399
+ * <p>IAM role ARNs have the format
2400
+ * <code>arn:partition:iam::account:role/role-name-with-path</code>. For example:
2401
+ * <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
2402
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
2403
+ * ARNs</a>.</p>
2404
+ */
2405
+ DataAccessRoleArn?: string;
2406
+ /**
2407
+ * @public
2408
+ * <p>Makes it possible to specify which speaker is on which channel. For example, if the clinician
2409
+ * is the first participant to speak, you would set <code>ChannelId</code> of the first <code>ChannelDefinition</code>
2410
+ * in the list to <code>0</code> (to indicate the first channel) and <code>ParticipantRole</code> to
2411
+ * <code>CLINICIAN</code> (to indicate that it's the clinician speaking).
2412
+ * Then you would set the <code>ChannelId</code> of the second <code>ChannelDefinition</code> in the list to
2413
+ * <code>1</code> (to indicate the second channel) and <code>ParticipantRole</code> to
2414
+ * <code>PATIENT</code> (to indicate that it's the patient speaking).
2415
+ * </p>
2416
+ */
2417
+ ChannelDefinitions?: MedicalScribeChannelDefinition[];
2418
+ /**
2419
+ * @public
2420
+ * <p>Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.</p>
2421
+ * <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
+ * resources</a>.</p>
2423
+ */
2424
+ Tags?: Tag[];
2425
+ }
2426
+ /**
2427
+ * @public
2428
+ */
2429
+ export interface GetMedicalScribeJobResponse {
2430
+ /**
2431
+ * @public
2432
+ * <p>Provides detailed information about the specified Medical Scribe job, including
2433
+ * job status and, if applicable, failure reason</p>
2434
+ */
2435
+ MedicalScribeJob?: MedicalScribeJob;
2436
+ }
2139
2437
  /**
2140
2438
  * @public
2141
2439
  */
@@ -2171,9 +2469,6 @@ export interface MedicalTranscriptionSetting {
2171
2469
  * partitioning labels the speech from individual speakers in your media file.</p>
2172
2470
  * <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
2173
2471
  * <code>MaxSpeakerLabels</code>.</p>
2174
- * <p>You can't include <code>ShowSpeakerLabels</code> and
2175
- * <code>ChannelIdentification</code> in the same request. Including both parameters
2176
- * returns a <code>BadRequestException</code>.</p>
2177
2472
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers
2178
2473
  * (diarization)</a>.</p>
2179
2474
  */
@@ -2195,9 +2490,6 @@ export interface MedicalTranscriptionSetting {
2195
2490
  * <p>If you have multi-channel audio and do not enable channel identification, your audio
2196
2491
  * is transcribed in a continuous manner and your transcript does not separate the speech
2197
2492
  * by channel.</p>
2198
- * <p>You can't include both <code>ShowSpeakerLabels</code> and
2199
- * <code>ChannelIdentification</code> in the same request. Including both parameters
2200
- * returns a <code>BadRequestException</code>.</p>
2201
2493
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
2202
2494
  * audio</a>.</p>
2203
2495
  */
@@ -2231,7 +2523,7 @@ export interface MedicalTranscriptionSetting {
2231
2523
  * <p>The name of the custom vocabulary you want to use when processing your medical
2232
2524
  * transcription job. Custom vocabulary names are case sensitive.</p>
2233
2525
  * <p>The language of the specified custom vocabulary must match the language code that you
2234
- * specify in your transcription request. If the languages don't match, the custom
2526
+ * specify in your transcription request. If the languages do not match, the custom
2235
2527
  * vocabulary isn't applied. There are no errors or warnings associated with a language
2236
2528
  * mismatch. US English (<code>en-US</code>) is the only valid language for Amazon Transcribe Medical.</p>
2237
2529
  */
@@ -2336,7 +2628,8 @@ export interface MedicalTranscriptionJob {
2336
2628
  * @public
2337
2629
  * <p>Describes the Amazon S3 location of the media file you want to use in your
2338
2630
  * request.</p>
2339
- * <p>For information on supported media formats, refer to the <a href="https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat">MediaFormat</a> parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
2631
+ * <p>For information on supported media formats, refer to the <code>MediaFormat</code>
2632
+ * parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
2340
2633
  * in the Amazon S3 Developer Guide.</p>
2341
2634
  */
2342
2635
  Media?: Media;
@@ -2381,7 +2674,7 @@ export interface MedicalTranscriptionJob {
2381
2674
  * <p>
2382
2675
  * <code>Unsupported media format</code>.</p>
2383
2676
  * <p>The media format specified in <code>MediaFormat</code> isn't valid. Refer to
2384
- * <b>MediaFormat</b> for a list of supported
2677
+ * refer to the <code>MediaFormat</code> parameter for a list of supported
2385
2678
  * formats.</p>
2386
2679
  * </li>
2387
2680
  * <li>
@@ -2410,14 +2703,14 @@ export interface MedicalTranscriptionJob {
2410
2703
  * <p>
2411
2704
  * <code>Invalid file size: file size too large</code>.</p>
2412
2705
  * <p>The size of your media file is larger than what Amazon Transcribe can
2413
- * process. For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
2706
+ * process. For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe">Service
2414
2707
  * quotas</a>.</p>
2415
2708
  * </li>
2416
2709
  * <li>
2417
2710
  * <p>
2418
2711
  * <code>Invalid number of channels: number of channels too large</code>.</p>
2419
2712
  * <p>Your audio contains more channels than Amazon Transcribe is able to process.
2420
- * For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
2713
+ * For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe">Service
2421
2714
  * quotas</a>.</p>
2422
2715
  * </li>
2423
2716
  * </ul>
@@ -2516,7 +2809,7 @@ export interface GetMedicalVocabularyResponse {
2516
2809
  FailureReason?: string;
2517
2810
  /**
2518
2811
  * @public
2519
- * <p>The S3 location where the specified custom medical vocabulary is stored; use this URI
2812
+ * <p>The Amazon S3 location where the specified custom medical vocabulary is stored; use this URI
2520
2813
  * to view or download the custom vocabulary.</p>
2521
2814
  */
2522
2815
  DownloadUri?: string;
@@ -2605,7 +2898,7 @@ export interface ModelSettings {
2605
2898
  * <p>The name of the custom language model you want to use when processing your
2606
2899
  * transcription job. Note that custom language model names are case sensitive.</p>
2607
2900
  * <p>The language of the specified custom language model must match the language code that
2608
- * you specify in your transcription request. If the languages don't match, the custom
2901
+ * you specify in your transcription request. If the languages do not match, the custom
2609
2902
  * language model isn't applied. There are no errors or warnings associated with a language
2610
2903
  * mismatch.</p>
2611
2904
  */
@@ -2613,7 +2906,8 @@ export interface ModelSettings {
2613
2906
  }
2614
2907
  /**
2615
2908
  * @public
2616
- * <p>Allows additional optional settings in your request, including channel identification, alternative transcriptions, and speaker
2909
+ * <p>Allows additional optional settings in your
2910
+ * request, including channel identification, alternative transcriptions, and speaker
2617
2911
  * partitioning. You can use that to apply custom vocabularies to your transcription
2618
2912
  * job.</p>
2619
2913
  */
@@ -2630,9 +2924,6 @@ export interface Settings {
2630
2924
  * partitioning labels the speech from individual speakers in your media file.</p>
2631
2925
  * <p>If you enable <code>ShowSpeakerLabels</code> in your request, you must also include
2632
2926
  * <code>MaxSpeakerLabels</code>.</p>
2633
- * <p>You can't include both <code>ShowSpeakerLabels</code> and
2634
- * <code>ChannelIdentification</code> in the same request. Including both parameters
2635
- * returns a <code>BadRequestException</code>.</p>
2636
2927
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html">Partitioning speakers
2637
2928
  * (diarization)</a>.</p>
2638
2929
  */
@@ -2651,9 +2942,6 @@ export interface Settings {
2651
2942
  * <p>Enables channel identification in multi-channel audio.</p>
2652
2943
  * <p>Channel identification transcribes the audio on each channel independently, then
2653
2944
  * appends the output for each channel into one transcript.</p>
2654
- * <p>You can't include both <code>ShowSpeakerLabels</code> and
2655
- * <code>ChannelIdentification</code> in the same request. Including both parameters
2656
- * returns a <code>BadRequestException</code>.</p>
2657
2945
  * <p>For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html">Transcribing multi-channel
2658
2946
  * audio</a>.</p>
2659
2947
  */
@@ -2875,7 +3163,7 @@ export interface TranscriptionJob {
2875
3163
  * <p>
2876
3164
  * <code>Unsupported media format</code>.</p>
2877
3165
  * <p>The media format specified in <code>MediaFormat</code> isn't valid. Refer to
2878
- * <b>MediaFormat</b> for a list of supported
3166
+ * refer to the <code>MediaFormat</code> parameter for a list of supported
2879
3167
  * formats.</p>
2880
3168
  * </li>
2881
3169
  * <li>
@@ -2904,14 +3192,14 @@ export interface TranscriptionJob {
2904
3192
  * <p>
2905
3193
  * <code>Invalid file size: file size too large</code>.</p>
2906
3194
  * <p>The size of your media file is larger than what Amazon Transcribe can
2907
- * process. For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
3195
+ * process. For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe">Service
2908
3196
  * quotas</a>.</p>
2909
3197
  * </li>
2910
3198
  * <li>
2911
3199
  * <p>
2912
3200
  * <code>Invalid number of channels: number of channels too large</code>.</p>
2913
3201
  * <p>Your audio contains more channels than Amazon Transcribe is able to process.
2914
- * For more information, refer to <a href="https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits">Guidelines and
3202
+ * For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/transcribe.html#limits-amazon-transcribe">Service
2915
3203
  * quotas</a>.</p>
2916
3204
  * </li>
2917
3205
  * </ul>
@@ -3056,7 +3344,7 @@ export interface GetVocabularyResponse {
3056
3344
  FailureReason?: string;
3057
3345
  /**
3058
3346
  * @public
3059
- * <p>The S3 location where the custom vocabulary is stored; use this URI to view or
3347
+ * <p>The Amazon S3 location where the custom vocabulary is stored; use this URI to view or
3060
3348
  * download the custom vocabulary.</p>
3061
3349
  */
3062
3350
  DownloadUri?: string;
@@ -3118,7 +3406,7 @@ export interface ListCallAnalyticsCategoriesRequest {
3118
3406
  * @public
3119
3407
  * <p>The maximum number of Call Analytics categories to return in each page of results. If
3120
3408
  * there are fewer results than the value that you specify, only the actual results are
3121
- * returned. If you don't specify a value, a default of 5 is used.</p>
3409
+ * returned. If you do not specify a value, a default of 5 is used.</p>
3122
3410
  */
3123
3411
  MaxResults?: number;
3124
3412
  }
@@ -3149,7 +3437,7 @@ export interface ListCallAnalyticsJobsRequest {
3149
3437
  /**
3150
3438
  * @public
3151
3439
  * <p>Returns only Call Analytics jobs with the specified status. Jobs are ordered by
3152
- * creation date, with the newest job first. If you don't include <code>Status</code>, all
3440
+ * creation date, with the newest job first. If you do not include <code>Status</code>, all
3153
3441
  * Call Analytics jobs are returned.</p>
3154
3442
  */
3155
3443
  Status?: CallAnalyticsJobStatus;
@@ -3172,7 +3460,7 @@ export interface ListCallAnalyticsJobsRequest {
3172
3460
  * @public
3173
3461
  * <p>The maximum number of Call Analytics jobs to return in each page of results. If there
3174
3462
  * are fewer results than the value that you specify, only the actual results are returned.
3175
- * If you don't specify a value, a default of 5 is used.</p>
3463
+ * If you do not specify a value, a default of 5 is used.</p>
3176
3464
  */
3177
3465
  MaxResults?: number;
3178
3466
  }
@@ -3208,7 +3496,7 @@ export interface ListLanguageModelsRequest {
3208
3496
  /**
3209
3497
  * @public
3210
3498
  * <p>Returns only custom language models with the specified status. Language models are
3211
- * ordered by creation date, with the newest model first. If you don't include
3499
+ * ordered by creation date, with the newest model first. If you do not include
3212
3500
  * <code>StatusEquals</code>, all custom language models are returned.</p>
3213
3501
  */
3214
3502
  StatusEquals?: ModelStatus;
@@ -3231,7 +3519,7 @@ export interface ListLanguageModelsRequest {
3231
3519
  * @public
3232
3520
  * <p>The maximum number of custom language models to return in each page of results. If
3233
3521
  * there are fewer results than the value that you specify, only the actual results are
3234
- * returned. If you don't specify a value, a default of 5 is used.</p>
3522
+ * returned. If you do not specify a value, a default of 5 is used.</p>
3235
3523
  */
3236
3524
  MaxResults?: number;
3237
3525
  }
@@ -3255,6 +3543,123 @@ export interface ListLanguageModelsResponse {
3255
3543
  */
3256
3544
  Models?: LanguageModel[];
3257
3545
  }
3546
+ /**
3547
+ * @public
3548
+ */
3549
+ export interface ListMedicalScribeJobsRequest {
3550
+ /**
3551
+ * @public
3552
+ * <p>Returns only Medical Scribe jobs with the specified status. Jobs are ordered by
3553
+ * creation date, with the newest job first. If you do not include <code>Status</code>, all
3554
+ * Medical Scribe jobs are returned.</p>
3555
+ */
3556
+ Status?: MedicalScribeJobStatus;
3557
+ /**
3558
+ * @public
3559
+ * <p>Returns only the Medical Scribe jobs that contain the specified string. The
3560
+ * search is not case sensitive.</p>
3561
+ */
3562
+ JobNameContains?: string;
3563
+ /**
3564
+ * @public
3565
+ * <p>If your <code>ListMedicalScribeJobs</code> request returns more results than
3566
+ * can be displayed, <code>NextToken</code> is displayed in the response with an associated
3567
+ * string. To get the next page of results, copy this string and repeat your request,
3568
+ * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3569
+ * to view all your results.</p>
3570
+ */
3571
+ NextToken?: string;
3572
+ /**
3573
+ * @public
3574
+ * <p>The maximum number of Medical Scribe jobs to return in each page of results. If
3575
+ * there are fewer results than the value that you specify, only the actual results are
3576
+ * returned. If you do not specify a value, a default of 5 is used.</p>
3577
+ */
3578
+ MaxResults?: number;
3579
+ }
3580
+ /**
3581
+ * @public
3582
+ * <p>Provides detailed information about a specific Medical Scribe job.</p>
3583
+ */
3584
+ export interface MedicalScribeJobSummary {
3585
+ /**
3586
+ * @public
3587
+ * <p>The name of the Medical Scribe job. Job names are case sensitive and must be
3588
+ * unique within an Amazon Web Services account.</p>
3589
+ */
3590
+ MedicalScribeJobName?: string;
3591
+ /**
3592
+ * @public
3593
+ * <p>The date and time the specified Medical Scribe job request was made.</p>
3594
+ * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3595
+ * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a Medical Scribe job
3596
+ * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
3597
+ */
3598
+ CreationTime?: Date;
3599
+ /**
3600
+ * @public
3601
+ * <p>The date and time your Medical Scribe job began processing.</p>
3602
+ * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3603
+ * example, <code>2022-05-04T12:32:58.789000-07:00</code> represents a Medical Scribe job
3604
+ * that started processing at 12:32 PM UTC-7 on May 4, 2022.</p>
3605
+ */
3606
+ StartTime?: Date;
3607
+ /**
3608
+ * @public
3609
+ * <p>The date and time the specified Medical Scribe job finished processing.</p>
3610
+ * <p>Timestamps are in the format <code>YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC</code>. For
3611
+ * example, <code>2022-05-04T12:32:58.761000-07:00</code> represents a Medical Scribe job
3612
+ * that finished processing at 12:32 PM UTC-7 on May 4, 2022.</p>
3613
+ */
3614
+ CompletionTime?: Date;
3615
+ /**
3616
+ * @public
3617
+ * <p>The language code used to create your Medical Scribe job. US English
3618
+ * (<code>en-US</code>) is the only supported language for Medical Scribe jobs. </p>
3619
+ */
3620
+ LanguageCode?: MedicalScribeLanguageCode;
3621
+ /**
3622
+ * @public
3623
+ * <p>Provides the status of the specified Medical Scribe job.</p>
3624
+ * <p>If the status is <code>COMPLETED</code>, the job is finished and you can find the
3625
+ * results at the location specified in <code>MedicalScribeOutput</code> If
3626
+ * the status is <code>FAILED</code>, <code>FailureReason</code> provides details on why
3627
+ * your Medical Scribe job failed.</p>
3628
+ */
3629
+ MedicalScribeJobStatus?: MedicalScribeJobStatus;
3630
+ /**
3631
+ * @public
3632
+ * <p>If <code>MedicalScribeJobStatus</code> is <code>FAILED</code>,
3633
+ * <code>FailureReason</code> contains information about why the transcription job
3634
+ * failed. See also: <a href="https://docs.aws.amazon.com/transcribe/latest/APIReference/CommonErrors.html">Common Errors</a>.</p>
3635
+ */
3636
+ FailureReason?: string;
3637
+ }
3638
+ /**
3639
+ * @public
3640
+ */
3641
+ export interface ListMedicalScribeJobsResponse {
3642
+ /**
3643
+ * @public
3644
+ * <p>Lists all Medical Scribe jobs that have the status specified in your request.
3645
+ * Jobs are ordered by creation date, with the newest job first.</p>
3646
+ */
3647
+ Status?: MedicalScribeJobStatus;
3648
+ /**
3649
+ * @public
3650
+ * <p>If <code>NextToken</code> is present in your response, it indicates that not all
3651
+ * results are displayed. To view the next set of results, copy the string associated with
3652
+ * the <code>NextToken</code> parameter in your results output, then run your request again
3653
+ * including <code>NextToken</code> with the value of the copied string. Repeat as needed
3654
+ * to view all your results.</p>
3655
+ */
3656
+ NextToken?: string;
3657
+ /**
3658
+ * @public
3659
+ * <p>Provides a summary of information about each result.</p>
3660
+ */
3661
+ MedicalScribeJobSummaries?: MedicalScribeJobSummary[];
3662
+ }
3258
3663
  /**
3259
3664
  * @public
3260
3665
  */
@@ -3262,7 +3667,7 @@ export interface ListMedicalTranscriptionJobsRequest {
3262
3667
  /**
3263
3668
  * @public
3264
3669
  * <p>Returns only medical transcription jobs with the specified status. Jobs are ordered by
3265
- * creation date, with the newest job first. If you don't include <code>Status</code>, all
3670
+ * creation date, with the newest job first. If you do not include <code>Status</code>, all
3266
3671
  * medical transcription jobs are returned.</p>
3267
3672
  */
3268
3673
  Status?: TranscriptionJobStatus;
@@ -3285,7 +3690,7 @@ export interface ListMedicalTranscriptionJobsRequest {
3285
3690
  * @public
3286
3691
  * <p>The maximum number of medical transcription jobs to return in each page of results. If
3287
3692
  * there are fewer results than the value that you specify, only the actual results are
3288
- * returned. If you don't specify a value, a default of 5 is used.</p>
3693
+ * returned. If you do not specify a value, a default of 5 is used.</p>
3289
3694
  */
3290
3695
  MaxResults?: number;
3291
3696
  }
@@ -3430,13 +3835,13 @@ export interface ListMedicalVocabulariesRequest {
3430
3835
  * @public
3431
3836
  * <p>The maximum number of custom medical vocabularies to return in each page of results.
3432
3837
  * If there are fewer results than the value that you specify, only the actual results are
3433
- * returned. If you don't specify a value, a default of 5 is used.</p>
3838
+ * returned. If you do not specify a value, a default of 5 is used.</p>
3434
3839
  */
3435
3840
  MaxResults?: number;
3436
3841
  /**
3437
3842
  * @public
3438
3843
  * <p>Returns only custom medical vocabularies with the specified state. Custom vocabularies
3439
- * are ordered by creation date, with the newest vocabulary first. If you don't include
3844
+ * are ordered by creation date, with the newest vocabulary first. If you do not include
3440
3845
  * <code>StateEquals</code>, all custom medical vocabularies are returned.</p>
3441
3846
  */
3442
3847
  StateEquals?: VocabularyState;
@@ -3553,7 +3958,7 @@ export interface ListTranscriptionJobsRequest {
3553
3958
  /**
3554
3959
  * @public
3555
3960
  * <p>Returns only transcription jobs with the specified status. Jobs are ordered by
3556
- * creation date, with the newest job first. If you don't include <code>Status</code>, all
3961
+ * creation date, with the newest job first. If you do not include <code>Status</code>, all
3557
3962
  * transcription jobs are returned.</p>
3558
3963
  */
3559
3964
  Status?: TranscriptionJobStatus;
@@ -3576,7 +3981,7 @@ export interface ListTranscriptionJobsRequest {
3576
3981
  * @public
3577
3982
  * <p>The maximum number of transcription jobs to return in each page of results. If there
3578
3983
  * are fewer results than the value that you specify, only the actual results are returned.
3579
- * If you don't specify a value, a default of 5 is used.</p>
3984
+ * If you do not specify a value, a default of 5 is used.</p>
3580
3985
  */
3581
3986
  MaxResults?: number;
3582
3987
  }
@@ -3742,13 +4147,13 @@ export interface ListVocabulariesRequest {
3742
4147
  * @public
3743
4148
  * <p>The maximum number of custom vocabularies to return in each page of results. If there
3744
4149
  * are fewer results than the value that you specify, only the actual results are returned.
3745
- * If you don't specify a value, a default of 5 is used.</p>
4150
+ * If you do not specify a value, a default of 5 is used.</p>
3746
4151
  */
3747
4152
  MaxResults?: number;
3748
4153
  /**
3749
4154
  * @public
3750
4155
  * <p>Returns only custom vocabularies with the specified state. Vocabularies are ordered by
3751
- * creation date, with the newest vocabulary first. If you don't include
4156
+ * creation date, with the newest vocabulary first. If you do not include
3752
4157
  * <code>StateEquals</code>, all custom medical vocabularies are returned.</p>
3753
4158
  */
3754
4159
  StateEquals?: VocabularyState;
@@ -3802,7 +4207,7 @@ export interface ListVocabularyFiltersRequest {
3802
4207
  * @public
3803
4208
  * <p>The maximum number of custom vocabulary filters to return in each page of results. If
3804
4209
  * there are fewer results than the value that you specify, only the actual results are
3805
- * returned. If you don't specify a value, a default of 5 is used.</p>
4210
+ * returned. If you do not specify a value, a default of 5 is used.</p>
3806
4211
  */
3807
4212
  MaxResults?: number;
3808
4213
  /**
@@ -3902,9 +4307,9 @@ export interface StartCallAnalyticsJobRequest {
3902
4307
  * value that matches the name you specified for your transcription job using the
3903
4308
  * <code>CallAnalyticsJobName</code> parameter.</p>
3904
4309
  * <p>You can specify a KMS key to encrypt your output using the
3905
- * <code>OutputEncryptionKMSKeyId</code> parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for
4310
+ * <code>OutputEncryptionKMSKeyId</code> parameter. If you do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for
3906
4311
  * server-side encryption.</p>
3907
- * <p>If you don't specify <code>OutputLocation</code>, your transcript is placed in a
4312
+ * <p>If you do not specify <code>OutputLocation</code>, your transcript is placed in a
3908
4313
  * service-managed Amazon S3 bucket and you are provided with a URI to access your
3909
4314
  * transcript.</p>
3910
4315
  */
@@ -3948,7 +4353,7 @@ export interface StartCallAnalyticsJobRequest {
3948
4353
  * <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
3949
4354
  * </li>
3950
4355
  * </ol>
3951
- * <p>If you don't specify an encryption key, your output is encrypted with the default
4356
+ * <p>If you do not specify an encryption key, your output is encrypted with the default
3952
4357
  * Amazon S3 key (SSE-S3).</p>
3953
4358
  * <p>If you specify a KMS key to encrypt your output, you must also specify
3954
4359
  * an output location using the <code>OutputLocation</code> parameter.</p>
@@ -3994,6 +4399,144 @@ export interface StartCallAnalyticsJobResponse {
3994
4399
  */
3995
4400
  CallAnalyticsJob?: CallAnalyticsJob;
3996
4401
  }
4402
+ /**
4403
+ * @public
4404
+ */
4405
+ export interface StartMedicalScribeJobRequest {
4406
+ /**
4407
+ * @public
4408
+ * <p>A unique name, chosen by you, for your Medical Scribe job.</p>
4409
+ * <p>This name is case sensitive, cannot contain spaces, and must be unique within an
4410
+ * Amazon Web Services account. If you try to create a new job with the same name as an
4411
+ * existing job, you get a <code>ConflictException</code> error.</p>
4412
+ */
4413
+ MedicalScribeJobName: string | undefined;
4414
+ /**
4415
+ * @public
4416
+ * <p>Describes the Amazon S3 location of the media file you want to use in your
4417
+ * request.</p>
4418
+ * <p>For information on supported media formats, refer to the <code>MediaFormat</code>
4419
+ * parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
4420
+ * in the Amazon S3 Developer Guide.</p>
4421
+ */
4422
+ Media: Media | undefined;
4423
+ /**
4424
+ * @public
4425
+ * <p>The name of the Amazon S3 bucket where you want your Medical Scribe
4426
+ * output stored. Do not include the <code>S3://</code> prefix of the specified
4427
+ * bucket.</p>
4428
+ * <p>Note that the role specified in the <code>DataAccessRoleArn</code> request parameter
4429
+ * must have permission to use the specified location. You
4430
+ * 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>
4431
+ */
4432
+ OutputBucketName: string | undefined;
4433
+ /**
4434
+ * @public
4435
+ * <p>The KMS key you want to use to encrypt your Medical Scribe
4436
+ * output.</p>
4437
+ * <p>If using a key located in the <b>current</b>
4438
+ * Amazon Web Services account, you can specify your KMS key in one of four
4439
+ * ways:</p>
4440
+ * <ol>
4441
+ * <li>
4442
+ * <p>Use the KMS key ID itself. For example,
4443
+ * <code>1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
4444
+ * </li>
4445
+ * <li>
4446
+ * <p>Use an alias for the KMS key ID. For example,
4447
+ * <code>alias/ExampleAlias</code>.</p>
4448
+ * </li>
4449
+ * <li>
4450
+ * <p>Use the Amazon Resource Name (ARN) for the KMS key ID. For
4451
+ * example,
4452
+ * <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
4453
+ * </li>
4454
+ * <li>
4455
+ * <p>Use the ARN for the KMS key alias. For example,
4456
+ * <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
4457
+ * </li>
4458
+ * </ol>
4459
+ * <p>If using a key located in a <b>different</b>
4460
+ * Amazon Web Services account than the current Amazon Web Services account, you can specify
4461
+ * your KMS key in one of two ways:</p>
4462
+ * <ol>
4463
+ * <li>
4464
+ * <p>Use the ARN for the KMS key ID. For example,
4465
+ * <code>arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
4466
+ * </li>
4467
+ * <li>
4468
+ * <p>Use the ARN for the KMS key alias. For example,
4469
+ * <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
4470
+ * </li>
4471
+ * </ol>
4472
+ * <p>If you do not specify an encryption key, your output is encrypted with the default
4473
+ * Amazon S3 key (SSE-S3).</p>
4474
+ * <p>Note that the role specified in the <code>DataAccessRoleArn</code> request parameter
4475
+ * must have permission to use the specified KMS key.</p>
4476
+ */
4477
+ OutputEncryptionKMSKeyId?: string;
4478
+ /**
4479
+ * @public
4480
+ * <p>A map of plain text, non-secret key:value pairs, known as encryption context pairs,
4481
+ * 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>
4482
+ */
4483
+ KMSEncryptionContext?: Record<string, string>;
4484
+ /**
4485
+ * @public
4486
+ * <p>The Amazon Resource Name (ARN) of an IAM role that has permissions to
4487
+ * access the Amazon S3 bucket that contains your input files,
4488
+ * write to the output bucket, and use your KMS key if supplied.
4489
+ * If the role that you specify doesn’t have the appropriate permissions your request fails.</p>
4490
+ * <p>IAM role ARNs have the format
4491
+ * <code>arn:partition:iam::account:role/role-name-with-path</code>. For example:
4492
+ * <code>arn:aws:iam::111122223333:role/Admin</code>.</p>
4493
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns">IAM
4494
+ * ARNs</a>.</p>
4495
+ */
4496
+ DataAccessRoleArn: string | undefined;
4497
+ /**
4498
+ * @public
4499
+ * <p>Makes it possible to control how your Medical Scribe job is processed using a
4500
+ * <code>MedicalScribeSettings</code> object. Specify <code>ChannelIdentification</code> if
4501
+ * <code>ChannelDefinitions</code> are set. Enabled <code>ShowSpeakerLabels</code> if <code>ChannelIdentification</code>
4502
+ * and <code>ChannelDefinitions</code> are not set. One and only one of <code>ChannelIdentification</code> and <code>ShowSpeakerLabels</code>
4503
+ * must be set. If <code>ShowSpeakerLabels</code> is set, <code>MaxSpeakerLabels</code> must also be set. Use <code>Settings</code>
4504
+ * to specify a vocabulary or vocabulary filter or both using <code>VocabularyName</code>, <code>VocabularyFilterName</code>.
4505
+ * <code>VocabularyFilterMethod</code> must be specified if <code>VocabularyFilterName</code> is set.
4506
+ * </p>
4507
+ */
4508
+ Settings: MedicalScribeSettings | undefined;
4509
+ /**
4510
+ * @public
4511
+ * <p>Makes it possible to specify which speaker is on which channel. For example, if the clinician
4512
+ * is the first participant to speak, you would set <code>ChannelId</code> of the first <code>ChannelDefinition</code>
4513
+ * in the list to <code>0</code> (to indicate the first channel) and <code>ParticipantRole</code> to
4514
+ * <code>CLINICIAN</code> (to indicate that it's the clinician speaking).
4515
+ * Then you would set the <code>ChannelId</code> of the second <code>ChannelDefinition</code> in the list to
4516
+ * <code>1</code> (to indicate the second channel) and <code>ParticipantRole</code> to
4517
+ * <code>PATIENT</code> (to indicate that it's the patient speaking).
4518
+ * </p>
4519
+ */
4520
+ ChannelDefinitions?: MedicalScribeChannelDefinition[];
4521
+ /**
4522
+ * @public
4523
+ * <p>Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.</p>
4524
+ * <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
+ * resources</a>.</p>
4526
+ */
4527
+ Tags?: Tag[];
4528
+ }
4529
+ /**
4530
+ * @public
4531
+ */
4532
+ export interface StartMedicalScribeJobResponse {
4533
+ /**
4534
+ * @public
4535
+ * <p>Provides detailed information about the current Medical Scribe job, including
4536
+ * job status and, if applicable, failure reason.</p>
4537
+ */
4538
+ MedicalScribeJob?: MedicalScribeJob;
4539
+ }
3997
4540
  /**
3998
4541
  * @public
3999
4542
  */
@@ -4020,7 +4563,7 @@ export interface StartMedicalTranscriptionJobRequest {
4020
4563
  /**
4021
4564
  * @public
4022
4565
  * <p>The sample rate, in hertz, of the audio track in your input media file.</p>
4023
- * <p>If you don't specify the media sample rate, Amazon Transcribe Medical determines it
4566
+ * <p>If you do not specify the media sample rate, Amazon Transcribe Medical determines it
4024
4567
  * 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
4025
4568
  * value detected, your job fails. Therefore, in most cases, it's advised to omit
4026
4569
  * <code>MediaSampleRateHertz</code> and let Amazon Transcribe Medical determine the
@@ -4036,7 +4579,8 @@ export interface StartMedicalTranscriptionJobRequest {
4036
4579
  * @public
4037
4580
  * <p>Describes the Amazon S3 location of the media file you want to use in your
4038
4581
  * request.</p>
4039
- * <p>For information on supported media formats, refer to the <a href="https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat">MediaFormat</a> parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
4582
+ * <p>For information on supported media formats, refer to the <code>MediaFormat</code>
4583
+ * parameter or the <a href="https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio">Media formats</a> section
4040
4584
  * in the Amazon S3 Developer Guide.</p>
4041
4585
  */
4042
4586
  Media: Media | undefined;
@@ -4134,7 +4678,7 @@ export interface StartMedicalTranscriptionJobRequest {
4134
4678
  * <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
4135
4679
  * </li>
4136
4680
  * </ol>
4137
- * <p>If you don't specify an encryption key, your output is encrypted with the default
4681
+ * <p>If you do not specify an encryption key, your output is encrypted with the default
4138
4682
  * Amazon S3 key (SSE-S3).</p>
4139
4683
  * <p>If you specify a KMS key to encrypt your output, you must also specify
4140
4684
  * an output location using the <code>OutputLocation</code> parameter.</p>
@@ -4259,7 +4803,7 @@ export interface StartTranscriptionJobRequest {
4259
4803
  /**
4260
4804
  * @public
4261
4805
  * <p>The sample rate, in hertz, of the audio track in your input media file.</p>
4262
- * <p>If you don't specify the media sample rate, Amazon Transcribe determines it for you.
4806
+ * <p>If you do not specify the media sample rate, Amazon Transcribe determines it for you.
4263
4807
  * If you specify the sample rate, it must match the rate detected by Amazon Transcribe.
4264
4808
  * If there's a mismatch between the value that you specify and the value detected, your
4265
4809
  * job fails. In most cases, you can omit <code>MediaSampleRateHertz</code> and let Amazon Transcribe determine the sample rate.</p>
@@ -4290,7 +4834,7 @@ export interface StartTranscriptionJobRequest {
4290
4834
  * <code>OutputKey</code> to <code>test-files/</code>.</p>
4291
4835
  * <p>Note that Amazon Transcribe must have permission to use the specified location. You
4292
4836
  * 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>
4293
- * <p>If you don't specify <code>OutputBucketName</code>, your transcript is placed in a
4837
+ * <p>If you do not specify <code>OutputBucketName</code>, your transcript is placed in a
4294
4838
  * service-managed Amazon S3 bucket and you are provided with a URI to access your
4295
4839
  * transcript.</p>
4296
4840
  */
@@ -4372,7 +4916,7 @@ export interface StartTranscriptionJobRequest {
4372
4916
  * <code>arn:aws:kms:region:account-ID:alias/ExampleAlias</code>.</p>
4373
4917
  * </li>
4374
4918
  * </ol>
4375
- * <p>If you don't specify an encryption key, your output is encrypted with the default
4919
+ * <p>If you do not specify an encryption key, your output is encrypted with the default
4376
4920
  * Amazon S3 key (SSE-S3).</p>
4377
4921
  * <p>If you specify a KMS key to encrypt your output, you must also specify
4378
4922
  * an output location using the <code>OutputLocation</code> parameter.</p>
@@ -4388,7 +4932,8 @@ export interface StartTranscriptionJobRequest {
4388
4932
  KMSEncryptionContext?: Record<string, string>;
4389
4933
  /**
4390
4934
  * @public
4391
- * <p>Specify additional optional settings in your request, including channel identification, alternative transcriptions, speaker
4935
+ * <p>Specify additional optional settings in your
4936
+ * request, including channel identification, alternative transcriptions, speaker
4392
4937
  * partitioning. You can use that to apply custom vocabularies and vocabulary filters.</p>
4393
4938
  * <p>If you want to include a custom vocabulary or a custom vocabulary filter (or both)
4394
4939
  * with your request but <b>do not</b> want to use automatic
@@ -4422,10 +4967,11 @@ export interface StartTranscriptionJobRequest {
4422
4967
  JobExecutionSettings?: JobExecutionSettings;
4423
4968
  /**
4424
4969
  * @public
4425
- * <p>Makes it possible to redact or flag specified personally identifiable information
4426
- * (PII) in your transcript. If you use <code>ContentRedaction</code>, you must also
4427
- * include the sub-parameters: <code>PiiEntityTypes</code>, <code>RedactionOutput</code>,
4428
- * and <code>RedactionType</code>.</p>
4970
+ * <p>Makes it possible to redact or flag specified personally identifiable information (PII) in
4971
+ * your transcript. If you use <code>ContentRedaction</code>, you must also include the
4972
+ * sub-parameters: <code>RedactionOutput</code> and <code>RedactionType</code>. You can
4973
+ * optionally include <code>PiiEntityTypes</code> to choose which types of PII you want to redact.
4974
+ * If you do not include <code>PiiEntityTypes</code> in your request, all PII is redacted.</p>
4429
4975
  */
4430
4976
  ContentRedaction?: ContentRedaction;
4431
4977
  /**