Struct aws_sdk_transcribe::types::MedicalScribeJob

#[non_exhaustive]
pub struct MedicalScribeJob {

    pub medical_scribe_job_name: Option<String>,
    pub medical_scribe_job_status: Option<MedicalScribeJobStatus>,
    pub language_code: Option<MedicalScribeLanguageCode>,
    pub media: Option<Media>,
    pub medical_scribe_output: Option<MedicalScribeOutput>,
    pub start_time: Option<DateTime>,
    pub creation_time: Option<DateTime>,
    pub completion_time: Option<DateTime>,
    pub failure_reason: Option<String>,
    pub settings: Option<MedicalScribeSettings>,
    pub data_access_role_arn: Option<String>,
    pub channel_definitions: Option<Vec<MedicalScribeChannelDefinition>>,
    pub tags: Option<Vec<Tag>>,
}

Provides detailed information about a Medical Scribe job.

To view the status of the specified Medical Scribe job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the locations specified in MedicalScribeOutput. If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

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_scribe_job_name: Option<String>

The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.

medical_scribe_job_status: Option<MedicalScribeJobStatus>

Provides the status of the specified Medical Scribe job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

language_code: Option<MedicalScribeLanguageCode>

The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.

media: Option<Media>

Describes the Amazon S3 location of the media file you want to use in your request.

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.

medical_scribe_output: Option<MedicalScribeOutput>

The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.

start_time: Option<DateTime>

The date and time your Medical Scribe job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.

creation_time: Option<DateTime>

The date and time the specified Medical Scribe job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.

completion_time: Option<DateTime>

The date and time the specified Medical Scribe job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.

failure_reason: Option<String>

If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.

settings: Option<MedicalScribeSettings>

Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.

data_access_role_arn: Option<String>

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails.

IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

For more information, see IAM ARNs.

channel_definitions: Option<Vec<MedicalScribeChannelDefinition>>

Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).

tags: Option<Vec<Tag>>

Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

Implementations

impl MedicalScribeJob

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

The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services account.

pub fn medical_scribe_job_status(&self) -> Option<&MedicalScribeJobStatus>

Provides the status of the specified Medical Scribe job.

If the status is COMPLETED, the job is finished and you can find the results at the location specified in MedicalScribeOutput If the status is FAILED, FailureReason provides details on why your Medical Scribe job failed.

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

The language code used to create your Medical Scribe job. US English (en-US) is the only supported language for Medical Scribe jobs.

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

Describes the Amazon S3 location of the media file you want to use in your request.

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.

pub fn medical_scribe_output(&self) -> Option<&MedicalScribeOutput>

The location of the output of your Medical Scribe job. ClinicalDocumentUri holds the Amazon S3 URI for the Clinical Document and TranscriptFileUri holds the Amazon S3 URI for the Transcript.

pub fn start_time(&self) -> Option<&DateTime>

The date and time your Medical Scribe job began processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.

pub fn creation_time(&self) -> Option<&DateTime>

The date and time the specified Medical Scribe job request was made.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM UTC-7 on May 4, 2022.

pub fn completion_time(&self) -> Option<&DateTime>

The date and time the specified Medical Scribe job finished processing.

Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32 PM UTC-7 on May 4, 2022.

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

If MedicalScribeJobStatus is FAILED, FailureReason contains information about why the transcription job failed. See also: Common Errors.

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

Makes it possible to control how your Medical Scribe job is processed using a MedicalScribeSettings object. Specify ChannelIdentification if ChannelDefinitions are set. Enabled ShowSpeakerLabels if ChannelIdentification and ChannelDefinitions are not set. One and only one of ChannelIdentification and ShowSpeakerLabels must be set. If ShowSpeakerLabels is set, MaxSpeakerLabels must also be set. Use Settings to specify a vocabulary or vocabulary filter or both using VocabularyName, VocabularyFilterName. VocabularyFilterMethod must be specified if VocabularyFilterName is set.

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

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files, write to the output bucket, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions your request fails.

IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

For more information, see IAM ARNs.

pub fn channel_definitions(&self) -> &[MedicalScribeChannelDefinition]

Makes it possible to specify which speaker is on which channel. For example, if the clinician is the first participant to speak, you would set ChannelId of the first ChannelDefinition in the list to 0 (to indicate the first channel) and ParticipantRole to CLINICIAN (to indicate that it's the clinician speaking). Then you would set the ChannelId of the second ChannelDefinition in the list to 1 (to indicate the second channel) and ParticipantRole to PATIENT (to indicate that it's the patient speaking).

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .channel_definitions.is_none().

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

Adds one or more custom tags, each in the form of a key:value pair, to the Medica Scribe job.

To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

impl MedicalScribeJob

pub fn builder() -> MedicalScribeJobBuilder

Creates a new builder-style object to manufacture MedicalScribeJob.

Trait Implementations

impl Clone for MedicalScribeJob

fn clone(&self) -> MedicalScribeJob

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MedicalScribeJob

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

Formats the value using the given formatter.

impl PartialEq for MedicalScribeJob

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

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

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

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

impl StructuralPartialEq for MedicalScribeJob