logo
Expand description

Amazon Lex Build-Time Actions

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.

If you’re using the service, you’re probably looking for LexModelsClient and LexModels.

Structs

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

Provides the settings needed for conversation logs.

Contains information about conversation log settings.

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.

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.

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.

A client for the Amazon Lex Model Building Service API.

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.

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

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.

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.

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: _ . : / = + - @.

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.

Enums

Errors returned by CreateBotVersion

Errors returned by CreateIntentVersion

Errors returned by CreateSlotTypeVersion

Errors returned by DeleteBotAlias

Errors returned by DeleteBotChannelAssociation

Errors returned by DeleteBot

Errors returned by DeleteBotVersion

Errors returned by DeleteIntent

Errors returned by DeleteIntentVersion

Errors returned by DeleteSlotType

Errors returned by DeleteSlotTypeVersion

Errors returned by DeleteUtterances

Errors returned by GetBotAlias

Errors returned by GetBotAliases

Errors returned by GetBotChannelAssociation

Errors returned by GetBotChannelAssociations

Errors returned by GetBot

Errors returned by GetBotVersions

Errors returned by GetBots

Errors returned by GetBuiltinIntent

Errors returned by GetBuiltinIntents

Errors returned by GetBuiltinSlotTypes

Errors returned by GetExport

Errors returned by GetImport

Errors returned by GetIntent

Errors returned by GetIntentVersions

Errors returned by GetIntents

Errors returned by GetSlotType

Errors returned by GetSlotTypeVersions

Errors returned by GetSlotTypes

Errors returned by GetUtterancesView

Errors returned by ListTagsForResource

Errors returned by PutBotAlias

Errors returned by PutBot

Errors returned by PutIntent

Errors returned by PutSlotType

Errors returned by StartImport

Errors returned by TagResource

Errors returned by UntagResource

Traits

Trait representing the capabilities of the Amazon Lex Model Building Service API. Amazon Lex Model Building Service clients implement this trait.