Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14107861793.8 KB

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?"

put/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/intents/

Path parameters

botIdstring required

The identifier of the bot associated with this intent.

botVersionstring required

The version of the bot associated with this intent.

localeIdstring required

The identifier of the language and locale where this intent is used. All of the bots, slot types, and slots used by the intent must have the same locale. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.

Request body

intentNamestring required

The name of the intent. Intent names must be unique in the locale that contains the intent and cannot match the name of any built-in intent.

intentDisplayNamestring

A display name for the intent. If configured, This name will be shown to users during Intent Disambiguation instead of the intent name. Display names should be user-friendly, descriptive and match the intent's purpose to improve user experience during disambiguation.

descriptionstring

A description of the intent. Use the description to help identify the intent in lists.

parentIntentSignaturestring

A unique identifier for the built-in intent to base this intent on.

Response

Success

intentIdstring

A unique identifier for the intent.

intentNamestring

The name specified for the intent.

intentDisplayNamestring

The display name specified for the intent.

descriptionstring

The description specified for the intent.

parentIntentSignaturestring

The signature of the parent intent specified for the intent.

botIdstring

The identifier of the bot associated with the intent.

botVersionstring

The version of the bot associated with the intent.

localeIdstring

The locale that the intent is specified to use.

creationDateTimestring date-time

A timestamp of the date and time that the intent was created.