interface FulfillmentUpdatesSpecificationProperty

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

Provides information for updating the user on the progress of fulfilling an intent.

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 fulfillmentUpdatesSpecificationProperty: lex.CfnBot.FulfillmentUpdatesSpecificationProperty = {
  active: false,

  // the properties below are optional
  startResponse: {
    delayInSeconds: 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,
  },
  timeoutInSeconds: 123,
  updateResponse: {
    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
active	`boolean \|` `IResolvable`	Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
startResponse?	`IResolvable` `\|` `FulfillmentStartResponseSpecificationProperty`	Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
timeoutInSeconds?	`number`	The length of time that the fulfillment Lambda function should run before it times out.
updateResponse?	`IResolvable` `\|` `FulfillmentUpdateResponseSpecificationProperty`	Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.

active

Type: boolean | IResolvable

Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.

If the active field is set to true, the startResponse , updateResponse , and timeoutInSeconds fields are required.

startResponse?

Type: IResolvable | FulfillmentStartResponseSpecificationProperty (optional)

Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.

timeoutInSeconds?

Type: number (optional)

The length of time that the fulfillment Lambda function should run before it times out.

updateResponse?

Type: IResolvable | FulfillmentUpdateResponseSpecificationProperty (optional)

Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.