custom_vocabulary_items
Creates, updates, deletes, gets or lists a custom_vocabulary_items resource.
Overview
| Name | custom_vocabulary_items |
| Type | Resource |
| Id | aws.lexv2_models.custom_vocabulary_items |
Fields
The following fields are returned by SELECT queries:
- list_custom_vocabulary_items
| Name | Datatype | Description |
|---|---|---|
bot_id | string | The identifier of the bot associated with this custom vocabulary. (pattern: <code>^[0-9a-zA-Z]+$</code>) |
bot_version | string | The identifier of the version of the bot associated with this custom vocabulary. (pattern: <code>^(DRAFT|[0-9]+)$</code>) |
custom_vocabulary_items | array | The custom vocabulary items from the list custom vocabulary response. |
locale_id | string | 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 . |
next_token | string | The nextToken identifier to the list custom vocabulary response. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_custom_vocabulary_items | select | bot_id, bot_version, locale_id, region | Paginated list of custom vocabulary items for a given bot locale's custom vocabulary. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
bot_id | string | The identifier of the version of the bot associated with this custom vocabulary. |
bot_version | string | The bot version of the bot to the list custom vocabulary request. |
locale_id | string | 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). |
region | string | AWS region (default: us-east-1) |
SELECT examples
- list_custom_vocabulary_items
Paginated list of custom vocabulary items for a given bot locale's custom vocabulary.
SELECT
bot_id,
bot_version,
custom_vocabulary_items,
locale_id,
next_token
FROM aws.lexv2_models.custom_vocabulary_items
WHERE bot_id = '{{ bot_id }}' -- required
AND bot_version = '{{ bot_version }}' -- required
AND locale_id = '{{ locale_id }}' -- required
AND region = '{{ region }}' -- required
;