update_medical_vocabulary

update_medical_vocabulary(**kwargs)

Updates an existing custom medical vocabulary with new values. This operation overwrites all existing information with your new values; you cannot append new terms onto an existing custom vocabulary.

See also: AWS API Documentation

Request Syntax

response = client.update_medical_vocabulary(
    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',
    VocabularyFileUri='string'
)
Parameters
  • VocabularyName (string) --

    [REQUIRED]

    The name of the custom medical vocabulary you want to update. Custom medical vocabulary names are case sensitive.

  • LanguageCode (string) --

    [REQUIRED]

    The language code that represents the language of the entries in the custom vocabulary you want to update. US English ( en-US ) is the only language supported with Amazon Transcribe Medical.

  • VocabularyFileUri (string) --

    [REQUIRED]

    The Amazon S3 location of the text file that contains your custom medical vocabulary. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

    Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-vocab-file.txt

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

Response Structure

  • (dict) --

    • VocabularyName (string) --

      The name of the updated custom medical vocabulary.

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

    • LastModifiedTime (datetime) --

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

      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.

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

Exceptions

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