Struct aws_sdk_transcribe::types::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 identify_multiple_languages: Option<bool>,
    pub language_options: Option<Vec<LanguageCode>>,
    pub identified_language_score: Option<f32>,
    pub language_codes: Option<Vec<LanguageCodeItem>>,
    pub tags: Option<Vec<Tag>>,
    pub subtitles: Option<SubtitlesOutput>,
    pub language_id_settings: Option<HashMap<LanguageCode, LanguageIdSettings>>,
    pub toxicity_detection: Option<Vec<ToxicityDetectionSettings>>,
}

Provides detailed information about a transcription job.

To view the status of the specified 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.

If you enabled content redaction, the redacted transcript can be found at the location specified in RedactedTranscriptFileUri.

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. 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 transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). 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 transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, LanguageCodes.

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>

Provides the Amazon S3 location of the media file you used in your request.

transcript: Option<Transcript>

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

start_time: Option<DateTime>

The date and time the specified 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 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 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 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.

settings: Option<Settings>

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.

model_settings: Option<ModelSettings>

Provides information on the custom language model you included in your request.

job_execution_settings: Option<JobExecutionSettings>

Provides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used.

content_redaction: Option<ContentRedaction>

Indicates whether redaction was enabled in your transcript.

identify_language: Option<bool>

Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.

identify_multiple_languages: Option<bool>

Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.

language_options: Option<Vec<LanguageCode>>

Provides the language codes you specified in your request.

identified_language_score: Option<f32>

The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

language_codes: Option<Vec<LanguageCodeItem>>

The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.

tags: Option<Vec<Tag>>

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

subtitles: Option<SubtitlesOutput>

Indicates whether subtitles were generated with your transcription.

language_id_settings: Option<HashMap<LanguageCode, LanguageIdSettings>>

Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.

toxicity_detection: Option<Vec<ToxicityDetectionSettings>>

Provides information about the toxicity detection settings applied to your transcription.

Implementations

impl TranscriptionJob

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

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

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

Provides the status of the specified transcription job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri (or RedactedTranscriptFileUri, if you requested transcript redaction). If the status is FAILED, FailureReason provides details on why your transcription job failed.

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

The language code used to create your transcription job. This parameter is used with single-language identification. For multi-language identification requests, refer to the plural version of this parameter, LanguageCodes.

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

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

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

The format of the input media file.

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

Provides the Amazon S3 location of the media file you used in your request.

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

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

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

The date and time the specified 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.

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

The date and time the specified 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.

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

The date and time the specified 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.

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

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

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.

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

Provides information on the custom language model you included in your request.

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

Provides information about how your transcription job was processed. This parameter shows if your request was queued and what data access role was used.

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

Indicates whether redaction was enabled in your transcript.

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

Indicates whether automatic language identification was enabled (TRUE) for the specified transcription job.

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

Indicates whether automatic multi-language identification was enabled (TRUE) for the specified transcription job.

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

Provides the language codes you specified in your request.

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

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

The confidence score associated with the language identified in your media file.

Confidence scores are values between 0 and 1; a larger value indicates a higher probability that the identified language correctly matches the language spoken in your media.

pub fn language_codes(&self) -> &[LanguageCodeItem]

The language codes used to create your transcription job. This parameter is used with multi-language identification. For single-language identification requests, refer to the singular version of this parameter, LanguageCode.

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

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

The tags, each in the form of a key:value pair, assigned to the specified 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().

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

Indicates whether subtitles were generated with your transcription.

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

Provides the name and language of all custom language models, custom vocabularies, and custom vocabulary filters that you included in your request.

pub fn toxicity_detection(&self) -> &[ToxicityDetectionSettings]

Provides information about the toxicity detection settings applied to your transcription.

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

impl TranscriptionJob

pub fn builder() -> TranscriptionJobBuilder

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 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: &Rhs) -> bool

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

impl StructuralPartialEq for TranscriptionJob