interface ResponseSpecificationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Lex.CfnBot.ResponseSpecificationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awslex#CfnBot_ResponseSpecificationProperty`
Java	`software.amazon.awscdk.services.lex.CfnBot.ResponseSpecificationProperty`
Python	`aws_cdk.aws_lex.CfnBot.ResponseSpecificationProperty`
TypeScript	`aws-cdk-lib` » `aws_lex` » `CfnBot` » `ResponseSpecificationProperty`

Specifies a list of message groups that Amazon Lex uses to respond the user 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 responseSpecificationProperty: lex.CfnBot.ResponseSpecificationProperty = {
  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,
};

Properties

Name	Type	Description
messageGroupsList	`IResolvable` `\|` `IResolvable` `\|` `MessageGroupProperty[]`	A collection of responses that Amazon Lex can send to the user.
allowInterrupt?	`boolean \|` `IResolvable`	Indicates whether the user can interrupt a speech response from Amazon Lex.

messageGroupsList

Type: IResolvable | IResolvable | MessageGroupProperty[]

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

Amazon Lex chooses the actual response to send at runtime.

allowInterrupt?

Type: boolean | IResolvable (optional)

Indicates whether the user can interrupt a speech response from Amazon Lex.