Intent - Amazon Lex API Reference

Intent

The current intent that Amazon Lex V2 is attempting to fulfill.

Contents

name

The name of the intent.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

confirmationState

Indicates whether the intent has been Confirmed, Denied, or None if the confirmation stage has not yet been reached.

Type: String

Valid Values: Confirmed | Denied | None

Required: No

slots

A map of all of the slots for the intent. The name of the slot maps to the value of the slot. If a slot has not been filled, the value is null.

Type: String to Slot object map

Key Length Constraints: Minimum length of 1.

Required: No

state

Indicates the fulfillment state for the intent. The meanings of each value are as follows:

  • Failed – The bot failed to fulfill the intent.

  • Fulfilled – The bot has completed fulfillment of the intent.

  • FulfillmentInProgress – The bot is in the middle of fulfilling the intent.

  • InProgress – The bot is in the middle of eliciting the slot values that are necessary to fulfill the intent.

  • ReadyForFulfillment – The bot has elicited all the slot values for the intent and is ready to fulfill the intent.

  • Waiting – The bot is waiting for a response from the user (limited to streaming conversations).

Type: String

Valid Values: Failed | Fulfilled | InProgress | ReadyForFulfillment | Waiting | FulfillmentInProgress

Required: No

See Also

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