Struct StartTranscriptionJobRequest

pub struct StartTranscriptionJobRequest {
    pub content_redaction: Option<ContentRedaction>,
    pub job_execution_settings: Option<JobExecutionSettings>,
    pub language_code: String,
    pub media: Media,
    pub media_format: Option<String>,
    pub media_sample_rate_hertz: Option<i64>,
    pub output_bucket_name: Option<String>,
    pub output_encryption_kms_key_id: Option<String>,
    pub settings: Option<Settings>,
    pub transcription_job_name: String,
}

Fields

content_redaction: Option<ContentRedaction>

An object that contains the request parameters for content redaction.

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.

language_code: String

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

media: Media

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

media_format: Option<String>

The format of the input media file.

media_sample_rate_hertz: Option<i64>

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.

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 AWS 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_encryption_kms_key_id: Option<String>

The Amazon Resource Name (ARN) of the AWS 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.

settings: Option<Settings>

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

transcription_job_name: String

The name of the job. Note that you can't use the strings "." or ".." by themselves as the job name. The name must also be unique within an AWS account. If you try to create a transcription job with the same name as a previous transcription job you will receive a ConflictException error.

Trait Implementations

impl Clone for StartTranscriptionJobRequest

fn clone(&self) -> StartTranscriptionJobRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StartTranscriptionJobRequest

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

Formats the value using the given formatter.

impl Default for StartTranscriptionJobRequest

fn default() -> StartTranscriptionJobRequest

Returns the “default value” for a type.

impl PartialEq for StartTranscriptionJobRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for StartTranscriptionJobRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StartTranscriptionJobRequest