Struct aws_sdk_transcribe::input::StartMedicalTranscriptionJobInput

#[non_exhaustive]
pub struct StartMedicalTranscriptionJobInput {

    pub medical_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<MedicalTranscriptionSetting>,
    pub content_identification_type: Option<MedicalContentIdentificationType>,
    pub specialty: Option<Specialty>,
    pub type: Option<Type>,
    pub tags: Option<Vec<Tag>>,
}

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.

medical_transcription_job_name: Option<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 Amazon Web Services 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.

language_code: Option<LanguageCode>

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_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 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.

media_format: Option<MediaFormat>

The audio format of the input media file.

media: Option<Media>

Describes the input media file in a transcription request.

output_bucket_name: Option<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 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 Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

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.

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 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.

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<MedicalTranscriptionSetting>

Optional settings for the medical transcription job.

content_identification_type: Option<MedicalContentIdentificationType>

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.

specialty: Option<Specialty>

The medical specialty of any clinician speaking in the input media.

type: Option<Type>

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, such as clinical notes.

tags: Option<Vec<Tag>>

Add tags to an Amazon Transcribe medical transcription job.

Implementations

impl StartMedicalTranscriptionJobInput

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

Consumes the builder and constructs an Operation<StartMedicalTranscriptionJob>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture StartMedicalTranscriptionJobInput

impl StartMedicalTranscriptionJobInput

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

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 Amazon Web Services 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.

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

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.

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 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.

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

The audio format of the input media file.

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

Describes the input media file in a transcription request.

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

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 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 Medical uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket.

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

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.

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 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.

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<&MedicalTranscriptionSetting>

Optional settings for the medical transcription job.

pub fn content_identification_type(
    &self
) -> Option<&MedicalContentIdentificationType>

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.

pub fn specialty(&self) -> Option<&Specialty>

The medical specialty of any clinician speaking in the input media.

pub fn type(&self) -> Option<&Type>

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, such as clinical notes.

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

Add tags to an Amazon Transcribe medical transcription job.

Trait Implementations

impl Clone for StartMedicalTranscriptionJobInput

fn clone(&self) -> StartMedicalTranscriptionJobInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartMedicalTranscriptionJobInput

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

Formats the value using the given formatter.

impl PartialEq<StartMedicalTranscriptionJobInput> for StartMedicalTranscriptionJobInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for StartMedicalTranscriptionJobInput