[ aws . lexv2-models ]
Updates the settings for a slot.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
update-slot
--slot-id <value>
--slot-name <value>
[--description <value>]
[--slot-type-id <value>]
--value-elicitation-setting <value>
[--obfuscation-setting <value>]
--bot-id <value>
--bot-version <value>
--locale-id <value>
--intent-id <value>
[--multiple-values-setting <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--slot-id
(string)
The unique identifier for the slot to update.
--slot-name
(string)
The new name for the slot.
--description
(string)
The new description for the slot.
--slot-type-id
(string)
The unique identifier of the new slot type to associate with this slot.
--value-elicitation-setting
(structure)
A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.
defaultValueSpecification -> (structure)
A list of default values for a slot. Default values are used when Amazon Lex hasn’t determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.
defaultValueList -> (list)
A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
(structure)
Specifies the default value to use when a user doesn’t provide a value for a slot.
defaultValue -> (string)
The default value to use when a user doesn’t provide a value for a slot.
slotConstraint -> (string)
Specifies whether the slot is required or optional.
promptSpecification -> (structure)
The prompt that Amazon Lex uses to elicit the slot value from the user.
messageGroups -> (list)
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
maxRetries -> (integer)
The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy -> (string)
Indicates how a message is selected from a message group among retries.
sampleUtterances -> (list)
If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.
(structure)
A sample utterance that invokes an intent or respond to a slot elicitation prompt.
utterance -> (string)
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification -> (structure)
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse -> (structure)
The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
continueResponse -> (structure)
The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
stillWaitingResponse -> (structure)
A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups -> (list)
One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
frequencyInSeconds -> (integer)
How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds -> (integer)
If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.
allowInterrupt -> (boolean)
Indicates that the user can interrupt the response by speaking while the message is being played.
active -> (boolean)
Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren’t used. If the
active
field isn’t specified, the default is true.slotCaptureSetting -> (structure)
Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
captureResponse -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
captureNextStep -> (structure)
Specifies the next step that the bot runs when the slot value is captured before the code hook times out.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
captureConditional -> (structure)
A list of conditional branches to evaluate after the slot value is captured.
active -> (boolean)
Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches -> (list)
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
(structure)
A set of actions that Amazon Lex should run if the condition is matched.
name -> (string)
The name of the branch.
condition -> (structure)
Contains the expression to evaluate. If the condition is true, the branch’s actions are taken.
expressionString -> (string)
The expression string that is evaluated.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
defaultBranch -> (structure)
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
failureResponse -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
failureNextStep -> (structure)
Specifies the next step that the bot runs when the slot value code is not recognized.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
failureConditional -> (structure)
A list of conditional branches to evaluate when the slot value isn’t captured.
active -> (boolean)
Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches -> (list)
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
(structure)
A set of actions that Amazon Lex should run if the condition is matched.
name -> (string)
The name of the branch.
condition -> (structure)
Contains the expression to evaluate. If the condition is true, the branch’s actions are taken.
expressionString -> (string)
The expression string that is evaluated.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
defaultBranch -> (structure)
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
codeHook -> (structure)
Code hook called after Amazon Lex successfully captures a slot value.
enableCodeHookInvocation -> (boolean)
Indicates whether a Lambda function should be invoked for the dialog.
active -> (boolean)
Determines whether a dialog code hook is used when the intent is activated.
invocationLabel -> (string)
A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification -> (structure)
Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
successNextStep -> (structure)
Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
successConditional -> (structure)
A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active -> (boolean)
Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches -> (list)
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
(structure)
A set of actions that Amazon Lex should run if the condition is matched.
name -> (string)
The name of the branch.
condition -> (structure)
Contains the expression to evaluate. If the condition is true, the branch’s actions are taken.
expressionString -> (string)
The expression string that is evaluated.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
defaultBranch -> (structure)
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
failureResponse -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
failureNextStep -> (structure)
Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
failureConditional -> (structure)
A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active -> (boolean)
Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches -> (list)
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
(structure)
A set of actions that Amazon Lex should run if the condition is matched.
name -> (string)
The name of the branch.
condition -> (structure)
Contains the expression to evaluate. If the condition is true, the branch’s actions are taken.
expressionString -> (string)
The expression string that is evaluated.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
defaultBranch -> (structure)
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
timeoutResponse -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
timeoutNextStep -> (structure)
Specifies the next step that the bot runs when the code hook times out.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
timeoutConditional -> (structure)
A list of conditional branches to evaluate if the code hook times out.
active -> (boolean)
Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches -> (list)
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
(structure)
A set of actions that Amazon Lex should run if the condition is matched.
name -> (string)
The name of the branch.
condition -> (structure)
Contains the expression to evaluate. If the condition is true, the branch’s actions are taken.
expressionString -> (string)
The expression string that is evaluated.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
defaultBranch -> (structure)
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
elicitationCodeHook -> (structure)
Code hook called when Amazon Lex doesn’t capture a slot value.
enableCodeHookInvocation -> (boolean)
Indicates whether a Lambda function should be invoked for the dialog.
invocationLabel -> (string)
A label that indicates the dialog step from which the dialog code hook is happening.
JSON Syntax:
{
"defaultValueSpecification": {
"defaultValueList": [
{
"defaultValue": "string"
}
...
]
},
"slotConstraint": "Required"|"Optional",
"promptSpecification": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"maxRetries": integer,
"allowInterrupt": true|false,
"messageSelectionStrategy": "Random"|"Ordered"
},
"sampleUtterances": [
{
"utterance": "string"
}
...
],
"waitAndContinueSpecification": {
"waitingResponse": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
},
"continueResponse": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
},
"stillWaitingResponse": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"frequencyInSeconds": integer,
"timeoutInSeconds": integer,
"allowInterrupt": true|false
},
"active": true|false
},
"slotCaptureSetting": {
"captureResponse": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
},
"captureNextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"captureConditional": {
"active": true|false,
"conditionalBranches": [
{
"name": "string",
"condition": {
"expressionString": "string"
},
"nextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"response": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
}
}
...
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"response": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
}
}
},
"failureResponse": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
},
"failureNextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"failureConditional": {
"active": true|false,
"conditionalBranches": [
{
"name": "string",
"condition": {
"expressionString": "string"
},
"nextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"response": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
}
}
...
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"response": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
}
}
},
"codeHook": {
"enableCodeHookInvocation": true|false,
"active": true|false,
"invocationLabel": "string",
"postCodeHookSpecification": {
"successResponse": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
},
"successNextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"successConditional": {
"active": true|false,
"conditionalBranches": [
{
"name": "string",
"condition": {
"expressionString": "string"
},
"nextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"response": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
}
}
...
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"response": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
}
}
},
"failureResponse": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
},
"failureNextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"failureConditional": {
"active": true|false,
"conditionalBranches": [
{
"name": "string",
"condition": {
"expressionString": "string"
},
"nextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"response": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
}
}
...
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"response": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
}
}
},
"timeoutResponse": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
},
"timeoutNextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"timeoutConditional": {
"active": true|false,
"conditionalBranches": [
{
"name": "string",
"condition": {
"expressionString": "string"
},
"nextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"response": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
}
}
...
],
"defaultBranch": {
"nextStep": {
"dialogAction": {
"type": "ElicitIntent"|"StartIntent"|"ElicitSlot"|"EvaluateConditional"|"InvokeDialogCodeHook"|"ConfirmIntent"|"FulfillIntent"|"CloseIntent"|"EndConversation",
"slotToElicit": "string",
"suppressNextMessage": true|false
},
"intent": {
"name": "string",
"slots": {"string": {
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{
"shape": "Scalar"|"List",
"value": {
"interpretedValue": "string"
},
"values": [
{ ... recursive ... }
...
]
}
...
]
}
...}
},
"sessionAttributes": {"string": "string"
...}
},
"response": {
"messageGroups": [
{
"message": {
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
},
"variations": [
{
"plainTextMessage": {
"value": "string"
},
"customPayload": {
"value": "string"
},
"ssmlMessage": {
"value": "string"
},
"imageResponseCard": {
"title": "string",
"subtitle": "string",
"imageUrl": "string",
"buttons": [
{
"text": "string",
"value": "string"
}
...
]
}
}
...
]
}
...
],
"allowInterrupt": true|false
}
}
}
}
},
"elicitationCodeHook": {
"enableCodeHookInvocation": true|false,
"invocationLabel": "string"
}
}
}
--obfuscation-setting
(structure)
New settings that determine how slot values are formatted in Amazon CloudWatch logs.
obfuscationSettingType -> (string)
Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
Shorthand Syntax:
obfuscationSettingType=string
JSON Syntax:
{
"obfuscationSettingType": "None"|"DefaultObfuscation"
}
--bot-id
(string)
The unique identifier of the bot that contains the slot.
--bot-version
(string)
The version of the bot that contains the slot. Must always be
DRAFT
.
--locale-id
(string)
The identifier of the language and locale that contains the slot. The string must match one of the supported locales. For more information, see Supported languages .
--intent-id
(string)
The identifier of the intent that contains the slot.
--multiple-values-setting
(structure)
Determines whether the slot accepts multiple values in one response. Multiple value slots are only available in the en-US locale. If you set this value to
true
in any other locale, Amazon Lex throws aValidationException
.If the
multipleValuesSetting
is not set, the default value isfalse
.allowMultipleValues -> (boolean)
Indicates whether a slot can return multiple values. When
true
, the slot may return more than one value in a response. Whenfalse
, the slot returns only a single value.Multi-value slots are only available in the en-US locale. If you set this value to
true
in any other locale, Amazon Lex throws aValidationException
.If the
allowMutlipleValues
is not set, the default value isfalse
.
Shorthand Syntax:
allowMultipleValues=boolean
JSON Syntax:
{
"allowMultipleValues": true|false
}
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
slotId -> (string)
The unique identifier of the slot that was updated.
slotName -> (string)
The updated name of the slot.
description -> (string)
The updated description of the bot.
slotTypeId -> (string)
The updated identifier of the slot type that provides values for the slot.
valueElicitationSetting -> (structure)
The updated prompts that Amazon Lex sends to the user to elicit a response that provides a value for the slot.
defaultValueSpecification -> (structure)
A list of default values for a slot. Default values are used when Amazon Lex hasn’t determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.
defaultValueList -> (list)
A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
(structure)
Specifies the default value to use when a user doesn’t provide a value for a slot.
defaultValue -> (string)
The default value to use when a user doesn’t provide a value for a slot.
slotConstraint -> (string)
Specifies whether the slot is required or optional.
promptSpecification -> (structure)
The prompt that Amazon Lex uses to elicit the slot value from the user.
messageGroups -> (list)
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
maxRetries -> (integer)
The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech prompt from the bot.
messageSelectionStrategy -> (string)
Indicates how a message is selected from a message group among retries.
sampleUtterances -> (list)
If you know a specific pattern that users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.
(structure)
A sample utterance that invokes an intent or respond to a slot elicitation prompt.
utterance -> (string)
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification -> (structure)
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse -> (structure)
The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
continueResponse -> (structure)
The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
stillWaitingResponse -> (structure)
A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.
messageGroups -> (list)
One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
frequencyInSeconds -> (integer)
How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds -> (integer)
If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.
allowInterrupt -> (boolean)
Indicates that the user can interrupt the response by speaking while the message is being played.
active -> (boolean)
Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren’t used. If the
active
field isn’t specified, the default is true.slotCaptureSetting -> (structure)
Specifies the settings that Amazon Lex uses when a slot value is successfully entered by a user.
captureResponse -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
captureNextStep -> (structure)
Specifies the next step that the bot runs when the slot value is captured before the code hook times out.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
captureConditional -> (structure)
A list of conditional branches to evaluate after the slot value is captured.
active -> (boolean)
Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches -> (list)
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
(structure)
A set of actions that Amazon Lex should run if the condition is matched.
name -> (string)
The name of the branch.
condition -> (structure)
Contains the expression to evaluate. If the condition is true, the branch’s actions are taken.
expressionString -> (string)
The expression string that is evaluated.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
defaultBranch -> (structure)
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
failureResponse -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
failureNextStep -> (structure)
Specifies the next step that the bot runs when the slot value code is not recognized.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
failureConditional -> (structure)
A list of conditional branches to evaluate when the slot value isn’t captured.
active -> (boolean)
Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches -> (list)
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
(structure)
A set of actions that Amazon Lex should run if the condition is matched.
name -> (string)
The name of the branch.
condition -> (structure)
Contains the expression to evaluate. If the condition is true, the branch’s actions are taken.
expressionString -> (string)
The expression string that is evaluated.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
defaultBranch -> (structure)
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
codeHook -> (structure)
Code hook called after Amazon Lex successfully captures a slot value.
enableCodeHookInvocation -> (boolean)
Indicates whether a Lambda function should be invoked for the dialog.
active -> (boolean)
Determines whether a dialog code hook is used when the intent is activated.
invocationLabel -> (string)
A label that indicates the dialog step from which the dialog code hook is happening.
postCodeHookSpecification -> (structure)
Contains the responses and actions that Amazon Lex takes after the Lambda function is complete.
successResponse -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
successNextStep -> (structure)
Specifics the next step the bot runs after the dialog code hook finishes successfully.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
successConditional -> (structure)
A list of conditional branches to evaluate after the dialog code hook finishes successfully.
active -> (boolean)
Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches -> (list)
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
(structure)
A set of actions that Amazon Lex should run if the condition is matched.
name -> (string)
The name of the branch.
condition -> (structure)
Contains the expression to evaluate. If the condition is true, the branch’s actions are taken.
expressionString -> (string)
The expression string that is evaluated.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
defaultBranch -> (structure)
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
failureResponse -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
failureNextStep -> (structure)
Specifies the next step the bot runs after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
failureConditional -> (structure)
A list of conditional branches to evaluate after the dialog code hook throws an exception or returns with the
State
field of theIntent
object set toFailed
.active -> (boolean)
Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches -> (list)
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
(structure)
A set of actions that Amazon Lex should run if the condition is matched.
name -> (string)
The name of the branch.
condition -> (structure)
Contains the expression to evaluate. If the condition is true, the branch’s actions are taken.
expressionString -> (string)
The expression string that is evaluated.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
defaultBranch -> (structure)
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
timeoutResponse -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
timeoutNextStep -> (structure)
Specifies the next step that the bot runs when the code hook times out.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
timeoutConditional -> (structure)
A list of conditional branches to evaluate if the code hook times out.
active -> (boolean)
Determines whether a conditional branch is active. When
active
is false, the conditions are not evaluated.conditionalBranches -> (list)
A list of conditional branches. A conditional branch is made up of a condition, a response and a next step. The response and next step are executed when the condition is true.
(structure)
A set of actions that Amazon Lex should run if the condition is matched.
name -> (string)
The name of the branch.
condition -> (structure)
Contains the expression to evaluate. If the condition is true, the branch’s actions are taken.
expressionString -> (string)
The expression string that is evaluated.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
defaultBranch -> (structure)
The conditional branch that should be followed when the conditions for other branches are not satisfied. A conditional branch is made up of a condition, a response and a next step.
nextStep -> (structure)
The next step in the conversation.
dialogAction -> (structure)
Defines the action that the bot executes at runtime when the conversation reaches this step.
type -> (string)
The action that the bot should execute.
slotToElicit -> (string)
If the dialog action is
ElicitSlot
, defines the slot to elicit from the user.suppressNextMessage -> (boolean)
When true the next message for the intent is not used.
intent -> (structure)
Override settings to configure the intent state.
name -> (string)
The name of the intent. Only required when you’re switching intents.
slots -> (map)
A map of all of the slot value overrides for the intent. The name of the slot maps to the value of the slot. Slots that are not included in the map aren’t overridden.,
key -> (string)
value -> (structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
(structure)
The slot values that Amazon Lex uses when it sets slot values in a dialog step.
shape -> (string)
When the shape value is
List
, it indicates that thevalues
field contains a list of slot values. When the value isScalar
, it indicates that thevalue
field contains a single value.value -> (structure)
The current value of the slot.
interpretedValue -> (string)
The value that Amazon Lex determines for the slot. The actual value depends on the setting of the value selection strategy for the bot. You can choose to use the value entered by the user, or you can have Amazon Lex choose the first value in the
resolvedValues
list.values -> (list)
A list of one or more values that the user provided for the slot. For example, for a slot that elicits pizza toppings, the values might be “pepperoni” and “pineapple.”
( … recursive … )
sessionAttributes -> (map)
Map of key/value pairs representing session-specific context information. It contains application information passed between Amazon Lex and a client application.
key -> (string)
value -> (string)
response -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
elicitationCodeHook -> (structure)
Code hook called when Amazon Lex doesn’t capture a slot value.
enableCodeHookInvocation -> (boolean)
Indicates whether a Lambda function should be invoked for the dialog.
invocationLabel -> (string)
A label that indicates the dialog step from which the dialog code hook is happening.
obfuscationSetting -> (structure)
The updated setting that determines whether the slot value is obfuscated in the Amazon CloudWatch logs.
obfuscationSettingType -> (string)
Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
botId -> (string)
The identifier of the bot that contains the slot.
botVersion -> (string)
The identifier of the slot version that contains the slot. Will always be
DRAFT
.
localeId -> (string)
The locale that contains the slot.
intentId -> (string)
The intent that contains the slot.
creationDateTime -> (timestamp)
The timestamp of the date and time that the slot was created.
lastUpdatedDateTime -> (timestamp)
The timestamp of the date and time that the slot was last updated.
multipleValuesSetting -> (structure)
Indicates whether the slot accepts multiple values in one response.
allowMultipleValues -> (boolean)
Indicates whether a slot can return multiple values. When
true
, the slot may return more than one value in a response. Whenfalse
, the slot returns only a single value.Multi-value slots are only available in the en-US locale. If you set this value to
true
in any other locale, Amazon Lex throws aValidationException
.If the
allowMutlipleValues
is not set, the default value isfalse
.