/AWS1/CL_TNBMEDICALSCRIBEJOB

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_medicalscribejobname TYPE /AWS1/TNBTRANSCRIPTIONJOBNAME /AWS1/TNBTRANSCRIPTIONJOBNAME

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

iv_medicalscribejobstatus TYPE /AWS1/TNBMEDICALSCRIBEJOBSTAT /AWS1/TNBMEDICALSCRIBEJOBSTAT

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.

iv_languagecode TYPE /AWS1/TNBMEDICALSCRIBELANGUA00 /AWS1/TNBMEDICALSCRIBELANGUA00

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

io_media TYPE REF TO /AWS1/CL_TNBMEDIA /AWS1/CL_TNBMEDIA

Media

io_medicalscribeoutput TYPE REF TO /AWS1/CL_TNBMEDICALSCRIBEOUT /AWS1/CL_TNBMEDICALSCRIBEOUT

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.

iv_starttime TYPE /AWS1/TNBDATETIME /AWS1/TNBDATETIME

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.

iv_creationtime TYPE /AWS1/TNBDATETIME /AWS1/TNBDATETIME

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.

iv_completiontime TYPE /AWS1/TNBDATETIME /AWS1/TNBDATETIME

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.

iv_failurereason TYPE /AWS1/TNBFAILUREREASON /AWS1/TNBFAILUREREASON

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

io_settings TYPE REF TO /AWS1/CL_TNBMEDICALSCRIBESTGS /AWS1/CL_TNBMEDICALSCRIBESTGS

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.

iv_dataaccessrolearn TYPE /AWS1/TNBDATAACCESSROLEARN /AWS1/TNBDATAACCESSROLEARN

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.

it_channeldefinitions TYPE /AWS1/CL_TNBMEDICALSCRIBECHA00=>TT_MEDICALSCRIBECHANNELDEFNS TT_MEDICALSCRIBECHANNELDEFNS

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

iv_medicalscribectxprovided TYPE /AWS1/TNBBOOLEAN /AWS1/TNBBOOLEAN

Indicates whether the MedicalScribeContext object was provided when the Medical Scribe job was started.

it_tags TYPE /AWS1/CL_TNBTAG=>TT_TAGLIST TT_TAGLIST

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

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

---

Queryable Attributes

MedicalScribeJobName

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

Accessible with the following methods

Method	Description
GET_MEDICALSCRIBEJOBNAME()	Getter for MEDICALSCRIBEJOBNAME, with configurable default
ASK_MEDICALSCRIBEJOBNAME()	Getter for MEDICALSCRIBEJOBNAME w/ exceptions if field has n
HAS_MEDICALSCRIBEJOBNAME()	Determine if MEDICALSCRIBEJOBNAME has a value

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.

Accessible with the following methods

Method	Description
GET_MEDICALSCRIBEJOBSTATUS()	Getter for MEDICALSCRIBEJOBSTATUS, with configurable default
ASK_MEDICALSCRIBEJOBSTATUS()	Getter for MEDICALSCRIBEJOBSTATUS w/ exceptions if field has
HAS_MEDICALSCRIBEJOBSTATUS()	Determine if MEDICALSCRIBEJOBSTATUS has a value

LanguageCode

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

Accessible with the following methods

Method	Description
GET_LANGUAGECODE()	Getter for LANGUAGECODE, with configurable default
ASK_LANGUAGECODE()	Getter for LANGUAGECODE w/ exceptions if field has no value
HAS_LANGUAGECODE()	Determine if LANGUAGECODE has a value

Media

Media

Accessible with the following methods

Method	Description
GET_MEDIA()	Getter for MEDIA

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.

Accessible with the following methods

Method	Description
GET_MEDICALSCRIBEOUTPUT()	Getter for MEDICALSCRIBEOUTPUT

StartTime

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.

Accessible with the following methods

Method	Description
GET_STARTTIME()	Getter for STARTTIME, with configurable default
ASK_STARTTIME()	Getter for STARTTIME w/ exceptions if field has no value
HAS_STARTTIME()	Determine if STARTTIME has a value

CreationTime

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.

Accessible with the following methods

Method	Description
GET_CREATIONTIME()	Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME()	Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME()	Determine if CREATIONTIME has a value

CompletionTime

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.

Accessible with the following methods

Method	Description
GET_COMPLETIONTIME()	Getter for COMPLETIONTIME, with configurable default
ASK_COMPLETIONTIME()	Getter for COMPLETIONTIME w/ exceptions if field has no valu
HAS_COMPLETIONTIME()	Determine if COMPLETIONTIME has a value

FailureReason

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

Accessible with the following methods

Method	Description
GET_FAILUREREASON()	Getter for FAILUREREASON, with configurable default
ASK_FAILUREREASON()	Getter for FAILUREREASON w/ exceptions if field has no value
HAS_FAILUREREASON()	Determine if FAILUREREASON has a value

Settings

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.

Accessible with the following methods

Method	Description
GET_SETTINGS()	Getter for SETTINGS

DataAccessRoleArn

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.

Accessible with the following methods

Method	Description
GET_DATAACCESSROLEARN()	Getter for DATAACCESSROLEARN, with configurable default
ASK_DATAACCESSROLEARN()	Getter for DATAACCESSROLEARN w/ exceptions if field has no v
HAS_DATAACCESSROLEARN()	Determine if DATAACCESSROLEARN has a value

ChannelDefinitions

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

Accessible with the following methods

Method	Description
GET_CHANNELDEFINITIONS()	Getter for CHANNELDEFINITIONS, with configurable default
ASK_CHANNELDEFINITIONS()	Getter for CHANNELDEFINITIONS w/ exceptions if field has no
HAS_CHANNELDEFINITIONS()	Determine if CHANNELDEFINITIONS has a value

MedicalScribeContextProvided

Indicates whether the MedicalScribeContext object was provided when the Medical Scribe job was started.

Accessible with the following methods

Method	Description
GET_MEDICALSCRIBECTXPROVIDED()	Getter for MEDICALSCRIBECONTEXTPROVIDED, with configurable d
ASK_MEDICALSCRIBECTXPROVIDED()	Getter for MEDICALSCRIBECONTEXTPROVIDED w/ exceptions if fie
HAS_MEDICALSCRIBECTXPROVIDED()	Determine if MEDICALSCRIBECONTEXTPROVIDED has a value

Tags

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

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

Accessible with the following methods

Method	Description
GET_TAGS()	Getter for TAGS, with configurable default
ASK_TAGS()	Getter for TAGS w/ exceptions if field has no value
HAS_TAGS()	Determine if TAGS has a value