interface FulfillmentUpdatesSpecificationProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.Lex.Mixins.CfnBotPropsMixin.FulfillmentUpdatesSpecificationProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awslex/mixins#CfnBotPropsMixin_FulfillmentUpdatesSpecificationProperty`
Java	`software.amazon.awscdk.mixins.preview.services.lex.mixins.CfnBotPropsMixin.FulfillmentUpdatesSpecificationProperty`
Python	`aws_cdk.mixins_preview.aws_lex.mixins.CfnBotPropsMixin.FulfillmentUpdatesSpecificationProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_lex` » `mixins` » `CfnBotPropsMixin` » `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 { mixins as lex_mixins } from '@aws-cdk/mixins-preview/aws-lex';
const fulfillmentUpdatesSpecificationProperty: lex_mixins.CfnBotPropsMixin.FulfillmentUpdatesSpecificationProperty = {
  active: false,
  startResponse: {
    allowInterrupt: false,
    delayInSeconds: 123,
    messageGroups: [{
      message: {
        customPayload: {
          value: 'value',
        },
        imageResponseCard: {
          buttons: [{
            text: 'text',
            value: 'value',
          }],
          imageUrl: 'imageUrl',
          subtitle: 'subtitle',
          title: 'title',
        },
        plainTextMessage: {
          value: 'value',
        },
        ssmlMessage: {
          value: 'value',
        },
      },
      variations: [{
        customPayload: {
          value: 'value',
        },
        imageResponseCard: {
          buttons: [{
            text: 'text',
            value: 'value',
          }],
          imageUrl: 'imageUrl',
          subtitle: 'subtitle',
          title: 'title',
        },
        plainTextMessage: {
          value: 'value',
        },
        ssmlMessage: {
          value: 'value',
        },
      }],
    }],
  },
  timeoutInSeconds: 123,
  updateResponse: {
    allowInterrupt: false,
    frequencyInSeconds: 123,
    messageGroups: [{
      message: {
        customPayload: {
          value: 'value',
        },
        imageResponseCard: {
          buttons: [{
            text: 'text',
            value: 'value',
          }],
          imageUrl: 'imageUrl',
          subtitle: 'subtitle',
          title: 'title',
        },
        plainTextMessage: {
          value: 'value',
        },
        ssmlMessage: {
          value: 'value',
        },
      },
      variations: [{
        customPayload: {
          value: 'value',
        },
        imageResponseCard: {
          buttons: [{
            text: 'text',
            value: 'value',
          }],
          imageUrl: 'imageUrl',
          subtitle: 'subtitle',
          title: 'title',
        },
        plainTextMessage: {
          value: 'value',
        },
        ssmlMessage: {
          value: 'value',
        },
      }],
    }],
  },
};

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 (optional)

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.

AWS CDK

2.233.0