Skip to content

VisualCustomAction

Source code in docs_src/capo_quicksight/types/visual_custom_action.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class VisualCustomAction(TypedDict, closed=True):
    custom_action_id: (
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    )
    """<p>The ID of the <code>VisualCustomAction</code>.</p>"""
    name: "capo_quicksight.types.visual_custom_action_name.VisualCustomActionName"
    """<p>The name of the <code>VisualCustomAction</code>.</p>"""
    status: NotRequired["capo_quicksight.types.widget_status.WidgetStatus"]
    """<p>The status of the <code>VisualCustomAction</code>.</p>"""
    trigger: (
        "capo_quicksight.types.visual_custom_action_trigger.VisualCustomActionTrigger"
    )
    """<p>The trigger of the <code>VisualCustomAction</code>.</p> <p>Valid values are defined as follows:</p> <ul> <li> <p> <code>DATA_POINT_CLICK</code>: Initiates a custom action by a left pointer click on a data point.</p> </li> <li> <p> <code>DATA_POINT_MENU</code>: Initiates a custom action by right pointer click from the menu.</p> </li> </ul>"""
    action_operations: "capo_quicksight.types.visual_custom_action_operation_list.VisualCustomActionOperationList"
    """<p>A list of <code>VisualCustomActionOperations</code>.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"""

action_operations instance-attribute 

action_operations: VisualCustomActionOperationList

A list of VisualCustomActionOperations.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

custom_action_id instance-attribute 

custom_action_id: ShortRestrictiveResourceId

The ID of the VisualCustomAction.

name instance-attribute 

name: VisualCustomActionName

The name of the VisualCustomAction.

status instance-attribute 

status: NotRequired[WidgetStatus]

The status of the VisualCustomAction.

trigger instance-attribute 

trigger: VisualCustomActionTrigger

The trigger of the VisualCustomAction.

Valid values are defined as follows:

  • DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

  • DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.