Struct aws_sdk_transcribe::types::MedicalTranscriptionJob

source · 
#[non_exhaustive]
pub struct MedicalTranscriptionJob {
Show 16 fields
    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>>,

}
Expand description

Provides detailed information about a 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 and 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.

Fields (Non-exhaustive)§

This struct is marked as 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 of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

§transcription_job_status: Option<TranscriptionJobStatus>

Provides the status of the specified medical transcription job.

If the status is COMPLETED, the job is finished and 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.

§language_code: Option<LanguageCode>

The language code used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions.

§media_sample_rate_hertz: Option<i32>

The sample rate, in hertz, of the audio track in your input media file.

§media_format: Option<MediaFormat>

The format of the input media file.

§media: Option<Media>

Describes the Amazon S3 location of the media file you want to use in your request.

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.

§transcript: Option<MedicalTranscript>

Provides you with the Amazon S3 URI you can use to access your transcript.

§start_time: Option<DateTime>

The date and time the specified medical transcription 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 transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

§creation_time: Option<DateTime>

The date and time the specified medical transcription 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 transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

§completion_time: Option<DateTime>

The date and time the specified medical transcription job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

§failure_reason: Option<String>

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.

§settings: Option<MedicalTranscriptionSetting>

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

§content_identification_type: Option<MedicalContentIdentificationType>

Indicates whether content identification was enabled for your transcription request.

§specialty: Option<Specialty>

Describes the medical specialty represented in your media.

§type: Option<Type>

Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

§tags: Option<Vec<Tag>>

The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

Implementations§

source§

impl MedicalTranscriptionJob

source

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

The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

source

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

Provides the status of the specified medical transcription job.

If the status is COMPLETED, the job is finished and 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.

source

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

The language code used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions.

source

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

The sample rate, in hertz, of the audio track in your input media file.

source

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

The format of the input media file.

source

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

Describes the Amazon S3 location of the media file you want to use in your request.

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.

source

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

Provides you with the Amazon S3 URI you can use to access your transcript.

source

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

The date and time the specified medical transcription 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 transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

source

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

The date and time the specified medical transcription 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 transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

source

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

The date and time the specified medical transcription job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

source

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

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.

source

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

Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

source

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

Indicates whether content identification was enabled for your transcription request.

source

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

Describes the medical specialty represented in your media.

source

pub fn type(&self) -> Option<&Type>

Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.

source

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

The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

source§

impl MedicalTranscriptionJob

source

pub fn builder() -> MedicalTranscriptionJobBuilder

Creates a new builder-style object to manufacture MedicalTranscriptionJob.

Trait Implementations§

source§

impl Clone for MedicalTranscriptionJob

source§

fn clone(&self) -> MedicalTranscriptionJob

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for MedicalTranscriptionJob

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for MedicalTranscriptionJob

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for MedicalTranscriptionJob

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more