interface IntentClosingSettingProperty

Language	Type name
.NET	Amazon.CDK.AWS.Lex.CfnBot.IntentClosingSettingProperty
Java	software.amazon.awscdk.services.lex.CfnBot.IntentClosingSettingProperty
Python	aws_cdk.aws_lex.CfnBot.IntentClosingSettingProperty
TypeScript	@aws-cdk/aws-lex » CfnBot » IntentClosingSettingProperty

Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as lex from '@aws-cdk/aws-lex';

declare const slotValueOverrideProperty_: lex.CfnBot.SlotValueOverrideProperty;
const intentClosingSettingProperty: lex.CfnBot.IntentClosingSettingProperty = {
  closingResponse: {
    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,
  },
  conditional: {
    conditionalBranches: [{
      condition: {
        expressionString: 'expressionString',
      },
      name: 'name',
      nextStep: {
        dialogAction: {
          type: 'type',

          // the properties below are optional
          slotToElicit: 'slotToElicit',
          suppressNextMessage: false,
        },
        intent: {
          name: 'name',
          slots: [{
            slotName: 'slotName',
            slotValueOverride: {
              shape: 'shape',
              value: {
                interpretedValue: 'interpretedValue',
              },
              values: [slotValueOverrideProperty_],
            },
          }],
        },
        sessionAttributes: [{
          key: 'key',

          // the properties below are optional
          value: 'value',
        }],
      },

      // the properties below are optional
      response: {
        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,
      },
    }],
    defaultBranch: {
      nextStep: {
        dialogAction: {
          type: 'type',

          // the properties below are optional
          slotToElicit: 'slotToElicit',
          suppressNextMessage: false,
        },
        intent: {
          name: 'name',
          slots: [{
            slotName: 'slotName',
            slotValueOverride: {
              shape: 'shape',
              value: {
                interpretedValue: 'interpretedValue',
              },
              values: [slotValueOverrideProperty_],
            },
          }],
        },
        sessionAttributes: [{
          key: 'key',

          // the properties below are optional
          value: 'value',
        }],
      },
      response: {
        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,
      },
    },
    isActive: false,
  },
  isActive: false,
  nextStep: {
    dialogAction: {
      type: 'type',

      // the properties below are optional
      slotToElicit: 'slotToElicit',
      suppressNextMessage: false,
    },
    intent: {
      name: 'name',
      slots: [{
        slotName: 'slotName',
        slotValueOverride: {
          shape: 'shape',
          value: {
            interpretedValue: 'interpretedValue',
          },
          values: [slotValueOverrideProperty_],
        },
      }],
    },
    sessionAttributes: [{
      key: 'key',

      // the properties below are optional
      value: 'value',
    }],
  },
};

Properties

Name	Type	Description
closingResponse?	IResolvable | ResponseSpecificationProperty	The response that Amazon Lex sends to the user when the intent is complete.
conditional?	IResolvable | ConditionalSpecificationProperty	A list of conditional branches associated with the intent's closing response.
isActive?	boolean | IResolvable	Specifies whether an intent's closing response is used.
nextStep?	IResolvable | DialogStateProperty	Specifies the next step that the bot executes after playing the intent's closing response.

---

closingResponse?

Type: IResolvable | ResponseSpecificationProperty (optional)

The response that Amazon Lex sends to the user when the intent is complete.

---

conditional?

Type: IResolvable | ConditionalSpecificationProperty (optional)

A list of conditional branches associated with the intent's closing response.

These branches are executed when the nextStep attribute is set to EvalutateConditional .

---

isActive?

Type: boolean | IResolvable (optional)

Specifies whether an intent's closing response is used.

When this field is false, the closing response isn't sent to the user. If the IsActive field isn't specified, the default is true.

---

nextStep?

Type: IResolvable | DialogStateProperty (optional)

Specifies the next step that the bot executes after playing the intent's closing response.