update_vocabulary

update_vocabulary(**kwargs)

Updates an existing custom 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_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',
    Phrases=[
        'string',
    ],
    VocabularyFileUri='string',
    DataAccessRoleArn='string'
)

Parameters

• VocabularyName (string) --

  [REQUIRED]

  The name of the custom vocabulary you want to update. Custom 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. Each custom vocabulary must contain terms in only one language.

  A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For example, if you create a custom vocabulary using US English ( en-US ), you can only apply this custom vocabulary to files that contain English audio.

  For a list of supported languages and their associated language codes, refer to the Supported languages table.

• Phrases (list) --

  Use this parameter if you want to update your custom vocabulary by including all desired terms, as comma-separated values, within your request. The other option for updating your custom vocabulary is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the VocabularyFileUri parameter.

  Note that if you include Phrases in your request, you cannot use VocabularyFileUri ; you must choose one or the other.

  Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to Character Sets for Custom Vocabularies to get the character set for your language.

  • (string) --
• VocabularyFileUri (string) --

  The Amazon S3 location of the text file that contains your custom 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

  Note that if you include VocabularyFileUri in your request, you cannot use the Phrases flag; you must choose one or the other.

• DataAccessRoleArn (string) --

  The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, 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.

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

  • LanguageCode (string) --

    The language code you selected for your custom vocabulary.

  • LastModifiedTime (datetime) --

    The date and time the specified custom 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 vocabulary. If the state is READY , you can use the custom vocabulary in a StartTranscriptionJob request.

Exceptions

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