[ aws . transcribe ]

list-vocabularies

Description

Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-vocabularies
[--next-token <value>]
[--max-results <value>]
[--state-equals <value>]
[--name-contains <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--next-token (string)

If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.

--max-results (integer)

The maximum number of vocabularies to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

--state-equals (string)

When specified, only returns vocabularies with the VocabularyState field equal to the specified state.

Possible values:

• PENDING

• READY

• FAILED

--name-contains (string)

When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is not case sensitive, ListVocabularies returns both “vocabularyname” and “VocabularyName” in the response list.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To list your custom vocabularies

The following list-vocabularies example lists the custom vocabularies associated with your AWS account and Region.

aws transcribe list-vocabularies

Output:

{
    "NextToken": "NextToken",
    "Vocabularies": [
        {
            "VocabularyName": "ards-test-1",
            "LanguageCode": "language-code",
            "LastModifiedTime": "2020-04-27T22:00:27.330000+00:00",
            "VocabularyState": "READY"
        },
        {
            "VocabularyName": "sample-test",
            "LanguageCode": "language-code",
            "LastModifiedTime": "2020-04-24T23:04:11.044000+00:00",
            "VocabularyState": "READY"
        },
        {
            "VocabularyName": "CRLF-to-LF-test-3-1",
            "LanguageCode": "language-code",
            "LastModifiedTime": "2020-04-24T22:12:22.277000+00:00",
            "VocabularyState": "READY"
        },
        {
            "VocabularyName": "CRLF-to-LF-test-2",
            "LanguageCode": "language-code",
            "LastModifiedTime": "2020-04-24T21:53:50.455000+00:00",
            "VocabularyState": "READY"
        },
        {
            "VocabularyName": "CRLF-to-LF-1-1",
            "LanguageCode": "language-code",
            "LastModifiedTime": "2020-04-24T21:39:33.356000+00:00",
            "VocabularyState": "READY"
        }
    ]
}

For more information, see Custom Vocabularies in the Amazon Transcribe Developer Guide.

Output

Status -> (string)

The requested vocabulary state.

NextToken -> (string)

The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set in the MaxResults parameter. If there are more jobs in the list than will fit on the page, Amazon Transcribe returns the NextPage token. To return in the next page of jobs, include the token in the next request to the ListVocabularies operation.

Vocabularies -> (list)

A list of objects that describe the vocabularies that match the search criteria in the request.

(structure)

Provides information about a custom vocabulary.

VocabularyName -> (string)

The name of the vocabulary.

LanguageCode -> (string)

The language code of the vocabulary entries.

LastModifiedTime -> (timestamp)

The date and time that the vocabulary was last modified.

VocabularyState -> (string)

The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.