PromptSpecification - Amazon Lex API Reference

PromptSpecification

Specifies a list of message groups that Amazon Lex sends to a user to elicit a response.

Contents

maxRetries

The maximum number of times the bot tries to elicit a response from the user using this prompt.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 5.

Required: Yes

messageGroups

A collection of messages that Amazon Lex can send to the user. Amazon Lex chooses the actual message to send at runtime.

Type: Array of MessageGroup objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Required: Yes

allowInterrupt

Indicates whether the user can interrupt a speech prompt from the bot.

Type: Boolean

Required: No

messageSelectionStrategy

Indicates how a message is selected from a message group among retries.

Type: String

Valid Values: Random | Ordered

Required: No

promptAttemptsSpecification

Specifies the advanced settings on each attempt of the prompt.

Type: String to PromptAttemptSpecification object map

Valid Keys: Initial | Retry1 | Retry2 | Retry3 | Retry4 | Retry5

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: