Skip to content

aws.transcribe.get_medical_scribe_job

Example SQL Queries

SELECT * FROM
aws.transcribe.get_medical_scribe_job
WHERE
"medical_scribe_job_name" = 'VALUE';

Description

Provides information about the specified Medical Scribe job.

To view the status of the specified medical transcription job, check the MedicalScribeJobStatus field. If the status is COMPLETED, the job is finished. 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.

To get a list of your Medical Scribe jobs, use the operation.

Table Definition

Column NameColumn Data Type
medical_scribe_job_name Required Input Column

The name of the Medical Scribe job you want information about. Job names are case sensitive.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
medical_scribe_job

Provides detailed information about the specified Medical Scribe job, including job status and, if applicable, failure reason

STRUCT(
"medical_scribe_job_name" VARCHAR,
"medical_scribe_job_status" VARCHAR,
"language_code" VARCHAR,
"media" STRUCT(
"media_file_uri" VARCHAR,
"redacted_media_file_uri" VARCHAR
),
"medical_scribe_output" STRUCT(
"transcript_file_uri" VARCHAR,
"clinical_document_uri" VARCHAR
),
"start_time" TIMESTAMP_S,
"creation_time" TIMESTAMP_S,
"completion_time" TIMESTAMP_S,
"failure_reason" VARCHAR,
"settings" STRUCT(
"show_speaker_labels" BOOLEAN,
"max_speaker_labels" BIGINT,
"channel_identification" BOOLEAN,
"vocabulary_name" VARCHAR,
"vocabulary_filter_name" VARCHAR,
"vocabulary_filter_method" VARCHAR
),
"data_access_role_arn" VARCHAR,
"channel_definitions" STRUCT(
"channel_id" BIGINT,
"participant_role" VARCHAR
)[],
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)
Show child fields
medical_scribe_job.channel_definitions[]
Show child fields
medical_scribe_job.channel_definitions[].channel_id

Specify the audio channel you want to define.

medical_scribe_job.channel_definitions[].participant_role

Specify the participant that you want to flag. The options are CLINICIAN and PATIENT

medical_scribe_job.completion_time

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.

medical_scribe_job.creation_time

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.

medical_scribe_job.data_access_role_arn

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.

medical_scribe_job.failure_reason

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

medical_scribe_job.language_code

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

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

Show child fields
medical_scribe_job.media.media_file_uri

The Amazon S3 location of the media file you want to transcribe. For example:

  • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac

  • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

medical_scribe_job.media.redacted_media_file_uri

The Amazon S3 location of the media file you want to redact. For example:

  • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac

  • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

RedactedMediaFileUri produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics (StartCallAnalyticsJob) transcription requests.

medical_scribe_job.medical_scribe_job_name

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

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.

medical_scribe_job.medical_scribe_output

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.

Show child fields
medical_scribe_job.medical_scribe_output.clinical_document_uri

Holds the Amazon S3 URI for the Clinical Document.

medical_scribe_job.medical_scribe_output.transcript_file_uri

Holds the Amazon S3 URI for the Transcript.

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

Show child fields
medical_scribe_job.settings.channel_identification

Enables channel identification in multi-channel audio.

Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

For more information, see Transcribing multi-channel audio.

medical_scribe_job.settings.max_speaker_labels

Specify the maximum number of speakers you want to partition in your media.

Note that if your media contains more speakers than the specified number, multiple speakers are treated as a single speaker.

If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

medical_scribe_job.settings.show_speaker_labels

Enables speaker partitioning (diarization) in your Medical Scribe output. Speaker partitioning labels the speech from individual speakers in your media file.

If you enable ShowSpeakerLabels in your request, you must also include MaxSpeakerLabels.

For more information, see Partitioning speakers (diarization).

medical_scribe_job.settings.vocabulary_filter_method

Specify how you want your custom vocabulary filter applied to your transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

medical_scribe_job.settings.vocabulary_filter_name

The name of the custom vocabulary filter you want to include in your Medical Scribe request. Custom vocabulary filter names are case sensitive.

Note that if you include VocabularyFilterName in your request, you must also include VocabularyFilterMethod.

medical_scribe_job.settings.vocabulary_name

The name of the custom vocabulary you want to include in your Medical Scribe request. Custom vocabulary names are case sensitive.

medical_scribe_job.start_time

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.

medical_scribe_job.tags[]
Show child fields
medical_scribe_job.tags[].key

The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the key is 'Department'.

medical_scribe_job.tags[].value

The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag Department:Sales, the value is 'Sales'.

Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.