aws-sdk 2.1503.0 → 2.1505.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 (41) hide show
  1. package/CHANGELOG.md +15 -1
  2. package/README.md +1 -1
  3. package/apis/appsync-2017-07-25.min.json +141 -6
  4. package/apis/b2bi-2022-06-23.examples.json +714 -0
  5. package/apis/b2bi-2022-06-23.min.json +1095 -0
  6. package/apis/b2bi-2022-06-23.paginators.json +28 -0
  7. package/apis/backup-2018-11-15.min.json +855 -84
  8. package/apis/backup-2018-11-15.paginators.json +18 -0
  9. package/apis/controltower-2018-05-10.min.json +80 -12
  10. package/apis/elasticache-2015-02-02.min.json +481 -132
  11. package/apis/elasticache-2015-02-02.paginators.json +12 -0
  12. package/apis/elasticfilesystem-2015-02-01.min.json +66 -32
  13. package/apis/fis-2020-12-01.min.json +366 -15
  14. package/apis/fis-2020-12-01.paginators.json +10 -0
  15. package/apis/metadata.json +3 -0
  16. package/apis/securityhub-2018-10-26.examples.json +433 -8
  17. package/apis/securityhub-2018-10-26.min.json +790 -336
  18. package/apis/securityhub-2018-10-26.paginators.json +12 -0
  19. package/apis/transcribe-2017-10-26.min.json +257 -70
  20. package/apis/transcribe-2017-10-26.paginators.json +5 -0
  21. package/clients/all.d.ts +1 -0
  22. package/clients/all.js +2 -1
  23. package/clients/appsync.d.ts +169 -0
  24. package/clients/b2bi.d.ts +1388 -0
  25. package/clients/b2bi.js +18 -0
  26. package/clients/backup.d.ts +848 -45
  27. package/clients/controltower.d.ts +103 -47
  28. package/clients/efs.d.ts +42 -9
  29. package/clients/elasticache.d.ts +484 -12
  30. package/clients/fis.d.ts +383 -3
  31. package/clients/glue.d.ts +3 -3
  32. package/clients/rds.d.ts +80 -80
  33. package/clients/securityhub.d.ts +603 -13
  34. package/clients/transcribeservice.d.ts +301 -45
  35. package/dist/aws-sdk-core-react-native.js +2 -2
  36. package/dist/aws-sdk-react-native.js +54 -17
  37. package/dist/aws-sdk.js +565 -167
  38. package/dist/aws-sdk.min.js +60 -60
  39. package/lib/config_service_placeholders.d.ts +2 -0
  40. package/lib/core.js +1 -1
  41. package/package.json +1 -1
