@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonLexModelBuilding
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonLexModelBuilding instead.
Amazon Lex is an AWS service for building conversational voice and text interfaces. Use these actions to create, update, and delete conversational bots for new and existing client applications.
| 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 |
|---|---|
CreateBotVersionResult |
createBotVersion (CreateBotVersionRequest createBotVersionRequest)
Creates a new version of the bot based on the
$LATEST version. |
CreateIntentVersionResult |
createIntentVersion (CreateIntentVersionRequest createIntentVersionRequest)
Creates a new version of an intent based on the
$LATEST version of the intent. |
CreateSlotTypeVersionResult |
createSlotTypeVersion (CreateSlotTypeVersionRequest createSlotTypeVersionRequest)
Creates a new version of a slot type based on the
$LATEST version of the specified slot type. |
DeleteBotResult |
deleteBot (DeleteBotRequest deleteBotRequest)
Deletes all versions of the bot, including the
$LATEST version. |
DeleteBotAliasResult |
deleteBotAlias (DeleteBotAliasRequest deleteBotAliasRequest)
Deletes an alias for the specified bot.
|
DeleteBotChannelAssociationResult |
deleteBotChannelAssociation (DeleteBotChannelAssociationRequest deleteBotChannelAssociationRequest)
Deletes the association between an Amazon Lex bot and a messaging platform.
|
DeleteBotVersionResult |
deleteBotVersion (DeleteBotVersionRequest deleteBotVersionRequest)
Deletes a specific version of a bot.
|
DeleteIntentResult |
deleteIntent (DeleteIntentRequest deleteIntentRequest)
Deletes all versions of the intent, including the
$LATEST version. |
DeleteIntentVersionResult |
deleteIntentVersion (DeleteIntentVersionRequest deleteIntentVersionRequest)
Deletes a specific version of an intent.
|
DeleteSlotTypeResult |
deleteSlotType (DeleteSlotTypeRequest deleteSlotTypeRequest)
Deletes all versions of the slot type, including the
$LATEST version. |
DeleteSlotTypeVersionResult |
deleteSlotTypeVersion (DeleteSlotTypeVersionRequest deleteSlotTypeVersionRequest)
Deletes a specific version of a slot type.
|
DeleteUtterancesResult |
deleteUtterances (DeleteUtterancesRequest deleteUtterancesRequest)
Deletes stored utterances.
|
GetBotResult |
getBot (GetBotRequest getBotRequest)
Returns metadata information for a specific bot.
|
GetBotAliasResult |
getBotAlias (GetBotAliasRequest getBotAliasRequest)
Returns information about an Amazon Lex bot alias.
|
GetBotAliasesResult |
getBotAliases (GetBotAliasesRequest getBotAliasesRequest)
Returns a list of aliases for a specified Amazon Lex bot.
|
GetBotChannelAssociationResult |
getBotChannelAssociation (GetBotChannelAssociationRequest getBotChannelAssociationRequest)
Returns information about the association between an Amazon Lex bot and a messaging platform.
|
GetBotChannelAssociationsResult |
getBotChannelAssociations (GetBotChannelAssociationsRequest getBotChannelAssociationsRequest)
Returns a list of all of the channels associated with the specified bot.
|
GetBotsResult |
getBots (GetBotsRequest getBotsRequest)
Returns bot information as follows:
|
GetBotVersionsResult |
getBotVersions (GetBotVersionsRequest getBotVersionsRequest)
Gets information about all of the versions of a bot.
|
GetBuiltinIntentResult |
getBuiltinIntent (GetBuiltinIntentRequest getBuiltinIntentRequest)
Returns information about a built-in intent.
|
GetBuiltinIntentsResult |
getBuiltinIntents (GetBuiltinIntentsRequest getBuiltinIntentsRequest)
Gets a list of built-in intents that meet the specified criteria.
|
GetBuiltinSlotTypesResult |
getBuiltinSlotTypes (GetBuiltinSlotTypesRequest getBuiltinSlotTypesRequest)
Gets a list of built-in slot types that meet the specified criteria.
|
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.
|
GetExportResult |
getExport (GetExportRequest getExportRequest)
Exports the contents of a Amazon Lex resource in a specified format.
|
GetImportResult |
getImport (GetImportRequest getImportRequest)
Gets information about an import job started with the
StartImport operation. |
GetIntentResult |
getIntent (GetIntentRequest getIntentRequest)
Returns information about an intent.
|
GetIntentsResult |
getIntents (GetIntentsRequest getIntentsRequest)
Returns intent information as follows:
|
GetIntentVersionsResult |
getIntentVersions (GetIntentVersionsRequest getIntentVersionsRequest)
Gets information about all of the versions of an intent.
|
GetMigrationResult |
getMigration (GetMigrationRequest getMigrationRequest)
Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot.
|
GetMigrationsResult |
getMigrations (GetMigrationsRequest getMigrationsRequest)
Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
|
GetSlotTypeResult |
getSlotType (GetSlotTypeRequest getSlotTypeRequest)
Returns information about a specific version of a slot type.
|
GetSlotTypesResult |
getSlotTypes (GetSlotTypesRequest getSlotTypesRequest)
Returns slot type information as follows:
|
GetSlotTypeVersionsResult |
getSlotTypeVersions (GetSlotTypeVersionsRequest getSlotTypeVersionsRequest)
Gets information about all versions of a slot type.
|
GetUtterancesViewResult |
getUtterancesView (GetUtterancesViewRequest getUtterancesViewRequest)
Use the
GetUtterancesView operation to get information about the utterances that your users have
made to your bot. |
ListTagsForResourceResult |
listTagsForResource (ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with the specified resource.
|
PutBotResult |
putBot (PutBotRequest putBotRequest)
Creates an Amazon Lex conversational bot or replaces an existing bot.
|
PutBotAliasResult |
putBotAlias (PutBotAliasRequest putBotAliasRequest)
Creates an alias for the specified version of the bot or replaces an alias for the specified bot.
|
PutIntentResult |
putIntent (PutIntentRequest putIntentRequest)
Creates an intent or replaces an existing intent.
|
PutSlotTypeResult |
putSlotType (PutSlotTypeRequest putSlotTypeRequest)
Creates a custom slot type or replaces an existing custom slot type.
|
void |
shutdown ()
Shuts down this client object, releasing any resources that might be held open.
|
StartImportResult |
startImport (StartImportRequest startImportRequest)
Starts a job to import a resource to Amazon Lex.
|
StartMigrationResult |
startMigration (StartMigrationRequest startMigrationRequest)
Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2.
|
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.
|
static final String ENDPOINT_PREFIX
CreateBotVersionResult createBotVersion(CreateBotVersionRequest createBotVersionRequest)
Creates a new version of the bot based on the $LATEST version. If the $LATEST 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.
You can update only the $LATEST version of the bot. You can't update the numbered versions that you
create with the CreateBotVersion operation.
When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permission for the lex:CreateBotVersion action.
createBotVersionRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.PreconditionFailedException - The checksum of the resource that you are trying to change does not match the checksum in the request.
Check the resource's checksum and try again.CreateIntentVersionResult createIntentVersion(CreateIntentVersionRequest createIntentVersionRequest)
Creates a new version of an intent based on the $LATEST version of the intent. If the
$LATEST version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a
new version. It returns the last version you created.
You can update only the $LATEST version of the intent. You can't update the numbered versions that
you create with the CreateIntentVersion operation.
When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permissions to perform the lex:CreateIntentVersion action.
createIntentVersionRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.PreconditionFailedException - The checksum of the resource that you are trying to change does not match the checksum in the request.
Check the resource's checksum and try again.CreateSlotTypeVersionResult createSlotTypeVersion(CreateSlotTypeVersionRequest createSlotTypeVersionRequest)
Creates a new version of a slot type based on the $LATEST version of the specified slot type. If the
$LATEST version of this resource has not changed since the last version that you created, Amazon Lex
doesn't create a new version. It returns the last version that you created.
You can update only the $LATEST version of a slot type. You can't update the numbered versions that
you create with the CreateSlotTypeVersion operation.
When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.
This operation requires permissions for the lex:CreateSlotTypeVersion action.
createSlotTypeVersionRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.PreconditionFailedException - The checksum of the resource that you are trying to change does not match the checksum in the request.
Check the resource's checksum and try again.DeleteBotResult deleteBot(DeleteBotRequest deleteBotRequest)
Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the
bot, use the DeleteBotVersion operation. The DeleteBot operation doesn't immediately remove
the bot schema. Instead, it is marked for deletion and removed later.
Amazon Lex stores utterances indefinitely for improving the ability of your bot to respond to user inputs. These utterances are not removed when the bot is deleted. To remove the utterances, use the DeleteUtterances operation.
If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a
ResourceInUseException exception that includes a reference to the alias that refers to the bot. To
remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring
alias until the DeleteBot operation is successful.
This operation requires permissions for the lex:DeleteBot action.
deleteBotRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.ResourceInUseException - The resource that you are attempting to delete is referred to by another resource. Use this information
to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
DeleteBotAliasResult deleteBotAlias(DeleteBotAliasRequest deleteBotAliasRequest)
Deletes an alias for the specified bot.
You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is
used in a channel association, the DeleteBot operation returns a ResourceInUseException
exception that includes a reference to the channel association that refers to the bot. You can remove the
reference to the alias by deleting the channel association. If you get the same exception again, delete the
referring association until the DeleteBotAlias operation is successful.
deleteBotAliasRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.ResourceInUseException - The resource that you are attempting to delete is referred to by another resource. Use this information
to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
DeleteBotChannelAssociationResult deleteBotChannelAssociation(DeleteBotChannelAssociationRequest deleteBotChannelAssociationRequest)
Deletes the association between an Amazon Lex bot and a messaging platform.
This operation requires permission for the lex:DeleteBotChannelAssociation action.
deleteBotChannelAssociationRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.DeleteBotVersionResult deleteBotVersion(DeleteBotVersionRequest deleteBotVersionRequest)
Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.
This operation requires permissions for the lex:DeleteBotVersion action.
deleteBotVersionRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.ResourceInUseException - The resource that you are attempting to delete is referred to by another resource. Use this information
to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
DeleteIntentResult deleteIntent(DeleteIntentRequest deleteIntentRequest)
Deletes all versions of the intent, including the $LATEST version. To delete a specific version of
the intent, use the DeleteIntentVersion operation.
You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first.
If you get the ResourceInUseException exception, it provides an example reference that shows where
the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get
the same exception when you attempt to delete the intent again, repeat until the intent has no references and the
call to DeleteIntent is successful.
This operation requires permission for the lex:DeleteIntent action.
deleteIntentRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.ResourceInUseException - The resource that you are attempting to delete is referred to by another resource. Use this information
to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
DeleteIntentVersionResult deleteIntentVersion(DeleteIntentVersionRequest deleteIntentVersionRequest)
Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation.
This operation requires permissions for the lex:DeleteIntentVersion action.
deleteIntentVersionRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.ResourceInUseException - The resource that you are attempting to delete is referred to by another resource. Use this information
to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
DeleteSlotTypeResult deleteSlotType(DeleteSlotTypeRequest deleteSlotTypeRequest)
Deletes all versions of the slot type, including the $LATEST version. To delete a specific version
of the slot type, use the DeleteSlotTypeVersion operation.
You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first.
If you get the ResourceInUseException exception, the exception provides an example reference that
shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the
intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until
the slot type has no references and the DeleteSlotType call is successful.
This operation requires permission for the lex:DeleteSlotType action.
deleteSlotTypeRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.ResourceInUseException - The resource that you are attempting to delete is referred to by another resource. Use this information
to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
DeleteSlotTypeVersionResult deleteSlotTypeVersion(DeleteSlotTypeVersionRequest deleteSlotTypeVersionRequest)
Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation.
This operation requires permissions for the lex:DeleteSlotTypeVersion action.
deleteSlotTypeVersionRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.ResourceInUseException - The resource that you are attempting to delete is referred to by another resource. Use this information
to remove references to the resource that you are trying to delete.
The body of the exception contains a JSON object that describes the resource.
{ "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,
"resourceReference": {
"name": string, "version": string } }
DeleteUtterancesResult deleteUtterances(DeleteUtterancesRequest deleteUtterancesRequest)
Deletes stored utterances.
Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input.
Use the DeleteUtterances operation to manually delete stored utterances for a specific user. When
you use the DeleteUtterances operation, utterances stored for improving your bot's ability to
respond to user input are deleted immediately. Utterances stored for use with the GetUtterancesView
operation are deleted after 15 days.
This operation requires permissions for the lex:DeleteUtterances action.
deleteUtterancesRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.GetBotResult getBot(GetBotRequest getBotRequest)
Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.
This operation requires permissions for the lex:GetBot action.
getBotRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.AmazonLexModelBuilding client = AmazonLexModelBuildingClientBuilder.standard().build();
GetBotRequest request = new GetBotRequest().withName("DocOrderPizza").withVersionOrAlias("$LATEST");
GetBotResult response = client.getBot(request);GetBotAliasResult getBotAlias(GetBotAliasRequest getBotAliasRequest)
Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the lex:GetBotAlias action.
getBotAliasRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.GetBotAliasesResult getBotAliases(GetBotAliasesRequest getBotAliasesRequest)
Returns a list of aliases for a specified Amazon Lex bot.
This operation requires permissions for the lex:GetBotAliases action.
getBotAliasesRequest - LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.GetBotChannelAssociationResult getBotChannelAssociation(GetBotChannelAssociationRequest getBotChannelAssociationRequest)
Returns information about the association between an Amazon Lex bot and a messaging platform.
This operation requires permissions for the lex:GetBotChannelAssociation action.
getBotChannelAssociationRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.GetBotChannelAssociationsResult getBotChannelAssociations(GetBotChannelAssociationsRequest getBotChannelAssociationsRequest)
Returns a list of all of the channels associated with the specified bot.
The GetBotChannelAssociations operation requires permissions for the
lex:GetBotChannelAssociations action.
getBotChannelAssociationsRequest - LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.GetBotVersionsResult getBotVersions(GetBotVersionsRequest getBotVersionsRequest)
Gets information about all of the versions of a bot.
The GetBotVersions operation returns a BotMetadata object for each version of a bot.
For example, if a bot has three numbered versions, the GetBotVersions operation returns four
BotMetadata objects in the response, one for each numbered version and one for the
$LATEST version.
The GetBotVersions operation always returns at least one version, the $LATEST version.
This operation requires permissions for the lex:GetBotVersions action.
getBotVersionsRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.GetBotsResult getBots(GetBotsRequest getBotsRequest)
Returns bot information as follows:
If you provide the nameContains field, the response includes information for the
$LATEST version of all bots whose name contains the specified string.
If you don't specify the nameContains field, the operation returns information about the
$LATEST version of all of your bots.
This operation requires permission for the lex:GetBots action.
getBotsRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.AmazonLexModelBuilding client = AmazonLexModelBuildingClientBuilder.standard().build();
GetBotsRequest request = new GetBotsRequest().withNextToken("").withMaxResults(5);
GetBotsResult response = client.getBots(request);GetBuiltinIntentResult getBuiltinIntent(GetBuiltinIntentRequest getBuiltinIntentRequest)
Returns information about a built-in intent.
This operation requires permission for the lex:GetBuiltinIntent action.
getBuiltinIntentRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.GetBuiltinIntentsResult getBuiltinIntents(GetBuiltinIntentsRequest getBuiltinIntentsRequest)
Gets a list of built-in intents that meet the specified criteria.
This operation requires permission for the lex:GetBuiltinIntents action.
getBuiltinIntentsRequest - LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.GetBuiltinSlotTypesResult getBuiltinSlotTypes(GetBuiltinSlotTypesRequest getBuiltinSlotTypesRequest)
Gets a list of built-in slot types that meet the specified criteria.
For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.
This operation requires permission for the lex:GetBuiltInSlotTypes action.
getBuiltinSlotTypesRequest - LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.GetExportResult getExport(GetExportRequest getExportRequest)
Exports the contents of a Amazon Lex resource in a specified format.
getExportRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.GetImportResult getImport(GetImportRequest getImportRequest)
Gets information about an import job started with the StartImport operation.
getImportRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.GetIntentResult getIntent(GetIntentRequest getIntentRequest)
Returns information about an intent. In addition to the intent name, you must specify the intent version.
This operation requires permissions to perform the lex:GetIntent action.
getIntentRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.AmazonLexModelBuilding client = AmazonLexModelBuildingClientBuilder.standard().build();
GetIntentRequest request = new GetIntentRequest().withName("DocOrderPizza").withVersion("$LATEST");
GetIntentResult response = client.getIntent(request);GetIntentVersionsResult getIntentVersions(GetIntentVersionsRequest getIntentVersionsRequest)
Gets information about all of the versions of an intent.
The GetIntentVersions operation returns an IntentMetadata object for each version of an
intent. For example, if an intent has three numbered versions, the GetIntentVersions operation
returns four IntentMetadata objects in the response, one for each numbered version and one for the
$LATEST version.
The GetIntentVersions operation always returns at least one version, the $LATEST
version.
This operation requires permissions for the lex:GetIntentVersions action.
getIntentVersionsRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.GetIntentsResult getIntents(GetIntentsRequest getIntentsRequest)
Returns intent information as follows:
If you specify the nameContains field, returns the $LATEST version of all intents that
contain the specified string.
If you don't specify the nameContains field, returns information about the $LATEST
version of all intents.
The operation requires permission for the lex:GetIntents action.
getIntentsRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.AmazonLexModelBuilding client = AmazonLexModelBuildingClientBuilder.standard().build();
GetIntentsRequest request = new GetIntentsRequest().withNextToken("").withMaxResults(10);
GetIntentsResult response = client.getIntents(request);GetMigrationResult getMigration(GetMigrationRequest getMigrationRequest)
Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to the migration.
getMigrationRequest - LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.NotFoundException - The resource specified in the request was not found. Check the resource and try again.GetMigrationsResult getMigrations(GetMigrationsRequest getMigrationsRequest)
Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
getMigrationsRequest - LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.GetSlotTypeResult getSlotType(GetSlotTypeRequest getSlotTypeRequest)
Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.
This operation requires permissions for the lex:GetSlotType action.
getSlotTypeRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.AmazonLexModelBuilding client = AmazonLexModelBuildingClientBuilder.standard().build();
GetSlotTypeRequest request = new GetSlotTypeRequest().withName("DocPizzaCrustType").withVersion("$LATEST");
GetSlotTypeResult response = client.getSlotType(request);GetSlotTypeVersionsResult getSlotTypeVersions(GetSlotTypeVersionsRequest getSlotTypeVersionsRequest)
Gets information about all versions of a slot type.
The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of
a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions
operation returns four SlotTypeMetadata objects in the response, one for each numbered version and
one for the $LATEST version.
The GetSlotTypeVersions operation always returns at least one version, the $LATEST
version.
This operation requires permissions for the lex:GetSlotTypeVersions action.
getSlotTypeVersionsRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.GetSlotTypesResult getSlotTypes(GetSlotTypesRequest getSlotTypesRequest)
Returns slot type information as follows:
If you specify the nameContains field, returns the $LATEST version of all slot types
that contain the specified string.
If you don't specify the nameContains field, returns information about the $LATEST
version of all slot types.
The operation requires permission for the lex:GetSlotTypes action.
getSlotTypesRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.AmazonLexModelBuilding client = AmazonLexModelBuildingClientBuilder.standard().build();
GetSlotTypesRequest request = new GetSlotTypesRequest().withNextToken("").withMaxResults(10);
GetSlotTypesResult response = client.getSlotTypes(request);GetUtterancesViewResult getUtterancesView(GetUtterancesViewRequest getUtterancesViewRequest)
Use the GetUtterancesView operation to get information about the utterances that your users have
made to your bot. You can use this list to tune the utterances that your bot responds to.
For example, say that you have created a bot to order flowers. After your users have used your bot for a while,
use the GetUtterancesView operation to see the requests that they have made and whether they have
been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this
utterance to the OrderFlowers intent so that your bot recognizes that utterance.
After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.
Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version.
If you set childDirected field to true when you created your bot, if you are using slot obfuscation
with one or more slots, or if you opted out of participating in improving Amazon Lex, utterances are not
available.
This operation requires permissions for the lex:GetUtterancesView action.
getUtterancesViewRequest - LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.
listTagsForResourceRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.PutBotResult putBot(PutBotRequest putBotRequest)
Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are
only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can
use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum
information, the bot is created or updated but Amazon Lex returns the response FAILED. You
can build the bot after you add one or more intents. For more information about Amazon Lex bots, see
how-it-works.
If you specify the name of an existing bot, the fields in the request replace the existing values in the
$LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the
request, except for the idleTTLInSeconds and privacySettings fields, which are set to
their default values. If you don't specify values for required fields, Amazon Lex throws an exception.
This operation requires permissions for the lex:PutBot action. For more information, see
security-iam.
putBotRequest - ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.PreconditionFailedException - The checksum of the resource that you are trying to change does not match the checksum in the request.
Check the resource's checksum and try again.AmazonLexModelBuilding client = AmazonLexModelBuildingClientBuilder.standard().build();
PutBotRequest request = new PutBotRequest()
.withName("DocOrderPizzaBot")
.withDescription("Orders a pizza from a local pizzeria.")
.withIntents(new Intent().withIntentName("DocOrderPizza").withIntentVersion("$LATEST"))
.withClarificationPrompt(
new Prompt().withMessages(
new Message().withContentType("PlainText").withContent("I'm sorry, I didn't hear that. Can you repeate what you just said?"),
new Message().withContentType("PlainText").withContent("Can you say that again?")).withMaxAttempts(1))
.withAbortStatement(
new Statement().withMessages(new Message().withContentType("PlainText").withContent("I don't understand. Can you try again?"),
new Message().withContentType("PlainText").withContent("I'm sorry, I don't understand."))).withIdleSessionTTLInSeconds(300)
.withProcessBehavior("SAVE").withLocale("en-US").withChildDirected(true);
PutBotResult response = client.putBot(request);PutBotAliasResult putBotAlias(PutBotAliasRequest putBotAliasRequest)
Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases.
This operation requires permissions for the lex:PutBotAlias action.
putBotAliasRequest - ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.PreconditionFailedException - The checksum of the resource that you are trying to change does not match the checksum in the request.
Check the resource's checksum and try again.PutIntentResult putIntent(PutIntentRequest putIntentRequest)
Creates an intent or replaces an existing intent.
To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot,
for example, you would create an OrderPizza intent.
To create an intent or replace an existing intent, you must provide the following:
Intent name. For example, OrderPizza.
Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza."
Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.
How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application.
You can specify other optional information in the request, such as:
A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?"
A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order."
A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?"
If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the
$LATEST version of the intent with the values in the request. Amazon Lex removes fields that you
don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you
update the $LATEST version of an intent, the status field of any bot that uses the
$LATEST version of the intent is set to NOT_BUILT.
For more information, see how-it-works.
This operation requires permissions for the lex:PutIntent action.
putIntentRequest - ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.PreconditionFailedException - The checksum of the resource that you are trying to change does not match the checksum in the request.
Check the resource's checksum and try again.AmazonLexModelBuilding client = AmazonLexModelBuildingClientBuilder.standard().build();
PutIntentRequest request = new PutIntentRequest()
.withName("DocOrderPizza")
.withDescription("Order a pizza from a local pizzeria.")
.withSlots(
new Slot()
.withName("Type")
.withDescription("The type of pizza to order.")
.withSlotConstraint("Required")
.withSlotType("DocPizzaType")
.withSlotTypeVersion("$LATEST")
.withValueElicitationPrompt(
new Prompt().withMessages(new Message().withContentType("PlainText").withContent("What type of pizza would you like?"),
new Message().withContentType("PlainText").withContent("Vegie or cheese pizza?"),
new Message().withContentType("PlainText").withContent("I can get you a vegie or a cheese pizza."))
.withMaxAttempts(1)).withPriority(1)
.withSampleUtterances("Get me a {Type} pizza.", "A {Type} pizza please.", "I'd like a {Type} pizza."),
new Slot()
.withName("Crust")
.withDescription("The type of pizza crust to order.")
.withSlotConstraint("Required")
.withSlotType("DocPizzaCrustType")
.withSlotTypeVersion("$LATEST")
.withValueElicitationPrompt(
new Prompt().withMessages(new Message().withContentType("PlainText").withContent("What type of crust would you like?"),
new Message().withContentType("PlainText").withContent("Thick or thin crust?")).withMaxAttempts(1))
.withPriority(2).withSampleUtterances("Make it a {Crust} crust.", "I'd like a {Crust} crust."),
new Slot()
.withName("Sauce")
.withDescription("The type of sauce to use on the pizza.")
.withSlotConstraint("Required")
.withSlotType("DocPizzaSauceType")
.withSlotTypeVersion("$LATEST")
.withValueElicitationPrompt(
new Prompt().withMessages(new Message().withContentType("PlainText").withContent("White or red sauce?"),
new Message().withContentType("PlainText").withContent("Garlic or tomato sauce?")).withMaxAttempts(1))
.withPriority(3).withSampleUtterances("Make it {Sauce} sauce.", "I'd like {Sauce} sauce."))
.withSampleUtterances("Order me a pizza.", "Order me a {Type} pizza.", "I want a {Crust} crust {Type} pizza",
"I want a {Crust} crust {Type} pizza with {Sauce} sauce.")
.withConfirmationPrompt(
new Prompt().withMessages(
new Message().withContentType("PlainText").withContent("Should I order your {Crust} crust {Type} pizza with {Sauce} sauce?"))
.withMaxAttempts(1))
.withRejectionStatement(
new Statement().withMessages(new Message().withContentType("PlainText").withContent("Ok, I'll cancel your order."), new Message()
.withContentType("PlainText").withContent("I cancelled your order.")))
.withConclusionStatement(
new Statement()
.withMessages(
new Message().withContentType("PlainText").withContent(
"All right, I ordered you a {Crust} crust {Type} pizza with {Sauce} sauce."),
new Message().withContentType("PlainText").withContent(
"OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.")).withResponseCard("foo"))
.withFulfillmentActivity(new FulfillmentActivity().withType("ReturnIntent"));
PutIntentResult response = client.putIntent(request);PutSlotTypeResult putSlotType(PutSlotTypeRequest putSlotTypeRequest)
Creates a custom slot type or replaces an existing custom slot type.
To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works.
If you specify the name of an existing slot type, the fields in the request replace the existing values in the
$LATEST version of the slot type. Amazon Lex removes the fields that you don't provide in the
request. If you don't specify required fields, Amazon Lex throws an exception. When you update the
$LATEST version of a slot type, if a bot uses the $LATEST version of an intent that
contains the slot type, the bot's status field is set to NOT_BUILT.
This operation requires permissions for the lex:PutSlotType action.
putSlotTypeRequest - ConflictException - There was a conflict processing the request. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.PreconditionFailedException - The checksum of the resource that you are trying to change does not match the checksum in the request.
Check the resource's checksum and try again.AmazonLexModelBuilding client = AmazonLexModelBuildingClientBuilder.standard().build();
PutSlotTypeRequest request = new PutSlotTypeRequest().withName("PizzaSauceType").withDescription("Available pizza sauces")
.withEnumerationValues(new EnumerationValue().withValue("red"), new EnumerationValue().withValue("white"));
PutSlotTypeResult response = client.putSlotType(request);StartImportResult startImport(StartImportRequest startImportRequest)
Starts a job to import a resource to Amazon Lex.
startImportRequest - LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.StartMigrationResult startMigration(StartMigrationRequest startMigrationRequest)
Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when you want to take advantage of the new features of Amazon Lex V2.
For more information, see Migrating a bot in the Amazon Lex developer guide.
startMigrationRequest - LimitExceededException - The request exceeded a limit. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.AccessDeniedException - Your IAM user or role does not have permission to call the Amazon Lex V2 APIs required to migrate your
bot.NotFoundException - The resource specified in the request was not found. Check the resource and try again.TagResourceResult 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 - NotFoundException - The resource specified in the request was not found. Check the resource and try again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.ConflictException - There was a conflict processing the request. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a bot, bot alias or bot channel.
untagResourceRequest - NotFoundException - The resource specified in the request was not found. Check the resource and try again.BadRequestException - The request is not well formed. For example, a value is invalid or a required field is missing. Check the
field values, and try again.ConflictException - There was a conflict processing the request. Try your request again.InternalFailureException - An internal Amazon Lex error occurred. Try your request again.LimitExceededException - The request exceeded a limit. Try your request again.void 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.