2022/07/05 - Amazon Lex Model Building V2 - 7 updated api methods
Changes This release introduces additional optional parameters "messageSelectionStrategy" to PromptSpecification, which enables the users to configure the bot to play messages in orderly manner.
{'intentConfirmationSetting': {'promptSpecification': {'messageSelectionStrategy': 'Random '
'| '
'Ordered'}}}
Creates an intent.
To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent.
When you create an intent, you must provide a name. You can optionally provide the following:
Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents.
Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.
How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.
A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?"
A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza."
A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"
See also: AWS API Documentation
Request Syntax
client.create_intent(
intentName='string',
description='string',
parentIntentSignature='string',
sampleUtterances=[
{
'utterance': 'string'
},
],
dialogCodeHook={
'enabled': True|False
},
fulfillmentCodeHook={
'enabled': True|False,
'postFulfillmentStatusSpecification': {
'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
},
'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
},
'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
}
},
'fulfillmentUpdatesSpecification': {
'active': True|False,
'startResponse': {
'delayInSeconds': 123,
'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
},
'updateResponse': {
'frequencyInSeconds': 123,
'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
},
'timeoutInSeconds': 123
}
},
intentConfirmationSetting={
'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': 123,
'allowInterrupt': True|False,
'messageSelectionStrategy': 'Random'|'Ordered'
},
'declinationResponse': {
'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
},
'active': True|False
},
intentClosingSetting={
'closingResponse': {
'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
},
'active': True|False
},
inputContexts=[
{
'name': 'string'
},
],
outputContexts=[
{
'name': 'string',
'timeToLiveInSeconds': 123,
'turnsToLive': 123
},
],
kendraConfiguration={
'kendraIndex': 'string',
'queryFilterStringEnabled': True|False,
'queryFilterString': 'string'
},
botId='string',
botVersion='string',
localeId='string'
)
string
[REQUIRED]
The name of the intent. Intent names must be unique in the locale that contains the intent and cannot match the name of any built-in intent.
string
A description of the intent. Use the description to help identify the intent in lists.
string
A unique identifier for the built-in intent to base this intent on.
list
An array of strings that a user might say to signal the intent. For example, "I want a pizza", or "I want a {PizzaSize} pizza".
In an utterance, slot names are enclosed in curly braces ("{", "}") to indicate where they should be displayed in the utterance shown to the user..
(dict) --
A sample utterance that invokes an intent or respond to a slot elicitation prompt.
utterance (string) -- [REQUIRED]
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
dict
Specifies that Amazon Lex invokes the alias Lambda function for each user input. You can invoke this Lambda function to personalize user interaction.
For example, suppose that your bot determines that the user's name is John. You Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, glutenIntolerant to true . You might find John's phone number and set the corresponding session attribute.
enabled (boolean) -- [REQUIRED]
Enables the dialog code hook so that it processes user requests.
dict
Specifies that Amazon Lex invokes the alias Lambda function when the intent is ready for fulfillment. You can invoke this function to complete the bot's transaction with the user.
For example, in a pizza ordering bot, the Lambda function can look up the closest pizza restaurant to the customer's location and then place an order on the customer's behalf.
enabled (boolean) -- [REQUIRED]
Indicates whether a Lambda function should be invoked to fulfill a specific intent.
postFulfillmentStatusSpecification (dict) --
Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.
successResponse (dict) --
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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 (dict) --
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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 (dict) --
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
fulfillmentUpdatesSpecification (dict) --
Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.
active (boolean) -- [REQUIRED]
Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the active field is set to true, the startResponse , updateResponse , and timeoutInSeconds fields are required.
startResponse (dict) --
Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
delayInSeconds (integer) -- [REQUIRED]
The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.
messageGroups (list) -- [REQUIRED]
One to 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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) --
Determines whether the user can interrupt the start message while it is playing.
updateResponse (dict) --
Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
frequencyInSeconds (integer) -- [REQUIRED]
The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
messageGroups (list) -- [REQUIRED]
One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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) --
Determines whether the user can interrupt an update message while it is playing.
timeoutInSeconds (integer) --
The length of time that the fulfillment Lambda function should run before it times out.
dict
Provides prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent.
promptSpecification (dict) -- [REQUIRED]
Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.
messageGroups (list) -- [REQUIRED]
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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) -- [REQUIRED]
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.
declinationResponse (dict) -- [REQUIRED]
When the user answers "no" to the question defined in promptSpecification , Amazon Lex responds with this response to acknowledge that the intent was canceled.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
active (boolean) --
Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.
dict
Sets the response that Amazon Lex sends to the user when the intent is closed.
closingResponse (dict) -- [REQUIRED]
The response that Amazon Lex sends to the user when the intent is complete.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
active (boolean) --
Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.
list
A list of contexts that must be active for this intent to be considered by Amazon Lex.
When an intent has an input context list, Amazon Lex only considers using the intent in an interaction with the user when the specified contexts are included in the active context list for the session. If the contexts are not active, then Amazon Lex will not use the intent.
A context can be automatically activated using the outputContexts property or it can be set at runtime.
For example, if there are two intents with different input contexts that respond to the same utterances, only the intent with the active context will respond.
An intent may have up to 5 input contexts. If an intent has multiple input contexts, all of the contexts must be active to consider the intent.
(dict) --
The name of a context that must be active for an intent to be selected by Amazon Lex.
name (string) -- [REQUIRED]
The name of the context.
list
A lists of contexts that the intent activates when it is fulfilled.
You can use an output context to indicate the intents that Amazon Lex should consider for the next turn of the conversation with a customer.
When you use the outputContextsList property, all of the contexts specified in the list are activated when the intent is fulfilled. You can set up to 10 output contexts. You can also set the number of conversation turns that the context should be active, or the length of time that the context should be active.
(dict) --
Describes a session context that is activated when an intent is fulfilled.
name (string) -- [REQUIRED]
The name of the output context.
timeToLiveInSeconds (integer) -- [REQUIRED]
The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
turnsToLive (integer) -- [REQUIRED]
The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
dict
Configuration information required to use the AMAZON.KendraSearchIntent intent to connect to an Amazon Kendra index. The AMAZON.KendraSearchIntent intent is called when Amazon Lex can't determine another intent to invoke.
kendraIndex (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.
queryFilterStringEnabled (boolean) --
Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
queryFilterString (string) --
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries .
string
[REQUIRED]
The identifier of the bot associated with this intent.
string
[REQUIRED]
The identifier of the version of the bot associated with this intent.
string
[REQUIRED]
The identifier of the language and locale where this intent is used. All of the bots, slot types, and slots used by the intent must have the same locale. For more information, see Supported languages .
dict
Response Syntax
{
'intentId': 'string',
'intentName': 'string',
'description': 'string',
'parentIntentSignature': 'string',
'sampleUtterances': [
{
'utterance': 'string'
},
],
'dialogCodeHook': {
'enabled': True|False
},
'fulfillmentCodeHook': {
'enabled': True|False,
'postFulfillmentStatusSpecification': {
'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
},
'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
},
'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
}
},
'fulfillmentUpdatesSpecification': {
'active': True|False,
'startResponse': {
'delayInSeconds': 123,
'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
},
'updateResponse': {
'frequencyInSeconds': 123,
'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
},
'timeoutInSeconds': 123
}
},
'intentConfirmationSetting': {
'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': 123,
'allowInterrupt': True|False,
'messageSelectionStrategy': 'Random'|'Ordered'
},
'declinationResponse': {
'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
},
'active': True|False
},
'intentClosingSetting': {
'closingResponse': {
'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
},
'active': True|False
},
'inputContexts': [
{
'name': 'string'
},
],
'outputContexts': [
{
'name': 'string',
'timeToLiveInSeconds': 123,
'turnsToLive': 123
},
],
'kendraConfiguration': {
'kendraIndex': 'string',
'queryFilterStringEnabled': True|False,
'queryFilterString': 'string'
},
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'creationDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
intentId (string) --
A unique identifier for the intent.
intentName (string) --
The name specified for the intent.
description (string) --
The description specified for the intent.
parentIntentSignature (string) --
The signature of the parent intent specified for the intent.
sampleUtterances (list) --
The sample utterances specified for the intent.
(dict) --
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.
dialogCodeHook (dict) --
The dialog Lambda function specified for the intent.
enabled (boolean) --
Enables the dialog code hook so that it processes user requests.
fulfillmentCodeHook (dict) --
The fulfillment Lambda function specified for the intent.
enabled (boolean) --
Indicates whether a Lambda function should be invoked to fulfill a specific intent.
postFulfillmentStatusSpecification (dict) --
Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.
successResponse (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
fulfillmentUpdatesSpecification (dict) --
Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.
active (boolean) --
Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the active field is set to true, the startResponse , updateResponse , and timeoutInSeconds fields are required.
startResponse (dict) --
Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
delayInSeconds (integer) --
The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.
messageGroups (list) --
One to 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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) --
Determines whether the user can interrupt the start message while it is playing.
updateResponse (dict) --
Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
frequencyInSeconds (integer) --
The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
messageGroups (list) --
One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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) --
Determines whether the user can interrupt an update message while it is playing.
timeoutInSeconds (integer) --
The length of time that the fulfillment Lambda function should run before it times out.
intentConfirmationSetting (dict) --
The confirmation setting specified for the intent.
promptSpecification (dict) --
Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.
messageGroups (list) --
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
declinationResponse (dict) --
When the user answers "no" to the question defined in promptSpecification , Amazon Lex responds with this response to acknowledge that the intent was canceled.
messageGroups (list) --
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
active (boolean) --
Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.
intentClosingSetting (dict) --
The closing setting specified for the intent.
closingResponse (dict) --
The response that Amazon Lex sends to the user when the intent is complete.
messageGroups (list) --
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
active (boolean) --
Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.
inputContexts (list) --
The list of input contexts specified for the intent.
(dict) --
The name of a context that must be active for an intent to be selected by Amazon Lex.
name (string) --
The name of the context.
outputContexts (list) --
The list of output contexts specified for the intent.
(dict) --
Describes a session context that is activated when an intent is fulfilled.
name (string) --
The name of the output context.
timeToLiveInSeconds (integer) --
The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
turnsToLive (integer) --
The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
kendraConfiguration (dict) --
Configuration for searching a Amazon Kendra index specified for the intent.
kendraIndex (string) --
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.
queryFilterStringEnabled (boolean) --
Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
queryFilterString (string) --
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries .
botId (string) --
The identifier of the bot associated with the intent.
botVersion (string) --
The identifier of the version of the bot associated with the intent.
localeId (string) --
The locale that the intent is specified to use.
creationDateTime (datetime) --
A timestamp of the date and time that the intent was created.
{'valueElicitationSetting': {'promptSpecification': {'messageSelectionStrategy': 'Random '
'| '
'Ordered'}}}
Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an OrderPizza intent might need slots for size, crust, and number of pizzas. For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user.
See also: AWS API Documentation
Request Syntax
client.create_slot(
slotName='string',
description='string',
slotTypeId='string',
valueElicitationSetting={
'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': 123,
'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': 123,
'timeoutInSeconds': 123,
'allowInterrupt': True|False
},
'active': True|False
}
},
obfuscationSetting={
'obfuscationSettingType': 'None'|'DefaultObfuscation'
},
botId='string',
botVersion='string',
localeId='string',
intentId='string',
multipleValuesSetting={
'allowMultipleValues': True|False
}
)
string
[REQUIRED]
The name of the slot. Slot names must be unique within the bot that contains the slot.
string
A description of the slot. Use this to help identify the slot in lists.
string
The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.
dict
[REQUIRED]
Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.
defaultValueSpecification (dict) --
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) -- [REQUIRED]
A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
(dict) --
Specifies the default value to use when a user doesn't provide a value for a slot.
defaultValue (string) -- [REQUIRED]
The default value to use when a user doesn't provide a value for a slot.
slotConstraint (string) -- [REQUIRED]
Specifies whether the slot is required or optional.
promptSpecification (dict) --
The prompt that Amazon Lex uses to elicit the slot value from the user.
messageGroups (list) -- [REQUIRED]
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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) -- [REQUIRED]
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.
(dict) --
A sample utterance that invokes an intent or respond to a slot elicitation prompt.
utterance (string) -- [REQUIRED]
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification (dict) --
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse (dict) -- [REQUIRED]
The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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 (dict) -- [REQUIRED]
The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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 (dict) --
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) -- [REQUIRED]
One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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) -- [REQUIRED]
How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds (integer) -- [REQUIRED]
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.
dict
Determines how slot values are used in Amazon CloudWatch logs. If the value of the obfuscationSetting parameter is DefaultObfuscation , slot values are obfuscated in the log output. If the value is None , the actual value is present in the log output.
The default is to obfuscate values in the CloudWatch logs.
obfuscationSettingType (string) -- [REQUIRED]
Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
string
[REQUIRED]
The identifier of the bot associated with the slot.
string
[REQUIRED]
The version of the bot associated with the slot.
string
[REQUIRED]
The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see Supported languages .
string
[REQUIRED]
The identifier of the intent that contains the slot.
dict
Indicates whether the slot returns multiple values in one response. 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 a ValidationException .
If the multipleValuesSetting is not set, the default value is false .
allowMultipleValues (boolean) --
Indicates whether a slot can return multiple values. When true , the slot may return more than one value in a response. When false , 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 a ValidationException .
If the allowMutlipleValues is not set, the default value is false .
dict
Response Syntax
{
'slotId': 'string',
'slotName': 'string',
'description': 'string',
'slotTypeId': 'string',
'valueElicitationSetting': {
'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': 123,
'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': 123,
'timeoutInSeconds': 123,
'allowInterrupt': True|False
},
'active': True|False
}
},
'obfuscationSetting': {
'obfuscationSettingType': 'None'|'DefaultObfuscation'
},
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'intentId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'multipleValuesSetting': {
'allowMultipleValues': True|False
}
}
Response Structure
(dict) --
slotId (string) --
The unique identifier associated with the slot. Use this to identify the slot when you update or delete it.
slotName (string) --
The name specified for the slot.
description (string) --
The description associated with the slot.
slotTypeId (string) --
The unique identifier of the slot type associated with this slot.
valueElicitationSetting (dict) --
The value elicitation settings specified for the slot.
defaultValueSpecification (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
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 (dict) --
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
obfuscationSetting (dict) --
Indicates whether the slot is configured to obfuscate values 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.
botId (string) --
The unique identifier of the bot associated with the slot.
botVersion (string) --
The version of the bot associated with the slot.
localeId (string) --
The language and local specified for the slot.
intentId (string) --
The unique identifier of the intent associated with the slot.
creationDateTime (datetime) --
The timestamp of the date and time that the slot was created.
multipleValuesSetting (dict) --
Indicates whether the slot returns 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. When false , 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 a ValidationException .
If the allowMutlipleValues is not set, the default value is false .
{'intentConfirmationSetting': {'promptSpecification': {'messageSelectionStrategy': 'Random '
'| '
'Ordered'}}}
Returns metadata about an intent.
See also: AWS API Documentation
Request Syntax
client.describe_intent(
intentId='string',
botId='string',
botVersion='string',
localeId='string'
)
string
[REQUIRED]
The identifier of the intent to describe.
string
[REQUIRED]
The identifier of the bot associated with the intent.
string
[REQUIRED]
The version of the bot associated with the intent.
string
[REQUIRED]
The identifier of the language and locale of the intent to describe. The string must match one of the supported locales. For more information, see Supported languages .
dict
Response Syntax
{
'intentId': 'string',
'intentName': 'string',
'description': 'string',
'parentIntentSignature': 'string',
'sampleUtterances': [
{
'utterance': 'string'
},
],
'dialogCodeHook': {
'enabled': True|False
},
'fulfillmentCodeHook': {
'enabled': True|False,
'postFulfillmentStatusSpecification': {
'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
},
'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
},
'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
}
},
'fulfillmentUpdatesSpecification': {
'active': True|False,
'startResponse': {
'delayInSeconds': 123,
'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
},
'updateResponse': {
'frequencyInSeconds': 123,
'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
},
'timeoutInSeconds': 123
}
},
'slotPriorities': [
{
'priority': 123,
'slotId': 'string'
},
],
'intentConfirmationSetting': {
'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': 123,
'allowInterrupt': True|False,
'messageSelectionStrategy': 'Random'|'Ordered'
},
'declinationResponse': {
'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
},
'active': True|False
},
'intentClosingSetting': {
'closingResponse': {
'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
},
'active': True|False
},
'inputContexts': [
{
'name': 'string'
},
],
'outputContexts': [
{
'name': 'string',
'timeToLiveInSeconds': 123,
'turnsToLive': 123
},
],
'kendraConfiguration': {
'kendraIndex': 'string',
'queryFilterStringEnabled': True|False,
'queryFilterString': 'string'
},
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
intentId (string) --
The unique identifier assigned to the intent when it was created.
intentName (string) --
The name specified for the intent.
description (string) --
The description of the intent.
parentIntentSignature (string) --
The identifier of the built-in intent that this intent is derived from, if any.
sampleUtterances (list) --
User utterances that trigger this intent.
(dict) --
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.
dialogCodeHook (dict) --
The Lambda function called during each turn of a conversation with the intent.
enabled (boolean) --
Enables the dialog code hook so that it processes user requests.
fulfillmentCodeHook (dict) --
The Lambda function called when the intent is complete and ready for fulfillment.
enabled (boolean) --
Indicates whether a Lambda function should be invoked to fulfill a specific intent.
postFulfillmentStatusSpecification (dict) --
Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.
successResponse (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
fulfillmentUpdatesSpecification (dict) --
Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.
active (boolean) --
Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the active field is set to true, the startResponse , updateResponse , and timeoutInSeconds fields are required.
startResponse (dict) --
Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
delayInSeconds (integer) --
The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.
messageGroups (list) --
One to 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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) --
Determines whether the user can interrupt the start message while it is playing.
updateResponse (dict) --
Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
frequencyInSeconds (integer) --
The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
messageGroups (list) --
One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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) --
Determines whether the user can interrupt an update message while it is playing.
timeoutInSeconds (integer) --
The length of time that the fulfillment Lambda function should run before it times out.
slotPriorities (list) --
The list that determines the priority that slots should be elicited from the user.
(dict) --
Sets the priority that Amazon Lex should use when eliciting slot values from a user.
priority (integer) --
The priority that a slot should be elicited.
slotId (string) --
The unique identifier of the slot.
intentConfirmationSetting (dict) --
Prompts that Amazon Lex sends to the user to confirm completion of an intent.
promptSpecification (dict) --
Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.
messageGroups (list) --
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
declinationResponse (dict) --
When the user answers "no" to the question defined in promptSpecification , Amazon Lex responds with this response to acknowledge that the intent was canceled.
messageGroups (list) --
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
active (boolean) --
Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.
intentClosingSetting (dict) --
The response that Amazon Lex sends to when the intent is closed.
closingResponse (dict) --
The response that Amazon Lex sends to the user when the intent is complete.
messageGroups (list) --
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
active (boolean) --
Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.
inputContexts (list) --
A list of contexts that must be active for the intent to be considered for sending to the user.
(dict) --
The name of a context that must be active for an intent to be selected by Amazon Lex.
name (string) --
The name of the context.
outputContexts (list) --
A list of contexts that are activated when the intent is fulfilled.
(dict) --
Describes a session context that is activated when an intent is fulfilled.
name (string) --
The name of the output context.
timeToLiveInSeconds (integer) --
The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
turnsToLive (integer) --
The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
kendraConfiguration (dict) --
Configuration information required to use the AMAZON.KendraSearchIntent intent.
kendraIndex (string) --
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.
queryFilterStringEnabled (boolean) --
Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
queryFilterString (string) --
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries .
botId (string) --
The identifier of the bot associated with the intent.
botVersion (string) --
The version of the bot associated with the intent.
localeId (string) --
The language and locale specified for the intent.
creationDateTime (datetime) --
A timestamp of the date and time that the intent was created.
lastUpdatedDateTime (datetime) --
A timestamp of the date and time that the intent was last updated.
{'valueElicitationSetting': {'promptSpecification': {'messageSelectionStrategy': 'Random '
'| '
'Ordered'}}}
Gets metadata information about a slot.
See also: AWS API Documentation
Request Syntax
client.describe_slot(
slotId='string',
botId='string',
botVersion='string',
localeId='string',
intentId='string'
)
string
[REQUIRED]
The unique identifier for the slot.
string
[REQUIRED]
The identifier of the bot associated with the slot.
string
[REQUIRED]
The version of the bot associated with the slot.
string
[REQUIRED]
The identifier of the language and locale of the slot to describe. The string must match one of the supported locales. For more information, see Supported languages .
string
[REQUIRED]
The identifier of the intent that contains the slot.
dict
Response Syntax
{
'slotId': 'string',
'slotName': 'string',
'description': 'string',
'slotTypeId': 'string',
'valueElicitationSetting': {
'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': 123,
'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': 123,
'timeoutInSeconds': 123,
'allowInterrupt': True|False
},
'active': True|False
}
},
'obfuscationSetting': {
'obfuscationSettingType': 'None'|'DefaultObfuscation'
},
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'intentId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'multipleValuesSetting': {
'allowMultipleValues': True|False
}
}
Response Structure
(dict) --
slotId (string) --
The unique identifier generated for the slot.
slotName (string) --
The name specified for the slot.
description (string) --
The description specified for the slot.
slotTypeId (string) --
The identifier of the slot type that determines the values entered into the slot.
valueElicitationSetting (dict) --
Prompts that Amazon Lex uses to elicit a value for the slot.
defaultValueSpecification (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
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 (dict) --
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
obfuscationSetting (dict) --
Whether slot values are shown in Amazon CloudWatch logs. If the value is None , the actual value of the slot is shown in 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 associated with the slot.
botVersion (string) --
The version of the bot associated with the slot.
localeId (string) --
The language and locale specified for the slot.
intentId (string) --
The identifier of the intent associated with the slot.
creationDateTime (datetime) --
A timestamp of the date and time that the slot was created.
lastUpdatedDateTime (datetime) --
A timestamp of the date and time that the slot was last updated.
multipleValuesSetting (dict) --
Indicates whether the slot accepts multiple values in a single utterance.
If the multipleValuesSetting is not set, the default value is false .
allowMultipleValues (boolean) --
Indicates whether a slot can return multiple values. When true , the slot may return more than one value in a response. When false , 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 a ValidationException .
If the allowMutlipleValues is not set, the default value is false .
{'slotSummaries': {'valueElicitationPromptSpecification': {'messageSelectionStrategy': 'Random '
'| '
'Ordered'}}}
Gets a list of slots that match the specified criteria.
See also: AWS API Documentation
Request Syntax
client.list_slots(
botId='string',
botVersion='string',
localeId='string',
intentId='string',
sortBy={
'attribute': 'SlotName'|'LastUpdatedDateTime',
'order': 'Ascending'|'Descending'
},
filters=[
{
'name': 'SlotName',
'values': [
'string',
],
'operator': 'CO'|'EQ'
},
],
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The identifier of the bot that contains the slot.
string
[REQUIRED]
The version of the bot that contains the slot.
string
[REQUIRED]
The identifier of the language and locale of the slots to list. The string must match one of the supported locales. For more information, see Supported languages .
string
[REQUIRED]
The unique identifier of the intent that contains the slot.
dict
Determines the sort order for the response from the ListSlots operation. You can choose to sort by the slot name or last updated date in either ascending or descending order.
attribute (string) -- [REQUIRED]
The attribute to use to sort the list.
order (string) -- [REQUIRED]
The order to sort the list. You can choose ascending or descending.
list
Provides the specification of a filter used to limit the slots in the response to only those that match the filter specification. You can only specify one filter and only one string to filter on.
(dict) --
Filters the response from the ListSlots operation.
name (string) -- [REQUIRED]
The name of the field to use for filtering.
values (list) -- [REQUIRED]
The value to use to filter the response.
(string) --
operator (string) -- [REQUIRED]
The operator to use for the filter. Specify EQ when the ListSlots operation should return only aliases that equal the specified value. Specify CO when the ListSlots operation should return aliases that contain the specified value.
integer
The maximum number of slots to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.
string
If the response from the ListSlots operation contains more results than specified in the maxResults parameter, a token is returned in the response. Use that token in the nextToken parameter to return the next page of results.
dict
Response Syntax
{
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'intentId': 'string',
'slotSummaries': [
{
'slotId': 'string',
'slotName': 'string',
'description': 'string',
'slotConstraint': 'Required'|'Optional',
'slotTypeId': 'string',
'valueElicitationPromptSpecification': {
'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': 123,
'allowInterrupt': True|False,
'messageSelectionStrategy': 'Random'|'Ordered'
},
'lastUpdatedDateTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
botId (string) --
The identifier of the bot that contains the slots.
botVersion (string) --
The version of the bot that contains the slots.
localeId (string) --
The language and locale of the slots in the list.
intentId (string) --
The identifier of the intent that contains the slots.
slotSummaries (list) --
Summary information for the slots that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more slots available, the nextToken field contains a token to get the next page of results.
(dict) --
Summary information about a slot, a value that the bot elicits from the user.
slotId (string) --
The unique identifier of the slot.
slotName (string) --
The name given to the slot.
description (string) --
The description of the slot.
slotConstraint (string) --
Whether the slot is required or optional. An intent is complete when all required slots are filled.
slotTypeId (string) --
The unique identifier for the slot type that defines the values for the slot.
valueElicitationPromptSpecification (dict) --
Prompts that are sent to the user to elicit a value for the slot.
messageGroups (list) --
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
lastUpdatedDateTime (datetime) --
The timestamp of the last date and time that the slot was updated.
nextToken (string) --
A token that indicates whether there are more results to return in a response to the ListSlots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListSlots operation request to get the next page of results.
{'intentConfirmationSetting': {'promptSpecification': {'messageSelectionStrategy': 'Random '
'| '
'Ordered'}}}
Updates the settings for an intent.
See also: AWS API Documentation
Request Syntax
client.update_intent(
intentId='string',
intentName='string',
description='string',
parentIntentSignature='string',
sampleUtterances=[
{
'utterance': 'string'
},
],
dialogCodeHook={
'enabled': True|False
},
fulfillmentCodeHook={
'enabled': True|False,
'postFulfillmentStatusSpecification': {
'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
},
'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
},
'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
}
},
'fulfillmentUpdatesSpecification': {
'active': True|False,
'startResponse': {
'delayInSeconds': 123,
'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
},
'updateResponse': {
'frequencyInSeconds': 123,
'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
},
'timeoutInSeconds': 123
}
},
slotPriorities=[
{
'priority': 123,
'slotId': 'string'
},
],
intentConfirmationSetting={
'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': 123,
'allowInterrupt': True|False,
'messageSelectionStrategy': 'Random'|'Ordered'
},
'declinationResponse': {
'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
},
'active': True|False
},
intentClosingSetting={
'closingResponse': {
'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
},
'active': True|False
},
inputContexts=[
{
'name': 'string'
},
],
outputContexts=[
{
'name': 'string',
'timeToLiveInSeconds': 123,
'turnsToLive': 123
},
],
kendraConfiguration={
'kendraIndex': 'string',
'queryFilterStringEnabled': True|False,
'queryFilterString': 'string'
},
botId='string',
botVersion='string',
localeId='string'
)
string
[REQUIRED]
The unique identifier of the intent to update.
string
[REQUIRED]
The new name for the intent.
string
The new description of the intent.
string
The signature of the new built-in intent to use as the parent of this intent.
list
New utterances used to invoke the intent.
(dict) --
A sample utterance that invokes an intent or respond to a slot elicitation prompt.
utterance (string) -- [REQUIRED]
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
dict
The new Lambda function to use between each turn of the conversation with the bot.
enabled (boolean) -- [REQUIRED]
Enables the dialog code hook so that it processes user requests.
dict
The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.
enabled (boolean) -- [REQUIRED]
Indicates whether a Lambda function should be invoked to fulfill a specific intent.
postFulfillmentStatusSpecification (dict) --
Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.
successResponse (dict) --
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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 (dict) --
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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 (dict) --
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
fulfillmentUpdatesSpecification (dict) --
Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.
active (boolean) -- [REQUIRED]
Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the active field is set to true, the startResponse , updateResponse , and timeoutInSeconds fields are required.
startResponse (dict) --
Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
delayInSeconds (integer) -- [REQUIRED]
The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.
messageGroups (list) -- [REQUIRED]
One to 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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) --
Determines whether the user can interrupt the start message while it is playing.
updateResponse (dict) --
Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
frequencyInSeconds (integer) -- [REQUIRED]
The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
messageGroups (list) -- [REQUIRED]
One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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) --
Determines whether the user can interrupt an update message while it is playing.
timeoutInSeconds (integer) --
The length of time that the fulfillment Lambda function should run before it times out.
list
A new list of slots and their priorities that are contained by the intent.
(dict) --
Sets the priority that Amazon Lex should use when eliciting slot values from a user.
priority (integer) -- [REQUIRED]
The priority that a slot should be elicited.
slotId (string) -- [REQUIRED]
The unique identifier of the slot.
dict
New prompts that Amazon Lex sends to the user to confirm the completion of an intent.
promptSpecification (dict) -- [REQUIRED]
Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.
messageGroups (list) -- [REQUIRED]
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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) -- [REQUIRED]
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.
declinationResponse (dict) -- [REQUIRED]
When the user answers "no" to the question defined in promptSpecification , Amazon Lex responds with this response to acknowledge that the intent was canceled.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
active (boolean) --
Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.
dict
The new response that Amazon Lex sends the user when the intent is closed.
closingResponse (dict) -- [REQUIRED]
The response that Amazon Lex sends to the user when the intent is complete.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
active (boolean) --
Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.
list
A new list of contexts that must be active in order for Amazon Lex to consider the intent.
(dict) --
The name of a context that must be active for an intent to be selected by Amazon Lex.
name (string) -- [REQUIRED]
The name of the context.
list
A new list of contexts that Amazon Lex activates when the intent is fulfilled.
(dict) --
Describes a session context that is activated when an intent is fulfilled.
name (string) -- [REQUIRED]
The name of the output context.
timeToLiveInSeconds (integer) -- [REQUIRED]
The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
turnsToLive (integer) -- [REQUIRED]
The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
dict
New configuration settings for connecting to an Amazon Kendra index.
kendraIndex (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.
queryFilterStringEnabled (boolean) --
Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
queryFilterString (string) --
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries .
string
[REQUIRED]
The identifier of the bot that contains the intent.
string
[REQUIRED]
The version of the bot that contains the intent. Must be DRAFT .
string
[REQUIRED]
The identifier of the language and locale where this intent is used. The string must match one of the supported locales. For more information, see Supported languages .
dict
Response Syntax
{
'intentId': 'string',
'intentName': 'string',
'description': 'string',
'parentIntentSignature': 'string',
'sampleUtterances': [
{
'utterance': 'string'
},
],
'dialogCodeHook': {
'enabled': True|False
},
'fulfillmentCodeHook': {
'enabled': True|False,
'postFulfillmentStatusSpecification': {
'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
},
'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
},
'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
}
},
'fulfillmentUpdatesSpecification': {
'active': True|False,
'startResponse': {
'delayInSeconds': 123,
'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
},
'updateResponse': {
'frequencyInSeconds': 123,
'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
},
'timeoutInSeconds': 123
}
},
'slotPriorities': [
{
'priority': 123,
'slotId': 'string'
},
],
'intentConfirmationSetting': {
'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': 123,
'allowInterrupt': True|False,
'messageSelectionStrategy': 'Random'|'Ordered'
},
'declinationResponse': {
'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
},
'active': True|False
},
'intentClosingSetting': {
'closingResponse': {
'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
},
'active': True|False
},
'inputContexts': [
{
'name': 'string'
},
],
'outputContexts': [
{
'name': 'string',
'timeToLiveInSeconds': 123,
'turnsToLive': 123
},
],
'kendraConfiguration': {
'kendraIndex': 'string',
'queryFilterStringEnabled': True|False,
'queryFilterString': 'string'
},
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
intentId (string) --
The identifier of the intent that was updated.
intentName (string) --
The updated name of the intent.
description (string) --
The updated description of the intent.
parentIntentSignature (string) --
The updated built-in intent that is the parent of this intent.
sampleUtterances (list) --
The updated list of sample utterances for the intent.
(dict) --
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.
dialogCodeHook (dict) --
The updated Lambda function called during each turn of the conversation with the user.
enabled (boolean) --
Enables the dialog code hook so that it processes user requests.
fulfillmentCodeHook (dict) --
The updated Lambda function called when the intent is ready for fulfillment.
enabled (boolean) --
Indicates whether a Lambda function should be invoked to fulfill a specific intent.
postFulfillmentStatusSpecification (dict) --
Provides settings for messages sent to the user for after the Lambda fulfillment function completes. Post-fulfillment messages can be sent for both streaming and non-streaming conversations.
successResponse (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
fulfillmentUpdatesSpecification (dict) --
Provides settings for update messages sent to the user for long-running Lambda fulfillment functions. Fulfillment updates can be used only with streaming conversations.
active (boolean) --
Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.
If the active field is set to true, the startResponse , updateResponse , and timeoutInSeconds fields are required.
startResponse (dict) --
Provides configuration information for the message sent to users when the fulfillment Lambda functions starts running.
delayInSeconds (integer) --
The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.
messageGroups (list) --
One to 5 message groups that contain start messages. Amazon Lex chooses one of the messages to play to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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) --
Determines whether the user can interrupt the start message while it is playing.
updateResponse (dict) --
Provides configuration information for messages sent periodically to the user while the fulfillment Lambda function is running.
frequencyInSeconds (integer) --
The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.
messageGroups (list) --
One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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) --
Determines whether the user can interrupt an update message while it is playing.
timeoutInSeconds (integer) --
The length of time that the fulfillment Lambda function should run before it times out.
slotPriorities (list) --
The updated list of slots and their priorities that are elicited from the user for the intent.
(dict) --
Sets the priority that Amazon Lex should use when eliciting slot values from a user.
priority (integer) --
The priority that a slot should be elicited.
slotId (string) --
The unique identifier of the slot.
intentConfirmationSetting (dict) --
The updated prompts that Amazon Lex sends to the user to confirm the completion of an intent.
promptSpecification (dict) --
Prompts the user to confirm the intent. This question should have a yes or no answer.
Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.
messageGroups (list) --
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
declinationResponse (dict) --
When the user answers "no" to the question defined in promptSpecification , Amazon Lex responds with this response to acknowledge that the intent was canceled.
messageGroups (list) --
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
active (boolean) --
Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the active field isn't specified, the default is true.
intentClosingSetting (dict) --
The updated response that Amazon Lex sends the user when the intent is closed.
closingResponse (dict) --
The response that Amazon Lex sends to the user when the intent is complete.
messageGroups (list) --
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
active (boolean) --
Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the active field isn't specified, the default is true.
inputContexts (list) --
The updated list of contexts that must be active for the intent to be considered by Amazon Lex.
(dict) --
The name of a context that must be active for an intent to be selected by Amazon Lex.
name (string) --
The name of the context.
outputContexts (list) --
The updated list of contexts that Amazon Lex activates when the intent is fulfilled.
(dict) --
Describes a session context that is activated when an intent is fulfilled.
name (string) --
The name of the output context.
timeToLiveInSeconds (integer) --
The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.
turnsToLive (integer) --
The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.
kendraConfiguration (dict) --
The updated configuration for connecting to an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.
kendraIndex (string) --
The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot.
queryFilterStringEnabled (boolean) --
Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.
queryFilterString (string) --
A query filter that Amazon Lex sends to Amazon Kendra to filter the response from a query. The filter is in the format defined by Amazon Kendra. For more information, see Filtering queries .
botId (string) --
The identifier of the bot that contains the intent.
botVersion (string) --
The version of the bot that contains the intent. Will always be DRAFT .
localeId (string) --
The updated language and locale of the intent.
creationDateTime (datetime) --
A timestamp of when the intent was created.
lastUpdatedDateTime (datetime) --
A timestamp of the last time that the intent was modified.
{'valueElicitationSetting': {'promptSpecification': {'messageSelectionStrategy': 'Random '
'| '
'Ordered'}}}
Updates the settings for a slot.
See also: AWS API Documentation
Request Syntax
client.update_slot(
slotId='string',
slotName='string',
description='string',
slotTypeId='string',
valueElicitationSetting={
'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': 123,
'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': 123,
'timeoutInSeconds': 123,
'allowInterrupt': True|False
},
'active': True|False
}
},
obfuscationSetting={
'obfuscationSettingType': 'None'|'DefaultObfuscation'
},
botId='string',
botVersion='string',
localeId='string',
intentId='string',
multipleValuesSetting={
'allowMultipleValues': True|False
}
)
string
[REQUIRED]
The unique identifier for the slot to update.
string
[REQUIRED]
The new name for the slot.
string
The new description for the slot.
string
The unique identifier of the new slot type to associate with this slot.
dict
[REQUIRED]
A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.
defaultValueSpecification (dict) --
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) -- [REQUIRED]
A list of default values. Amazon Lex chooses the default value to use in the order that they are presented in the list.
(dict) --
Specifies the default value to use when a user doesn't provide a value for a slot.
defaultValue (string) -- [REQUIRED]
The default value to use when a user doesn't provide a value for a slot.
slotConstraint (string) -- [REQUIRED]
Specifies whether the slot is required or optional.
promptSpecification (dict) --
The prompt that Amazon Lex uses to elicit the slot value from the user.
messageGroups (list) -- [REQUIRED]
A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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) -- [REQUIRED]
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.
(dict) --
A sample utterance that invokes an intent or respond to a slot elicitation prompt.
utterance (string) -- [REQUIRED]
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
waitAndContinueSpecification (dict) --
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse (dict) -- [REQUIRED]
The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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 (dict) -- [REQUIRED]
The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.
messageGroups (list) -- [REQUIRED]
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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 (dict) --
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) -- [REQUIRED]
One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) -- [REQUIRED]
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) -- [REQUIRED]
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) -- [REQUIRED]
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) -- [REQUIRED]
The SSML text that defines the prompt.
imageResponseCard (dict) --
A message that defines a response card that the client application can show to the user.
title (string) -- [REQUIRED]
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.
(dict) --
Describes a button to use on a response card used to gather slot values from a user.
text (string) -- [REQUIRED]
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value (string) -- [REQUIRED]
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) -- [REQUIRED]
How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.
timeoutInSeconds (integer) -- [REQUIRED]
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.
dict
New settings that determine how slot values are formatted in Amazon CloudWatch logs.
obfuscationSettingType (string) -- [REQUIRED]
Value that determines whether Amazon Lex obscures slot values in conversation logs. The default is to obscure the values.
string
[REQUIRED]
The unique identifier of the bot that contains the slot.
string
[REQUIRED]
The version of the bot that contains the slot. Must always be DRAFT .
string
[REQUIRED]
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 .
string
[REQUIRED]
The identifier of the intent that contains the slot.
dict
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 a ValidationException .
If the multipleValuesSetting is not set, the default value is false .
allowMultipleValues (boolean) --
Indicates whether a slot can return multiple values. When true , the slot may return more than one value in a response. When false , 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 a ValidationException .
If the allowMutlipleValues is not set, the default value is false .
dict
Response Syntax
{
'slotId': 'string',
'slotName': 'string',
'description': 'string',
'slotTypeId': 'string',
'valueElicitationSetting': {
'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': 123,
'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': 123,
'timeoutInSeconds': 123,
'allowInterrupt': True|False
},
'active': True|False
}
},
'obfuscationSetting': {
'obfuscationSettingType': 'None'|'DefaultObfuscation'
},
'botId': 'string',
'botVersion': 'string',
'localeId': 'string',
'intentId': 'string',
'creationDateTime': datetime(2015, 1, 1),
'lastUpdatedDateTime': datetime(2015, 1, 1),
'multipleValuesSetting': {
'allowMultipleValues': True|False
}
}
Response Structure
(dict) --
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 (dict) --
The updated prompts that Amazon Lex sends to the user to elicit a response that provides a value for the slot.
defaultValueSpecification (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
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 (dict) --
Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.
waitingResponse (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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 (dict) --
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.
(dict) --
Provides one or more messages that Amazon Lex should send to the user.
message (dict) --
The primary message that Amazon Lex should send to the user.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
(dict) --
The object that provides message text and it's type.
plainTextMessage (dict) --
A message in plain text format.
value (string) --
The message to send to the user.
customPayload (dict) --
A message in a custom format defined by the client application.
value (string) --
The string that is sent to your application.
ssmlMessage (dict) --
A message in Speech Synthesis Markup Language (SSML).
value (string) --
The SSML text that defines the prompt.
imageResponseCard (dict) --
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.
(dict) --
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.
obfuscationSetting (dict) --
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 (datetime) --
The timestamp of the date and time that the slot was created.
lastUpdatedDateTime (datetime) --
The timestamp of the date and time that the slot was last updated.
multipleValuesSetting (dict) --
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. When false , 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 a ValidationException .
If the allowMutlipleValues is not set, the default value is false .