@Stability(value=Stable)
public static interface CfnBot.IntentProperty
extends software.amazon.jsii.JsiiSerializable
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.lex.*;
IntentProperty intentProperty = IntentProperty.builder()
.name("name")
// the properties below are optional
.description("description")
.dialogCodeHook(DialogCodeHookSettingProperty.builder()
.enabled(false)
.build())
.fulfillmentCodeHook(FulfillmentCodeHookSettingProperty.builder()
.enabled(false)
// the properties below are optional
.fulfillmentUpdatesSpecification(FulfillmentUpdatesSpecificationProperty.builder()
.active(false)
// the properties below are optional
.startResponse(FulfillmentStartResponseSpecificationProperty.builder()
.delayInSeconds(123)
.messageGroups(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.timeoutInSeconds(123)
.updateResponse(FulfillmentUpdateResponseSpecificationProperty.builder()
.frequencyInSeconds(123)
.messageGroups(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.build())
.postFulfillmentStatusSpecification(PostFulfillmentStatusSpecificationProperty.builder()
.failureResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.successResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.timeoutResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.build())
.build())
.inputContexts(List.of(InputContextProperty.builder()
.name("name")
.build()))
.intentClosingSetting(IntentClosingSettingProperty.builder()
.closingResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
// the properties below are optional
.isActive(false)
.build())
.intentConfirmationSetting(IntentConfirmationSettingProperty.builder()
.declinationResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.promptSpecification(PromptSpecificationProperty.builder()
.maxRetries(123)
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.messageSelectionStrategy("messageSelectionStrategy")
.build())
// the properties below are optional
.isActive(false)
.build())
.kendraConfiguration(KendraConfigurationProperty.builder()
.kendraIndex("kendraIndex")
// the properties below are optional
.queryFilterString("queryFilterString")
.queryFilterStringEnabled(false)
.build())
.outputContexts(List.of(OutputContextProperty.builder()
.name("name")
.timeToLiveInSeconds(123)
.turnsToLive(123)
.build()))
.parentIntentSignature("parentIntentSignature")
.sampleUtterances(List.of(SampleUtteranceProperty.builder()
.utterance("utterance")
.build()))
.slotPriorities(List.of(SlotPriorityProperty.builder()
.priority(123)
.slotName("slotName")
.build()))
.slots(List.of(SlotProperty.builder()
.name("name")
.slotTypeName("slotTypeName")
.valueElicitationSetting(SlotValueElicitationSettingProperty.builder()
.slotConstraint("slotConstraint")
// the properties below are optional
.defaultValueSpecification(SlotDefaultValueSpecificationProperty.builder()
.defaultValueList(List.of(SlotDefaultValueProperty.builder()
.defaultValue("defaultValue")
.build()))
.build())
.promptSpecification(PromptSpecificationProperty.builder()
.maxRetries(123)
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.messageSelectionStrategy("messageSelectionStrategy")
.build())
.sampleUtterances(List.of(SampleUtteranceProperty.builder()
.utterance("utterance")
.build()))
.waitAndContinueSpecification(WaitAndContinueSpecificationProperty.builder()
.continueResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
.waitingResponse(ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build())
// the properties below are optional
.isActive(false)
.stillWaitingResponse(StillWaitingResponseSpecificationProperty.builder()
.frequencyInSeconds(123)
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
.timeoutInSeconds(123)
// the properties below are optional
.allowInterrupt(false)
.build())
.build())
.build())
// the properties below are optional
.description("description")
.multipleValuesSetting(MultipleValuesSettingProperty.builder()
.allowMultipleValues(false)
.build())
.obfuscationSetting(ObfuscationSettingProperty.builder()
.obfuscationSettingType("obfuscationSettingType")
.build())
.build()))
.build();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnBot.IntentProperty.Builder
A builder for
CfnBot.IntentProperty |
static class |
CfnBot.IntentProperty.Jsii$Proxy
An implementation for
CfnBot.IntentProperty |
| Modifier and Type | Method and 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 |
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()
Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index.
|
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.
|
@Stability(value=Stable) @NotNull String getName()
Intent names must be unique within the locale that contains the intent and can't match the name of any built-in intent.
@Stability(value=Stable) @Nullable default String getDescription()
Use the description to help identify the intent in lists.
@Stability(value=Stable) @Nullable default Object getDialogCodeHook()
You can invoke this Lambda function to personalize user interaction.
@Stability(value=Stable) @Nullable default Object getFulfillmentCodeHook()
You can invoke this function to complete the bot's transaction with the user.
@Stability(value=Stable) @Nullable default Object getInputContexts()
@Stability(value=Stable) @Nullable default Object getIntentClosingSetting()
@Stability(value=Stable) @Nullable default Object getIntentConfirmationSetting()
If the user answers "no," the settings contain a statement that is sent to the user to end the intent.
@Stability(value=Stable) @Nullable default Object getKendraConfiguration()
@Stability(value=Stable) @Nullable default Object getOutputContexts()
@Stability(value=Stable) @Nullable default String getParentIntentSignature()
@Stability(value=Stable) @Nullable default Object getSampleUtterances()
@Stability(value=Stable) @Nullable default Object getSlotPriorities()
Amazon Lex prompts the user for slot values in priority order.
@Stability(value=Stable) @Nullable default Object getSlots()
@Stability(value=Stable) static CfnBot.IntentProperty.Builder builder()
CfnBot.IntentProperty.Builder of CfnBot.IntentPropertyCopyright © 2022. All rights reserved.