@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonLexModelsV2
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonLexModelsV2 instead.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
BuildBotLocaleResult |
buildBotLocale(BuildBotLocaleRequest buildBotLocaleRequest)
Builds a bot, its intents, and its slot types into a specific locale.
|
CreateBotResult |
createBot(CreateBotRequest createBotRequest)
Creates an Amazon Lex conversational bot.
|
CreateBotAliasResult |
createBotAlias(CreateBotAliasRequest createBotAliasRequest)
Creates an alias for the specified version of a bot.
|
CreateBotLocaleResult |
createBotLocale(CreateBotLocaleRequest createBotLocaleRequest)
Creates a locale in the bot.
|
CreateBotVersionResult |
createBotVersion(CreateBotVersionRequest createBotVersionRequest)
Creates a new version of the bot based on the
DRAFT version. |
CreateIntentResult |
createIntent(CreateIntentRequest createIntentRequest)
Creates an intent.
|
CreateSlotResult |
createSlot(CreateSlotRequest createSlotRequest)
Creates a slot in an intent.
|
CreateSlotTypeResult |
createSlotType(CreateSlotTypeRequest createSlotTypeRequest)
Creates a custom slot type
|
DeleteBotResult |
deleteBot(DeleteBotRequest deleteBotRequest)
Deletes all versions of a bot, including the
Draft version. |
DeleteBotAliasResult |
deleteBotAlias(DeleteBotAliasRequest deleteBotAliasRequest)
Deletes the specified bot alias.
|
DeleteBotLocaleResult |
deleteBotLocale(DeleteBotLocaleRequest deleteBotLocaleRequest)
Removes a locale from a bot.
|
DeleteBotVersionResult |
deleteBotVersion(DeleteBotVersionRequest deleteBotVersionRequest)
Deletes a specific version of a bot.
|
DeleteIntentResult |
deleteIntent(DeleteIntentRequest deleteIntentRequest)
Removes the specified intent.
|
DeleteSlotResult |
deleteSlot(DeleteSlotRequest deleteSlotRequest)
Deletes the specified slot from an intent.
|
DeleteSlotTypeResult |
deleteSlotType(DeleteSlotTypeRequest deleteSlotTypeRequest)
Deletes a slot type from a bot locale.
|
DescribeBotResult |
describeBot(DescribeBotRequest describeBotRequest)
Provides metadata information about a bot.
|
DescribeBotAliasResult |
describeBotAlias(DescribeBotAliasRequest describeBotAliasRequest)
Get information about a specific bot alias.
|
DescribeBotLocaleResult |
describeBotLocale(DescribeBotLocaleRequest describeBotLocaleRequest)
Describes the settings that a bot has for a specific locale.
|
DescribeBotVersionResult |
describeBotVersion(DescribeBotVersionRequest describeBotVersionRequest)
Provides metadata about a version of a bot.
|
DescribeIntentResult |
describeIntent(DescribeIntentRequest describeIntentRequest)
Returns metadata about an intent.
|
DescribeSlotResult |
describeSlot(DescribeSlotRequest describeSlotRequest)
Gets metadata information about a slot.
|
DescribeSlotTypeResult |
describeSlotType(DescribeSlotTypeRequest describeSlotTypeRequest)
Gets metadata information about a slot type.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListBotAliasesResult |
listBotAliases(ListBotAliasesRequest listBotAliasesRequest)
Gets a list of aliases for the specified bot.
|
ListBotLocalesResult |
listBotLocales(ListBotLocalesRequest listBotLocalesRequest)
Gets a list of locales for the specified bot.
|
ListBotsResult |
listBots(ListBotsRequest listBotsRequest)
Gets a list of available bots.
|
ListBotVersionsResult |
listBotVersions(ListBotVersionsRequest listBotVersionsRequest)
Gets information about all of the versions of a bot.
|
ListBuiltInIntentsResult |
listBuiltInIntents(ListBuiltInIntentsRequest listBuiltInIntentsRequest)
Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
|
ListBuiltInSlotTypesResult |
listBuiltInSlotTypes(ListBuiltInSlotTypesRequest listBuiltInSlotTypesRequest)
Gets a list of built-in slot types that meet the specified criteria.
|
ListIntentsResult |
listIntents(ListIntentsRequest listIntentsRequest)
Get a list of intents that meet the specified criteria.
|
ListSlotsResult |
listSlots(ListSlotsRequest listSlotsRequest)
Gets a list of slots that match the specified criteria.
|
ListSlotTypesResult |
listSlotTypes(ListSlotTypesRequest listSlotTypesRequest)
Gets a list of slot types that match the specified criteria.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a bot, bot alias, or bot channel.
|
UpdateBotResult |
updateBot(UpdateBotRequest updateBotRequest)
Updates the configuration of an existing bot.
|
UpdateBotAliasResult |
updateBotAlias(UpdateBotAliasRequest updateBotAliasRequest)
Updates the configuration of an existing bot alias.
|
UpdateBotLocaleResult |
updateBotLocale(UpdateBotLocaleRequest updateBotLocaleRequest)
Updates the settings that a bot has for a specific locale.
|
UpdateIntentResult |
updateIntent(UpdateIntentRequest updateIntentRequest)
Updates the settings for an intent.
|
UpdateSlotResult |
updateSlot(UpdateSlotRequest updateSlotRequest)
Updates the settings for a slot.
|
UpdateSlotTypeResult |
updateSlotType(UpdateSlotTypeRequest updateSlotTypeRequest)
Updates the configuration of an existing slot type.
|
static final String ENDPOINT_PREFIX
BuildBotLocaleResult buildBotLocale(BuildBotLocaleRequest buildBotLocaleRequest)
Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.
buildBotLocaleRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionCreateBotResult createBot(CreateBotRequest createBotRequest)
Creates an Amazon Lex conversational bot.
createBotRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionCreateBotAliasResult createBotAlias(CreateBotAliasRequest createBotAliasRequest)
Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.
For example, you can create an alias called "PROD" that your applications use to call the Amazon Lex bot.
createBotAliasRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionCreateBotLocaleResult createBotLocale(CreateBotLocaleRequest createBotLocaleRequest)
Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.
createBotLocaleRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionCreateBotVersionResult createBotVersion(CreateBotVersionRequest createBotVersionRequest)
Creates a new version of the bot based on the DRAFT version. If the DRAFT version of
this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version, it
returns the last created version.
When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1.
createBotVersionRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionCreateIntentResult createIntent(CreateIntentRequest createIntentRequest)
Creates an intent.
To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza
ordering bot you would create an OrderPizza intent.
When you create an intent, you must provide a name. You can optionally provide the following:
Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.
Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.
How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.
A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"
A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."
A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"
createIntentRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionCreateSlotResult createSlot(CreateSlotRequest createSlotRequest)
Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an
OrderPizza intent might need slots for size, crust, and number of pizzas. For each slot, you define
one or more utterances that Amazon Lex uses to elicit a response from the user.
createSlotRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionCreateSlotTypeResult createSlotType(CreateSlotTypeRequest createSlotTypeRequest)
Creates a custom slot type
To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.
createSlotTypeRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionDeleteBotResult deleteBot(DeleteBotRequest deleteBotRequest)
Deletes all versions of a bot, including the Draft version. To delete a specific version, use the
DeleteBotVersion operation.
When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot.
If a bot has an alias, the DeleteBot operation returns a ResourceInUseException
exception. If you want to delete the bot and the alias, set the skipResourceInUseCheck parameter to
true.
deleteBotRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionConflictExceptionPreconditionFailedExceptionInternalServerExceptionDeleteBotAliasResult deleteBotAlias(DeleteBotAliasRequest deleteBotAliasRequest)
Deletes the specified bot alias.
deleteBotAliasRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionConflictExceptionPreconditionFailedExceptionInternalServerExceptionDeleteBotLocaleResult deleteBotLocale(DeleteBotLocaleRequest deleteBotLocaleRequest)
Removes a locale from a bot.
When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.
deleteBotLocaleRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionDeleteBotVersionResult deleteBotVersion(DeleteBotVersionRequest deleteBotVersionRequest)
Deletes a specific version of a bot. To delete all version of a bot, use the DeleteBot operation.
deleteBotVersionRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionConflictExceptionPreconditionFailedExceptionInternalServerExceptionDeleteIntentResult deleteIntent(DeleteIntentRequest deleteIntentRequest)
Removes the specified intent.
Deleting an intent also deletes the slots associated with the intent.
deleteIntentRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionConflictExceptionPreconditionFailedExceptionInternalServerExceptionDeleteSlotResult deleteSlot(DeleteSlotRequest deleteSlotRequest)
Deletes the specified slot from an intent.
deleteSlotRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionConflictExceptionPreconditionFailedExceptionInternalServerExceptionDeleteSlotTypeResult deleteSlotType(DeleteSlotTypeRequest deleteSlotTypeRequest)
Deletes a slot type from a bot locale.
If a slot is using the slot type, Amazon Lex throws a ResourceInUseException exception. To avoid the
exception, set the skipResourceInUseCheck parameter to true.
deleteSlotTypeRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionConflictExceptionPreconditionFailedExceptionInternalServerExceptionDescribeBotResult describeBot(DescribeBotRequest describeBotRequest)
Provides metadata information about a bot.
describeBotRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionResourceNotFoundExceptionInternalServerExceptionDescribeBotAliasResult describeBotAlias(DescribeBotAliasRequest describeBotAliasRequest)
Get information about a specific bot alias.
describeBotAliasRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionResourceNotFoundExceptionInternalServerExceptionDescribeBotLocaleResult describeBotLocale(DescribeBotLocaleRequest describeBotLocaleRequest)
Describes the settings that a bot has for a specific locale.
describeBotLocaleRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionResourceNotFoundExceptionInternalServerExceptionDescribeBotVersionResult describeBotVersion(DescribeBotVersionRequest describeBotVersionRequest)
Provides metadata about a version of a bot.
describeBotVersionRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionResourceNotFoundExceptionInternalServerExceptionDescribeIntentResult describeIntent(DescribeIntentRequest describeIntentRequest)
Returns metadata about an intent.
describeIntentRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionResourceNotFoundExceptionInternalServerExceptionDescribeSlotResult describeSlot(DescribeSlotRequest describeSlotRequest)
Gets metadata information about a slot.
describeSlotRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionResourceNotFoundExceptionInternalServerExceptionDescribeSlotTypeResult describeSlotType(DescribeSlotTypeRequest describeSlotTypeRequest)
Gets metadata information about a slot type.
describeSlotTypeRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionResourceNotFoundExceptionInternalServerExceptionListBotAliasesResult listBotAliases(ListBotAliasesRequest listBotAliasesRequest)
Gets a list of aliases for the specified bot.
listBotAliasesRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionInternalServerExceptionListBotLocalesResult listBotLocales(ListBotLocalesRequest listBotLocalesRequest)
Gets a list of locales for the specified bot.
listBotLocalesRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionInternalServerExceptionListBotVersionsResult listBotVersions(ListBotVersionsRequest listBotVersionsRequest)
Gets information about all of the versions of a bot.
The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has
three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered
version and one for the DRAFT version.
The ListBotVersions operation always returns at least one version, the DRAFT version.
listBotVersionsRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionInternalServerExceptionListBotsResult listBots(ListBotsRequest listBotsRequest)
Gets a list of available bots.
listBotsRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionInternalServerExceptionListBuiltInIntentsResult listBuiltInIntents(ListBuiltInIntentsRequest listBuiltInIntentsRequest)
Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
To use a built-in intent as a the base for your own intent, include the built-in intent signature in the
parentIntentSignature parameter when you call the CreateIntent operation. For more
information, see CreateIntent.
listBuiltInIntentsRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionInternalServerExceptionListBuiltInSlotTypesResult listBuiltInSlotTypes(ListBuiltInSlotTypesRequest listBuiltInSlotTypesRequest)
Gets a list of built-in slot types that meet the specified criteria.
listBuiltInSlotTypesRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionInternalServerExceptionListIntentsResult listIntents(ListIntentsRequest listIntentsRequest)
Get a list of intents that meet the specified criteria.
listIntentsRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionInternalServerExceptionListSlotTypesResult listSlotTypes(ListSlotTypesRequest listSlotTypesRequest)
Gets a list of slot types that match the specified criteria.
listSlotTypesRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionInternalServerExceptionListSlotsResult listSlots(ListSlotsRequest listSlotsRequest)
Gets a list of slots that match the specified criteria.
listSlotsRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionInternalServerExceptionListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.
listTagsForResourceRequest - InternalServerExceptionThrottlingExceptionResourceNotFoundExceptionValidationExceptionTagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
tagResourceRequest - InternalServerExceptionThrottlingExceptionResourceNotFoundExceptionValidationExceptionUntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a bot, bot alias, or bot channel.
untagResourceRequest - InternalServerExceptionThrottlingExceptionResourceNotFoundExceptionValidationExceptionUpdateBotResult updateBot(UpdateBotRequest updateBotRequest)
Updates the configuration of an existing bot.
updateBotRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionUpdateBotAliasResult updateBotAlias(UpdateBotAliasRequest updateBotAliasRequest)
Updates the configuration of an existing bot alias.
updateBotAliasRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionUpdateBotLocaleResult updateBotLocale(UpdateBotLocaleRequest updateBotLocaleRequest)
Updates the settings that a bot has for a specific locale.
updateBotLocaleRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionUpdateIntentResult updateIntent(UpdateIntentRequest updateIntentRequest)
Updates the settings for an intent.
updateIntentRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionUpdateSlotResult updateSlot(UpdateSlotRequest updateSlotRequest)
Updates the settings for a slot.
updateSlotRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionUpdateSlotTypeResult updateSlotType(UpdateSlotTypeRequest updateSlotTypeRequest)
Updates the configuration of an existing slot type.
updateSlotTypeRequest - ThrottlingExceptionServiceQuotaExceededExceptionValidationExceptionPreconditionFailedExceptionConflictExceptionInternalServerExceptionvoid shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.