facet_attributes

Creates, updates, deletes, gets or lists a facet_attributes resource.

Overview

Name	facet_attributes
Type	Resource
Id	aws.clouddirectory.facet_attributes

Fields

The following fields are returned by SELECT queries:

list_facet_attributes

Name	Datatype	Description
attribute_definition	object	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	object	An attribute reference that is associated with the attribute. See Attribute References for more information.
name	string	The name of the facet attribute. (pattern: <code>^[a-zA-Z0-9._:-]*$</code>)
required_behavior	string	The required behavior of the FacetAttribute. (REQUIRED_ALWAYS, NOT_REQUIRED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_facet_attributes	select	x-amz-data-partition, region		Retrieves attributes attached to the facet.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
x-amz-data-partition	string	The ARN of the schema where the facet resides.

SELECT examples

list_facet_attributes

Retrieves attributes attached to the facet.

SELECT
attribute_definition,
attribute_reference,
name,
required_behavior
FROM aws.clouddirectory.facet_attributes
WHERE `x-amz-data-partition` = '{{ x-amz-data-partition }}' -- required
AND region = '{{ region }}' -- required
;