Skip to content

ActionSummary

Source code in docs_src/capo_qbusiness/types/action_summary.py 
11
12
13
14
15
16
17
18
19
class ActionSummary(TypedDict, closed=True):
    action_identifier: NotRequired["capo_qbusiness.types.string.String"]
    """<p>The identifier of an Amazon Q Business plugin action.</p>"""
    display_name: NotRequired["capo_qbusiness.types.string.String"]
    """<p>The display name assigned by Amazon Q Business to a plugin action. You can't modify this value.</p>"""
    instruction_example: NotRequired["capo_qbusiness.types.string.String"]
    """<p>An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example:</p> <ul> <li> <p>Create a Jira task</p> </li> <li> <p>Create a chat assistant task to find the root cause of a specific incident</p> </li> </ul>"""
    description: NotRequired["capo_qbusiness.types.string.String"]
    """<p>The description of an Amazon Q Business plugin action.</p>"""

action_identifier instance-attribute 

action_identifier: NotRequired[String]

The identifier of an Amazon Q Business plugin action.

description instance-attribute 

description: NotRequired[String]

The description of an Amazon Q Business plugin action.

display_name instance-attribute 

display_name: NotRequired[String]

The display name assigned by Amazon Q Business to a plugin action. You can't modify this value.

instruction_example instance-attribute 

instruction_example: NotRequired[String]

An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example:

  • Create a Jira task

  • Create a chat assistant task to find the root cause of a specific incident