Skip to content

ActionReviewEvent

Source code in docs_src/capo_qbusiness/types/action_review_event.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class ActionReviewEvent(TypedDict, closed=True):
    conversation_id: NotRequired["capo_qbusiness.types.conversation_id.ConversationId"]
    """<p>The identifier of the conversation with which the action review event is associated.</p>"""
    user_message_id: NotRequired["capo_qbusiness.types.message_id.MessageId"]
    """<p>The identifier of the conversation with which the plugin action is associated.</p>"""
    system_message_id: NotRequired["capo_qbusiness.types.message_id.MessageId"]
    """<p>The identifier of an Amazon Q Business AI generated associated with the action review event.</p>"""
    plugin_id: NotRequired["capo_qbusiness.types.plugin_id.PluginId"]
    """<p>The identifier of the plugin associated with the action review event.</p>"""
    plugin_type: NotRequired["capo_qbusiness.types.plugin_type.PluginType"]
    """<p>The type of plugin.</p>"""
    payload: NotRequired[
        "capo_qbusiness.types.action_review_payload.ActionReviewPayload"
    ]
    """<p>Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.</p>"""
    payload_field_name_separator: NotRequired[
        "capo_qbusiness.types.action_payload_field_name_separator.ActionPayloadFieldNameSeparator"
    ]
    """<p>A string used to retain information about the hierarchical contexts within an action review event payload.</p>"""

conversation_id instance-attribute 

conversation_id: NotRequired[ConversationId]

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

payload instance-attribute 

payload: NotRequired[ActionReviewPayload]

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

payload_field_name_separator instance-attribute 

payload_field_name_separator: NotRequired[ActionPayloadFieldNameSeparator]

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

plugin_id instance-attribute 

plugin_id: NotRequired[PluginId]

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

plugin_type instance-attribute 

plugin_type: NotRequired[PluginType]

The type of plugin.

system_message_id instance-attribute 

system_message_id: NotRequired[MessageId]

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

user_message_id instance-attribute 

user_message_id: NotRequired[MessageId]

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