CloudDirectory / Client / list_facet_attributes

list_facet_attributes#

CloudDirectory.Client.list_facet_attributes(**kwargs)#

Retrieves attributes attached to the facet.

See also: AWS API Documentation

Request Syntax

response = client.list_facet_attributes(
    SchemaArn='string',
    Name='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • SchemaArn (string) –

    [REQUIRED]

    The ARN of the schema where the facet resides.

  • Name (string) –

    [REQUIRED]

    The name of the facet whose attributes will be retrieved.

  • NextToken (string) – The pagination token.

  • MaxResults (integer) – The maximum number of results to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Attributes': [
        {
            'Name': 'string',
            'AttributeDefinition': {
                'Type': 'STRING'|'BINARY'|'BOOLEAN'|'NUMBER'|'DATETIME'|'VARIANT',
                'DefaultValue': {
                    'StringValue': 'string',
                    'BinaryValue': b'bytes',
                    'BooleanValue': True|False,
                    'NumberValue': 'string',
                    'DatetimeValue': datetime(2015, 1, 1)
                },
                'IsImmutable': True|False,
                'Rules': {
                    'string': {
                        'Type': 'BINARY_LENGTH'|'NUMBER_COMPARISON'|'STRING_FROM_SET'|'STRING_LENGTH',
                        'Parameters': {
                            'string': 'string'
                        }
                    }
                }
            },
            'AttributeReference': {
                'TargetFacetName': 'string',
                'TargetAttributeName': 'string'
            },
            'RequiredBehavior': 'REQUIRED_ALWAYS'|'NOT_REQUIRED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Attributes (list) –

      The attributes attached to the facet.

      • (dict) –

        An attribute that is associated with the Facet.

        • Name (string) –

          The name of the facet attribute.

        • AttributeDefinition (dict) –

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

          • Type (string) –

            The type of the attribute.

          • DefaultValue (dict) –

            The default value of the attribute (if configured).

            • StringValue (string) –

              A string data value.

            • BinaryValue (bytes) –

              A binary data value.

            • BooleanValue (boolean) –

              A Boolean data value.

            • NumberValue (string) –

              A number data value.

            • DatetimeValue (datetime) –

              A date and time value.

          • IsImmutable (boolean) –

            Whether the attribute is mutable or not.

          • Rules (dict) –

            Validation rules attached to the attribute definition.

            • (string) –

              • (dict) –

                Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.

                • Type (string) –

                  The type of attribute validation rule.

                • Parameters (dict) –

                  The minimum and maximum parameters that are associated with the rule.

                  • (string) –

                    • (string) –

        • AttributeReference (dict) –

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

          • TargetFacetName (string) –

            The target facet name that is associated with the facet reference. See Attribute References for more information.

          • TargetAttributeName (string) –

            The target attribute name that is associated with the facet reference. See Attribute References for more information.

        • RequiredBehavior (string) –

          The required behavior of the FacetAttribute.

    • NextToken (string) –

      The pagination token.

Exceptions