TranscribeService / Client / get_medical_vocabulary

get_medical_vocabulary#

TranscribeService.Client.get_medical_vocabulary(**kwargs)#

Provides information about the specified custom medical vocabulary.

To view the status of the specified custom medical vocabulary, check the VocabularyState field. If the status is READY, your custom vocabulary is available to use. If the status is FAILED, FailureReason provides details on why your vocabulary failed.

To get a list of your custom medical vocabularies, use the operation.

See also: AWS API Documentation

Request Syntax

response = client.get_medical_vocabulary(
    VocabularyName='string'
)
Parameters:

VocabularyName (string) –

[REQUIRED]

The name of the custom medical vocabulary you want information about. Custom medical vocabulary names are case sensitive.

Return type:

dict

Returns:

Response Syntax

{
    'VocabularyName': 'string',
    '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',
    'VocabularyState': 'PENDING'|'READY'|'FAILED',
    'LastModifiedTime': datetime(2015, 1, 1),
    'FailureReason': 'string',
    'DownloadUri': 'string'
}

Response Structure

  • (dict) –

    • VocabularyName (string) –

      The name of the custom medical vocabulary you requested information about.

    • LanguageCode (string) –

      The language code you selected for your custom medical vocabulary. US English ( en-US) is the only language supported with Amazon Transcribe Medical.

    • VocabularyState (string) –

      The processing state of your custom medical vocabulary. If the state is READY, you can use the custom vocabulary in a StartMedicalTranscriptionJob request.

    • LastModifiedTime (datetime) –

      The date and time the specified custom medical vocabulary was last modified.

      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 12:32 PM UTC-7 on May 4, 2022.

    • FailureReason (string) –

      If VocabularyState is FAILED, FailureReason contains information about why the custom medical vocabulary request failed. See also: Common Errors.

    • DownloadUri (string) –

      The S3 location where the specified custom medical vocabulary is stored; use this URI to view or download the custom vocabulary.

Exceptions

  • TranscribeService.Client.exceptions.NotFoundException

  • TranscribeService.Client.exceptions.LimitExceededException

  • TranscribeService.Client.exceptions.InternalFailureException

  • TranscribeService.Client.exceptions.BadRequestException