Skip to content

PredefinedAttribute

Source code in docs_src/capo_connect/types/predefined_attribute.py
class PredefinedAttribute(TypedDict, closed=True):
    name: NotRequired[
        "capo_connect.types.predefined_attribute_name.PredefinedAttributeName"
    ]
    """<p>The name of the predefined attribute.</p>"""
    values: NotRequired[
        "capo_connect.types.predefined_attribute_values.PredefinedAttributeValues"
    ]
    """<p>The values of the predefined attribute.</p>"""
    purposes: NotRequired[
        "capo_connect.types.predefined_attribute_purpose_name_list.PredefinedAttributePurposeNameList"
    ]
    """<p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Connect Customer admin website.</p>"""
    attribute_configuration: NotRequired[
        "capo_connect.types.predefined_attribute_configuration.PredefinedAttributeConfiguration"
    ]
    """<p>Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Connect Customer admin website.</p>"""
    last_modified_time: NotRequired["capo_connect.types.timestamp.Timestamp"]
    """<p>Last modified time.</p>"""
    last_modified_region: NotRequired["capo_connect.types.region_name.RegionName"]
    """<p>Last modified region.</p>"""

attribute_configuration instance-attribute

attribute_configuration: NotRequired[PredefinedAttributeConfiguration]

Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Connect Customer admin website.

last_modified_region instance-attribute

last_modified_region: NotRequired[RegionName]

Last modified region.

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

Last modified time.

name instance-attribute

name: NotRequired[PredefinedAttributeName]

The name of the predefined attribute.

purposes instance-attribute

purposes: NotRequired[PredefinedAttributePurposeNameList]

Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Connect Customer admin website.

values instance-attribute

values: NotRequired[PredefinedAttributeValues]

The values of the predefined attribute.