Skip to content

InsightVisual

Source code in docs_src/capo_quicksight/types/insight_visual.py
class InsightVisual(TypedDict, closed=True):
    visual_id: (
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    )
    """<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"""
    title: NotRequired[
        "capo_quicksight.types.visual_title_label_options.VisualTitleLabelOptions"
    ]
    """<p>The title that is displayed on the visual.</p>"""
    subtitle: NotRequired[
        "capo_quicksight.types.visual_subtitle_label_options.VisualSubtitleLabelOptions"
    ]
    """<p>The subtitle that is displayed on the visual.</p>"""
    insight_configuration: NotRequired[
        "capo_quicksight.types.insight_configuration.InsightConfiguration"
    ]
    """<p>The configuration of an insight visual.</p>"""
    actions: NotRequired[
        "capo_quicksight.types.visual_custom_action_list.VisualCustomActionList"
    ]
    """<p>The list of custom actions that are configured for a visual.</p>"""
    data_set_identifier: "capo_quicksight.types.data_set_identifier.DataSetIdentifier"
    """<p>The dataset that is used in the insight visual.</p>"""
    topic_identifier: NotRequired[
        "capo_quicksight.types.topic_identifier.TopicIdentifier"
    ]
    """<p>The topic that is used in the insight visual.</p>"""
    visual_content_alt_text: NotRequired[
        "capo_quicksight.types.long_plain_text.LongPlainText"
    ]
    """<p>The alt text for the visual.</p>"""

actions instance-attribute

actions: NotRequired[VisualCustomActionList]

The list of custom actions that are configured for a visual.

data_set_identifier instance-attribute

data_set_identifier: DataSetIdentifier

The dataset that is used in the insight visual.

insight_configuration instance-attribute

insight_configuration: NotRequired[InsightConfiguration]

The configuration of an insight visual.

subtitle instance-attribute

subtitle: NotRequired[VisualSubtitleLabelOptions]

The subtitle that is displayed on the visual.

title instance-attribute

title: NotRequired[VisualTitleLabelOptions]

The title that is displayed on the visual.

topic_identifier instance-attribute

topic_identifier: NotRequired[TopicIdentifier]

The topic that is used in the insight visual.

visual_content_alt_text instance-attribute

visual_content_alt_text: NotRequired[LongPlainText]

The alt text for the visual.

visual_id instance-attribute

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.