software.amazon.awscdk.services.lex

Interface CfnBot.StillWaitingResponseSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBot.StillWaitingResponseSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnBot

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

Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.

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.*;
 StillWaitingResponseSpecificationProperty stillWaitingResponseSpecificationProperty = 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnBot.StillWaitingResponseSpecificationProperty.Builder	builder()
default Object	getAllowInterrupt() Indicates that the user can interrupt the response by speaking while the message is being played.
Number	getFrequencyInSeconds() How often a message should be sent to the user.
Object	getMessageGroupsList() A collection of responses that Amazon Lex can send to the user.
Number	getTimeoutInSeconds() If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFrequencyInSeconds

@Stability(value=Stable)
 @NotNull
Number getFrequencyInSeconds()

How often a message should be sent to the user.

Minimum of 1 second, maximum of 5 minutes.

getMessageGroupsList

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

A collection of responses that Amazon Lex can send to the user.

Amazon Lex chooses the actual response to send at runtime.

getTimeoutInSeconds

@Stability(value=Stable)
 @NotNull
Number getTimeoutInSeconds()

If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

getAllowInterrupt

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

Indicates that the user can interrupt the response by speaking while the message is being played.

builder

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

Returns:

a CfnBot.StillWaitingResponseSpecificationProperty.Builder of CfnBot.StillWaitingResponseSpecificationProperty