Skip to content

UpdateDomainLayoutRequest

Source code in docs_src/capo_customer_profiles/types/update_domain_layout_request.py
class UpdateDomainLayoutRequest(TypedDict, closed=True):
    domain_name: "capo_customer_profiles.types.name.name"
    """<p>The unique name of the domain.</p>"""
    layout_definition_name: "capo_customer_profiles.types.name.name"
    """<p>The unique name of the layout.</p>"""
    description: NotRequired[
        "capo_customer_profiles.types.sensitive_text.sensitiveText"
    ]
    """<p>The description of the layout</p>"""
    display_name: NotRequired["capo_customer_profiles.types.display_name.displayName"]
    """<p>The display name of the layout</p>"""
    is_default: "capo_customer_profiles.types.boolean.boolean"
    """<p>If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.</p>"""
    layout_type: NotRequired["capo_customer_profiles.types.layout_type.LayoutType"]
    """<p>The type of layout that can be used to view data under a Customer Profiles domain.</p>"""
    layout: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to2000000.sensitiveString1To2000000"
    ]
    """<p>A customizable layout that can be used to view data under a Customer Profiles domain.</p>"""

description instance-attribute

description: NotRequired[sensitiveText]

The description of the layout

display_name instance-attribute

display_name: NotRequired[displayName]

The display name of the layout

domain_name instance-attribute

domain_name: name

The unique name of the domain.

is_default instance-attribute

is_default: boolean

If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.

layout instance-attribute

layout: NotRequired[sensitiveString1To2000000]

A customizable layout that can be used to view data under a Customer Profiles domain.

layout_definition_name instance-attribute

layout_definition_name: name

The unique name of the layout.

layout_type instance-attribute

layout_type: NotRequired[LayoutType]

The type of layout that can be used to view data under a Customer Profiles domain.