software.amazon.awscdk.services.lex

Interface CfnBot.WaitAndContinueSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.WaitAndContinueSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnBot

@Stability(value=Stable)
public static interface CfnBot.WaitAndContinueSpecificationProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

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.*;
 WaitAndContinueSpecificationProperty waitAndContinueSpecificationProperty = 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnBot.WaitAndContinueSpecificationProperty.Builder	builder()
Object	getContinueResponse() The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
default Object	getIsActive() Specifies whether the bot will wait for a user to respond.
default Object	getStillWaitingResponse() A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
Object	getWaitingResponse() The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getContinueResponse

@Stability(value=Stable)
 @NotNull
Object getContinueResponse()

The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

getWaitingResponse

@Stability(value=Stable)
 @NotNull
Object getWaitingResponse()

The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

getIsActive

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

Specifies whether the bot will wait for a user to respond.

When this field is false, wait and continue responses for a slot aren't used and the bot expects an appropriate response within the configured timeout. If the IsActive field isn't specified, the default is true.

getStillWaitingResponse

@Stability(value=Stable)
 @Nullable
default Object getStillWaitingResponse()

A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

builder

@Stability(value=Stable)
static CfnBot.WaitAndContinueSpecificationProperty.Builder builder()

Returns:

a CfnBot.WaitAndContinueSpecificationProperty.Builder of CfnBot.WaitAndContinueSpecificationProperty