[ aws . lexv2-models ]
describe-intent¶
Description¶
Returns metadata about an intent.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-intent
--intent-id <value>
--bot-id <value>
--bot-version <value>
--locale-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--intent-id (string)
The identifier of the intent to describe.
--bot-id (string)
The identifier of the bot associated with the intent.
--bot-version (string)
The version of the bot associated with the intent.
--locale-id (string)
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 .
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
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.
(structure)
A sample utterance that invokes an intent or respond to a slot elicitation prompt.
utterance -> (string)
The sample utterance that Amazon Lex uses to build its machine-learning model to recognize intents.
dialogCodeHook -> (structure)
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 -> (structure)
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 -> (structure)
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 -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
failureResponse -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
timeoutResponse -> (structure)
Specifies a list of message groups that Amazon Lex uses to respond the user input.
messageGroups -> (list)
A collection of responses that Amazon Lex can send to the user. Amazon Lex chooses the actual response to send at runtime.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
fulfillmentUpdatesSpecification -> (structure)
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
activefield is set to true, thestartResponse,updateResponse, andtimeoutInSecondsfields are required.startResponse -> (structure)
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.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Determines whether the user can interrupt the start message while it is playing.
updateResponse -> (structure)
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.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
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.
(structure)
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 -> (structure)
Prompts that Amazon Lex sends to the user to confirm completion of an intent.
promptSpecification -> (structure)
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
OrderPizzaintent, 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.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
maxRetries -> (integer)
The maximum number of times the bot tries to elicit a response from the user using this prompt.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech prompt from the bot.
declinationResponse -> (structure)
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.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
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
activefield isn’t specified, the default is true.
intentClosingSetting -> (structure)
The response that Amazon Lex sends to when the intent is closed.
closingResponse -> (structure)
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.
(structure)
Provides one or more messages that Amazon Lex should send to the user.
message -> (structure)
The primary message that Amazon Lex should send to the user.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
variations -> (list)
Message variations to send to the user. When variations are defined, Amazon Lex chooses the primary message or one of the variations to send to the user.
(structure)
The object that provides message text and it’s type.
plainTextMessage -> (structure)
A message in plain text format.
value -> (string)
The message to send to the user.
customPayload -> (structure)
A message in a custom format defined by the client application.
value -> (string)
The string that is sent to your application.
ssmlMessage -> (structure)
A message in Speech Synthesis Markup Language (SSML).
value -> (string)
The SSML text that defines the prompt.
imageResponseCard -> (structure)
A message that defines a response card that the client application can show to the user.
title -> (string)
The title to display on the response card. The format of the title is determined by the platform displaying the response card.
subtitle -> (string)
The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.
imageUrl -> (string)
The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.
buttons -> (list)
A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.
(structure)
Describes a button to use on a response card used to gather slot values from a user.
text -> (string)
The text that appears on the button. Use this to tell the user what value is returned when they choose this button.
value -> (string)
The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.
allowInterrupt -> (boolean)
Indicates whether the user can interrupt a speech response from Amazon Lex.
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
activefield 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.
(structure)
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.
(structure)
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 -> (structure)
Configuration information required to use the
AMAZON.KendraSearchIntentintent.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 -> (timestamp)
A timestamp of the date and time that the intent was created.
lastUpdatedDateTime -> (timestamp)
A timestamp of the date and time that the intent was last updated.