Package software.amazon.awscdk.services.lex

Interface CfnBot.IntentProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.IntentProperty.Jsii$Proxy

Enclosing class:

CfnBot

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

Represents an action that the user wants to perform.

Example:

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBot.IntentProperty.Builder	builder()
default String	getDescription()	A description of the intent.
default Object	getDialogCodeHook()	Specifies that Amazon Lex invokes the alias Lambda function for each user input.
default Object	getFulfillmentCodeHook()	Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment.
default Object	getInitialResponseSetting()	Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
default Object	getInputContexts()	A list of contexts that must be active for this intent to be considered by Amazon Lex .
default Object	getIntentClosingSetting()	Sets the response that Amazon Lex sends to the user when the intent is closed.
default Object	getIntentConfirmationSetting()	Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent.
default Object	getKendraConfiguration()	Provides configuration information for the AMAZON.KendraSearchIntent intent.
String	getName()	The name of the intent.
default Object	getOutputContexts()	A list of contexts that the intent activates when it is fulfilled.
default String	getParentIntentSignature()	A unique identifier for the built-in intent to base this intent on.
default Object	getSampleUtterances()	A list of utterances that a user might say to signal the intent.
default Object	getSlotPriorities()	Indicates the priority for slots.
default Object	getSlots()	A list of slots that the intent requires for fulfillment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

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.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the intent.

Use the description to help identify the intent in lists.

See Also:

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

getDialogCodeHook

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

Specifies that Amazon Lex invokes the alias Lambda function for each user input.

You can invoke this Lambda function to personalize user interaction.

See Also:

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

getFulfillmentCodeHook

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

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.

See Also:

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

getInitialResponseSetting

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

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

See Also:

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

getInputContexts

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

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

See Also:

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

getIntentClosingSetting

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

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

See Also:

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

getIntentConfirmationSetting

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

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.

See Also:

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

getKendraConfiguration

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

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.

See Also:

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

getOutputContexts

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

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

See Also:

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

getParentIntentSignature

@Stability(Stable)
@Nullable
default String getParentIntentSignature()

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

See Also:

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

getSampleUtterances

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

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

See Also:

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

getSlotPriorities

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

Indicates the priority for slots.

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

See Also:

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

getSlots

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

A list of slots that the intent requires for fulfillment.

See Also:

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

builder

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

Returns:

a CfnBot.IntentProperty.Builder of CfnBot.IntentProperty