aws_transcribe_medical_transcription_job

account_id

Type: STRING

completion_time

Type: TIMESTAMP
Provider name: CompletionTime
Description: The date and time the specified medical transcription job finished processing. Timestamps are in the format YYYY-MM-DD’T’HH:MM:SS.SSSSSS-UTC. For example, 2022-05-04T12:33:13.922000-07:00 represents a transcription job that started processing at 12:33 PM UTC-7 on May 4, 2022.

content_identification_type

Type: STRING
Provider name: ContentIdentificationType
Description: Indicates whether content identification was enabled for your transcription request.

creation_time

Type: TIMESTAMP
Provider name: CreationTime
Description: The date and time the specified medical transcription 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 transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

failure_reason

Type: STRING
Provider name: FailureReason
Description: If TranscriptionJobStatus is FAILED, FailureReason contains information about why the transcription job request failed. The FailureReason field contains one of the following values:

• Unsupported media format. The media format specified in MediaFormat isn’t valid. Refer to refer to the MediaFormat parameter for a list of supported formats.
• The media format provided does not match the detected media format. The media format specified in MediaFormat doesn’t match the format of the input file. Check the media format of your media file and correct the specified value.
• Invalid sample rate for audio file. The sample rate specified in MediaSampleRateHertz isn’t valid. The sample rate must be between 16,000 and 48,000 hertz.
• The sample rate provided does not match the detected sample rate. The sample rate specified in MediaSampleRateHertz doesn’t match the sample rate detected in your input media file. Check the sample rate of your media file and correct the specified value.
• Invalid file size: file size too large. The size of your media file is larger than what Amazon Transcribe can process. For more information, refer to Service quotas.
• Invalid number of channels: number of channels too large. Your audio contains more channels than Amazon Transcribe is able to process. For more information, refer to Service quotas.

language_code

Type: STRING
Provider name: LanguageCode
Description: The language code used to create your medical transcription job. US English (en-US) is the only supported language for medical transcriptions.

media

Type: STRUCT
Provider name: Media

• media_file_uri
  Type: STRING
  Provider name: MediaFileUri
  Description: 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.
  
• redacted_media_file_uri
  Type: STRING
  Provider name: RedactedMediaFileUri
  Description: 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.
  

media_format

Type: STRING
Provider name: MediaFormat
Description: The format of the input media file.

media_sample_rate_hertz

Type: INT32
Provider name: MediaSampleRateHertz
Description: The sample rate, in hertz, of the audio track in your input media file.

medical_transcription_job_name

Type: STRING
Provider name: MedicalTranscriptionJobName
Description: The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.

settings

Type: STRUCT
Provider name: Settings
Description: Provides information on any additional settings that were included in your request. Additional settings include channel identification, alternative transcriptions, speaker partitioning, custom vocabularies, and custom vocabulary filters.

• channel_identification
  Type: BOOLEAN
  Provider name: ChannelIdentification
  Description: 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. If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript does not separate the speech by channel. For more information, see Transcribing multi-channel audio.
  
• max_alternatives
  Type: INT32
  Provider name: MaxAlternatives
  Description: Indicate the maximum number of alternative transcriptions you want Amazon Transcribe Medical to include in your transcript. If you select a number greater than the number of alternative transcriptions generated by Amazon Transcribe Medical, only the actual number of alternative transcriptions are included. If you include MaxAlternatives in your request, you must also include ShowAlternatives with a value of true. For more information, see Alternative transcriptions.
  
• max_speaker_labels
  Type: INT32
  Provider name: MaxSpeakerLabels
  Description: 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.
  
• show_alternatives
  Type: BOOLEAN
  Provider name: ShowAlternatives
  Description: To include alternative transcriptions within your transcription output, include ShowAlternatives in your transcription request. If you include ShowAlternatives, you must also include MaxAlternatives, which is the maximum number of alternative transcriptions you want Amazon Transcribe Medical to generate. For more information, see Alternative transcriptions.
  
• show_speaker_labels
  Type: BOOLEAN
  Provider name: ShowSpeakerLabels
  Description: Enables speaker partitioning (diarization) in your transcription 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).
  
• vocabulary_name
  Type: STRING
  Provider name: VocabularyName
  Description: The name of the custom vocabulary you want to use when processing your medical transcription job. Custom vocabulary names are case sensitive. The language of the specified custom vocabulary must match the language code that you specify in your transcription request. If the languages do not match, the custom vocabulary isn’t applied. There are no errors or warnings associated with a language mismatch. US English (en-US) is the only valid language for Amazon Transcribe Medical.
  

specialty

Type: STRING
Provider name: Specialty
Description: Describes the medical specialty represented in your media.

start_time

Type: TIMESTAMP
Provider name: StartTime
Description: The date and time the specified medical transcription 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 transcription job that started processing at 12:32 PM UTC-7 on May 4, 2022.

tags

Type: UNORDERED_LIST_STRING

transcript

Type: STRUCT
Provider name: Transcript
Description: Provides you with the Amazon S3 URI you can use to access your transcript.

• transcript_file_uri
  Type: STRING
  Provider name: TranscriptFileUri
  Description: The Amazon S3 location of your transcript. You can use this URI to access or download your transcript. Note that this is the Amazon S3 location you specified in your request using the OutputBucketName parameter.
  

transcription_job_status

Type: STRING
Provider name: TranscriptionJobStatus
Description: Provides the status of the specified medical transcription job. If the status is COMPLETED, the job is finished and you can find the results at the location specified in TranscriptFileUri. If the status is FAILED, FailureReason provides details on why your transcription job failed.

type

Type: STRING
Provider name: Type
Description: Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.