ListCustomVocabularyItems - Amazon Lex API Reference

ListCustomVocabularyItems

Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.

Request Syntax

POST /bots/botId/botversions/botVersion/botlocales/localeId/customvocabulary/DEFAULT/list HTTP/1.1 Content-type: application/json { "maxResults": number, "nextToken": "string" }

URI Request Parameters

The request uses the following URI parameters.

botId

The identifier of the version of the bot associated with this custom vocabulary.

Length Constraints: Fixed length of 10.

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

Required: Yes

botVersion

The bot version of the bot to the list custom vocabulary request.

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

Pattern: ^(DRAFT|[0-9]+)$

Required: Yes

localeId

The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html).

Required: Yes

Request Body

The request accepts the following data in JSON format.

maxResults

The maximum number of items returned by the list operation.

Type: Integer

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

Required: No

nextToken

The nextToken identifier to the list custom vocabulary request.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "botId": "string", "botVersion": "string", "customVocabularyItems": [ { "displayAs": "string", "itemId": "string", "phrase": "string", "weight": number } ], "localeId": "string", "nextToken": "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.

botId

The identifier of the bot associated with this custom vocabulary.

Type: String

Length Constraints: Fixed length of 10.

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

botVersion

The identifier of the version of the bot associated with this custom vocabulary.

Type: String

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

Pattern: ^(DRAFT|[0-9]+)$

customVocabularyItems

The custom vocabulary items from the list custom vocabulary response.

Type: Array of CustomVocabularyItem objects

localeId

The identifier of the language and locale where this custom vocabulary is used. The string must match one of the supported locales. For more information, see Supported Languages .

Type: String

nextToken

The nextToken identifier to the list custom vocabulary response.

Type: String

Errors

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

InternalServerException

The service encountered an unexpected condition. Try your request again.

HTTP Status Code: 500

ResourceNotFoundException

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

HTTP Status Code: 404

ServiceQuotaExceededException

You have reached a quota for your bot.

HTTP Status Code: 402

ThrottlingException

Your request rate is too high. Reduce the frequency of requests.

HTTP Status Code: 429

ValidationException

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

HTTP Status Code: 400

See Also

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