Struct aws_sdk_transcribe::types::builders::TranscriptionJobBuilder

#[non_exhaustive]
pub struct TranscriptionJobBuilder { /* private fields */ }

A builder for TranscriptionJob.

Implementations

impl TranscriptionJobBuilder

pub fn transcription_job_name(self, input: impl Into<String>) -> Self

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

pub fn set_transcription_job_name(self, input: Option<String>) -> Self

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

pub fn get_transcription_job_name(&self) -> &Option<String>

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, input: TranscriptionJobStatus) -> Self

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 set_transcription_job_status( self, input: Option<TranscriptionJobStatus> ) -> Self

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 get_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, input: LanguageCode) -> Self

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 set_language_code(self, input: Option<LanguageCode>) -> Self

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 get_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, input: i32) -> Self

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

pub fn set_media_sample_rate_hertz(self, input: Option<i32>) -> Self

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

pub fn get_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, input: MediaFormat) -> Self

The format of the input media file.

pub fn set_media_format(self, input: Option<MediaFormat>) -> Self

The format of the input media file.

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

The format of the input media file.

pub fn media(self, input: Media) -> Self

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

pub fn set_media(self, input: Option<Media>) -> Self

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

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

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

pub fn transcript(self, input: Transcript) -> Self

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

pub fn set_transcript(self, input: Option<Transcript>) -> Self

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

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

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

pub fn start_time(self, input: DateTime) -> Self

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 set_start_time(self, input: Option<DateTime>) -> Self

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 get_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, input: DateTime) -> Self

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 set_creation_time(self, input: Option<DateTime>) -> Self

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 get_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, input: DateTime) -> Self

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 set_completion_time(self, input: Option<DateTime>) -> Self

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 get_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, input: impl Into<String>) -> Self

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 set_failure_reason(self, input: Option<String>) -> Self

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 get_failure_reason(&self) -> &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.

pub fn settings(self, input: Settings) -> Self

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 set_settings(self, input: Option<Settings>) -> Self

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 get_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, input: ModelSettings) -> Self

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

pub fn set_model_settings(self, input: Option<ModelSettings>) -> Self

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

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

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

pub fn job_execution_settings(self, input: JobExecutionSettings) -> Self

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 set_job_execution_settings( self, input: Option<JobExecutionSettings> ) -> Self

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 get_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, input: ContentRedaction) -> Self

Indicates whether redaction was enabled in your transcript.

pub fn set_content_redaction(self, input: Option<ContentRedaction>) -> Self

Indicates whether redaction was enabled in your transcript.

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

Indicates whether redaction was enabled in your transcript.

pub fn identify_language(self, input: bool) -> Self

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

pub fn set_identify_language(self, input: Option<bool>) -> Self

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

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

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

pub fn identify_multiple_languages(self, input: bool) -> Self

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

pub fn set_identify_multiple_languages(self, input: Option<bool>) -> Self

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

pub fn get_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, input: LanguageCode) -> Self

Appends an item to language_options.

To override the contents of this collection use set_language_options.

Provides the language codes you specified in your request.

pub fn set_language_options(self, input: Option<Vec<LanguageCode>>) -> Self

Provides the language codes you specified in your request.

pub fn get_language_options(&self) -> &Option<Vec<LanguageCode>>

Provides the language codes you specified in your request.

pub fn identified_language_score(self, input: f32) -> Self

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 set_identified_language_score(self, input: Option<f32>) -> Self

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 get_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, input: LanguageCodeItem) -> Self

Appends an item to language_codes.

To override the contents of this collection use set_language_codes.

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.

pub fn set_language_codes(self, input: Option<Vec<LanguageCodeItem>>) -> Self

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.

pub fn get_language_codes(&self) -> &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.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

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

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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

pub fn get_tags(&self) -> &Option<Vec<Tag>>

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

pub fn subtitles(self, input: SubtitlesOutput) -> Self

Indicates whether subtitles were generated with your transcription.

pub fn set_subtitles(self, input: Option<SubtitlesOutput>) -> Self

Indicates whether subtitles were generated with your transcription.

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

Indicates whether subtitles were generated with your transcription.

pub fn language_id_settings( self, k: LanguageCode, v: LanguageIdSettings ) -> Self

Adds a key-value pair to language_id_settings.

To override the contents of this collection use set_language_id_settings.

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

pub fn set_language_id_settings( self, input: Option<HashMap<LanguageCode, LanguageIdSettings>> ) -> Self

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

pub fn get_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, input: ToxicityDetectionSettings) -> Self

Appends an item to toxicity_detection.

To override the contents of this collection use set_toxicity_detection.

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

pub fn set_toxicity_detection( self, input: Option<Vec<ToxicityDetectionSettings>> ) -> Self

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

pub fn get_toxicity_detection(&self) -> &Option<Vec<ToxicityDetectionSettings>>

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

pub fn build(self) -> TranscriptionJob

Consumes the builder and constructs a TranscriptionJob.

Trait Implementations

impl Clone for TranscriptionJobBuilder

fn clone(&self) -> TranscriptionJobBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TranscriptionJobBuilder

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

Formats the value using the given formatter.

impl Default for TranscriptionJobBuilder

fn default() -> TranscriptionJobBuilder

Returns the “default value” for a type.

impl PartialEq for TranscriptionJobBuilder

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