@@ -75,6 +75,14 @@ declare class TranscribeService extends Service {
75
75
  * Deletes a custom language model. To use this operation, specify the name of the language model you want to delete using ModelName. custom language model names are case sensitive.
76
76
  */
77
77
  deleteLanguageModel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
78
+ /**
79
+ * Deletes a Medical Scribe job. To use this operation, specify the name of the job you want to delete using MedicalScribeJobName. Job names are case sensitive.
80
+ */
81
+ deleteMedicalScribeJob(params: TranscribeService.Types.DeleteMedicalScribeJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
82
+ /**
83
+ * Deletes a Medical Scribe job. To use this operation, specify the name of the job you want to delete using MedicalScribeJobName. Job names are case sensitive.
84
+ */
85
+ deleteMedicalScribeJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
78
86
  /**
79
87
  * Deletes a medical transcription job. To use this operation, specify the name of the job you want to delete using MedicalTranscriptionJobName. Job names are case sensitive.
80
88
  */
@@ -139,6 +147,14 @@ declare class TranscribeService extends Service {
139
147
  * Provides information about the specified Call Analytics job. To view the job's status, refer to CallAnalyticsJobStatus. If the status is COMPLETED, the job is finished. You can find your completed transcript at the URI specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed. If you enabled personally identifiable information (PII) redaction, the redacted transcript appears at the location specified in RedactedTranscriptFileUri. If you chose to redact the audio in your media file, you can find your redacted media file at the location specified in RedactedMediaFileUri. To get a list of your Call Analytics jobs, use the operation.
140
148
  */
141
149
  getCallAnalyticsJob(callback?: (err: AWSError, data: TranscribeService.Types.GetCallAnalyticsJobResponse) => void): Request<TranscribeService.Types.GetCallAnalyticsJobResponse, AWSError>;
150
+ /**
151
+ * Provides information about the specified Medical Scribe job. To view the status of the specified medical transcription job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed. To get a list of your Medical Scribe jobs, use the operation.
152
+ */
153
+ getMedicalScribeJob(params: TranscribeService.Types.GetMedicalScribeJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.GetMedicalScribeJobResponse) => void): Request<TranscribeService.Types.GetMedicalScribeJobResponse, AWSError>;
154
+ /**
155
+ * Provides information about the specified Medical Scribe job. To view the status of the specified medical transcription job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed. To get a list of your Medical Scribe jobs, use the operation.
156
+ */
157
+ getMedicalScribeJob(callback?: (err: AWSError, data: TranscribeService.Types.GetMedicalScribeJobResponse) => void): Request<TranscribeService.Types.GetMedicalScribeJobResponse, AWSError>;
142
158
  /**
143
159
  * Provides information about the specified medical transcription job. To view the status of the specified medical transcription job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished. You can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed. To get a list of your medical transcription jobs, use the operation.
144
160
  */
@@ -203,6 +219,14 @@ declare class TranscribeService extends Service {
203
219
  * Provides a list of custom language models that match the specified criteria. If no criteria are specified, all custom language models are returned. To get detailed information about a specific custom language model, use the operation.
204
220
  */
205
221
  listLanguageModels(callback?: (err: AWSError, data: TranscribeService.Types.ListLanguageModelsResponse) => void): Request<TranscribeService.Types.ListLanguageModelsResponse, AWSError>;
222
+ /**
223
+ * Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned. To get detailed information about a specific Medical Scribe job, use the operation.
224
+ */
225
+ listMedicalScribeJobs(params: TranscribeService.Types.ListMedicalScribeJobsRequest, callback?: (err: AWSError, data: TranscribeService.Types.ListMedicalScribeJobsResponse) => void): Request<TranscribeService.Types.ListMedicalScribeJobsResponse, AWSError>;
226
+ /**
227
+ * Provides a list of Medical Scribe jobs that match the specified criteria. If no criteria are specified, all Medical Scribe jobs are returned. To get detailed information about a specific Medical Scribe job, use the operation.
228
+ */
229
+ listMedicalScribeJobs(callback?: (err: AWSError, data: TranscribeService.Types.ListMedicalScribeJobsResponse) => void): Request<TranscribeService.Types.ListMedicalScribeJobsResponse, AWSError>;
206
230
  /**
207
231
  * Provides a list of medical transcription jobs that match the specified criteria. If no criteria are specified, all medical transcription jobs are returned. To get detailed information about a specific medical transcription job, use the operation.
208
232
  */
@@ -260,19 +284,27 @@ declare class TranscribeService extends Service {
260
284
  */
261
285
  startCallAnalyticsJob(callback?: (err: AWSError, data: TranscribeService.Types.StartCallAnalyticsJobResponse) => void): Request<TranscribeService.Types.StartCallAnalyticsJobResponse, AWSError>;
262
286
  /**
263
- * Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request. In addition to many standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works. To make a StartMedicalTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the S3 location of the file using the Media parameter. You must include the following parameters in your StartMedicalTranscriptionJob request: region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. MedicalTranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account. Media (MediaFileUri): The Amazon S3 location of your media file. LanguageCode: This must be en-US. OutputBucketName: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also include OutputKey. Specialty: This must be PRIMARYCARE. Type: Choose whether your audio is a conversation or a dictation.
287
+ * Transcribes patient-clinician conversations and generates clinical notes. Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to Amazon Web Services HealthScribe. To make a StartMedicalScribeJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. You must include the following parameters in your StartMedicalTranscriptionJob request: DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified in Media, write permission on the Amazon S3 bucket specified in OutputBucketName, and full permissions on the KMS key specified in OutputEncryptionKMSKeyId (if set). The role should also allow transcribe.amazonaws.com to assume it. Media (MediaFileUri): The Amazon S3 location of your media file. MedicalScribeJobName: A custom name you create for your MedicalScribe job that is unique within your Amazon Web Services account. OutputBucketName: The Amazon S3 bucket where you want your output files stored. Settings: A MedicalScribeSettings obect that must set exactly one of ShowSpeakerLabels or ChannelIdentification to true. If ShowSpeakerLabels is true, MaxSpeakerLabels must also be set. ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only if the ChannelIdentification value of Settings is set to true.
288
+ */
289
+ startMedicalScribeJob(params: TranscribeService.Types.StartMedicalScribeJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.StartMedicalScribeJobResponse) => void): Request<TranscribeService.Types.StartMedicalScribeJobResponse, AWSError>;
290
+ /**
291
+ * Transcribes patient-clinician conversations and generates clinical notes. Amazon Web Services HealthScribe automatically provides rich conversation transcripts, identifies speaker roles, classifies dialogues, extracts medical terms, and generates preliminary clinical notes. To learn more about these features, refer to Amazon Web Services HealthScribe. To make a StartMedicalScribeJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. You must include the following parameters in your StartMedicalTranscriptionJob request: DataAccessRoleArn: The ARN of an IAM role with the these minimum permissions: read permission on input file Amazon S3 bucket specified in Media, write permission on the Amazon S3 bucket specified in OutputBucketName, and full permissions on the KMS key specified in OutputEncryptionKMSKeyId (if set). The role should also allow transcribe.amazonaws.com to assume it. Media (MediaFileUri): The Amazon S3 location of your media file. MedicalScribeJobName: A custom name you create for your MedicalScribe job that is unique within your Amazon Web Services account. OutputBucketName: The Amazon S3 bucket where you want your output files stored. Settings: A MedicalScribeSettings obect that must set exactly one of ShowSpeakerLabels or ChannelIdentification to true. If ShowSpeakerLabels is true, MaxSpeakerLabels must also be set. ChannelDefinitions: A MedicalScribeChannelDefinitions array should be set if and only if the ChannelIdentification value of Settings is set to true.
292
+ */
293
+ startMedicalScribeJob(callback?: (err: AWSError, data: TranscribeService.Types.StartMedicalScribeJobResponse) => void): Request<TranscribeService.Types.StartMedicalScribeJobResponse, AWSError>;
294
+ /**
295
+ * Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request. In addition to many standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works. To make a StartMedicalTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. You must include the following parameters in your StartMedicalTranscriptionJob request: region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. MedicalTranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account. Media (MediaFileUri): The Amazon S3 location of your media file. LanguageCode: This must be en-US. OutputBucketName: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also include OutputKey. Specialty: This must be PRIMARYCARE. Type: Choose whether your audio is a conversation or a dictation.
264
296
  */
265
297
  startMedicalTranscriptionJob(params: TranscribeService.Types.StartMedicalTranscriptionJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.StartMedicalTranscriptionJobResponse) => void): Request<TranscribeService.Types.StartMedicalTranscriptionJobResponse, AWSError>;
266
298
  /**
267
- * Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request. In addition to many standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works. To make a StartMedicalTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the S3 location of the file using the Media parameter. You must include the following parameters in your StartMedicalTranscriptionJob request: region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. MedicalTranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account. Media (MediaFileUri): The Amazon S3 location of your media file. LanguageCode: This must be en-US. OutputBucketName: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also include OutputKey. Specialty: This must be PRIMARYCARE. Type: Choose whether your audio is a conversation or a dictation.
299
+ * Transcribes the audio from a medical dictation or conversation and applies any additional Request Parameters you choose to include in your request. In addition to many standard transcription features, Amazon Transcribe Medical provides you with a robust medical vocabulary and, optionally, content identification, which adds flags to personal health information (PHI). To learn more about these features, refer to How Amazon Transcribe Medical works. To make a StartMedicalTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. You must include the following parameters in your StartMedicalTranscriptionJob request: region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. MedicalTranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account. Media (MediaFileUri): The Amazon S3 location of your media file. LanguageCode: This must be en-US. OutputBucketName: The Amazon S3 bucket where you want your transcript stored. If you want your output stored in a sub-folder of this bucket, you must also include OutputKey. Specialty: This must be PRIMARYCARE. Type: Choose whether your audio is a conversation or a dictation.
268
300
  */
269
301
  startMedicalTranscriptionJob(callback?: (err: AWSError, data: TranscribeService.Types.StartMedicalTranscriptionJobResponse) => void): Request<TranscribeService.Types.StartMedicalTranscriptionJobResponse, AWSError>;
270
302
  /**
271
- * Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request. To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. You must include the following parameters in your StartTranscriptionJob request: region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. TranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account. Media (MediaFileUri): The Amazon S3 location of your media file. One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language of your media file, specify it using the LanguageCode parameter; you can find all valid language codes in the Supported languages table. If you don't know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.
303
+ * Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request. To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. You must include the following parameters in your StartTranscriptionJob request: region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. TranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account. Media (MediaFileUri): The Amazon S3 location of your media file. One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language of your media file, specify it using the LanguageCode parameter; you can find all valid language codes in the Supported languages table. If you do not know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.
272
304
  */
273
305
  startTranscriptionJob(params: TranscribeService.Types.StartTranscriptionJobRequest, callback?: (err: AWSError, data: TranscribeService.Types.StartTranscriptionJobResponse) => void): Request<TranscribeService.Types.StartTranscriptionJobResponse, AWSError>;
274
306
  /**
275
- * Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request. To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. You must include the following parameters in your StartTranscriptionJob request: region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. TranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account. Media (MediaFileUri): The Amazon S3 location of your media file. One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language of your media file, specify it using the LanguageCode parameter; you can find all valid language codes in the Supported languages table. If you don't know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.
307
+ * Transcribes the audio from a media file and applies any additional Request Parameters you choose to include in your request. To make a StartTranscriptionJob request, you must first upload your media file into an Amazon S3 bucket; you can then specify the Amazon S3 location of the file using the Media parameter. You must include the following parameters in your StartTranscriptionJob request: region: The Amazon Web Services Region where you are making your request. For a list of Amazon Web Services Regions supported with Amazon Transcribe, refer to Amazon Transcribe endpoints and quotas. TranscriptionJobName: A custom name you create for your transcription job that is unique within your Amazon Web Services account. Media (MediaFileUri): The Amazon S3 location of your media file. One of LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages: If you know the language of your media file, specify it using the LanguageCode parameter; you can find all valid language codes in the Supported languages table. If you do not know the languages spoken in your media, use either IdentifyLanguage or IdentifyMultipleLanguages and let Amazon Transcribe identify the languages for you.
276
308
  */
277
309
  startTranscriptionJob(callback?: (err: AWSError, data: TranscribeService.Types.StartTranscriptionJobResponse) => void): Request<TranscribeService.Types.StartTranscriptionJobResponse, AWSError>;
278
310
  /**
@@ -356,7 +388,7 @@ declare namespace TranscribeService {
356
388
  */
357
389
  CallAnalyticsJobStatus?: CallAnalyticsJobStatus;
358
390
  /**
359
- * The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table. If you don't know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.
391
+ * The language code used to create your Call Analytics job. For a list of supported languages and their associated language codes, refer to the Supported languages table. If you do not know the language spoken in your media file, you can omit this field and let Amazon Transcribe automatically identify the language of your media. To improve the accuracy of language identification, you can include several language codes and Amazon Transcribe chooses the closest match for your transcription.
360
392
  */
361
393
  LanguageCode?: LanguageCode;
362
394
  /**
@@ -385,7 +417,7 @@ declare namespace TranscribeService {
385
417
  */
386
418
  CompletionTime?: DateTime;
387
419
  /**
388
- * If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed. The FailureReason field contains one of the following values: Unsupported media format. The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats. The media format provided does not match the detected media format. The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value. Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz. The sample rate provided does not match the detected sample rate. The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value. Invalid file size: file size too large. The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas. Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
420
+ * If CallAnalyticsJobStatus is FAILED, FailureReason contains information about why the Call Analytics job request failed. The FailureReason field contains one of the following values: Unsupported media format. The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats. The media format provided does not match the detected media format. The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value. Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz. The sample rate provided does not match the detected sample rate. The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value. Invalid file size: file size too large. The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas. Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.
389
421
  */
390
422
  FailureReason?: FailureReason;
391
423
  /**
@@ -420,7 +452,7 @@ declare namespace TranscribeService {
420
452
  */
421
453
  VocabularyFilterMethod?: VocabularyFilterMethod;
422
454
  /**
423
- * The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive. The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
455
+ * The name of the custom language model you want to use when processing your Call Analytics job. Note that custom language model names are case sensitive. The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
424
456
  */
425
457
  LanguageModelName?: ModelName;
426
458
  ContentRedaction?: ContentRedaction;
@@ -507,7 +539,7 @@ declare namespace TranscribeService {
507
539
  export type ChannelId = number;
508
540
  export interface ContentRedaction {
509
541
  /**
510
- * Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact.
542
+ * Specify the category of information you want to redact; PII (personally identifiable information) is the only valid value. You can use PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted.
511
543
  */
512
544
  RedactionType: RedactionType;
513
545
  /**
@@ -515,7 +547,7 @@ declare namespace TranscribeService {
515
547
  */
516
548
  RedactionOutput: RedactionOutput;
517
549
  /**
518
- * Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL.
550
+ * Specify which types of personally identifiable information (PII) you want to redact in your transcript. You can include as many types as you'd like, or you can select ALL. If you do not include PiiEntityTypes in your request, all PII is redacted.
519
551
  */
520
552
  PiiEntityTypes?: PiiEntityTypes;
521
553
  }
@@ -735,6 +767,12 @@ declare namespace TranscribeService {
735
767
  */
736
768
  ModelName: ModelName;
737
769
  }
770
+ export interface DeleteMedicalScribeJobRequest {
771
+ /**
772
+ * The name of the Medical Scribe job you want to delete. Job names are case sensitive.
773
+ */
774
+ MedicalScribeJobName: TranscriptionJobName;
775
+ }
738
776
  export interface DeleteMedicalTranscriptionJobRequest {
739
777
  /**
740
778
  * The name of the medical transcription job you want to delete. Job names are case sensitive.
@@ -803,6 +841,18 @@ declare namespace TranscribeService {
803
841
  */
804
842
  CallAnalyticsJob?: CallAnalyticsJob;
805
843
  }
844
+ export interface GetMedicalScribeJobRequest {
845
+ /**
846
+ * The name of the Medical Scribe job you want information about. Job names are case sensitive.
847
+ */
848
+ MedicalScribeJobName: TranscriptionJobName;
849
+ }
850
+ export interface GetMedicalScribeJobResponse {
851
+ /**
852
+ * Provides detailed information about the specified Medical Scribe job, including job status and, if applicable, failure reason
853
+ */
854
+ MedicalScribeJob?: MedicalScribeJob;
855
+ }
806
856
  export interface GetMedicalTranscriptionJobRequest {
807
857
  /**
808
858
  * The name of the medical transcription job you want information about. Job names are case sensitive.
@@ -843,7 +893,7 @@ declare namespace TranscribeService {
843
893
  */
844
894
  FailureReason?: FailureReason;
845
895
  /**
846
- * The S3 location where the specified custom medical vocabulary is stored; use this URI to view or download the custom vocabulary.
896
+ * The Amazon S3 location where the specified custom medical vocabulary is stored; use this URI to view or download the custom vocabulary.
847
897
  */
848
898
  DownloadUri?: Uri;
849
899
  }
@@ -911,7 +961,7 @@ declare namespace TranscribeService {
911
961
  */
912
962
  FailureReason?: FailureReason;
913
963
  /**
914
- * The S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.
964
+ * The Amazon S3 location where the custom vocabulary is stored; use this URI to view or download the custom vocabulary.
915
965
  */
916
966
  DownloadUri?: Uri;
917
967
  }
@@ -979,15 +1029,15 @@ declare namespace TranscribeService {
979
1029
  export type LanguageCodeList = LanguageCodeItem[];
980
1030
  export interface LanguageIdSettings {
981
1031
  /**
982
- * The name of the custom vocabulary you want to use when processing your transcription job. Custom vocabulary names are case sensitive. The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages don't match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.
1032
+ * The name of the custom vocabulary you want to use when processing your transcription job. Custom vocabulary names are case sensitive. The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch.
983
1033
  */
984
1034
  VocabularyName?: VocabularyName;
985
1035
  /**
986
- * The name of the custom vocabulary filter you want to use when processing your transcription job. Custom vocabulary filter names are case sensitive. The language of the specified custom vocabulary filter must match the language code that you specify in your transcription request. If the languages don't match, the custom vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch. Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.
1036
+ * The name of the custom vocabulary filter you want to use when processing your transcription job. Custom vocabulary filter names are case sensitive. The language of the specified custom vocabulary filter must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary filter isn't applied. There are no errors or warnings associated with a language mismatch. Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.
987
1037
  */
988
1038
  VocabularyFilterName?: VocabularyFilterName;
989
1039
  /**
990
- * The name of the custom language model you want to use when processing your transcription job. Note that custom language model names are case sensitive. The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
1040
+ * The name of the custom language model you want to use when processing your transcription job. Note that custom language model names are case sensitive. The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
991
1041
  */
992
1042
  LanguageModelName?: ModelName;
993
1043
  }
@@ -1006,7 +1056,7 @@ declare namespace TranscribeService {
1006
1056
  */
1007
1057
  LastModifiedTime?: DateTime;
1008
1058
  /**
1009
- * The language code used to create your custom language model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data. For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that U.S. English (en-US) is the only language supported with Amazon Transcribe Medical.
1059
+ * The language code used to create your custom language model. Each custom language model must contain terms in only one language, and the language you select for your custom language model must match the language of your training and tuning data. For a list of supported languages and their associated language codes, refer to the Supported languages table. Note that US English (en-US) is the only language supported with Amazon Transcribe Medical.
1010
1060
  */
1011
1061
  LanguageCode?: CLMLanguageCode;
1012
1062
  /**
@@ -1037,7 +1087,7 @@ declare namespace TranscribeService {
1037
1087
  */
1038
1088
  NextToken?: NextToken;
1039
1089
  /**
1040
- * The maximum number of Call Analytics categories to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
1090
+ * The maximum number of Call Analytics categories to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.
1041
1091
  */
1042
1092
  MaxResults?: MaxResults;
1043
1093
  }
@@ -1053,7 +1103,7 @@ declare namespace TranscribeService {
1053
1103
  }
1054
1104
  export interface ListCallAnalyticsJobsRequest {
1055
1105
  /**
1056
- * Returns only Call Analytics jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all Call Analytics jobs are returned.
1106
+ * Returns only Call Analytics jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status, all Call Analytics jobs are returned.
1057
1107
  */
1058
1108
  Status?: CallAnalyticsJobStatus;
1059
1109
  /**
@@ -1065,7 +1115,7 @@ declare namespace TranscribeService {
1065
1115
  */
1066
1116
  NextToken?: NextToken;
1067
1117
  /**
1068
- * The maximum number of Call Analytics jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
1118
+ * The maximum number of Call Analytics jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.
1069
1119
  */
1070
1120
  MaxResults?: MaxResults;
1071
1121
  }
@@ -1085,7 +1135,7 @@ declare namespace TranscribeService {
1085
1135
  }
1086
1136
  export interface ListLanguageModelsRequest {
1087
1137
  /**
1088
- * Returns only custom language models with the specified status. Language models are ordered by creation date, with the newest model first. If you don't include StatusEquals, all custom language models are returned.
1138
+ * Returns only custom language models with the specified status. Language models are ordered by creation date, with the newest model first. If you do not include StatusEquals, all custom language models are returned.
1089
1139
  */
1090
1140
  StatusEquals?: ModelStatus;
1091
1141
  /**
@@ -1097,7 +1147,7 @@ declare namespace TranscribeService {
1097
1147
  */
1098
1148
  NextToken?: NextToken;
1099
1149
  /**
1100
- * The maximum number of custom language models to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
1150
+ * The maximum number of custom language models to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.
1101
1151
  */
1102
1152
  MaxResults?: MaxResults;
1103
1153
  }
@@ -1111,9 +1161,41 @@ declare namespace TranscribeService {
1111
1161
  */
1112
1162
  Models?: Models;
1113
1163
  }
1164
+ export interface ListMedicalScribeJobsRequest {
1165
+ /**
1166
+ * Returns only Medical Scribe jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status, all Medical Scribe jobs are returned.
1167
+ */
1168
+ Status?: MedicalScribeJobStatus;
1169
+ /**
1170
+ * Returns only the Medical Scribe jobs that contain the specified string. The search is not case sensitive.
1171
+ */
1172
+ JobNameContains?: TranscriptionJobName;
1173
+ /**
1174
+ * If your ListMedicalScribeJobs request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.
1175
+ */
1176
+ NextToken?: NextToken;
1177
+ /**
1178
+ * The maximum number of Medical Scribe jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.
1179
+ */
1180
+ MaxResults?: MaxResults;
1181
+ }
1182
+ export interface ListMedicalScribeJobsResponse {
1183
+ /**
1184
+ * Lists all Medical Scribe jobs that have the status specified in your request. Jobs are ordered by creation date, with the newest job first.
1185
+ */
1186
+ Status?: MedicalScribeJobStatus;
1187
+ /**
1188
+ * If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.
1189
+ */
1190
+ NextToken?: NextToken;
1191
+ /**
1192
+ * Provides a summary of information about each result.
1193
+ */
1194
+ MedicalScribeJobSummaries?: MedicalScribeJobSummaries;
1195
+ }
1114
1196
  export interface ListMedicalTranscriptionJobsRequest {
1115
1197
  /**
1116
- * Returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all medical transcription jobs are returned.
1198
+ * Returns only medical transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status, all medical transcription jobs are returned.
1117
1199
  */
1118
1200
  Status?: TranscriptionJobStatus;
1119
1201
  /**
@@ -1125,7 +1207,7 @@ declare namespace TranscribeService {
1125
1207
  */
1126
1208
  NextToken?: NextToken;
1127
1209
  /**
1128
- * The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
1210
+ * The maximum number of medical transcription jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.
1129
1211
  */
1130
1212
  MaxResults?: MaxResults;
1131
1213
  }
@@ -1149,11 +1231,11 @@ declare namespace TranscribeService {
1149
1231
  */
1150
1232
  NextToken?: NextToken;
1151
1233
  /**
1152
- * The maximum number of custom medical vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
1234
+ * The maximum number of custom medical vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.
1153
1235
  */
1154
1236
  MaxResults?: MaxResults;
1155
1237
  /**
1156
- * Returns only custom medical vocabularies with the specified state. Custom vocabularies are ordered by creation date, with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are returned.
1238
+ * Returns only custom medical vocabularies with the specified state. Custom vocabularies are ordered by creation date, with the newest vocabulary first. If you do not include StateEquals, all custom medical vocabularies are returned.
1157
1239
  */
1158
1240
  StateEquals?: VocabularyState;
1159
1241
  /**
@@ -1193,7 +1275,7 @@ declare namespace TranscribeService {
1193
1275
  }
1194
1276
  export interface ListTranscriptionJobsRequest {
1195
1277
  /**
1196
- * Returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you don't include Status, all transcription jobs are returned.
1278
+ * Returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest job first. If you do not include Status, all transcription jobs are returned.
1197
1279
  */
1198
1280
  Status?: TranscriptionJobStatus;
1199
1281
  /**
@@ -1205,7 +1287,7 @@ declare namespace TranscribeService {
1205
1287
  */
1206
1288
  NextToken?: NextToken;
1207
1289
  /**
1208
- * The maximum number of transcription jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
1290
+ * The maximum number of transcription jobs to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.
1209
1291
  */
1210
1292
  MaxResults?: MaxResults;
1211
1293
  }
@@ -1229,11 +1311,11 @@ declare namespace TranscribeService {
1229
1311
  */
1230
1312
  NextToken?: NextToken;
1231
1313
  /**
1232
- * The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
1314
+ * The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.
1233
1315
  */
1234
1316
  MaxResults?: MaxResults;
1235
1317
  /**
1236
- * Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you don't include StateEquals, all custom medical vocabularies are returned.
1318
+ * Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you do not include StateEquals, all custom medical vocabularies are returned.
1237
1319
  */
1238
1320
  StateEquals?: VocabularyState;
1239
1321
  /**
@@ -1261,7 +1343,7 @@ declare namespace TranscribeService {
1261
1343
  */
1262
1344
  NextToken?: NextToken;
1263
1345
  /**
1264
- * The maximum number of custom vocabulary filters to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don't specify a value, a default of 5 is used.
1346
+ * The maximum number of custom vocabulary filters to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you do not specify a value, a default of 5 is used.
1265
1347
  */
1266
1348
  MaxResults?: MaxResults;
1267
1349
  /**
@@ -1296,6 +1378,139 @@ declare namespace TranscribeService {
1296
1378
  export type MediaSampleRateHertz = number;
1297
1379
  export type MedicalContentIdentificationType = "PHI"|string;
1298
1380
  export type MedicalMediaSampleRateHertz = number;
1381
+ export interface MedicalScribeChannelDefinition {
1382
+ /**
1383
+ * Specify the audio channel you want to define.
1384
+ */
1385
+ ChannelId: MedicalScribeChannelId;
1386
+ /**
1387
+ * Specify the participant that you want to flag. The options are CLINICIAN and PATIENT
1388
+ */
1389
+ ParticipantRole: MedicalScribeParticipantRole;
1390
+ }
1391
+ export type MedicalScribeChannelDefinitions = MedicalScribeChannelDefinition[];
1392
+ export type MedicalScribeChannelId = number;
1393
+ export interface MedicalScribeJob {
1394
+ /**
1395
+ * The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.
1396
+ */
1397
+ MedicalScribeJobName?: TranscriptionJobName;
1398
+ /**
1399
+ * Provides the status of the specified Medical Scribe job. If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.
1400
+ */
1401
+ MedicalScribeJobStatus?: MedicalScribeJobStatus;
1402
+ /**
1403
+ * The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.
1404
+ */
1405
+ LanguageCode?: MedicalScribeLanguageCode;
1406
+ Media?: Media;
1407
+ /**
1408
+ * The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.
1409
+ */
1410
+ MedicalScribeOutput?: MedicalScribeOutput;
1411
+ /**
1412
+ * The date and time your Medical Scribe job began processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
1413
+ */
1414
+ StartTime?: DateTime;
1415
+ /**
1416
+ * The date and time the specified Medical Scribe job request was made. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
1417
+ */
1418
+ CreationTime?: DateTime;
1419
+ /**
1420
+ * The date and time the specified Medical Scribe job finished processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.
1421
+ */
1422
+ CompletionTime?: DateTime;
1423
+ /**
1424
+ * If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
1425
+ */
1426
+ FailureReason?: FailureReason;
1427
+ /**
1428
+ * Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.
1429
+ */
1430
+ Settings?: MedicalScribeSettings;
1431
+ /**
1432
+ * The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.
1433
+ */
1434
+ DataAccessRoleArn?: DataAccessRoleArn;
1435
+ /**
1436
+ * Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).
1437
+ */
1438
+ ChannelDefinitions?: MedicalScribeChannelDefinitions;
1439
+ /**
1440
+ * Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
1441
+ */
1442
+ Tags?: TagList;
1443
+ }
1444
+ export type MedicalScribeJobStatus = "QUEUED"|"IN_PROGRESS"|"FAILED"|"COMPLETED"|string;
1445
+ export type MedicalScribeJobSummaries = MedicalScribeJobSummary[];
1446
+ export interface MedicalScribeJobSummary {
1447
+ /**
1448
+ * The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.
1449
+ */
1450
+ MedicalScribeJobName?: TranscriptionJobName;
1451
+ /**
1452
+ * The date and time the specified Medical Scribe job request was made. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
1453
+ */
1454
+ CreationTime?: DateTime;
1455
+ /**
1456
+ * The date and time your Medical Scribe job began processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.
1457
+ */
1458
+ StartTime?: DateTime;
1459
+ /**
1460
+ * The date and time the specified Medical Scribe job finished processing. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.
1461
+ */
1462
+ CompletionTime?: DateTime;
1463
+ /**
1464
+ * The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.
1465
+ */
1466
+ LanguageCode?: MedicalScribeLanguageCode;
1467
+ /**
1468
+ * Provides the status of the specified Medical Scribe job. If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.
1469
+ */
1470
+ MedicalScribeJobStatus?: MedicalScribeJobStatus;
1471
+ /**
1472
+ * If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.
1473
+ */
1474
+ FailureReason?: FailureReason;
1475
+ }
1476
+ export type MedicalScribeLanguageCode = "en-US"|string;
1477
+ export interface MedicalScribeOutput {
1478
+ /**
1479
+ * Holds the Amazon S3 URI for the Transcript.
1480
+ */
1481
+ TranscriptFileUri: Uri;
1482
+ /**
1483
+ * Holds the Amazon S3 URI for the Clinical Document.
1484
+ */
1485
+ ClinicalDocumentUri: Uri;
1486
+ }
1487
+ export type MedicalScribeParticipantRole = "PATIENT"|"CLINICIAN"|string;
1488
+ export interface MedicalScribeSettings {
1489
+ /**
1490
+ * Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file. If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels. For more information, see Partitioning speakers (diarization).
1491
+ */
1492
+ ShowSpeakerLabels?: Boolean;
1493
+ /**
1494
+ * Specify the maximum number of speakers you want to partition in your media. Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.
1495
+ */
1496
+ MaxSpeakerLabels?: MaxSpeakers;
1497
+ /**
1498
+ * Enables channel identification in multi-channel audio. Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript. For more information, see Transcribing multi-channel audio.
1499
+ */
1500
+ ChannelIdentification?: Boolean;
1501
+ /**
1502
+ * The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.
1503
+ */
1504
+ VocabularyName?: VocabularyName;
1505
+ /**
1506
+ * The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive. Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.
1507
+ */
1508
+ VocabularyFilterName?: VocabularyFilterName;
1509
+ /**
1510
+ * Specify how you want your custom vocabulary filter applied to your transcript. To replace words with ***, choose mask. To delete words, choose remove. To flag words without changing them, choose tag.
1511
+ */
1512
+ VocabularyFilterMethod?: VocabularyFilterMethod;
1513
+ }
1299
1514
  export interface MedicalTranscript {
1300
1515
  /**
1301
1516
  * The Amazon S3 location of your transcript. You can use this URI to access or download your transcript. Note that this is the Amazon S3 location you specified in your request using the OutputBucketName parameter.
@@ -1341,7 +1556,7 @@ declare namespace TranscribeService {
1341
1556
  */
1342
1557
  CompletionTime?: DateTime;
1343
1558
  /**
1344
- * If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed. The FailureReason field contains one of the following values: Unsupported media format. The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats. The media format provided does not match the detected media format. The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value. Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and 48,000 hertz. The sample rate provided does not match the detected sample rate. The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value. Invalid file size: file size too large. The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas. Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
1559
+ * If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed. The FailureReason field contains one of the following values: Unsupported media format. The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats. The media format provided does not match the detected media format. The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value. Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 16,000 and 48,000 hertz. The sample rate provided does not match the detected sample rate. The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value. Invalid file size: file size too large. The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas. Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.
1345
1560
  */
1346
1561
  FailureReason?: FailureReason;
1347
1562
  /**
@@ -1414,7 +1629,7 @@ declare namespace TranscribeService {
1414
1629
  }
1415
1630
  export interface MedicalTranscriptionSetting {
1416
1631
  /**
1417
- * Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file. If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels. You can't include ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException. For more information, see Partitioning speakers (diarization).
1632
+ * Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file. If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels. For more information, see Partitioning speakers (diarization).
1418
1633
  */
1419
1634
  ShowSpeakerLabels?: Boolean;
1420
1635
  /**
@@ -1422,7 +1637,7 @@ declare namespace TranscribeService {
1422
1637
  */
1423
1638
  MaxSpeakerLabels?: MaxSpeakers;
1424
1639
  /**
1425
- * Enables channel identification in multi-channel audio. Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript. If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel. You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException. For more information, see Transcribing multi-channel audio.
1640
+ * Enables channel identification in multi-channel audio. Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript. If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel. For more information, see Transcribing multi-channel audio.
1426
1641
  */
1427
1642
  ChannelIdentification?: Boolean;
1428
1643
  /**
@@ -1434,14 +1649,14 @@ declare namespace TranscribeService {
1434
1649
  */
1435
1650
  MaxAlternatives?: MaxAlternatives;
1436
1651
  /**
1437
- * The name of the custom vocabulary you want to use when processing your medical transcription job. Custom vocabulary names are case sensitive. The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages don't match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.
1652
+ * The name of the custom vocabulary you want to use when processing your medical transcription job. Custom vocabulary names are case sensitive. The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary isn't applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.
1438
1653
  */
1439
1654
  VocabularyName?: VocabularyName;
1440
1655
  }
1441
1656
  export type ModelName = string;
1442
1657
  export interface ModelSettings {
1443
1658
  /**
1444
- * The name of the custom language model you want to use when processing your transcription job. Note that custom language model names are case sensitive. The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
1659
+ * The name of the custom language model you want to use when processing your transcription job. Note that custom language model names are case sensitive. The language of the specified custom language model must match the language code that you specify in your transcription request. If the languages do not match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.
1445
1660
  */
1446
1661
  LanguageModelName?: ModelName;
1447
1662
  }
@@ -1545,7 +1760,7 @@ declare namespace TranscribeService {
1545
1760
  */
1546
1761
  VocabularyName?: VocabularyName;
1547
1762
  /**
1548
- * Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file. If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels. You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException. For more information, see Partitioning speakers (diarization).
1763
+ * Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file. If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels. For more information, see Partitioning speakers (diarization).
1549
1764
  */
1550
1765
  ShowSpeakerLabels?: Boolean;
1551
1766
  /**
@@ -1553,7 +1768,7 @@ declare namespace TranscribeService {
1553
1768
  */
1554
1769
  MaxSpeakerLabels?: MaxSpeakers;
1555
1770
  /**
1556
- * Enables channel identification in multi-channel audio. Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript. You can't include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException. For more information, see Transcribing multi-channel audio.
1771
+ * Enables channel identification in multi-channel audio. Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript. For more information, see Transcribing multi-channel audio.
1557
1772
  */
1558
1773
  ChannelIdentification?: Boolean;
1559
1774
  /**
@@ -1584,11 +1799,11 @@ declare namespace TranscribeService {
1584
1799
  */
1585
1800
  Media: Media;
1586
1801
  /**
1587
- * The Amazon S3 location where you want your Call Analytics transcription output stored. You can use any of the following formats to specify the output location: s3://DOC-EXAMPLE-BUCKET s3://DOC-EXAMPLE-BUCKET/my-output-folder/ s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json Unless you specify a file name (option 3), the name of your output file has a default value that matches the name you specified for your transcription job using the CallAnalyticsJobName parameter. You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption. If you don't specify OutputLocation, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.
1802
+ * The Amazon S3 location where you want your Call Analytics transcription output stored. You can use any of the following formats to specify the output location: s3://DOC-EXAMPLE-BUCKET s3://DOC-EXAMPLE-BUCKET/my-output-folder/ s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json Unless you specify a file name (option 3), the name of your output file has a default value that matches the name you specified for your transcription job using the CallAnalyticsJobName parameter. You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId parameter. If you do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption. If you do not specify OutputLocation, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.
1588
1803
  */
1589
1804
  OutputLocation?: Uri;
1590
1805
  /**
1591
- * The KMS key you want to use to encrypt your Call Analytics output. If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways: Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Use an alias for the KMS key ID. For example, alias/ExampleAlias. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways: Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If you don't specify an encryption key, your output 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 using the OutputLocation parameter. Note that the role making the request must have permission to use the specified KMS key.
1806
+ * The KMS key you want to use to encrypt your Call Analytics output. If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways: Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Use an alias for the KMS key ID. For example, alias/ExampleAlias. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways: Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If you do not specify an encryption key, your output 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 using the OutputLocation parameter. Note that the role making the request must have permission to use the specified KMS key.
1592
1807
  */
1593
1808
  OutputEncryptionKMSKeyId?: KMSKeyId;
1594
1809
  /**
@@ -1610,6 +1825,47 @@ declare namespace TranscribeService {
1610
1825
  */
1611
1826
  CallAnalyticsJob?: CallAnalyticsJob;
1612
1827
  }
1828
+ export interface StartMedicalScribeJobRequest {
1829
+ /**
1830
+ * A unique name, chosen by you, for your Medical Scribe job. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.
1831
+ */
1832
+ MedicalScribeJobName: TranscriptionJobName;
1833
+ Media: Media;
1834
+ /**
1835
+ * The name of the Amazon S3 bucket where you want your Medical Scribe output stored. Do not include the S3:// prefix of the specified bucket. Note that the role specified in the DataAccessRoleArn request parameter must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles.
1836
+ */
1837
+ OutputBucketName: OutputBucketName;
1838
+ /**
1839
+ * The KMS key you want to use to encrypt your Medical Scribe output. If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways: Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Use an alias for the KMS key ID. For example, alias/ExampleAlias. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways: Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3). Note that the role specified in the DataAccessRoleArn request parameter must have permission to use the specified KMS key.
1840
+ */
1841
+ OutputEncryptionKMSKeyId?: KMSKeyId;
1842
+ /**
1843
+ * A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data. For more information, see KMS encryption context and Asymmetric keys in KMS.
1844
+ */
1845
+ KMSEncryptionContext?: KMSEncryptionContextMap;
1846
+ /**
1847
+ * The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails. IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin. For more information, see IAM ARNs.
1848
+ */
1849
+ DataAccessRoleArn: DataAccessRoleArn;
1850
+ /**
1851
+ * Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.
1852
+ */
1853
+ Settings: MedicalScribeSettings;
1854
+ /**
1855
+ * Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).
1856
+ */
1857
+ ChannelDefinitions?: MedicalScribeChannelDefinitions;
1858
+ /**
1859
+ * Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
1860
+ */
1861
+ Tags?: TagList;
1862
+ }
1863
+ export interface StartMedicalScribeJobResponse {
1864
+ /**
1865
+ * Provides detailed information about the current Medical Scribe job, including job status and, if applicable, failure reason.
1866
+ */
1867
+ MedicalScribeJob?: MedicalScribeJob;
1868
+ }
1613
1869
  export interface StartMedicalTranscriptionJobRequest {
1614
1870
  /**
1615
1871
  * A unique name, chosen by you, for your medical transcription job. The name that you specify is also used as the default name of your transcription output file. If you want to specify a different name for your transcription output, use the OutputKey parameter. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.
@@ -1620,7 +1876,7 @@ declare namespace TranscribeService {
1620
1876
  */
1621
1877
  LanguageCode: LanguageCode;
1622
1878
  /**
1623
- * The sample rate, in hertz, of the audio track in your input media file. If you don't specify the media sample rate, Amazon Transcribe Medical determines it 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 value detected, your job fails. Therefore, in most cases, it's advised to omit MediaSampleRateHertz and let Amazon Transcribe Medical determine the sample rate.
1879
+ * The sample rate, in hertz, of the audio track in your input media file. If you do not specify the media sample rate, Amazon Transcribe Medical determines it 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 value detected, your job fails. Therefore, in most cases, it's advised to omit MediaSampleRateHertz and let Amazon Transcribe Medical determine the sample rate.
1624
1880
  */
1625
1881
  MediaSampleRateHertz?: MedicalMediaSampleRateHertz;
1626
1882
  /**
@@ -1637,7 +1893,7 @@ declare namespace TranscribeService {
1637
1893
  */
1638
1894
  OutputKey?: OutputKey;
1639
1895
  /**
1640
- * The KMS key you want to use to encrypt your medical transcription output. If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways: Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Use an alias for the KMS key ID. For example, alias/ExampleAlias. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways: Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If you don't specify an encryption key, your output 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 using the OutputLocation parameter. Note that the role making the request must have permission to use the specified KMS key.
1896
+ * The KMS key you want to use to encrypt your medical transcription output. If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways: Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Use an alias for the KMS key ID. For example, alias/ExampleAlias. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways: Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If you do not specify an encryption key, your output 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 using the OutputLocation parameter. Note that the role making the request must have permission to use the specified KMS key.
1641
1897
  */
1642
1898
  OutputEncryptionKMSKeyId?: KMSKeyId;
1643
1899
  /**
@@ -1681,7 +1937,7 @@ declare namespace TranscribeService {
1681
1937
  */
1682
1938
  LanguageCode?: LanguageCode;
1683
1939
  /**
1684
- * The sample rate, in hertz, of the audio track in your input media file. If you don't specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe. If there's a mismatch between the value that you specify and the value detected, your job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.
1940
+ * The sample rate, in hertz, of the audio track in your input media file. If you do not specify the media sample rate, Amazon Transcribe determines it for you. If you specify the sample rate, it must match the rate detected by Amazon Transcribe. If there's a mismatch between the value that you specify and the value detected, your job fails. In most cases, you can omit MediaSampleRateHertz and let Amazon Transcribe determine the sample rate.
1685
1941
  */
1686
1942
  MediaSampleRateHertz?: MediaSampleRateHertz;
1687
1943
  /**
@@ -1693,7 +1949,7 @@ declare namespace TranscribeService {
1693
1949
  */
1694
1950
  Media: Media;
1695
1951
  /**
1696
- * The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the S3:// prefix of the specified bucket. If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket. For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/. Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles. If you don't specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.
1952
+ * The name of the Amazon S3 bucket where you want your transcription output stored. Do not include the S3:// prefix of the specified bucket. If you want your output to go to a sub-folder of this bucket, specify it using the OutputKey parameter; OutputBucketName only accepts the name of a bucket. For example, if you want your output stored in S3://DOC-EXAMPLE-BUCKET, set OutputBucketName to DOC-EXAMPLE-BUCKET. However, if you want your output stored in S3://DOC-EXAMPLE-BUCKET/test-files/, set OutputBucketName to DOC-EXAMPLE-BUCKET and OutputKey to test-files/. Note that Amazon Transcribe must have permission to use the specified location. You can change Amazon S3 permissions using the Amazon Web Services Management Console. See also Permissions Required for IAM User Roles. If you do not specify OutputBucketName, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.
1697
1953
  */
1698
1954
  OutputBucketName?: OutputBucketName;
1699
1955
  /**
@@ -1701,7 +1957,7 @@ declare namespace TranscribeService {
1701
1957
  */
1702
1958
  OutputKey?: OutputKey;
1703
1959
  /**
1704
- * The KMS key you want to use to encrypt your transcription output. If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways: Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Use an alias for the KMS key ID. For example, alias/ExampleAlias. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways: Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If you don't specify an encryption key, your output 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 using the OutputLocation parameter. Note that the role making the request must have permission to use the specified KMS key.
1960
+ * The KMS key you want to use to encrypt your transcription output. If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways: Use the KMS key ID itself. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. Use an alias for the KMS key ID. For example, alias/ExampleAlias. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways: Use the ARN for the KMS key ID. For example, arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab. Use the ARN for the KMS key alias. For example, arn:aws:kms:region:account-ID:alias/ExampleAlias. If you do not specify an encryption key, your output 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 using the OutputLocation parameter. Note that the role making the request must have permission to use the specified KMS key.
1705
1961
  */
1706
1962
  OutputEncryptionKMSKeyId?: KMSKeyId;
1707
1963
  /**
@@ -1721,7 +1977,7 @@ declare namespace TranscribeService {
1721
1977
  */
1722
1978
  JobExecutionSettings?: JobExecutionSettings;
1723
1979
  /**
1724
- * Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: PiiEntityTypes, RedactionOutput, and RedactionType.
1980
+ * Makes it possible to redact or flag specified personally identifiable information (PII) in your transcript. If you use ContentRedaction, you must also include the sub-parameters: RedactionOutput and RedactionType. You can optionally include PiiEntityTypes to choose which types of PII you want to redact. If you do not include PiiEntityTypes in your request, all PII is redacted.
1725
1981
  */
1726
1982
  ContentRedaction?: ContentRedaction;
1727
1983
  /**
@@ -1910,7 +2166,7 @@ declare namespace TranscribeService {
1910
2166
  */
1911
2167
  CompletionTime?: DateTime;
1912
2168
  /**
1913
- * If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed. The FailureReason field contains one of the following values: Unsupported media format. The media format specified in MediaFormat isn't valid. Refer to MediaFormat for a list of supported formats. The media format provided does not match the detected media format. The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value. Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz. The sample rate provided does not match the detected sample rate. The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value. Invalid file size: file size too large. The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Guidelines and quotas. Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Guidelines and quotas.
2169
+ * If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed. The FailureReason field contains one of the following values: Unsupported media format. The media format specified in MediaFormat isn't valid. Refer to refer to the MediaFormat parameter for a list of supported formats. The media format provided does not match the detected media format. The media format specified in MediaFormat doesn't match the format of the input file. Check the media format of your media file and correct the specified value. Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz isn't valid. The sample rate must be between 8,000 and 48,000 hertz. The sample rate provided does not match the detected sample rate. The sample rate specified in MediaSampleRateHertz doesn't match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value. Invalid file size: file size too large. The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas. Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.
1914
2170
  */
1915
2171
  FailureReason?: FailureReason;
1916
2172
  /**