Struct aws_sdk_transcribe::model::TranscriptionJob

#[non_exhaustive]
pub struct TranscriptionJob {

    pub 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<Transcript>,
    pub start_time: Option<DateTime>,
    pub creation_time: Option<DateTime>,
    pub completion_time: Option<DateTime>,
    pub failure_reason: Option<String>,
    pub settings: Option<Settings>,
    pub model_settings: Option<ModelSettings>,
    pub job_execution_settings: Option<JobExecutionSettings>,
    pub content_redaction: Option<ContentRedaction>,
    pub identify_language: Option<bool>,
    pub language_options: Option<Vec<LanguageCode>>,
    pub identified_language_score: Option<f32>,
    pub tags: Option<Vec<Tag>>,
    pub subtitles: Option<SubtitlesOutput>,
    pub language_id_settings: Option<HashMap<LanguageCode, LanguageIdSettings>>,
}

Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.

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.

transcription_job_name: Option<String>

The name of the transcription job.

transcription_job_status: Option<TranscriptionJobStatus>

The status of the transcription job.

language_code: Option<LanguageCode>

The language code for the input speech.

media_sample_rate_hertz: Option<i32>

The sample rate, in Hertz (Hz), of the audio track in the input media file.

media_format: Option<MediaFormat>

The format of the input media file.

media: Option<Media>

An object that describes the input media for the transcription job.

transcript: Option<Transcript>

An object that describes the output of the transcription job.

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 completed.

failure_reason: Option<String>

If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

The FailureReason field can contain 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 that 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 Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.

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

settings: Option<Settings>

Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.

model_settings: Option<ModelSettings>

An object containing the details of your custom language model.

job_execution_settings: Option<JobExecutionSettings>

Provides information about how a transcription job is executed.

content_redaction: Option<ContentRedaction>

An object that describes content redaction settings for the transcription job.

identify_language: Option<bool>

A value that shows if automatic language identification was enabled for a transcription job.

language_options: Option<Vec<LanguageCode>>

An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.

identified_language_score: Option<f32>

A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.

tags: Option<Vec<Tag>>

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

subtitles: Option<SubtitlesOutput>

Generate subtitles for your batch transcription job.

language_id_settings: Option<HashMap<LanguageCode, LanguageIdSettings>>

Language-specific settings that can be specified when language identification is enabled for your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Implementations

impl TranscriptionJob

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

The name of the transcription job.

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

The status of the transcription job.

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

The language code for the input speech.

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

The sample rate, in Hertz (Hz), of the audio track in the input media file.

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

The format of the input media file.

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

An object that describes the input media for the transcription job.

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

An object that describes the output of the transcription job.

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 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 can contain 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 that 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 Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.

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

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

Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.

pub fn model_settings(&self) -> Option<&ModelSettings>

An object containing the details of your custom language model.

pub fn job_execution_settings(&self) -> Option<&JobExecutionSettings>

Provides information about how a transcription job is executed.

pub fn content_redaction(&self) -> Option<&ContentRedaction>

An object that describes content redaction settings for the transcription job.

pub fn identify_language(&self) -> Option<bool>

A value that shows if automatic language identification was enabled for a transcription job.

pub fn language_options(&self) -> Option<&[LanguageCode]>

An object that shows the optional array of languages inputted for transcription jobs with automatic language identification enabled.

pub fn identified_language_score(&self) -> Option<f32>

A value between zero and one that Amazon Transcribe assigned to the language that it identified in the source audio. Larger values indicate that Amazon Transcribe has higher confidence in the language it identified.

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

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

pub fn subtitles(&self) -> Option<&SubtitlesOutput>

Generate subtitles for your batch transcription job.

pub fn language_id_settings(
    &self
) -> Option<&HashMap<LanguageCode, LanguageIdSettings>>

Language-specific settings that can be specified when language identification is enabled for your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

impl TranscriptionJob

pub fn builder() -> Builder

Creates a new builder-style object to manufacture TranscriptionJob

Trait Implementations

impl Clone for TranscriptionJob

fn clone(&self) -> TranscriptionJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TranscriptionJob

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

Formats the value using the given formatter.

impl PartialEq<TranscriptionJob> for TranscriptionJob

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

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

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

This method tests for !=.

impl StructuralPartialEq for TranscriptionJob