Skip to content

AnonymousUserDashboardEmbeddingConfiguration

Source code in docs_src/capo_quicksight/types/anonymous_user_dashboard_embedding_configuration.py
class AnonymousUserDashboardEmbeddingConfiguration(TypedDict, closed=True):
    initial_dashboard_id: (
        "capo_quicksight.types.short_restrictive_resource_id.ShortRestrictiveResourceId"
    )
    """<p>The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon Quick Sight renders this dashboard.</p> <p>The Amazon Resource Name (ARN) of this dashboard must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>"""
    enabled_features: NotRequired[
        "capo_quicksight.types.anonymous_user_dashboard_embedding_configuration_enabled_features.AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures"
    ]
    """<p>A list of all enabled features of a specified anonymous dashboard.</p>"""
    disabled_features: NotRequired[
        "capo_quicksight.types.anonymous_user_dashboard_embedding_configuration_disabled_features.AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures"
    ]
    """<p>A list of all disabled features of a specified anonymous dashboard.</p>"""
    feature_configurations: NotRequired[
        "capo_quicksight.types.anonymous_user_dashboard_feature_configurations.AnonymousUserDashboardFeatureConfigurations"
    ]
    """<p>The feature configuration for an embedded dashboard.</p>"""

disabled_features instance-attribute

A list of all disabled features of a specified anonymous dashboard.

enabled_features instance-attribute

A list of all enabled features of a specified anonymous dashboard.

feature_configurations instance-attribute

feature_configurations: NotRequired[AnonymousUserDashboardFeatureConfigurations]

The feature configuration for an embedded dashboard.

initial_dashboard_id instance-attribute

initial_dashboard_id: ShortRestrictiveResourceId

The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon Quick Sight renders this dashboard.

The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.