Skip to content

VisualMessageConfiguration

Source code in docs_src/capo_quicksight/types/visual_message_configuration.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class VisualMessageConfiguration(TypedDict, closed=True):
    enabled: "capo_quicksight.types.boolean.Boolean"
    """<p>Specifies whether the custom message is displayed on the visual. When set to <code>true</code>, the custom message appears in place of the default message. When set to <code>false</code> or omitted, the default message is displayed.</p>"""
    title: NotRequired["capo_quicksight.types.visual_message_text.VisualMessageText"]
    """<p>The title text of the message that is displayed on the visual.</p>"""
    title_visibility: NotRequired["capo_quicksight.types.visibility.Visibility"]
    """<p>Specifies whether the title of the message is displayed.</p>"""
    description: NotRequired[
        "capo_quicksight.types.visual_message_text.VisualMessageText"
    ]
    """<p>The description text of the message that is displayed on the visual.</p>"""
    description_visibility: NotRequired["capo_quicksight.types.visibility.Visibility"]
    """<p>Specifies whether the description of the message is displayed.</p>"""
    link_text: NotRequired[
        "capo_quicksight.types.visual_message_text.VisualMessageText"
    ]
    """<p>The display text of the hyperlink that is shown in the message.</p>"""
    link_url: NotRequired[
        "capo_quicksight.types.visual_message_link_url.VisualMessageLinkUrl"
    ]
    """<p>The destination URL of the hyperlink that is shown in the message. Only valid <code>http</code>, <code>https</code>, and <code>mailto</code> URLs are supported.</p>"""
    link_visibility: NotRequired["capo_quicksight.types.visibility.Visibility"]
    """<p>Specifies whether the hyperlink in the message is displayed.</p>"""

description instance-attribute 

description: NotRequired[VisualMessageText]

The description text of the message that is displayed on the visual.

description_visibility instance-attribute 

description_visibility: NotRequired[Visibility]

Specifies whether the description of the message is displayed.

enabled instance-attribute 

enabled: Boolean

Specifies whether the custom message is displayed on the visual. When set to true, the custom message appears in place of the default message. When set to false or omitted, the default message is displayed.

link_text instance-attribute 

link_text: NotRequired[VisualMessageText]

The display text of the hyperlink that is shown in the message.

link_url: NotRequired[VisualMessageLinkUrl]

The destination URL of the hyperlink that is shown in the message. Only valid http, https, and mailto URLs are supported.

link_visibility: NotRequired[Visibility]

Specifies whether the hyperlink in the message is displayed.

title instance-attribute 

title: NotRequired[VisualMessageText]

The title text of the message that is displayed on the visual.

title_visibility instance-attribute 

title_visibility: NotRequired[Visibility]

Specifies whether the title of the message is displayed.