AWS::Lex::Bot IntentConfirmationSetting

Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

Syntax

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

JSON

{
  "CodeHook" : DialogCodeHookInvocationSetting,
  "ConfirmationConditional" : ConditionalSpecification,
  "ConfirmationNextStep" : DialogState,
  "ConfirmationResponse" : ResponseSpecification,
  "DeclinationConditional" : ConditionalSpecification,
  "DeclinationNextStep" : DialogState,
  "DeclinationResponse" : ResponseSpecification,
  "ElicitationCodeHook" : ElicitationCodeHookInvocationSetting,
  "FailureConditional" : ConditionalSpecification,
  "FailureNextStep" : DialogState,
  "FailureResponse" : ResponseSpecification,
  "IsActive" : Boolean,
  "PromptSpecification" : PromptSpecification
}

YAML

  CodeHook: 
    DialogCodeHookInvocationSetting
  ConfirmationConditional: 
    ConditionalSpecification
  ConfirmationNextStep: 
    DialogState
  ConfirmationResponse: 
    ResponseSpecification
  DeclinationConditional: 
    ConditionalSpecification
  DeclinationNextStep: 
    DialogState
  DeclinationResponse: 
    ResponseSpecification
  ElicitationCodeHook: 
    ElicitationCodeHookInvocationSetting
  FailureConditional: 
    ConditionalSpecification
  FailureNextStep: 
    DialogState
  FailureResponse: 
    ResponseSpecification
  IsActive: Boolean
  PromptSpecification: 
    PromptSpecification

Properties

CodeHook

The DialogCodeHookInvocationSetting object associated with intent's confirmation step. The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook.

Required: No

Type: DialogCodeHookInvocationSetting

Update requires: No interruption

ConfirmationConditional

A list of conditional branches to evaluate after the intent is closed.

Required: No

Type: ConditionalSpecification

Update requires: No interruption

ConfirmationNextStep

Specifies the next step that the bot executes when the customer confirms the intent.

Required: No

Type: DialogState

Update requires: No interruption

ConfirmationResponse

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Required: No

Type: ResponseSpecification

Update requires: No interruption

DeclinationConditional

A list of conditional branches to evaluate after the intent is declined.

Required: No

Type: ConditionalSpecification

Update requires: No interruption

DeclinationNextStep

Specifies the next step that the bot executes when the customer declines the intent.

Required: No

Type: DialogState

Update requires: No interruption

DeclinationResponse

When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

Required: No

Type: ResponseSpecification

Update requires: No interruption

ElicitationCodeHook

The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.

Required: No

Type: ElicitationCodeHookInvocationSetting

Update requires: No interruption

FailureConditional

Provides a list of conditional branches. Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

Required: No

Type: ConditionalSpecification

Update requires: No interruption

FailureNextStep

The next step to take in the conversation if the confirmation step fails.

Required: No

Type: DialogState

Update requires: No interruption

FailureResponse

Specifies a list of message groups that Amazon Lex uses to respond the user input when the intent confirmation fails.

Required: No

Type: ResponseSpecification

Update requires: No interruption

IsActive

Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the IsActive field isn't specified, the default is true.

Required: No

Type: Boolean

Update requires: No interruption

PromptSpecification

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

Required: Yes

Type: PromptSpecification

Update requires: No interruption