ResponseSpecificationProperty Struct
Specifies a list of message groups that Amazon Lex uses to respond the user input.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lex as lex } from 'aws-cdk-lib';
const responseSpecificationProperty: lex.CfnBot.ResponseSpecificationProperty = {
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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lex as lex
response_specification_property = lex.CfnBot.ResponseSpecificationProperty(
message_groups_list=[lex.CfnBot.MessageGroupProperty(
message=lex.CfnBot.MessageProperty(
custom_payload=lex.CfnBot.CustomPayloadProperty(
value="value"
),
image_response_card=lex.CfnBot.ImageResponseCardProperty(
title="title",
# the properties below are optional
buttons=[lex.CfnBot.ButtonProperty(
text="text",
value="value"
)],
image_url="imageUrl",
subtitle="subtitle"
),
plain_text_message=lex.CfnBot.PlainTextMessageProperty(
value="value"
),
ssml_message=lex.CfnBot.SSMLMessageProperty(
value="value"
)
),
# the properties below are optional
variations=[lex.CfnBot.MessageProperty(
custom_payload=lex.CfnBot.CustomPayloadProperty(
value="value"
),
image_response_card=lex.CfnBot.ImageResponseCardProperty(
title="title",
# the properties below are optional
buttons=[lex.CfnBot.ButtonProperty(
text="text",
value="value"
)],
image_url="imageUrl",
subtitle="subtitle"
),
plain_text_message=lex.CfnBot.PlainTextMessageProperty(
value="value"
),
ssml_message=lex.CfnBot.SSMLMessageProperty(
value="value"
)
)]
)],
# the properties below are optional
allow_interrupt=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.lex.*;
ResponseSpecificationProperty responseSpecificationProperty = ResponseSpecificationProperty.builder()
.messageGroupsList(List.of(MessageGroupProperty.builder()
.message(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build())
// the properties below are optional
.variations(List.of(MessageProperty.builder()
.customPayload(CustomPayloadProperty.builder()
.value("value")
.build())
.imageResponseCard(ImageResponseCardProperty.builder()
.title("title")
// the properties below are optional
.buttons(List.of(ButtonProperty.builder()
.text("text")
.value("value")
.build()))
.imageUrl("imageUrl")
.subtitle("subtitle")
.build())
.plainTextMessage(PlainTextMessageProperty.builder()
.value("value")
.build())
.ssmlMessage(SSMLMessageProperty.builder()
.value("value")
.build())
.build()))
.build()))
// the properties below are optional
.allowInterrupt(false)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Lex;
var responseSpecificationProperty = 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
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
responseSpecificationProperty := &ResponseSpecificationProperty{
MessageGroupsList: []interface{}{
&MessageGroupProperty{
Message: &MessageProperty{
CustomPayload: &CustomPayloadProperty{
Value: jsii.String("value"),
},
ImageResponseCard: &ImageResponseCardProperty{
Title: jsii.String("title"),
// the properties below are optional
Buttons: []interface{}{
&ButtonProperty{
Text: jsii.String("text"),
Value: jsii.String("value"),
},
},
ImageUrl: jsii.String("imageUrl"),
Subtitle: jsii.String("subtitle"),
},
PlainTextMessage: &PlainTextMessageProperty{
Value: jsii.String("value"),
},
SsmlMessage: &SSMLMessageProperty{
Value: jsii.String("value"),
},
},
// the properties below are optional
Variations: []interface{}{
&MessageProperty{
CustomPayload: &CustomPayloadProperty{
Value: jsii.String("value"),
},
ImageResponseCard: &ImageResponseCardProperty{
Title: jsii.String("title"),
// the properties below are optional
Buttons: []interface{}{
&ButtonProperty{
Text: jsii.String("text"),
Value: jsii.String("value"),
},
},
ImageUrl: jsii.String("imageUrl"),
Subtitle: jsii.String("subtitle"),
},
PlainTextMessage: &PlainTextMessageProperty{
Value: jsii.String("value"),
},
SsmlMessage: &SSMLMessageProperty{
Value: jsii.String("value"),
},
},
},
},
},
// the properties below are optional
AllowInterrupt: jsii.Boolean(false),
}
Properties
allowInterruptoptionalboolean | IResolvableallow_interruptoptionaltyping.Union[bool, IResolvable]allowInterruptoptionalBooleanAllowInterruptoptionalboolAllowInterruptoptionalinterface{}#Indicates whether the user can interrupt a speech response from Amazon Lex.
messageGroupsListIResolvable | IResolvable | CfnBot.MessageGroupProperty[]message_groups_listtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MessageGroupProperty]]]messageGroupsListIResolvableMessageGroupsListIResolvableMessageGroupsListinterface{}required#A collection of responses that Amazon Lex can send to the user.
Amazon Lex chooses the actual response to send at runtime.