interface SlotCaptureSettingProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Lex.CfnBot.SlotCaptureSettingProperty |
 Java | software.amazon.awscdk.services.lex.CfnBot.SlotCaptureSettingProperty |
 Python | aws_cdk.aws_lex.CfnBot.SlotCaptureSettingProperty |
 TypeScript | @aws-cdk/aws-lex » CfnBot » SlotCaptureSettingProperty |
Settings used when Amazon Lex successfully captures a slot value from a user.
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 slotCaptureSettingProperty: lex.CfnBot.SlotCaptureSettingProperty = {
captureConditional: {
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,
},
captureNextStep: {
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',
}],
},
captureResponse: {
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,
},
codeHook: {
enableCodeHookInvocation: false,
isActive: false,
postCodeHookSpecification: {
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,
},
},
// the properties below are optional
invocationLabel: 'invocationLabel',
},
elicitationCodeHook: {
enableCodeHookInvocation: false,
// the properties below are optional
invocationLabel: 'invocationLabel',
},
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,
},
};
Properties
| Name | Type | Description |
|---|---|---|
| capture | IResolvable | Conditional | A list of conditional branches to evaluate after the slot value is captured. |
| capture | IResolvable | Dialog | Specifies the next step that the bot runs when the slot value is captured before the code hook times out. |
| capture | IResolvable | Response | Specifies a list of message groups that Amazon Lex uses to respond the user input. |
| code | IResolvable | Dialog | Code hook called after Amazon Lex successfully captures a slot value. |
| elicitation | IResolvable | Elicitation | Code hook called when Amazon Lex doesn't capture a slot value. |
| failure | IResolvable | Conditional | A list of conditional branches to evaluate when the slot value isn't captured. |
| failure | IResolvable | Dialog | Specifies the next step that the bot runs when the slot value code is not recognized. |
| failure | IResolvable | Response | Specifies a list of message groups that Amazon Lex uses to respond the user input when the slot fails to be captured. |
captureConditional?
Type:
IResolvable | Conditional
(optional)
A list of conditional branches to evaluate after the slot value is captured.
captureNextStep?
Type:
IResolvable | Dialog
(optional)
Specifies the next step that the bot runs when the slot value is captured before the code hook times out.
captureResponse?
Type:
IResolvable | Response
(optional)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
codeHook?
Type:
IResolvable | Dialog
(optional)
Code hook called after Amazon Lex successfully captures a slot value.
elicitationCodeHook?
Type:
IResolvable | Elicitation
(optional)
Code hook called when Amazon Lex doesn't capture a slot value.
failureConditional?
Type:
IResolvable | Conditional
(optional)
A list of conditional branches to evaluate when the slot value isn't captured.
failureNextStep?
Type:
IResolvable | Dialog
(optional)
Specifies the next step that the bot runs when the slot value code is not recognized.
failureResponse?
Type:
IResolvable | Response
(optional)
Specifies a list of message groups that Amazon Lex uses to respond the user input when the slot fails to be captured.