custom_vocabulary_metadatas
Creates, updates, deletes, gets or lists a custom_vocabulary_metadatas resource.
Overview
| Name | custom_vocabulary_metadatas |
| Type | Resource |
| Id | aws.lexv2_models.custom_vocabulary_metadatas |
Fields
The following fields are returned by SELECT queries:
- describe_custom_vocabulary_metadata
| Name | Datatype | Description |
|---|---|---|
bot_id | string | The identifier of the bot that contains the custom vocabulary. (pattern: <code>^[0-9a-zA-Z]+$</code>) |
bot_version | string | The version of the bot that contains the custom vocabulary to describe. (pattern: <code>^(DRAFT|[0-9]+)$</code>) |
creation_date_time | string (date-time) | The date and time that the custom vocabulary was created. |
custom_vocabulary_status | string | The status of the custom vocabulary. If the status is Ready the custom vocabulary is ready to use. (Ready, Deleting, Exporting, Importing, Creating) |
last_updated_date_time | string (date-time) | The date and time that the custom vocabulary was last updated. |
locale_id | string | The locale that contains the custom vocabulary to describe. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_custom_vocabulary_metadata | select | bot_id, bot_version, locale_id, region | Provides metadata information about a 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 unique identifier of the bot that contains the custom vocabulary. |
bot_version | string | The bot version of the bot to return metadata for. |
locale_id | string | The locale to return the custom vocabulary information for. The locale must be en_GB. |
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_custom_vocabulary_metadata
Provides metadata information about a custom vocabulary.
SELECT
bot_id,
bot_version,
creation_date_time,
custom_vocabulary_status,
last_updated_date_time,
locale_id
FROM aws.lexv2_models.custom_vocabulary_metadatas
WHERE bot_id = '{{ bot_id }}' -- required
AND bot_version = '{{ bot_version }}' -- required
AND locale_id = '{{ locale_id }}' -- required
AND region = '{{ region }}' -- required
;