ListVocabularies - Amazon Transcribe

ListVocabularies

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

Request Syntax

{ "MaxResults": number, "NameContains": "string", "NextToken": "string", "StateEquals": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NameContains

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z._-]+

Required: No

NextToken

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

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .+

Required: No

StateEquals

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

Type: String

Valid Values: PENDING | READY | FAILED

Required: No

Response Syntax

{ "NextToken": "string", "Status": "string", "Vocabularies": [ { "LanguageCode": "string", "LastModifiedTime": number, "VocabularyName": "string", "VocabularyState": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .+

Status

The requested vocabulary state.

Type: String

Valid Values: PENDING | READY | FAILED

Vocabularies

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

Type: Array of VocabularyInfo objects

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

Your request didn't pass one or more validation tests. For example, if the entity that you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's "in progress"). See the exception Message field for more information.

HTTP Status Code: 400

InternalFailureException

There was an internal error. Check the error message and try your request again.

HTTP Status Code: 500

LimitExceededException

Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: