ActionReviewEvent
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.
Contents
- conversationId
-
The identifier of the conversation with which the action review event is associated.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]{35}$Required: No
- payload
-
Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
Type: String to ActionReviewPayloadField object map
Key Length Constraints: Minimum length of 1.
Required: No
- payloadFieldNameSeparator
-
A string used to retain information about the hierarchical contexts within an action review event payload.
Type: String
Length Constraints: Fixed length of 1.
Required: No
- pluginId
-
The identifier of the plugin associated with the action review event.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: No
- pluginType
-
The type of plugin.
Type: String
Valid Values:
SERVICE_NOW | SALESFORCE | JIRA | ZENDESK | CUSTOMRequired: No
- systemMessageId
-
The identifier of an Amazon Q Business AI generated associated with the action review event.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]{35}$Required: No
- userMessageId
-
The identifier of the conversation with which the plugin action is associated.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]{35}$Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
