AWS::Lex::Bot Intent

Represents an action that the user wants to perform.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Description" : String,
  "DialogCodeHook" : DialogCodeHookSetting,
  "FulfillmentCodeHook" : FulfillmentCodeHookSetting,
  "InitialResponseSetting" : InitialResponseSetting,
  "InputContexts" : [ InputContext, ... ],
  "IntentClosingSetting" : IntentClosingSetting,
  "IntentConfirmationSetting" : IntentConfirmationSetting,
  "KendraConfiguration" : KendraConfiguration,
  "Name" : String,
  "OutputContexts" : [ OutputContext, ... ],
  "ParentIntentSignature" : String,
  "SampleUtterances" : [ SampleUtterance, ... ],
  "SlotPriorities" : [ SlotPriority, ... ],
  "Slots" : [ Slot, ... ]
}

YAML

  Description: String
  DialogCodeHook: 
    DialogCodeHookSetting
  FulfillmentCodeHook: 
    FulfillmentCodeHookSetting
  InitialResponseSetting: 
    InitialResponseSetting
  InputContexts: 
    - InputContext
  IntentClosingSetting: 
    IntentClosingSetting
  IntentConfirmationSetting: 
    IntentConfirmationSetting
  KendraConfiguration: 
    KendraConfiguration
  Name: String
  OutputContexts: 
    - OutputContext
  ParentIntentSignature: String
  SampleUtterances: 
    - SampleUtterance
  SlotPriorities: 
    - SlotPriority
  Slots: 
    - Slot

Properties

Description

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

Required: No

Type: String

Maximum: 200

Update requires: No interruption

DialogCodeHook

Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.

Required: No

Type: DialogCodeHookSetting

Update requires: No interruption

FulfillmentCodeHook

Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user.

Required: No

Type: FulfillmentCodeHookSetting

Update requires: No interruption

InitialResponseSetting

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

Required: No

Type: InitialResponseSetting

Update requires: No interruption

InputContexts

A list of contexts that must be active for this intent to be considered by Amazon Lex.

Required: No

Type: Array of InputContext

Maximum: 5

Update requires: No interruption

IntentClosingSetting

Sets the response that Amazon Lex sends to the user when the intent is closed.

Required: No

Type: IntentClosingSetting

Update requires: No interruption

IntentConfirmationSetting

Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent.

Required: No

Type: IntentConfirmationSetting

Update requires: No interruption

KendraConfiguration

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.

Required: No

Type: KendraConfiguration

Update requires: No interruption

Name

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

Required: Yes

Type: String

Pattern: ^([0-9a-zA-Z][_-]?)+$

Minimum: 1

Maximum: 100

Update requires: No interruption

OutputContexts

A list of contexts that the intent activates when it is fulfilled.

Required: No

Type: Array of OutputContext

Maximum: 10

Update requires: No interruption

ParentIntentSignature

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

Required: No

Type: String

Update requires: No interruption

SampleUtterances

A list of utterances that a user might say to signal the intent.

Required: No

Type: Array of SampleUtterance

Update requires: No interruption

SlotPriorities

Indicates the priority for slots. Amazon Lex prompts the user for slot values in priority order.

Required: No

Type: Array of SlotPriority

Update requires: No interruption

Slots

A list of slots that the intent requires for fulfillment.

Required: No

Type: Array of Slot

Maximum: 100

Update requires: No interruption