Amazon.LexModelBuildingService.Model

Your IAM user or role does not have permission to call the Amazon Lex V2 APIs required to migrate your bot.

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.

Provides information about a bot alias.

Represents an association between an Amazon Lex bot and an external messaging platform.

Provides information about a bot. .

Provides metadata for a built-in intent.

Provides information about a slot used in a built-in intent.

Provides information about a built in slot type.

Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot..

There was a conflict processing the request. Try your request again.

Provides the settings needed for conversation logs.

Contains information about conversation log settings.

Container for the parameters to the CreateBotVersion operation. 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.

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.

This is the response object from the CreateBotVersion operation.

Container for the parameters to the CreateIntentVersion operation. 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.

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.

This is the response object from the CreateIntentVersion operation.

Container for the parameters to the CreateSlotTypeVersion operation. 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.

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.

This is the response object from the CreateSlotTypeVersion operation.

Container for the parameters to the DeleteBotAlias operation. 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.

This is the response object from the DeleteBotAlias operation.

Container for the parameters to the DeleteBotChannelAssociation operation. Deletes the association between an Amazon Lex bot and a messaging platform.

This operation requires permission for the lex:DeleteBotChannelAssociation action.

This is the response object from the DeleteBotChannelAssociation operation.

Container for the parameters to the DeleteBot operation. 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.

This is the response object from the DeleteBot operation.

Container for the parameters to the DeleteBotVersion operation. 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.

This is the response object from the DeleteBotVersion operation.

Container for the parameters to the DeleteIntent operation. 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.

This operation requires permission for the lex:DeleteIntent action.

This is the response object from the DeleteIntent operation.

Container for the parameters to the DeleteIntentVersion operation. 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.

This is the response object from the DeleteIntentVersion operation.

Container for the parameters to the DeleteSlotType operation. 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.

This operation requires permission for the lex:DeleteSlotType action.

This is the response object from the DeleteSlotType operation.

Container for the parameters to the DeleteSlotTypeVersion operation. 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.

This is the response object from the DeleteSlotTypeVersion operation.

Container for the parameters to the DeleteUtterances operation. 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.

This is the response object from the DeleteUtterances operation.

Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.

For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values

• thick

• thin

• stuffed

A prompt for additional activity after an intent is fulfilled. For example, after the OrderPizza intent is fulfilled, you might prompt the user to find out whether the user wants to order drinks.

Describes how the intent is fulfilled after the user provides all of the information required for the intent. You can provide a Lambda function to process the intent, or you can return the intent information to the client application. We recommend that you use a Lambda function so that the relevant logic lives in the Cloud and limit the client-side code primarily to presentation. If you need to update the logic, you only update the Lambda function; you don't need to upgrade your client application.

Consider the following examples:

• In a pizza ordering application, after the user provides all of the information for placing an order, you use a Lambda function to place an order with a pizzeria.

• In a gaming application, when a user says "pick up a rock," this information must go back to the client application so that it can perform the operation and update the graphics. In this case, you want Amazon Lex to return the intent data to the client.

Container for the parameters to the GetBotAliases operation. Returns a list of aliases for a specified Amazon Lex bot.

This operation requires permissions for the lex:GetBotAliases action.

This is the response object from the GetBotAliases operation.

Container for the parameters to the GetBotAlias operation. 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.

This is the response object from the GetBotAlias operation.

Container for the parameters to the GetBotChannelAssociation operation. Returns information about the association between an Amazon Lex bot and a messaging platform.

This operation requires permissions for the lex:GetBotChannelAssociation action.

This is the response object from the GetBotChannelAssociation operation.

Container for the parameters to the GetBotChannelAssociations operation. Returns a list of all of the channels associated with the specified bot.

The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action.

This is the response object from the GetBotChannelAssociations operation.

Container for the parameters to the GetBot operation. 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.

This is the response object from the GetBot operation.

Container for the parameters to the GetBots operation. 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.

This is the response object from the GetBots operation.

Container for the parameters to the GetBotVersions operation. 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.

This is the response object from the GetBotVersions operation.

Container for the parameters to the GetBuiltinIntent operation. Returns information about a built-in intent.

This operation requires permission for the lex:GetBuiltinIntent action.

This is the response object from the GetBuiltinIntent operation.

Container for the parameters to the GetBuiltinIntents operation. Gets a list of built-in intents that meet the specified criteria.

This operation requires permission for the lex:GetBuiltinIntents action.

