Struct aws_sdk_transcribe::model::MedicalTranscriptionJob

#[non_exhaustive]
pub struct MedicalTranscriptionJob {

    pub medical_transcription_job_name: Option<String>,
    pub transcription_job_status: Option<TranscriptionJobStatus>,
    pub language_code: Option<LanguageCode>,
    pub media_sample_rate_hertz: Option<i32>,
    pub media_format: Option<MediaFormat>,
    pub media: Option<Media>,
    pub transcript: Option<MedicalTranscript>,
    pub start_time: Option<DateTime>,
    pub creation_time: Option<DateTime>,
    pub completion_time: Option<DateTime>,
    pub failure_reason: Option<String>,
    pub settings: Option<MedicalTranscriptionSetting>,
    pub content_identification_type: Option<MedicalContentIdentificationType>,
    pub specialty: Option<Specialty>,
    pub type: Option<Type>,
    pub tags: Option<Vec<Tag>>,
}

The data structure that contains the information for a medical transcription job.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

medical_transcription_job_name: Option<String>

The name for a given medical transcription job.

transcription_job_status: Option<TranscriptionJobStatus>

The completion status of a medical transcription job.

language_code: Option<LanguageCode>

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.

media_sample_rate_hertz: Option<i32>

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.

media_format: Option<MediaFormat>

The format of the input media file.

media: Option<Media>

Describes the input media file in a transcription request.

transcript: Option<MedicalTranscript>

An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

start_time: Option<DateTime>

A timestamp that shows when the job started processing.

creation_time: Option<DateTime>

A timestamp that shows when the job was created.

completion_time: Option<DateTime>

A timestamp that shows when the job was completed.

failure_reason: Option<String>

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 in the Amazon Transcribe Medical Guide

• Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference

settings: Option<MedicalTranscriptionSetting>

Object that contains object.

content_identification_type: Option<MedicalContentIdentificationType>

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.

specialty: Option<Specialty>

The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.

type: Option<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?.

tags: Option<Vec<Tag>>

A key:value pair assigned to a given medical transcription job.

Implementations

impl MedicalTranscriptionJob

pub fn medical_transcription_job_name(&self) -> Option<&str>

The name for a given medical transcription job.

pub fn transcription_job_status(&self) -> Option<&TranscriptionJobStatus>

The completion status of a medical transcription job.

pub fn language_code(&self) -> Option<&LanguageCode>

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.

pub fn media_sample_rate_hertz(&self) -> Option<i32>

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.

pub fn media_format(&self) -> Option<&MediaFormat>

The format of the input media file.

pub fn media(&self) -> Option<&Media>

Describes the input media file in a transcription request.

pub fn transcript(&self) -> Option<&MedicalTranscript>

An object that contains the MedicalTranscript. The MedicalTranscript contains the TranscriptFileUri.

pub fn start_time(&self) -> Option<&DateTime>

A timestamp that shows when the job started processing.

pub fn creation_time(&self) -> Option<&DateTime>

A timestamp that shows when the job was created.

pub fn completion_time(&self) -> Option<&DateTime>

A timestamp that shows when the job was completed.

pub fn failure_reason(&self) -> Option<&str>

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 in the Amazon Transcribe Medical Guide

• Invalid number of channels: number of channels too large- Your audio contains more channels than Amazon Transcribe Medical is configured to process. To request additional channels, see Amazon Transcribe Medical Endpoints and Quotas in the Amazon Web Services General Reference

pub fn settings(&self) -> Option<&MedicalTranscriptionSetting>

Object that contains object.

pub fn content_identification_type(
    &self
) -> Option<&MedicalContentIdentificationType>

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.

pub fn specialty(&self) -> Option<&Specialty>

The medical specialty of any clinicians providing a dictation or having a conversation. Refer to Transcribing a medical conversationfor a list of supported specialties.

pub fn type(&self) -> Option<&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?.

pub fn tags(&self) -> Option<&[Tag]>

A key:value pair assigned to a given medical transcription job.

impl MedicalTranscriptionJob

pub fn builder() -> Builder

Creates a new builder-style object to manufacture MedicalTranscriptionJob

Trait Implementations

impl Clone for MedicalTranscriptionJob

fn clone(&self) -> MedicalTranscriptionJob

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MedicalTranscriptionJob

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<MedicalTranscriptionJob> for MedicalTranscriptionJob

fn eq(&self, other: &MedicalTranscriptionJob) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MedicalTranscriptionJob) -> bool

This method tests for !=.

impl StructuralPartialEq for MedicalTranscriptionJob