pub struct StartTranscriptionJobRequest {Show 14 fields
pub content_redaction: Option<ContentRedaction>,
pub identify_language: Option<bool>,
pub job_execution_settings: Option<JobExecutionSettings>,
pub language_code: Option<String>,
pub language_options: Option<Vec<String>>,
pub media: Media,
pub media_format: Option<String>,
pub media_sample_rate_hertz: Option<i64>,
pub model_settings: Option<ModelSettings>,
pub output_bucket_name: Option<String>,
pub output_encryption_kms_key_id: Option<String>,
pub output_key: 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.
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
.
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: Option<String>
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 16000 Hz or higher.
language_options: Option<Vec<String>>
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.
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.
model_settings: Option<ModelSettings>
Choose the custom language model you use for your transcription job in this parameter.
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.
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.
settings: Option<Settings>
A Settings
object that provides optional settings for a transcription job.
transcription_job_name: 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 AWS account. If you try to create a transcription job with the same name as a previous transcription job, you get a ConflictException
error.
Trait Implementations
sourceimpl Clone for StartTranscriptionJobRequest
impl Clone for StartTranscriptionJobRequest
sourcefn clone(&self) -> StartTranscriptionJobRequest
fn clone(&self) -> StartTranscriptionJobRequest
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for StartTranscriptionJobRequest
impl Debug for StartTranscriptionJobRequest
sourceimpl Default for StartTranscriptionJobRequest
impl Default for StartTranscriptionJobRequest
sourcefn default() -> StartTranscriptionJobRequest
fn default() -> StartTranscriptionJobRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<StartTranscriptionJobRequest> for StartTranscriptionJobRequest
impl PartialEq<StartTranscriptionJobRequest> for StartTranscriptionJobRequest
sourcefn eq(&self, other: &StartTranscriptionJobRequest) -> bool
fn eq(&self, other: &StartTranscriptionJobRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &StartTranscriptionJobRequest) -> bool
fn ne(&self, other: &StartTranscriptionJobRequest) -> bool
This method tests for !=
.
impl StructuralPartialEq for StartTranscriptionJobRequest
Auto Trait Implementations
impl RefUnwindSafe for StartTranscriptionJobRequest
impl Send for StartTranscriptionJobRequest
impl Sync for StartTranscriptionJobRequest
impl Unpin for StartTranscriptionJobRequest
impl UnwindSafe for StartTranscriptionJobRequest
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more