Interface CfnBot.IDialogCodeHookInvocationSettingProperty
Settings that specify the dialog code hook that is called by Amazon Lex at a step of the conversation.
Namespace: Amazon.CDK.AWS.Lex
Assembly: Amazon.CDK.AWS.Lex.dll
Syntax (csharp)
public interface IDialogCodeHookInvocationSettingProperty
Syntax (vb)
Public Interface IDialogCodeHookInvocationSettingProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lex;
SlotValueOverrideProperty slotValueOverrideProperty_;
var dialogCodeHookInvocationSettingProperty = new DialogCodeHookInvocationSettingProperty {
EnableCodeHookInvocation = false,
IsActive = false,
PostCodeHookSpecification = new PostDialogCodeHookInvocationSpecificationProperty {
FailureConditional = new ConditionalSpecificationProperty {
ConditionalBranches = new [] { new ConditionalBranchProperty {
Condition = new ConditionProperty {
ExpressionString = "expressionString"
},
Name = "name",
NextStep = new DialogStateProperty {
DialogAction = new DialogActionProperty {
Type = "type",
// the properties below are optional
SlotToElicit = "slotToElicit",
SuppressNextMessage = false
},
Intent = new IntentOverrideProperty {
Name = "name",
Slots = new [] { new SlotValueOverrideMapProperty {
SlotName = "slotName",
SlotValueOverride = new SlotValueOverrideProperty {
Shape = "shape",
Value = new SlotValueProperty {
InterpretedValue = "interpretedValue"
},
Values = new [] { slotValueOverrideProperty_ }
}
} }
},
SessionAttributes = new [] { new SessionAttributeProperty {
Key = "key",
// the properties below are optional
Value = "value"
} }
},
// the properties below are optional
Response = new ResponseSpecificationProperty {
MessageGroupsList = new [] { new MessageGroupProperty {
Message = new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
},
// the properties below are optional
Variations = new [] { new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
} }
} },
// the properties below are optional
AllowInterrupt = false
}
} },
DefaultBranch = new DefaultConditionalBranchProperty {
NextStep = new DialogStateProperty {
DialogAction = new DialogActionProperty {
Type = "type",
// the properties below are optional
SlotToElicit = "slotToElicit",
SuppressNextMessage = false
},
Intent = new IntentOverrideProperty {
Name = "name",
Slots = new [] { new SlotValueOverrideMapProperty {
SlotName = "slotName",
SlotValueOverride = new SlotValueOverrideProperty {
Shape = "shape",
Value = new SlotValueProperty {
InterpretedValue = "interpretedValue"
},
Values = new [] { slotValueOverrideProperty_ }
}
} }
},
SessionAttributes = new [] { new SessionAttributeProperty {
Key = "key",
// the properties below are optional
Value = "value"
} }
},
Response = new ResponseSpecificationProperty {
MessageGroupsList = new [] { new MessageGroupProperty {
Message = new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
},
// the properties below are optional
Variations = new [] { new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
} }
} },
// the properties below are optional
AllowInterrupt = false
}
},
IsActive = false
},
FailureNextStep = new DialogStateProperty {
DialogAction = new DialogActionProperty {
Type = "type",
// the properties below are optional
SlotToElicit = "slotToElicit",
SuppressNextMessage = false
},
Intent = new IntentOverrideProperty {
Name = "name",
Slots = new [] { new SlotValueOverrideMapProperty {
SlotName = "slotName",
SlotValueOverride = new SlotValueOverrideProperty {
Shape = "shape",
Value = new SlotValueProperty {
InterpretedValue = "interpretedValue"
},
Values = new [] { slotValueOverrideProperty_ }
}
} }
},
SessionAttributes = new [] { new SessionAttributeProperty {
Key = "key",
// the properties below are optional
Value = "value"
} }
},
FailureResponse = new ResponseSpecificationProperty {
MessageGroupsList = new [] { new MessageGroupProperty {
Message = new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
},
// the properties below are optional
Variations = new [] { new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
} }
} },
// the properties below are optional
AllowInterrupt = false
},
SuccessConditional = new ConditionalSpecificationProperty {
ConditionalBranches = new [] { new ConditionalBranchProperty {
Condition = new ConditionProperty {
ExpressionString = "expressionString"
},
Name = "name",
NextStep = new DialogStateProperty {
DialogAction = new DialogActionProperty {
Type = "type",
// the properties below are optional
SlotToElicit = "slotToElicit",
SuppressNextMessage = false
},
Intent = new IntentOverrideProperty {
Name = "name",
Slots = new [] { new SlotValueOverrideMapProperty {
SlotName = "slotName",
SlotValueOverride = new SlotValueOverrideProperty {
Shape = "shape",
Value = new SlotValueProperty {
InterpretedValue = "interpretedValue"
},
Values = new [] { slotValueOverrideProperty_ }
}
} }
},
SessionAttributes = new [] { new SessionAttributeProperty {
Key = "key",
// the properties below are optional
Value = "value"
} }
},
// the properties below are optional
Response = new ResponseSpecificationProperty {
MessageGroupsList = new [] { new MessageGroupProperty {
Message = new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
},
// the properties below are optional
Variations = new [] { new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
} }
} },
// the properties below are optional
AllowInterrupt = false
}
} },
DefaultBranch = new DefaultConditionalBranchProperty {
NextStep = new DialogStateProperty {
DialogAction = new DialogActionProperty {
Type = "type",
// the properties below are optional
SlotToElicit = "slotToElicit",
SuppressNextMessage = false
},
Intent = new IntentOverrideProperty {
Name = "name",
Slots = new [] { new SlotValueOverrideMapProperty {
SlotName = "slotName",
SlotValueOverride = new SlotValueOverrideProperty {
Shape = "shape",
Value = new SlotValueProperty {
InterpretedValue = "interpretedValue"
},
Values = new [] { slotValueOverrideProperty_ }
}
} }
},
SessionAttributes = new [] { new SessionAttributeProperty {
Key = "key",
// the properties below are optional
Value = "value"
} }
},
Response = new ResponseSpecificationProperty {
MessageGroupsList = new [] { new MessageGroupProperty {
Message = new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
},
// the properties below are optional
Variations = new [] { new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
} }
} },
// the properties below are optional
AllowInterrupt = false
}
},
IsActive = false
},
SuccessNextStep = new DialogStateProperty {
DialogAction = new DialogActionProperty {
Type = "type",
// the properties below are optional
SlotToElicit = "slotToElicit",
SuppressNextMessage = false
},
Intent = new IntentOverrideProperty {
Name = "name",
Slots = new [] { new SlotValueOverrideMapProperty {
SlotName = "slotName",
SlotValueOverride = new SlotValueOverrideProperty {
Shape = "shape",
Value = new SlotValueProperty {
InterpretedValue = "interpretedValue"
},
Values = new [] { slotValueOverrideProperty_ }
}
} }
},
SessionAttributes = new [] { new SessionAttributeProperty {
Key = "key",
// the properties below are optional
Value = "value"
} }
},
SuccessResponse = new ResponseSpecificationProperty {
MessageGroupsList = new [] { new MessageGroupProperty {
Message = new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
},
// the properties below are optional
Variations = new [] { new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
} }
} },
// the properties below are optional
AllowInterrupt = false
},
TimeoutConditional = new ConditionalSpecificationProperty {
ConditionalBranches = new [] { new ConditionalBranchProperty {
Condition = new ConditionProperty {
ExpressionString = "expressionString"
},
Name = "name",
NextStep = new DialogStateProperty {
DialogAction = new DialogActionProperty {
Type = "type",
// the properties below are optional
SlotToElicit = "slotToElicit",
SuppressNextMessage = false
},
Intent = new IntentOverrideProperty {
Name = "name",
Slots = new [] { new SlotValueOverrideMapProperty {
SlotName = "slotName",
SlotValueOverride = new SlotValueOverrideProperty {
Shape = "shape",
Value = new SlotValueProperty {
InterpretedValue = "interpretedValue"
},
Values = new [] { slotValueOverrideProperty_ }
}
} }
},
SessionAttributes = new [] { new SessionAttributeProperty {
Key = "key",
// the properties below are optional
Value = "value"
} }
},
// the properties below are optional
Response = new ResponseSpecificationProperty {
MessageGroupsList = new [] { new MessageGroupProperty {
Message = new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
},
// the properties below are optional
Variations = new [] { new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
} }
} },
// the properties below are optional
AllowInterrupt = false
}
} },
DefaultBranch = new DefaultConditionalBranchProperty {
NextStep = new DialogStateProperty {
DialogAction = new DialogActionProperty {
Type = "type",
// the properties below are optional
SlotToElicit = "slotToElicit",
SuppressNextMessage = false
},
Intent = new IntentOverrideProperty {
Name = "name",
Slots = new [] { new SlotValueOverrideMapProperty {
SlotName = "slotName",
SlotValueOverride = new SlotValueOverrideProperty {
Shape = "shape",
Value = new SlotValueProperty {
InterpretedValue = "interpretedValue"
},
Values = new [] { slotValueOverrideProperty_ }
}
} }
},
SessionAttributes = new [] { new SessionAttributeProperty {
Key = "key",
// the properties below are optional
Value = "value"
} }
},
Response = new ResponseSpecificationProperty {
MessageGroupsList = new [] { new MessageGroupProperty {
Message = new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
},
// the properties below are optional
Variations = new [] { new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
} }
} },
// the properties below are optional
AllowInterrupt = false
}
},
IsActive = false
},
TimeoutNextStep = new DialogStateProperty {
DialogAction = new DialogActionProperty {
Type = "type",
// the properties below are optional
SlotToElicit = "slotToElicit",
SuppressNextMessage = false
},
Intent = new IntentOverrideProperty {
Name = "name",
Slots = new [] { new SlotValueOverrideMapProperty {
SlotName = "slotName",
SlotValueOverride = new SlotValueOverrideProperty {
Shape = "shape",
Value = new SlotValueProperty {
InterpretedValue = "interpretedValue"
},
Values = new [] { slotValueOverrideProperty_ }
}
} }
},
SessionAttributes = new [] { new SessionAttributeProperty {
Key = "key",
// the properties below are optional
Value = "value"
} }
},
TimeoutResponse = new ResponseSpecificationProperty {
MessageGroupsList = new [] { new MessageGroupProperty {
Message = new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
},
// the properties below are optional
Variations = new [] { new MessageProperty {
CustomPayload = new CustomPayloadProperty {
Value = "value"
},
ImageResponseCard = new ImageResponseCardProperty {
Title = "title",
// the properties below are optional
Buttons = new [] { new ButtonProperty {
Text = "text",
Value = "value"
} },
ImageUrl = "imageUrl",
Subtitle = "subtitle"
},
PlainTextMessage = new PlainTextMessageProperty {
Value = "value"
},
SsmlMessage = new SSMLMessageProperty {
Value = "value"
}
} }
} },
// the properties below are optional
AllowInterrupt = false
}
},
// the properties below are optional
InvocationLabel = "invocationLabel"
};
Synopsis
Properties
EnableCodeHookInvocation | Indicates whether a Lambda function should be invoked for the dialog. |
InvocationLabel | A label that indicates the dialog step from which the dialog code hook is happening. |
IsActive | Determines whether a dialog code hook is used when the intent is activated. |
PostCodeHookSpecification | Contains the responses and actions that Amazon Lex takes after the Lambda function is complete. |
Properties
EnableCodeHookInvocation
Indicates whether a Lambda function should be invoked for the dialog.
object EnableCodeHookInvocation { get; }
Property Value
System.Object
Remarks
InvocationLabel
A label that indicates the dialog step from which the dialog code hook is happening.
virtual string InvocationLabel { get; }
Property Value
System.String
Remarks
IsActive
Determines whether a dialog code hook is used when the intent is activated.
object IsActive { get; }
Property Value
System.Object
Remarks
PostCodeHookSpecification
Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
object PostCodeHookSpecification { get; }
Property Value
System.Object