aws-cdk-lib.aws_lex.CfnBot.WaitAndContinueSpecificationProperty

interface WaitAndContinueSpecificationProperty

LanguageType name
.NETAmazon.CDK.AWS.Lex.CfnBot.WaitAndContinueSpecificationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awslex#CfnBot_WaitAndContinueSpecificationProperty
Javasoftware.amazon.awscdk.services.lex.CfnBot.WaitAndContinueSpecificationProperty
Pythonaws_cdk.aws_lex.CfnBot.WaitAndContinueSpecificationProperty
TypeScript aws-cdk-lib » aws_lex » CfnBot » WaitAndContinueSpecificationProperty

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 { aws_lex as lex } from 'aws-cdk-lib';
const waitAndContinueSpecificationProperty: lex.CfnBot.WaitAndContinueSpecificationProperty = {
  continueResponse: {
    messageGroupsList: [{
      message: {
        customPayload: {
          value: 'value',
        },
        imageResponseCard: {
          title: 'title',

          // the properties below are optional
          buttons: [{
            text: 'text',
            value: 'value',
          }],
          imageUrl: 'imageUrl',
          subtitle: 'subtitle',
        },
        plainTextMessage: {
          value: 'value',
        },
        ssmlMessage: {
          value: 'value',
        },
      },

      // the properties below are optional
      variations: [{
        customPayload: {
          value: 'value',
        },
        imageResponseCard: {
          title: 'title',

          // the properties below are optional
          buttons: [{
            text: 'text',
            value: 'value',
          }],
          imageUrl: 'imageUrl',
          subtitle: 'subtitle',
        },
        plainTextMessage: {
          value: 'value',
        },
        ssmlMessage: {
          value: 'value',
        },
      }],
    }],

    // the properties below are optional
    allowInterrupt: false,
  },
  waitingResponse: {
    messageGroupsList: [{
      message: {
        customPayload: {
          value: 'value',
        },
        imageResponseCard: {
          title: 'title',

          // the properties below are optional
          buttons: [{
            text: 'text',
            value: 'value',
          }],
          imageUrl: 'imageUrl',
          subtitle: 'subtitle',
        },
        plainTextMessage: {
          value: 'value',
        },
        ssmlMessage: {
          value: 'value',
        },
      },

      // the properties below are optional
      variations: [{
        customPayload: {
          value: 'value',
        },
        imageResponseCard: {
          title: 'title',

          // the properties below are optional
          buttons: [{
            text: 'text',
            value: 'value',
          }],
          imageUrl: 'imageUrl',
          subtitle: 'subtitle',
        },
        plainTextMessage: {
          value: 'value',
        },
        ssmlMessage: {
          value: 'value',
        },
      }],
    }],

    // the properties below are optional
    allowInterrupt: false,
  },

  // the properties below are optional
  isActive: false,
  stillWaitingResponse: {
    frequencyInSeconds: 123,
    messageGroupsList: [{
      message: {
        customPayload: {
          value: 'value',
        },
        imageResponseCard: {
          title: 'title',

          // the properties below are optional
          buttons: [{
            text: 'text',
            value: 'value',
          }],
          imageUrl: 'imageUrl',
          subtitle: 'subtitle',
        },
        plainTextMessage: {
          value: 'value',
        },
        ssmlMessage: {
          value: 'value',
        },
      },

      // the properties below are optional
      variations: [{
        customPayload: {
          value: 'value',
        },
        imageResponseCard: {
          title: 'title',

          // the properties below are optional
          buttons: [{
            text: 'text',
            value: 'value',
          }],
          imageUrl: 'imageUrl',
          subtitle: 'subtitle',
        },
        plainTextMessage: {
          value: 'value',
        },
        ssmlMessage: {
          value: 'value',
        },
      }],
    }],
    timeoutInSeconds: 123,

    // the properties below are optional
    allowInterrupt: false,
  },
};

Properties

NameTypeDescription
continueResponseIResolvable | ResponseSpecificationPropertyThe response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
waitingResponseIResolvable | ResponseSpecificationPropertyThe response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
isActive?boolean | IResolvableSpecifies whether the bot will wait for a user to respond.
stillWaitingResponse?IResolvable | StillWaitingResponseSpecificationPropertyA response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

continueResponse

Type: IResolvable | ResponseSpecificationProperty

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


waitingResponse

Type: IResolvable | ResponseSpecificationProperty

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


isActive?

Type: boolean | IResolvable (optional)

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. If the IsActive field isn't specified, the default is true.


stillWaitingResponse?

Type: IResolvable | StillWaitingResponseSpecificationProperty (optional)

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