Skip to content

UpdatePredefinedAttributeRequest

Source code in docs_src/capo_connect/types/update_predefined_attribute_request.py
class UpdatePredefinedAttributeRequest(TypedDict, closed=True):
    instance_id: "capo_connect.types.instance_id.InstanceId"
    """<p>The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>"""
    name: "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.input_predefined_attribute_configuration.InputPredefinedAttributeConfiguration"
    ]
    """<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>"""

attribute_configuration instance-attribute

attribute_configuration: NotRequired[InputPredefinedAttributeConfiguration]

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.

instance_id instance-attribute

instance_id: InstanceId

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

name instance-attribute

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.