Skip to content

ActionReview

Source code in docs_src/capo_qbusiness/types/action_review.py
class ActionReview(TypedDict, closed=True):
    plugin_id: NotRequired["capo_qbusiness.types.plugin_id.PluginId"]
    """<p>The identifier of the plugin associated with the action review.</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 payload.</p>"""

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

plugin_id instance-attribute

plugin_id: NotRequired[PluginId]

The identifier of the plugin associated with the action review.

plugin_type instance-attribute

plugin_type: NotRequired[PluginType]

The type of plugin.