Skip to content

SheetVisualScopingConfiguration

Source code in docs_src/capo_quicksight/types/sheet_visual_scoping_configuration.py
class SheetVisualScopingConfiguration(TypedDict, closed=True):
    sheet_id: (
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    )
    """<p>The selected sheet that the filter is applied to.</p>"""
    scope: "capo_quicksight.types.filter_visual_scope.FilterVisualScope"
    """<p>The scope of the applied entities. Choose one of the following options:</p> <ul> <li> <p> <code>ALL_VISUALS</code> </p> </li> <li> <p> <code>SELECTED_VISUALS</code> </p> </li> </ul>"""
    visual_ids: NotRequired[
        "capo_quicksight.types.filtered_visuals_list.FilteredVisualsList"
    ]
    """<p>The selected visuals that the filter is applied to.</p>"""

scope instance-attribute

The scope of the applied entities. Choose one of the following options:

  • ALL_VISUALS

  • SELECTED_VISUALS

sheet_id instance-attribute

The selected sheet that the filter is applied to.

visual_ids instance-attribute

visual_ids: NotRequired[FilteredVisualsList]

The selected visuals that the filter is applied to.