pub struct StartMedicalTranscriptionJobRequest {
pub content_identification_type: Option<String>,
pub language_code: String,
pub media: Media,
pub media_format: Option<String>,
pub media_sample_rate_hertz: Option<i64>,
pub medical_transcription_job_name: String,
pub output_bucket_name: String,
pub output_encryption_kms_key_id: Option<String>,
pub output_key: Option<String>,
pub settings: Option<MedicalTranscriptionSetting>,
pub specialty: String,
pub type_: String,
}
Fields
content_identification_type: Option<String>
You can configure Amazon Transcribe Medical to label content in the transcription output. If you specify PHI
, Amazon Transcribe Medical labels the personal health information (PHI) that it identifies in the transcription output.
language_code: String
The language code for the language spoken in the input media file. US English (en-US) is the valid value for medical transcription jobs. Any other value you enter for language code results in a BadRequestException
error.
media: Media
media_format: Option<String>
The audio 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 Medical determines the sample rate. If you specify the sample rate, it must match the rate detected by Amazon Transcribe Medical. In most cases, you should leave the MediaSampleRateHertz
field blank and let Amazon Transcribe Medical determine the sample rate.
medical_transcription_job_name: String
The name of the medical transcription 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 medical transcription job with the same name as a previous medical transcription job, you get a ConflictException
error.
output_bucket_name: String
The Amazon S3 location where the transcription is stored.
You must set OutputBucketName
for Amazon Transcribe Medical to store the transcription results. Your transcript appears in the S3 location you specify. When you call the GetMedicalTranscriptionJob, the operation returns this location in the TranscriptFileUri
field. The S3 bucket must have permissions that allow Amazon Transcribe Medical 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 Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.
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 StartMedicalTranscriptionJob operation must have permission to use the specified KMS key.
You 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 in the current account or another account: "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 medical 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 medical transcription job.
If you don't specify an output key, Amazon Transcribe Medical 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<MedicalTranscriptionSetting>
Optional settings for the medical transcription job.
specialty: String
The medical specialty of any clinician speaking in the input media.
type_: String
The type of speech in the input audio. CONVERSATION
refers to conversations between two or more speakers, e.g., a conversations between doctors and patients. DICTATION
refers to single-speaker dictated speech, e.g., for clinical notes.
Trait Implementations
sourceimpl Clone for StartMedicalTranscriptionJobRequest
impl Clone for StartMedicalTranscriptionJobRequest
sourcefn clone(&self) -> StartMedicalTranscriptionJobRequest
fn clone(&self) -> StartMedicalTranscriptionJobRequest
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 Default for StartMedicalTranscriptionJobRequest
impl Default for StartMedicalTranscriptionJobRequest
sourcefn default() -> StartMedicalTranscriptionJobRequest
fn default() -> StartMedicalTranscriptionJobRequest
Returns the “default value” for a type. Read more
sourceimpl PartialEq<StartMedicalTranscriptionJobRequest> for StartMedicalTranscriptionJobRequest
impl PartialEq<StartMedicalTranscriptionJobRequest> for StartMedicalTranscriptionJobRequest
sourcefn eq(&self, other: &StartMedicalTranscriptionJobRequest) -> bool
fn eq(&self, other: &StartMedicalTranscriptionJobRequest) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &StartMedicalTranscriptionJobRequest) -> bool
fn ne(&self, other: &StartMedicalTranscriptionJobRequest) -> bool
This method tests for !=
.
impl StructuralPartialEq for StartMedicalTranscriptionJobRequest
Auto Trait Implementations
impl RefUnwindSafe for StartMedicalTranscriptionJobRequest
impl Send for StartMedicalTranscriptionJobRequest
impl Sync for StartMedicalTranscriptionJobRequest
impl Unpin for StartMedicalTranscriptionJobRequest
impl UnwindSafe for StartMedicalTranscriptionJobRequest
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