Struct aws_sdk_transcribe::input::StartTranscriptionJobInput

#[non_exhaustive]
pub struct StartTranscriptionJobInput {

    pub transcription_job_name: Option<String>,
    pub language_code: Option<LanguageCode>,
    pub media_sample_rate_hertz: Option<i32>,
    pub media_format: Option<MediaFormat>,
    pub media: Option<Media>,
    pub output_bucket_name: Option<String>,
    pub output_key: Option<String>,
    pub output_encryption_kms_key_id: Option<String>,
    pub kms_encryption_context: Option<HashMap<String, 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 subtitles: Option<Subtitles>,
    pub tags: Option<Vec<Tag>>,
    pub language_id_settings: Option<HashMap<LanguageCode, LanguageIdSettings>>,
}

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 job. You can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.

language_code: Option<LanguageCode>

The language code for the language used in the input media file.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

media_sample_rate_hertz: Option<i32>

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

If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.

media_format: Option<MediaFormat>

The format of the input media file.

media: Option<Media>

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

output_bucket_name: Option<String>

The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

output_key: Option<String>

You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

output_encryption_kms_key_id: Option<String>

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

You can use either of the following to identify a KMS key in the current account:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

• ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

kms_encryption_context: Option<HashMap<String, String>>

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

settings: Option<Settings>

A Settings object that provides optional settings for a transcription job.

model_settings: Option<ModelSettings>

Choose the custom language model you use for your transcription job in this parameter.

job_execution_settings: Option<JobExecutionSettings>

Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.

content_redaction: Option<ContentRedaction>

An object that contains the request parameters for content redaction.

identify_language: Option<bool>

Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.

language_options: Option<Vec<LanguageCode>>

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

subtitles: Option<Subtitles>

Add subtitles to your batch transcription job.

tags: Option<Vec<Tag>>

Add tags to an Amazon Transcribe transcription job.

language_id_settings: Option<HashMap<LanguageCode, LanguageIdSettings>>

The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Implementations

impl StartTranscriptionJobInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<StartTranscriptionJob, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<StartTranscriptionJob>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture StartTranscriptionJobInput

impl StartTranscriptionJobInput

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

The name of the job. You can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an Amazon Web Services account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException error.

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

The language code for the language used in the input media file.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

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

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

If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.

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

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

The location where the transcription is stored.

If you set the OutputBucketName, Amazon Transcribe puts the transcript in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. If you enable content redaction, the redacted transcript appears in RedactedTranscriptFileUri. If you enable content redaction and choose to output an unredacted transcript, that transcript's location still appears in the TranscriptFileUri. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

You can specify an Amazon Web Services Key Management Service (KMS) key to encrypt the output of your transcription using the OutputEncryptionKMSKeyId parameter. If you don't specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

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

You can specify a location in an Amazon S3 bucket to store the output of your transcription job.

If you don't specify an output key, Amazon Transcribe stores the output of your transcription job in the Amazon S3 bucket you specified. By default, the object key is "your-transcription-job-name.json".

You can use output keys to specify the Amazon S3 prefix and file name of the transcription output. For example, specifying the Amazon S3 prefix, "folder1/folder2/", as an output key would lead to the output being stored as "folder1/folder2/your-transcription-job-name.json". If you specify "my-other-job-name.json" as the output key, the object key is changed to "my-other-job-name.json". You can use an output key to change both the prefix and the file name, for example "folder/my-other-job-name.json".

If you specify an output key, you must also specify an S3 bucket in the OutputBucketName parameter.

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

The Amazon Resource Name (ARN) of the Amazon Web Services Key Management Service (KMS) key used to encrypt the output of the transcription job. The user calling the StartTranscriptionJob operation must have permission to use the specified KMS key.

You can use either of the following to identify a KMS key in the current account:

• KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

• KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the current account or another account:

• Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:region:account ID:key/1234abcd-12ab-34cd-56ef-1234567890ab"

• ARN of a KMS Key Alias: "arn:aws:kms:region:account-ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the transcription job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also specify an output location in the OutputBucketName parameter.

pub fn kms_encryption_context(&self) -> Option<&HashMap<String, String>>

A map of plain text, non-secret key:value pairs, known as encryption context pairs, that provide an added layer of security for your data.

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

A Settings object that provides optional settings for a transcription job.

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

Choose the custom language model you use for your transcription job in this parameter.

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

Provides information about how a transcription job is executed. Use this field to indicate that the job can be queued for deferred execution if the concurrency limit is reached and there are no slots available to immediately run the job.

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

An object that contains the request parameters for content redaction.

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

Set this field to true to enable automatic language identification. Automatic language identification is disabled by default. You receive a BadRequestException error if you enter a value for a LanguageCode.

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

An object containing a list of languages that might be present in your collection of audio files. Automatic language identification chooses a language that best matches the source audio from that list.

To transcribe speech in Modern Standard Arabic (ar-SA), your audio or video file must be encoded at a sample rate of 16,000 Hz or higher.

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

Add subtitles to your batch transcription job.

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

Add tags to an Amazon Transcribe transcription job.

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

The language identification settings associated with your transcription job. These settings include VocabularyName, VocabularyFilterName, and LanguageModelName.

Trait Implementations

impl Clone for StartTranscriptionJobInput

fn clone(&self) -> StartTranscriptionJobInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartTranscriptionJobInput

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

Formats the value using the given formatter.

impl PartialEq<StartTranscriptionJobInput> for StartTranscriptionJobInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for StartTranscriptionJobInput