This is the response object from the GetBuiltinIntents operation.

Container for the parameters to the GetBuiltinSlotTypes operation. 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.

This is the response object from the GetBuiltinSlotTypes operation.

Container for the parameters to the GetExport operation. Exports the contents of a Amazon Lex resource in a specified format.

This is the response object from the GetExport operation.

Container for the parameters to the GetImport operation. Gets information about an import job started with the StartImport operation.

This is the response object from the GetImport operation.

Container for the parameters to the GetIntent operation. 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.

This is the response object from the GetIntent operation.

Container for the parameters to the GetIntents operation. 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.

This is the response object from the GetIntents operation.

Container for the parameters to the GetIntentVersions operation. 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.

This is the response object from the GetIntentVersions operation.

Container for the parameters to the GetMigration operation. 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.

This is the response object from the GetMigration operation.

Container for the parameters to the GetMigrations operation. Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.

This is the response object from the GetMigrations operation.

Container for the parameters to the GetSlotType operation. 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.

This is the response object from the GetSlotType operation.

Container for the parameters to the GetSlotTypes operation. 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.

This is the response object from the GetSlotTypes operation.

Container for the parameters to the GetSlotTypeVersions operation. 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.

This is the response object from the GetSlotTypeVersions operation.

Container for the parameters to the GetUtterancesView operation. 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.

This is the response object from the GetUtterancesView operation.

The name of a context that must be active for an intent to be selected by Amazon Lex.

Identifies the specific version of an intent.

Provides information about an intent.

An internal Amazon Lex error occurred. Try your request again.

Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance. For more information, see AMAZON.KendraSearchIntent.

Paginators for the LexModelBuildingService service

The request exceeded a limit. Try your request again.

Container for the parameters to the ListTagsForResource operation. Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.

This is the response object from the ListTagsForResource operation.

Settings used to configure delivery mode and destination for conversation logs.

The settings for conversation logs.

The message object that provides the message text and its type.

Provides information about alerts and warnings that Amazon Lex sends during a migration. The alerts include information about how to resolve the issue.

Provides information about migrating a bot from Amazon Lex V1 to Amazon Lex V2.

The resource specified in the request was not found. Check the resource and try again.

The specification of an output context that is set when an intent is fulfilled.

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.

Obtains information from the user. To define a prompt, provide one or more messages and specify the number of attempts to get information from the user. If you provide more than one message, Amazon Lex chooses one of the messages to use to prompt the user. For more information, see how-it-works.

Container for the parameters to the PutBotAlias operation. 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.

This is the response object from the PutBotAlias operation.

Container for the parameters to the PutBot operation. 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.

This is the response object from the PutBot operation.

Container for the parameters to the PutIntent operation. 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.

This is the response object from the PutIntent operation.

Container for the parameters to the PutSlotType operation. 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.

This is the response object from the PutSlotType operation.

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 } }

Describes the resource that refers to the resource that you are attempting to delete. This object is returned as part of the ResourceInUseException exception.

Identifies the version of a specific slot.

A default value for a slot.

Contains the default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot.

Provides configuration information for a slot type.

Provides information about a slot type..

Provides a regular expression used to validate the value of a slot.

Container for the parameters to the StartImport operation. Starts a job to import a resource to Amazon Lex.

This is the response object from the StartImport operation.

Container for the parameters to the StartMigration operation. 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.

This is the response object from the StartMigration operation.

A collection of messages that convey information to the user. At runtime, Amazon Lex selects the message to convey.

A list of key/value pairs that identify a bot, bot alias, or bot channel. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Container for the parameters to the TagResource operation. Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.

This is the response object from the TagResource operation.

Container for the parameters to the UntagResource operation. Removes tags from a bot, bot alias or bot channel.

This is the response object from the UntagResource operation.

Provides information about a single utterance that was made to your bot.

Provides a list of utterances that have been made to a specific version of your bot. The list contains a maximum of 100 utterances.

Paginator for the GetBotAliases operation

Paginator for the GetBotChannelAssociations operation

Paginator for the GetBots operation

Paginator for the GetBotVersions operation

Paginator for the GetBuiltinIntents operation

Paginator for the GetBuiltinSlotTypes operation

Paginator for the GetIntents operation

Paginator for the GetIntentVersions operation

Paginator for the GetMigrations operation

Paginator for the GetSlotTypes operation

Paginator for the GetSlotTypeVersions operation

Paginators for the LexModelBuildingService service