interface PostFulfillmentStatusSpecificationProperty

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

Provides a setting that determines whether the post-fulfillment response is sent to the user.

For more information, see

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 postFulfillmentStatusSpecificationProperty: lex.CfnBot.PostFulfillmentStatusSpecificationProperty = {
  failureConditional: {
    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,
  },
  failureNextStep: {
    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',
    }],
  },
  failureResponse: {
    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,
  },
  successConditional: {
    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,
  },
  successNextStep: {
    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',
    }],
  },
  successResponse: {
    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,
  },
  timeoutConditional: {
    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,
  },
  timeoutNextStep: {
    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',
    }],
  },
  timeoutResponse: {
    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
failureConditional?	IResolvable | ConditionalSpecificationProperty	A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed .
failureNextStep?	IResolvable | DialogStateProperty	Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed .
failureResponse?	IResolvable | ResponseSpecificationProperty	Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn't successful.
successConditional?	IResolvable | ConditionalSpecificationProperty	A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.
successNextStep?	IResolvable | DialogStateProperty	Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.
successResponse?	IResolvable | ResponseSpecificationProperty	Specifies a list of message groups that Amazon Lex uses to respond when the fulfillment is successful.
timeoutConditional?	IResolvable | ConditionalSpecificationProperty	A list of conditional branches to evaluate if the fulfillment code hook times out.
timeoutNextStep?	IResolvable | DialogStateProperty	Specifies the next step that the bot runs when the fulfillment code hook times out.
timeoutResponse?	IResolvable | ResponseSpecificationProperty	Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn't completed within the timeout period.

---

failureConditional?

Type: IResolvable | ConditionalSpecificationProperty (optional)

A list of conditional branches to evaluate after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed .

---

failureNextStep?

Type: IResolvable | DialogStateProperty (optional)

Specifies the next step the bot runs after the fulfillment code hook throws an exception or returns with the State field of the Intent object set to Failed .

---

failureResponse?

Type: IResolvable | ResponseSpecificationProperty (optional)

Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn't successful.

---

successConditional?

Type: IResolvable | ConditionalSpecificationProperty (optional)

A list of conditional branches to evaluate after the fulfillment code hook finishes successfully.

---

successNextStep?

Type: IResolvable | DialogStateProperty (optional)

Specifies the next step in the conversation that Amazon Lex invokes when the fulfillment code hook completes successfully.

---

successResponse?

Type: IResolvable | ResponseSpecificationProperty (optional)

Specifies a list of message groups that Amazon Lex uses to respond when the fulfillment is successful.

---

timeoutConditional?

Type: IResolvable | ConditionalSpecificationProperty (optional)

A list of conditional branches to evaluate if the fulfillment code hook times out.

---

timeoutNextStep?

Type: IResolvable | DialogStateProperty (optional)

Specifies the next step that the bot runs when the fulfillment code hook times out.

---

timeoutResponse?

Type: IResolvable | ResponseSpecificationProperty (optional)

Specifies a list of message groups that Amazon Lex uses to respond when fulfillment isn't completed within the timeout period.