/AWS1/CL_QQBACTIONREVIEWEVENT

An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_conversationid TYPE /AWS1/QQBCONVERSATIONID /AWS1/QQBCONVERSATIONID

The identifier of the conversation with which the action review event is associated.

iv_usermessageid TYPE /AWS1/QQBMESSAGEID /AWS1/QQBMESSAGEID

The identifier of the conversation with which the plugin action is associated.

iv_systemmessageid TYPE /AWS1/QQBMESSAGEID /AWS1/QQBMESSAGEID

The identifier of an Amazon Q Business AI generated associated with the action review event.

iv_pluginid TYPE /AWS1/QQBPLUGINID /AWS1/QQBPLUGINID

The identifier of the plugin associated with the action review event.

iv_plugintype TYPE /AWS1/QQBPLUGINTYPE /AWS1/QQBPLUGINTYPE

The type of plugin.

it_payload TYPE /AWS1/CL_QQBACTREVIEWPAYLOAD00=>TT_ACTIONREVIEWPAYLOAD TT_ACTIONREVIEWPAYLOAD

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

iv_payloadfieldnameseparator TYPE /AWS1/QQBACTPAYLOADFIELDNAME00 /AWS1/QQBACTPAYLOADFIELDNAME00

A string used to retain information about the hierarchical contexts within an action review event payload.

---

Queryable Attributes

conversationId

The identifier of the conversation with which the action review event is associated.

Accessible with the following methods

Method	Description
GET_CONVERSATIONID()	Getter for CONVERSATIONID, with configurable default
ASK_CONVERSATIONID()	Getter for CONVERSATIONID w/ exceptions if field has no valu
HAS_CONVERSATIONID()	Determine if CONVERSATIONID has a value

userMessageId

The identifier of the conversation with which the plugin action is associated.

Accessible with the following methods

Method	Description
GET_USERMESSAGEID()	Getter for USERMESSAGEID, with configurable default
ASK_USERMESSAGEID()	Getter for USERMESSAGEID w/ exceptions if field has no value
HAS_USERMESSAGEID()	Determine if USERMESSAGEID has a value

systemMessageId

The identifier of an Amazon Q Business AI generated associated with the action review event.

Accessible with the following methods

Method	Description
GET_SYSTEMMESSAGEID()	Getter for SYSTEMMESSAGEID, with configurable default
ASK_SYSTEMMESSAGEID()	Getter for SYSTEMMESSAGEID w/ exceptions if field has no val
HAS_SYSTEMMESSAGEID()	Determine if SYSTEMMESSAGEID has a value

pluginId

The identifier of the plugin associated with the action review event.

Accessible with the following methods

Method	Description
GET_PLUGINID()	Getter for PLUGINID, with configurable default
ASK_PLUGINID()	Getter for PLUGINID w/ exceptions if field has no value
HAS_PLUGINID()	Determine if PLUGINID has a value

pluginType

The type of plugin.

Accessible with the following methods

Method	Description
GET_PLUGINTYPE()	Getter for PLUGINTYPE, with configurable default
ASK_PLUGINTYPE()	Getter for PLUGINTYPE w/ exceptions if field has no value
HAS_PLUGINTYPE()	Determine if PLUGINTYPE has a value

payload

Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.

Accessible with the following methods

Method	Description
GET_PAYLOAD()	Getter for PAYLOAD, with configurable default
ASK_PAYLOAD()	Getter for PAYLOAD w/ exceptions if field has no value
HAS_PAYLOAD()	Determine if PAYLOAD has a value

payloadFieldNameSeparator

A string used to retain information about the hierarchical contexts within an action review event payload.

Accessible with the following methods

Method	Description
GET_PAYLOADFIELDNAMESEPARA00()	Getter for PAYLOADFIELDNAMESEPARATOR, with configurable defa
ASK_PAYLOADFIELDNAMESEPARA00()	Getter for PAYLOADFIELDNAMESEPARATOR w/ exceptions if field
HAS_PAYLOADFIELDNAMESEPARA00()	Determine if PAYLOADFIELDNAMESEPARATOR has a value