Skip to content

FacetAttribute

Source code in docs_src/capo_clouddirectory/types/facet_attribute.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class FacetAttribute(TypedDict, closed=True):
    name: "capo_clouddirectory.types.attribute_name.AttributeName"
    """<p>The name of the facet attribute.</p>"""
    attribute_definition: NotRequired[
        "capo_clouddirectory.types.facet_attribute_definition.FacetAttributeDefinition"
    ]
    """<p>A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html">Attribute References</a> for more information.</p>"""
    attribute_reference: NotRequired[
        "capo_clouddirectory.types.facet_attribute_reference.FacetAttributeReference"
    ]
    """<p>An attribute reference that is associated with the attribute. See <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html">Attribute References</a> for more information.</p>"""
    required_behavior: NotRequired[
        "capo_clouddirectory.types.required_attribute_behavior.RequiredAttributeBehavior"
    ]
    """<p>The required behavior of the <code>FacetAttribute</code>.</p>"""

attribute_definition instance-attribute 

attribute_definition: NotRequired[FacetAttributeDefinition]

A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.

attribute_reference instance-attribute 

attribute_reference: NotRequired[FacetAttributeReference]

An attribute reference that is associated with the attribute. See Attribute References for more information.

name instance-attribute 

name: AttributeName

The name of the facet attribute.

required_behavior instance-attribute 

required_behavior: NotRequired[RequiredAttributeBehavior]

The required behavior of the FacetAttribute.