Interface CfnBot.FulfillmentCodeHookSettingProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnBot.FulfillmentCodeHookSettingProperty.Jsii$Proxy
- Enclosing class:
CfnBot
@Stability(Stable)
public static interface CfnBot.FulfillmentCodeHookSettingProperty
extends software.amazon.jsii.JsiiSerializable
Determines if a Lambda function should be invoked for a specific intent.
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.*; SlotValueOverrideProperty slotValueOverrideProperty_; FulfillmentCodeHookSettingProperty fulfillmentCodeHookSettingProperty = 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()) .isActive(false) .postFulfillmentStatusSpecification(PostFulfillmentStatusSpecificationProperty.builder() .failureConditional(ConditionalSpecificationProperty.builder() .conditionalBranches(List.of(ConditionalBranchProperty.builder() .condition(ConditionProperty.builder() .expressionString("expressionString") .build()) .name("name") .nextStep(DialogStateProperty.builder() .dialogAction(DialogActionProperty.builder() .type("type") // the properties below are optional .slotToElicit("slotToElicit") .suppressNextMessage(false) .build()) .intent(IntentOverrideProperty.builder() .name("name") .slots(List.of(SlotValueOverrideMapProperty.builder() .slotName("slotName") .slotValueOverride(SlotValueOverrideProperty.builder() .shape("shape") .value(SlotValueProperty.builder() .interpretedValue("interpretedValue") .build()) .values(List.of(slotValueOverrideProperty_)) .build()) .build())) .build()) .sessionAttributes(List.of(SessionAttributeProperty.builder() .key("key") // the properties below are optional .value("value") .build())) .build()) // the properties below are optional .response(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())) .defaultBranch(DefaultConditionalBranchProperty.builder() .nextStep(DialogStateProperty.builder() .dialogAction(DialogActionProperty.builder() .type("type") // the properties below are optional .slotToElicit("slotToElicit") .suppressNextMessage(false) .build()) .intent(IntentOverrideProperty.builder() .name("name") .slots(List.of(SlotValueOverrideMapProperty.builder() .slotName("slotName") .slotValueOverride(SlotValueOverrideProperty.builder() .shape("shape") .value(SlotValueProperty.builder() .interpretedValue("interpretedValue") .build()) .values(List.of(slotValueOverrideProperty_)) .build()) .build())) .build()) .sessionAttributes(List.of(SessionAttributeProperty.builder() .key("key") // the properties below are optional .value("value") .build())) .build()) .response(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()) .isActive(false) .build()) .failureNextStep(DialogStateProperty.builder() .dialogAction(DialogActionProperty.builder() .type("type") // the properties below are optional .slotToElicit("slotToElicit") .suppressNextMessage(false) .build()) .intent(IntentOverrideProperty.builder() .name("name") .slots(List.of(SlotValueOverrideMapProperty.builder() .slotName("slotName") .slotValueOverride(SlotValueOverrideProperty.builder() .shape("shape") .value(SlotValueProperty.builder() .interpretedValue("interpretedValue") .build()) .values(List.of(slotValueOverrideProperty_)) .build()) .build())) .build()) .sessionAttributes(List.of(SessionAttributeProperty.builder() .key("key") // the properties below are optional .value("value") .build())) .build()) .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()) .successConditional(ConditionalSpecificationProperty.builder() .conditionalBranches(List.of(ConditionalBranchProperty.builder() .condition(ConditionProperty.builder() .expressionString("expressionString") .build()) .name("name") .nextStep(DialogStateProperty.builder() .dialogAction(DialogActionProperty.builder() .type("type") // the properties below are optional .slotToElicit("slotToElicit") .suppressNextMessage(false) .build()) .intent(IntentOverrideProperty.builder() .name("name") .slots(List.of(SlotValueOverrideMapProperty.builder() .slotName("slotName") .slotValueOverride(SlotValueOverrideProperty.builder() .shape("shape") .value(SlotValueProperty.builder() .interpretedValue("interpretedValue") .build()) .values(List.of(slotValueOverrideProperty_)) .build()) .build())) .build()) .sessionAttributes(List.of(SessionAttributeProperty.builder() .key("key") // the properties below are optional .value("value") .build())) .build()) // the properties below are optional .response(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())) .defaultBranch(DefaultConditionalBranchProperty.builder() .nextStep(DialogStateProperty.builder() .dialogAction(DialogActionProperty.builder() .type("type") // the properties below are optional .slotToElicit("slotToElicit") .suppressNextMessage(false) .build()) .intent(IntentOverrideProperty.builder() .name("name") .slots(List.of(SlotValueOverrideMapProperty.builder() .slotName("slotName") .slotValueOverride(SlotValueOverrideProperty.builder() .shape("shape") .value(SlotValueProperty.builder() .interpretedValue("interpretedValue") .build()) .values(List.of(slotValueOverrideProperty_)) .build()) .build())) .build()) .sessionAttributes(List.of(SessionAttributeProperty.builder() .key("key") // the properties below are optional .value("value") .build())) .build()) .response(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()) .isActive(false) .build()) .successNextStep(DialogStateProperty.builder() .dialogAction(DialogActionProperty.builder() .type("type") // the properties below are optional .slotToElicit("slotToElicit") .suppressNextMessage(false) .build()) .intent(IntentOverrideProperty.builder() .name("name") .slots(List.of(SlotValueOverrideMapProperty.builder() .slotName("slotName") .slotValueOverride(SlotValueOverrideProperty.builder() .shape("shape") .value(SlotValueProperty.builder() .interpretedValue("interpretedValue") .build()) .values(List.of(slotValueOverrideProperty_)) .build()) .build())) .build()) .sessionAttributes(List.of(SessionAttributeProperty.builder() .key("key") // the properties below are optional .value("value") .build())) .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()) .timeoutConditional(ConditionalSpecificationProperty.builder() .conditionalBranches(List.of(ConditionalBranchProperty.builder() .condition(ConditionProperty.builder() .expressionString("expressionString") .build()) .name("name") .nextStep(DialogStateProperty.builder() .dialogAction(DialogActionProperty.builder() .type("type") // the properties below are optional .slotToElicit("slotToElicit") .suppressNextMessage(false) .build()) .intent(IntentOverrideProperty.builder() .name("name") .slots(List.of(SlotValueOverrideMapProperty.builder() .slotName("slotName") .slotValueOverride(SlotValueOverrideProperty.builder() .shape("shape") .value(SlotValueProperty.builder() .interpretedValue("interpretedValue") .build()) .values(List.of(slotValueOverrideProperty_)) .build()) .build())) .build()) .sessionAttributes(List.of(SessionAttributeProperty.builder() .key("key") // the properties below are optional .value("value") .build())) .build()) // the properties below are optional .response(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())) .defaultBranch(DefaultConditionalBranchProperty.builder() .nextStep(DialogStateProperty.builder() .dialogAction(DialogActionProperty.builder() .type("type") // the properties below are optional .slotToElicit("slotToElicit") .suppressNextMessage(false) .build()) .intent(IntentOverrideProperty.builder() .name("name") .slots(List.of(SlotValueOverrideMapProperty.builder() .slotName("slotName") .slotValueOverride(SlotValueOverrideProperty.builder() .shape("shape") .value(SlotValueProperty.builder() .interpretedValue("interpretedValue") .build()) .values(List.of(slotValueOverrideProperty_)) .build()) .build())) .build()) .sessionAttributes(List.of(SessionAttributeProperty.builder() .key("key") // the properties below are optional .value("value") .build())) .build()) .response(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()) .isActive(false) .build()) .timeoutNextStep(DialogStateProperty.builder() .dialogAction(DialogActionProperty.builder() .type("type") // the properties below are optional .slotToElicit("slotToElicit") .suppressNextMessage(false) .build()) .intent(IntentOverrideProperty.builder() .name("name") .slots(List.of(SlotValueOverrideMapProperty.builder() .slotName("slotName") .slotValueOverride(SlotValueOverrideProperty.builder() .shape("shape") .value(SlotValueProperty.builder() .interpretedValue("interpretedValue") .build()) .values(List.of(slotValueOverrideProperty_)) .build()) .build())) .build()) .sessionAttributes(List.of(SessionAttributeProperty.builder() .key("key") // the properties below are optional .value("value") .build())) .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();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnBot.FulfillmentCodeHookSettingProperty
static final class
An implementation forCfnBot.FulfillmentCodeHookSettingProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Indicates whether a Lambda function should be invoked to fulfill a specific intent.default Object
Provides settings for update messages sent to the user for long-running Lambda fulfillment functions.default Object
Determines whether the fulfillment code hook is used.default Object
Provides settings for messages sent to the user for after the Lambda fulfillment function completes.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getEnabled
Indicates whether a Lambda function should be invoked to fulfill a specific intent. -
getFulfillmentUpdatesSpecification
Provides settings for update messages sent to the user for long-running Lambda fulfillment functions.Fulfillment updates can be used only with streaming conversations.
-
getIsActive
Determines whether the fulfillment code hook is used.When
active
is false, the code hook doesn't run. -
getPostFulfillmentStatusSpecification
Provides settings for messages sent to the user for after the Lambda fulfillment function completes.Post-fulfillment messages can be sent for both streaming and non-streaming conversations.
-
builder
-