TranscribeService / Client / list_vocabularies

list_vocabularies

TranscribeService.Client.list_vocabularies(**kwargs)

Provides a list of custom vocabularies that match the specified criteria. If no criteria are specified, all custom vocabularies are returned.

To get detailed information about a specific custom vocabulary, use the operation.

See also: AWS API Documentation

Request Syntax

response = client.list_vocabularies(
    NextToken='string',
    MaxResults=123,
    StateEquals='PENDING'|'READY'|'FAILED',
    NameContains='string'
)

Parameters:

• NextToken (string) – If your ListVocabularies request returns more results than can be displayed, NextToken is displayed in the response with an associated string. To get the next page of results, copy this string and repeat your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.

• MaxResults (integer) – The maximum number of custom vocabularies to return in each page of results. If there are fewer results than the value that you specify, only the actual results are returned. If you don’t specify a value, a default of 5 is used.

• StateEquals (string) – Returns only custom vocabularies with the specified state. Vocabularies are ordered by creation date, with the newest vocabulary first. If you don’t include StateEquals, all custom medical vocabularies are returned.

• NameContains (string) – Returns only the custom vocabularies that contain the specified string. The search is not case sensitive.

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'PENDING'|'READY'|'FAILED',
    'NextToken': 'string',
    'Vocabularies': [
        {
            '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) –

  • Status (string) –

    Lists all custom vocabularies that have the status specified in your request. Vocabularies are ordered by creation date, with the newest vocabulary first.

  • NextToken (string) –

    If NextToken is present in your response, it indicates that not all results are displayed. To view the next set of results, copy the string associated with the NextToken parameter in your results output, then run your request again including NextToken with the value of the copied string. Repeat as needed to view all your results.

  • Vocabularies (list) –

    Provides information about the custom vocabularies that match the criteria specified in your request.

    • (dict) –

      Provides information about a custom vocabulary, including the language of the custom vocabulary, when it was last modified, its name, and the processing state.

      • VocabularyName (string) –

        A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account.

      • LanguageCode (string) –

        The language code used to create your custom vocabulary. 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.

      • LastModifiedTime (datetime) –

        The date and time the specified custom 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.

      • 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