interface FulfillmentUpdateResponseSpecificationProperty

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

Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.

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 fulfillmentUpdateResponseSpecificationProperty: lex.CfnBot.FulfillmentUpdateResponseSpecificationProperty = {
  frequencyInSeconds: 123,
  messageGroups: [{
    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
frequencyInSeconds	`number`	The frequency that a message is sent to the user.
messageGroups	`IResolvable` `\|` `IResolvable` `\|` `MessageGroupProperty[]`	1 - 5 message groups that contain update messages.
allowInterrupt?	`boolean \|` `IResolvable`	Determines whether the user can interrupt an update message while it is playing.

frequencyInSeconds

Type: number

The frequency that a message is sent to the user.

When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

messageGroups

Type: IResolvable | IResolvable | MessageGroupProperty[]

1 - 5 message groups that contain update messages.

Amazon Lex chooses one of the messages to play to the user.

allowInterrupt?

Type: boolean | IResolvable (optional)

Determines whether the user can interrupt an update message while it is playing.