IntentSummary

public struct IntentSummary : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • 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.

    Declaration

    Swift

    public let checkpointLabel: String?

  • 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.

    Declaration

    Swift

    public let confirmationStatus: ConfirmationStatus?

  • 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.

    Declaration

    Swift

    public let dialogActionType: DialogActionType

  • 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.

    Declaration

    Swift

    public let fulfillmentState: FulfillmentState?

  • The name of the intent.

    Declaration

    Swift

    public let intentName: String?

  • Map of the slots that have been gathered and their values.

    Declaration

    Swift

    public let slots: [String : String]?

  • The next slot to elicit from the user. If there is not slot to elicit, the field is blank.

    Declaration

    Swift

    public let slotToElicit: String?

  • Undocumented

    Declaration

    Swift

    public init(checkpointLabel: String? = nil, confirmationStatus: ConfirmationStatus? = nil, dialogActionType: DialogActionType, fulfillmentState: FulfillmentState? = nil, intentName: String? = nil, slots: [String : String]? = nil, slotToElicit: String? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws