Struct aws_sdk_transcribe::types::TranscriptionJobSummary

#[non_exhaustive]
pub struct TranscriptionJobSummary {

    pub transcription_job_name: Option<String>,
    pub creation_time: Option<DateTime>,
    pub start_time: Option<DateTime>,
    pub completion_time: Option<DateTime>,
    pub language_code: Option<LanguageCode>,
    pub transcription_job_status: Option<TranscriptionJobStatus>,
    pub failure_reason: Option<String>,
    pub output_location_type: Option<OutputLocationType>,
    pub content_redaction: Option<ContentRedaction>,
    pub model_settings: Option<ModelSettings>,
    pub identify_language: Option<bool>,
    pub identify_multiple_languages: Option<bool>,
    pub identified_language_score: Option<f32>,
    pub language_codes: Option<Vec<LanguageCodeItem>>,
    pub toxicity_detection: Option<Vec<ToxicityDetectionSettings>>,
}

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

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.

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.

start_time: Option<DateTime>

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

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.

language_code: Option<LanguageCode>

The language code used to create your transcription.

transcription_job_status: Option<TranscriptionJobStatus>

Provides the status of your 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.

failure_reason: Option<String>

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.

output_location_type: Option<OutputLocationType>

Indicates where the specified transcription output is stored.

If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field.

content_redaction: Option<ContentRedaction>

The content redaction settings of the transcription job.

model_settings: Option<ModelSettings>

Provides the name of the custom language model that was included in the specified transcription job.

Only use ModelSettings with the LanguageModelName sub-parameter if you're not using automatic language identification (). If using LanguageIdSettings in your request, this parameter contains a LanguageModelName sub-parameter.

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.

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, the singular version of this parameter, LanguageCode, is present.

toxicity_detection: Option<Vec<ToxicityDetectionSettings>>

Indicates whether toxicity detection was enabled for the specified transcription job.

Implementations

impl TranscriptionJobSummary

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 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 start_time(&self) -> Option<&DateTime>

The date and time your 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 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 language_code(&self) -> Option<&LanguageCode>

The language code used to create your transcription.

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

Provides the status of your 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 failure_reason(&self) -> Option<&str>

If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.

pub fn output_location_type(&self) -> Option<&OutputLocationType>

Indicates where the specified transcription output is stored.

If the value is CUSTOMER_BUCKET, the location is the Amazon S3 bucket you specified using the OutputBucketName parameter in your request. If you also included OutputKey in your request, your output is located in the path you specified in your request.

If the value is SERVICE_BUCKET, the location is a service-managed Amazon S3 bucket. To access a transcript stored in a service-managed bucket, use the URI shown in the TranscriptFileUri or RedactedTranscriptFileUri field.

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

The content redaction settings of the transcription job.

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

Provides the name of the custom language model that was included in the specified transcription job.

Only use ModelSettings with the LanguageModelName sub-parameter if you're not using automatic language identification (). If using LanguageIdSettings in your request, this parameter contains a LanguageModelName sub-parameter.

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 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, the singular version of this parameter, LanguageCode, is present.

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 toxicity_detection(&self) -> &[ToxicityDetectionSettings]

Indicates whether toxicity detection was enabled for 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 .toxicity_detection.is_none().

impl TranscriptionJobSummary

pub fn builder() -> TranscriptionJobSummaryBuilder

Creates a new builder-style object to manufacture TranscriptionJobSummary.

Trait Implementations

impl Clone for TranscriptionJobSummary

fn clone(&self) -> TranscriptionJobSummary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TranscriptionJobSummary

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

Formats the value using the given formatter.

impl PartialEq for TranscriptionJobSummary

fn eq(&self, other: &TranscriptionJobSummary) -> 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 TranscriptionJobSummary