class Aws::Lex::Types::IntentSummary

Provides information about the state of an intent. You can use this information to get the current state of an intent so that you can process the intent, or so that you can return the intent to its previous state.

@note When making an API call, you may pass IntentSummary

data as a hash:

    {
      intent_name: "IntentName",
      checkpoint_label: "IntentSummaryCheckpointLabel",
      slots: {
        "String" => "String",
      },
      confirmation_status: "None", # accepts None, Confirmed, Denied
      dialog_action_type: "ElicitIntent", # required, accepts ElicitIntent, ConfirmIntent, ElicitSlot, Close, Delegate
      fulfillment_state: "Fulfilled", # accepts Fulfilled, Failed, ReadyForFulfillment
      slot_to_elicit: "String",
    }

@!attribute [rw] intent_name

The name of the intent.
@return [String]

@!attribute [rw] checkpoint_label

A user-defined label that identifies a particular intent. You can
use this label to return to a previous intent.

Use the `checkpointLabelFilter` parameter of the `GetSessionRequest`
operation to filter the intents returned by the operation to those
with only the specified label.
@return [String]

@!attribute [rw] slots

Map of the slots that have been gathered and their values.
@return [Hash<String,String>]

@!attribute [rw] confirmation_status

The status of the intent after the user responds to the confirmation
prompt. If the user confirms the intent, Amazon Lex sets this field
to `Confirmed`. If the user denies the intent, Amazon Lex sets this
value to `Denied`. The possible values are:

* `Confirmed` - The user has responded "Yes" to the confirmation
  prompt, confirming that the intent is complete and that it is
  ready to be fulfilled.

* `Denied` - The user has responded "No" to the confirmation
  prompt.

* `None` - The user has never been prompted for confirmation; or,
  the user was prompted but did not confirm or deny the prompt.
@return [String]

@!attribute [rw] dialog_action_type

The next action that the bot should take in its interaction with the
user. The possible values are:

* `ConfirmIntent` - The next action is asking the user if the intent
  is complete and ready to be fulfilled. This is a yes/no question
  such as "Place the order?"

* `Close` - Indicates that the there will not be a response from the
  user. For example, the statement "Your order has been placed"
  does not require a response.

* `ElicitIntent` - The next action is to determine the intent that
  the user wants to fulfill.

* `ElicitSlot` - The next action is to elicit a slot value from the
  user.
@return [String]

@!attribute [rw] fulfillment_state

The fulfillment state of the intent. The possible values are:

* `Failed` - The Lambda function associated with the intent failed
  to fulfill the intent.

* `Fulfilled` - The intent has fulfilled by the Lambda function
  associated with the intent.

* `ReadyForFulfillment` - All of the information necessary for the
  intent is present and the intent ready to be fulfilled by the
  client application.
@return [String]

@!attribute [rw] slot_to_elicit

The next slot to elicit from the user. If there is not slot to
elicit, the field is blank.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/IntentSummary AWS API Documentation

Constants

SENSITIVE