class Aws::TranscribeService::Types::MedicalTranscriptionJob
The data structure that contains the information for a medical transcription job.
@!attribute [rw] medical_transcription_job_name
The name for a given medical transcription job. @return [String]
@!attribute [rw] transcription_job_status
The completion status of a medical transcription job. @return [String]
@!attribute [rw] language_code
The language code for the language spoken in the source audio file. US English (en-US) is the only supported language for medical transcriptions. Any other value you enter for language code results in a `BadRequestException` error. @return [String]
@!attribute [rw] media_sample_rate_hertz
The sample rate, in Hertz, of the source audio containing medical information. If you don't specify the sample rate, Amazon Transcribe Medical determines it for you. If you choose to specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the `MedicalMediaSampleHertz` blank and let Amazon Transcribe Medical determine the sample rate. @return [Integer]
@!attribute [rw] media_format
The format of the input media file. @return [String]
@!attribute [rw] media
Describes the input media file in a transcription request. @return [Types::Media]
@!attribute [rw] transcript
An object that contains the `MedicalTranscript`. The `MedicalTranscript` contains the `TranscriptFileUri`. @return [Types::MedicalTranscript]
@!attribute [rw] start_time
A timestamp that shows when the job started processing. @return [Time]
@!attribute [rw] creation_time
A timestamp that shows when the job was created. @return [Time]
@!attribute [rw] completion_time
A timestamp that shows when the job was completed. @return [Time]
@!attribute [rw] failure_reason
If the `TranscriptionJobStatus` field is `FAILED`, this field contains information about why the job failed. The `FailureReason` field contains one of the following values: * `Unsupported media format`- The media format specified in the `MediaFormat` field of the request isn't valid. See the description of the `MediaFormat` field for a list of valid values. * `The media format provided does not match the detected media format`- The media format of the audio file doesn't match the format specified in the `MediaFormat` field in the request. Check the media format of your media file and make sure the two values match. * `Invalid sample rate for audio file`- The sample rate specified in the `MediaSampleRateHertz` of the request isn't valid. The sample rate must be between 8,000 and 48,000 Hertz. * `The sample rate provided does not match the detected sample rate`- The sample rate in the audio file doesn't match the sample rate specified in the `MediaSampleRateHertz` field in the request. Check the sample rate of your media file and make sure that the two values match. * `Invalid file size: file size too large`- The size of your audio file is larger than what Amazon Transcribe Medical can process. For more information, see [Guidelines and Quotas][1] in the *Amazon Transcribe Medical Guide* * `Invalid number of channels: number of channels too large`- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see [Amazon Transcribe Medical Endpoints and Quotas][2] in the *Amazon Web Services General Reference* [1]: https://docs.aws.amazon.com/transcribe/latest/dg/limits-guidelines.html#limits [2]: https://docs.aws.amazon.com/general/latest/gr/transcribe-medical.html @return [String]
@!attribute [rw] settings
Object that contains object. @return [Types::MedicalTranscriptionSetting]
@!attribute [rw] content_identification_type
Shows the type of content that you've configured Amazon Transcribe Medical to identify in a transcription job. If the value is `PHI`, you've configured the job to identify personal health information (PHI) in the transcription output. @return [String]
@!attribute [rw] specialty
The medical specialty of any clinicians providing a dictation or having a conversation. Refer to [Transcribing a medical conversation][1]for a list of supported specialties. [1]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-medical-conversation.html @return [String]
@!attribute [rw] type
The type of speech in the transcription job. `CONVERSATION` is generally used for patient-physician dialogues. `DICTATION` is the setting for physicians speaking their notes after seeing a patient. For more information, see [What is Amazon Transcribe Medical?][1]. [1]: https://docs.aws.amazon.com/transcribe/latest/dg/what-is-transcribe-med.html @return [String]
@!attribute [rw] tags
A key:value pair assigned to a given medical transcription job. @return [Array<Types::Tag>]
@see docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscriptionJob AWS API Documentation
Constants
- SENSITIVE