TranscribeService / Client / get_medical_transcription_job

get_medical_transcription_job#

TranscribeService.Client.get_medical_transcription_job(**kwargs)#

Provides information about the specified medical transcription job.

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

To get a list of your medical transcription jobs, use the operation.

Request Syntax

response = client.get_medical_transcription_job(
    MedicalTranscriptionJobName='string'
)

Parameters:

MedicalTranscriptionJobName (string) –

[REQUIRED]

The name of the medical transcription job you want information about. Job names are case sensitive.

Return type:

dict

Returns:

Response Syntax

{
    'MedicalTranscriptionJob': {
        'MedicalTranscriptionJobName': 'string',
        'TranscriptionJobStatus': 'QUEUED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
        'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ'|'vi-VN'|'sv-SE'|'ab-GE'|'ast-ES'|'az-AZ'|'ba-RU'|'be-BY'|'bg-BG'|'bn-IN'|'bs-BA'|'ca-ES'|'ckb-IQ'|'ckb-IR'|'cs-CZ'|'cy-WL'|'el-GR'|'et-ET'|'eu-ES'|'fi-FI'|'gl-ES'|'gu-IN'|'ha-NG'|'hr-HR'|'hu-HU'|'hy-AM'|'is-IS'|'ka-GE'|'kab-DZ'|'kk-KZ'|'kn-IN'|'ky-KG'|'lg-IN'|'lt-LT'|'lv-LV'|'mhr-RU'|'mi-NZ'|'mk-MK'|'ml-IN'|'mn-MN'|'mr-IN'|'mt-MT'|'no-NO'|'or-IN'|'pa-IN'|'pl-PL'|'ps-AF'|'ro-RO'|'rw-RW'|'si-LK'|'sk-SK'|'sl-SI'|'so-SO'|'sr-RS'|'su-ID'|'sw-BI'|'sw-KE'|'sw-RW'|'sw-TZ'|'sw-UG'|'tl-PH'|'tt-RU'|'ug-CN'|'uk-UA'|'uz-UZ'|'wo-SN'|'zu-ZA',
        'MediaSampleRateHertz': 123,
        'MediaFormat': 'mp3'|'mp4'|'wav'|'flac'|'ogg'|'amr'|'webm'|'m4a',
        'Media': {
            'MediaFileUri': 'string',
            'RedactedMediaFileUri': 'string'
        },
        'Transcript': {
            'TranscriptFileUri': 'string'
        },
        'StartTime': datetime(2015, 1, 1),
        'CreationTime': datetime(2015, 1, 1),
        'CompletionTime': datetime(2015, 1, 1),
        'FailureReason': 'string',
        'Settings': {
            'ShowSpeakerLabels': True|False,
            'MaxSpeakerLabels': 123,
            'ChannelIdentification': True|False,
            'ShowAlternatives': True|False,
            'MaxAlternatives': 123,
            'VocabularyName': 'string'
        },
        'ContentIdentificationType': 'PHI',
        'Specialty': 'PRIMARYCARE',
        'Type': 'CONVERSATION'|'DICTATION',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- MedicalTranscriptionJob (dict) –
  
  Provides detailed information about the specified medical transcription job, including job status and, if applicable, failure reason.
  - MedicalTranscriptionJobName (string) –
    
    The name of the medical transcription job. Job names are case sensitive and must be unique within an Amazon Web Services account.
  - TranscriptionJobStatus (string) –
    
    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.
  - LanguageCode (string) –
    
    The language code used to create your medical transcription job. US English ( en-US) is the only supported language for medical transcriptions.
  - MediaSampleRateHertz (integer) –
    
    The sample rate, in hertz, of the audio track in your input media file.
  - MediaFormat (string) –
    
    The format of the input media file.
  - Media (dict) –
    
    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.
    - MediaFileUri (string) –
      
      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.
    - RedactedMediaFileUri (string) –
      
      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.
      
      Warning
      RedactedMediaFileUri produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics ( StartCallAnalyticsJob) transcription requests.
  - Transcript (dict) –
    
    Provides you with the Amazon S3 URI you can use to access your transcript.
    - TranscriptFileUri (string) –
      
      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.
  - StartTime (datetime) –
    
    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.
  - CreationTime (datetime) –
    
    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.
  - CompletionTime (datetime) –
    
    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.
  - FailureReason (string) –
    
    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 MediaFormat 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 Guidelines and 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 Guidelines and quotas.
  - Settings (dict) –
    
    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.
    - ShowSpeakerLabels (boolean) –
      
      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.
      
      You can’t include ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
      
      For more information, see Partitioning speakers (diarization).
    - MaxSpeakerLabels (integer) –
      
      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.
    - ChannelIdentification (boolean) –
      
      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.
      
      You can’t include both ShowSpeakerLabels and ChannelIdentification in the same request. Including both parameters returns a BadRequestException.
      
      For more information, see Transcribing multi-channel audio.
    - ShowAlternatives (boolean) –
      
      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.
    - MaxAlternatives (integer) –
      
      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.
    - VocabularyName (string) –
      
      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 don’t 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.
  - ContentIdentificationType (string) –
    
    Indicates whether content identification was enabled for your transcription request.
  - Specialty (string) –
    
    Describes the medical specialty represented in your media.
  - Type (string) –
    
    Indicates whether the input media is a dictation or a conversation, as specified in the StartMedicalTranscriptionJob request.
  - Tags (list) –
    
    The tags, each in the form of a key:value pair, assigned to the specified medical transcription job.
    - (dict) –
      
      Adds metadata, in the form of a key:value pair, to the specified resource.
      
      For example, you could add the tag Department:Sales to a resource to indicate that it pertains to your organization’s sales department. You can also use tags for tag-based access control.
      
      To learn more about tagging, see Tagging resources.
      - Key (string) –
        
        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’.
      - Value (string) –
        
        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.

Exceptions

TranscribeService.Client.exceptions.BadRequestException
TranscribeService.Client.exceptions.LimitExceededException
TranscribeService.Client.exceptions.InternalFailureException
TranscribeService.Client.exceptions.NotFoundException