@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonLexModelsV2 extends Object implements AmazonLexModelsV2
AmazonLexModelsV2
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
BuildBotLocaleResult |
buildBotLocale(BuildBotLocaleRequest request)
Builds a bot, its intents, and its slot types into a specific locale.
|
CreateBotResult |
createBot(CreateBotRequest request)
Creates an Amazon Lex conversational bot.
|
CreateBotAliasResult |
createBotAlias(CreateBotAliasRequest request)
Creates an alias for the specified version of a bot.
|
CreateBotLocaleResult |
createBotLocale(CreateBotLocaleRequest request)
Creates a locale in the bot.
|
CreateBotVersionResult |
createBotVersion(CreateBotVersionRequest request)
Creates a new version of the bot based on the
DRAFT version. |
CreateIntentResult |
createIntent(CreateIntentRequest request)
Creates an intent.
|
CreateSlotResult |
createSlot(CreateSlotRequest request)
Creates a slot in an intent.
|
CreateSlotTypeResult |
createSlotType(CreateSlotTypeRequest request)
Creates a custom slot type
|
DeleteBotResult |
deleteBot(DeleteBotRequest request)
Deletes all versions of a bot, including the
Draft version. |
DeleteBotAliasResult |
deleteBotAlias(DeleteBotAliasRequest request)
Deletes the specified bot alias.
|
DeleteBotLocaleResult |
deleteBotLocale(DeleteBotLocaleRequest request)
Removes a locale from a bot.
|
DeleteBotVersionResult |
deleteBotVersion(DeleteBotVersionRequest request)
Deletes a specific version of a bot.
|
DeleteIntentResult |
deleteIntent(DeleteIntentRequest request)
Removes the specified intent.
|
DeleteSlotResult |
deleteSlot(DeleteSlotRequest request)
Deletes the specified slot from an intent.
|
DeleteSlotTypeResult |
deleteSlotType(DeleteSlotTypeRequest request)
Deletes a slot type from a bot locale.
|
DescribeBotResult |
describeBot(DescribeBotRequest request)
Provides metadata information about a bot.
|
DescribeBotAliasResult |
describeBotAlias(DescribeBotAliasRequest request)
Get information about a specific bot alias.
|
DescribeBotLocaleResult |
describeBotLocale(DescribeBotLocaleRequest request)
Describes the settings that a bot has for a specific locale.
|
DescribeBotVersionResult |
describeBotVersion(DescribeBotVersionRequest request)
Provides metadata about a version of a bot.
|
DescribeIntentResult |
describeIntent(DescribeIntentRequest request)
Returns metadata about an intent.
|
DescribeSlotResult |
describeSlot(DescribeSlotRequest request)
Gets metadata information about a slot.
|
DescribeSlotTypeResult |
describeSlotType(DescribeSlotTypeRequest request)
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 request)
Gets a list of aliases for the specified bot.
|
ListBotLocalesResult |
listBotLocales(ListBotLocalesRequest request)
Gets a list of locales for the specified bot.
|
ListBotsResult |
listBots(ListBotsRequest request)
Gets a list of available bots.
|
ListBotVersionsResult |
listBotVersions(ListBotVersionsRequest request)
Gets information about all of the versions of a bot.
|
ListBuiltInIntentsResult |
listBuiltInIntents(ListBuiltInIntentsRequest request)
Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.
|
ListBuiltInSlotTypesResult |
listBuiltInSlotTypes(ListBuiltInSlotTypesRequest request)
Gets a list of built-in slot types that meet the specified criteria.
|
ListIntentsResult |
listIntents(ListIntentsRequest request)
Get a list of intents that meet the specified criteria.
|
ListSlotsResult |
listSlots(ListSlotsRequest request)
Gets a list of slots that match the specified criteria.
|
ListSlotTypesResult |
listSlotTypes(ListSlotTypesRequest request)
Gets a list of slot types that match the specified criteria.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
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 request)
Adds the specified tags to the specified resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from a bot, bot alias, or bot channel.
|
UpdateBotResult |
updateBot(UpdateBotRequest request)
Updates the configuration of an existing bot.
|
UpdateBotAliasResult |
updateBotAlias(UpdateBotAliasRequest request)
Updates the configuration of an existing bot alias.
|
UpdateBotLocaleResult |
updateBotLocale(UpdateBotLocaleRequest request)
Updates the settings that a bot has for a specific locale.
|
UpdateIntentResult |
updateIntent(UpdateIntentRequest request)
Updates the settings for an intent.
|
UpdateSlotResult |
updateSlot(UpdateSlotRequest request)
Updates the settings for a slot.
|
UpdateSlotTypeResult |
updateSlotType(UpdateSlotTypeRequest request)
Updates the configuration of an existing slot type.
|
public BuildBotLocaleResult buildBotLocale(BuildBotLocaleRequest request)
AmazonLexModelsV2
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.
buildBotLocale
in interface AmazonLexModelsV2
public CreateBotResult createBot(CreateBotRequest request)
AmazonLexModelsV2
Creates an Amazon Lex conversational bot.
createBot
in interface AmazonLexModelsV2
public CreateBotAliasResult createBotAlias(CreateBotAliasRequest request)
AmazonLexModelsV2
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.
createBotAlias
in interface AmazonLexModelsV2
public CreateBotLocaleResult createBotLocale(CreateBotLocaleRequest request)
AmazonLexModelsV2
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.
createBotLocale
in interface AmazonLexModelsV2
public CreateBotVersionResult createBotVersion(CreateBotVersionRequest request)
AmazonLexModelsV2
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.
createBotVersion
in interface AmazonLexModelsV2
public CreateIntentResult createIntent(CreateIntentRequest request)
AmazonLexModelsV2
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?"
createIntent
in interface AmazonLexModelsV2
public CreateSlotResult createSlot(CreateSlotRequest request)
AmazonLexModelsV2
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.
createSlot
in interface AmazonLexModelsV2
public CreateSlotTypeResult createSlotType(CreateSlotTypeRequest request)
AmazonLexModelsV2
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.
createSlotType
in interface AmazonLexModelsV2
public DeleteBotResult deleteBot(DeleteBotRequest request)
AmazonLexModelsV2
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
.
deleteBot
in interface AmazonLexModelsV2
public DeleteBotAliasResult deleteBotAlias(DeleteBotAliasRequest request)
AmazonLexModelsV2
Deletes the specified bot alias.
deleteBotAlias
in interface AmazonLexModelsV2
public DeleteBotLocaleResult deleteBotLocale(DeleteBotLocaleRequest request)
AmazonLexModelsV2
Removes a locale from a bot.
When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.
deleteBotLocale
in interface AmazonLexModelsV2
public DeleteBotVersionResult deleteBotVersion(DeleteBotVersionRequest request)
AmazonLexModelsV2
Deletes a specific version of a bot. To delete all version of a bot, use the DeleteBot operation.
deleteBotVersion
in interface AmazonLexModelsV2
public DeleteIntentResult deleteIntent(DeleteIntentRequest request)
AmazonLexModelsV2
Removes the specified intent.
Deleting an intent also deletes the slots associated with the intent.
deleteIntent
in interface AmazonLexModelsV2
public DeleteSlotResult deleteSlot(DeleteSlotRequest request)
AmazonLexModelsV2
Deletes the specified slot from an intent.
deleteSlot
in interface AmazonLexModelsV2
public DeleteSlotTypeResult deleteSlotType(DeleteSlotTypeRequest request)
AmazonLexModelsV2
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
.
deleteSlotType
in interface AmazonLexModelsV2
public DescribeBotResult describeBot(DescribeBotRequest request)
AmazonLexModelsV2
Provides metadata information about a bot.
describeBot
in interface AmazonLexModelsV2
public DescribeBotAliasResult describeBotAlias(DescribeBotAliasRequest request)
AmazonLexModelsV2
Get information about a specific bot alias.
describeBotAlias
in interface AmazonLexModelsV2
public DescribeBotLocaleResult describeBotLocale(DescribeBotLocaleRequest request)
AmazonLexModelsV2
Describes the settings that a bot has for a specific locale.
describeBotLocale
in interface AmazonLexModelsV2
public DescribeBotVersionResult describeBotVersion(DescribeBotVersionRequest request)
AmazonLexModelsV2
Provides metadata about a version of a bot.
describeBotVersion
in interface AmazonLexModelsV2
public DescribeIntentResult describeIntent(DescribeIntentRequest request)
AmazonLexModelsV2
Returns metadata about an intent.
describeIntent
in interface AmazonLexModelsV2
public DescribeSlotResult describeSlot(DescribeSlotRequest request)
AmazonLexModelsV2
Gets metadata information about a slot.
describeSlot
in interface AmazonLexModelsV2
public DescribeSlotTypeResult describeSlotType(DescribeSlotTypeRequest request)
AmazonLexModelsV2
Gets metadata information about a slot type.
describeSlotType
in interface AmazonLexModelsV2
public ListBotAliasesResult listBotAliases(ListBotAliasesRequest request)
AmazonLexModelsV2
Gets a list of aliases for the specified bot.
listBotAliases
in interface AmazonLexModelsV2
public ListBotLocalesResult listBotLocales(ListBotLocalesRequest request)
AmazonLexModelsV2
Gets a list of locales for the specified bot.
listBotLocales
in interface AmazonLexModelsV2
public ListBotVersionsResult listBotVersions(ListBotVersionsRequest request)
AmazonLexModelsV2
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.
listBotVersions
in interface AmazonLexModelsV2
public ListBotsResult listBots(ListBotsRequest request)
AmazonLexModelsV2
Gets a list of available bots.
listBots
in interface AmazonLexModelsV2
public ListBuiltInIntentsResult listBuiltInIntents(ListBuiltInIntentsRequest request)
AmazonLexModelsV2
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.
listBuiltInIntents
in interface AmazonLexModelsV2
public ListBuiltInSlotTypesResult listBuiltInSlotTypes(ListBuiltInSlotTypesRequest request)
AmazonLexModelsV2
Gets a list of built-in slot types that meet the specified criteria.
listBuiltInSlotTypes
in interface AmazonLexModelsV2
public ListIntentsResult listIntents(ListIntentsRequest request)
AmazonLexModelsV2
Get a list of intents that meet the specified criteria.
listIntents
in interface AmazonLexModelsV2
public ListSlotTypesResult listSlotTypes(ListSlotTypesRequest request)
AmazonLexModelsV2
Gets a list of slot types that match the specified criteria.
listSlotTypes
in interface AmazonLexModelsV2
public ListSlotsResult listSlots(ListSlotsRequest request)
AmazonLexModelsV2
Gets a list of slots that match the specified criteria.
listSlots
in interface AmazonLexModelsV2
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AmazonLexModelsV2
Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.
listTagsForResource
in interface AmazonLexModelsV2
public TagResourceResult tagResource(TagResourceRequest request)
AmazonLexModelsV2
Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
tagResource
in interface AmazonLexModelsV2
public UntagResourceResult untagResource(UntagResourceRequest request)
AmazonLexModelsV2
Removes tags from a bot, bot alias, or bot channel.
untagResource
in interface AmazonLexModelsV2
public UpdateBotResult updateBot(UpdateBotRequest request)
AmazonLexModelsV2
Updates the configuration of an existing bot.
updateBot
in interface AmazonLexModelsV2
public UpdateBotAliasResult updateBotAlias(UpdateBotAliasRequest request)
AmazonLexModelsV2
Updates the configuration of an existing bot alias.
updateBotAlias
in interface AmazonLexModelsV2
public UpdateBotLocaleResult updateBotLocale(UpdateBotLocaleRequest request)
AmazonLexModelsV2
Updates the settings that a bot has for a specific locale.
updateBotLocale
in interface AmazonLexModelsV2
public UpdateIntentResult updateIntent(UpdateIntentRequest request)
AmazonLexModelsV2
Updates the settings for an intent.
updateIntent
in interface AmazonLexModelsV2
public UpdateSlotResult updateSlot(UpdateSlotRequest request)
AmazonLexModelsV2
Updates the settings for a slot.
updateSlot
in interface AmazonLexModelsV2
public UpdateSlotTypeResult updateSlotType(UpdateSlotTypeRequest request)
AmazonLexModelsV2
Updates the configuration of an existing slot type.
updateSlotType
in interface AmazonLexModelsV2
public void shutdown()
AmazonLexModelsV2
shutdown
in interface AmazonLexModelsV2
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonLexModelsV2
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.
getCachedResponseMetadata
in interface AmazonLexModelsV2
request
- The originally executed request.