Skip to content

Qbusiness  >  Structures  >  ActionSummary

ActionSummary

Structure Class

ActionSummary dataclass

Summary information for an Amazon Q Business plugin action.

Attributes

action_identifier class-attribute instance-attribute
action_identifier: str | None = None

The identifier of an Amazon Q Business plugin action.

description class-attribute instance-attribute
description: str | None = None

The description of an Amazon Q Business plugin action.

display_name class-attribute instance-attribute
display_name: str | None = None

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

instruction_example class-attribute instance-attribute
instruction_example: str | None = None

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