Package software.amazon.awscdk.services.lex

Interface CfnBot.IntentConfirmationSettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.IntentConfirmationSettingProperty.Jsii$Proxy

Enclosing class:

CfnBot

@Stability(Stable)
public static interface CfnBot.IntentConfirmationSettingProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBot.IntentConfirmationSettingProperty.Builder	A builder for CfnBot.IntentConfirmationSettingProperty
static final class	CfnBot.IntentConfirmationSettingProperty.Jsii$Proxy	An implementation for CfnBot.IntentConfirmationSettingProperty

Method Summary

Modifier and Type	Method	Description
static CfnBot.IntentConfirmationSettingProperty.Builder	builder()
default Object	getCodeHook()	The DialogCodeHookInvocationSetting object associated with intent's confirmation step.
default Object	getConfirmationConditional()	A list of conditional branches to evaluate after the intent is closed.
default Object	getConfirmationNextStep()	Specifies the next step that the bot executes when the customer confirms the intent.
default Object	getConfirmationResponse()	Specifies a list of message groups that Amazon Lex uses to respond the user input.
default Object	getDeclinationConditional()	A list of conditional branches to evaluate after the intent is declined.
default Object	getDeclinationNextStep()	Specifies the next step that the bot executes when the customer declines the intent.
default Object	getDeclinationResponse()	When the user answers "no" to the question defined in promptSpecification , Amazon Lex responds with this response to acknowledge that the intent was canceled.
default Object	getElicitationCodeHook()	The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.
default Object	getFailureConditional()	Provides a list of conditional branches.
default Object	getFailureNextStep()	The next step to take in the conversation if the confirmation step fails.
default Object	getFailureResponse()	Specifies a list of message groups that Amazon Lex uses to respond the user input when the intent confirmation fails.
default Object	getIsActive()	Specifies whether the intent's confirmation is sent to the user.
Object	getPromptSpecification()	Prompts the user to confirm the intent.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPromptSpecification

@Stability(Stable)
@NotNull
Object getPromptSpecification()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-promptspecification

getCodeHook

@Stability(Stable)
@Nullable
default Object getCodeHook()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-codehook

getConfirmationConditional

@Stability(Stable)
@Nullable
default Object getConfirmationConditional()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-confirmationconditional

getConfirmationNextStep

@Stability(Stable)
@Nullable
default Object getConfirmationNextStep()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-confirmationnextstep

getConfirmationResponse

@Stability(Stable)
@Nullable
default Object getConfirmationResponse()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-confirmationresponse

getDeclinationConditional

@Stability(Stable)
@Nullable
default Object getDeclinationConditional()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-declinationconditional

getDeclinationNextStep

@Stability(Stable)
@Nullable
default Object getDeclinationNextStep()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-declinationnextstep

getDeclinationResponse

@Stability(Stable)
@Nullable
default Object getDeclinationResponse()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-declinationresponse

getElicitationCodeHook

@Stability(Stable)
@Nullable
default Object getElicitationCodeHook()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-elicitationcodehook

getFailureConditional

@Stability(Stable)
@Nullable
default Object getFailureConditional()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-failureconditional

getFailureNextStep

@Stability(Stable)
@Nullable
default Object getFailureNextStep()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-failurenextstep

getFailureResponse

@Stability(Stable)
@Nullable
default Object getFailureResponse()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-failureresponse

getIsActive

@Stability(Stable)
@Nullable
default Object getIsActive()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-lex-bot-intentconfirmationsetting.html#cfn-lex-bot-intentconfirmationsetting-isactive

builder

@Stability(Stable)
static CfnBot.IntentConfirmationSettingProperty.Builder builder()

Returns:

a CfnBot.IntentConfirmationSettingProperty.Builder of CfnBot.IntentConfirmationSettingProperty