interface PostDialogCodeHookInvocationSpecificationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Lex.CfnBot.PostDialogCodeHookInvocationSpecificationProperty |
 Java | software.amazon.awscdk.services.lex.CfnBot.PostDialogCodeHookInvocationSpecificationProperty |
 Python | aws_cdk.aws_lex.CfnBot.PostDialogCodeHookInvocationSpecificationProperty |
 TypeScript | @aws-cdk/aws-lex » CfnBot » PostDialogCodeHookInvocationSpecificationProperty |
Specifies next steps to run after the dialog code hook finishes.
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 postDialogCodeHookInvocationSpecificationProperty: lex.CfnBot.PostDialogCodeHookInvocationSpecificationProperty = {
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 |
|---|---|---|
| failure | IResolvable | Conditional | A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed . |
| failure | IResolvable | Dialog | Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed . |
| failure | IResolvable | Response | Specifies a list of message groups that Amazon Lex uses to respond the user input when the code hook fails. |
| success | IResolvable | Conditional | A list of conditional branches to evaluate after the dialog code hook finishes successfully. |
| success | IResolvable | Dialog | Specifics the next step the bot runs after the dialog code hook finishes successfully. |
| success | IResolvable | Response | Specifies a list of message groups that Amazon Lex uses to respond when the code hook succeeds. |
| timeout | IResolvable | Conditional | A list of conditional branches to evaluate if the code hook times out. |
| timeout | IResolvable | Dialog | Specifies the next step that the bot runs when the code hook times out. |
| timeout | IResolvable | Response | Specifies a list of message groups that Amazon Lex uses to respond to the user input when the code hook times out. |
failureConditional?
Type:
IResolvable | Conditional
(optional)
A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed .
failureNextStep?
Type:
IResolvable | Dialog
(optional)
Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the State field of the Intent object set to Failed .
failureResponse?
Type:
IResolvable | Response
(optional)
Specifies a list of message groups that Amazon Lex uses to respond the user input when the code hook fails.
successConditional?
Type:
IResolvable | Conditional
(optional)
A list of conditional branches to evaluate after the dialog code hook finishes successfully.
successNextStep?
Type:
IResolvable | Dialog
(optional)
Specifics the next step the bot runs after the dialog code hook finishes successfully.
successResponse?
Type:
IResolvable | Response
(optional)
Specifies a list of message groups that Amazon Lex uses to respond when the code hook succeeds.
timeoutConditional?
Type:
IResolvable | Conditional
(optional)
A list of conditional branches to evaluate if the code hook times out.
timeoutNextStep?
Type:
IResolvable | Dialog
(optional)
Specifies the next step that the bot runs when the code hook times out.
timeoutResponse?
Type:
IResolvable | Response
(optional)
Specifies a list of message groups that Amazon Lex uses to respond to the user input when the code hook times out.