v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1466336354.1 KB

Creates a new <a>Facet</a> in a schema. Facet creation is allowed only in development or applied schemas.

put/amazonclouddirectory/2017-01-11/facet/create#x-amz-data-partition

Headers

x-amz-data-partitionstring required

The schema ARN in which the new <a>Facet</a> will be created. For more information, see <a>arns</a>.

Request body

Namestring required

The name of the <a>Facet</a>, which is unique for a given schema.

ObjectType'NODE' | 'LEAF_NODE' | 'POLICY' | 'INDEX'
<p>Specifies whether a given object created from this facet is of type node, leaf node, policy or index.</p> <ul> <li> <p>Node: Can have multiple children but one parent.</p> </li> </ul> <ul> <li> <p>Leaf node: Cannot have children but can have multiple parents.</p> </li> </ul> <ul> <li> <p>Policy: Allows you to store a policy document and policy type. For more information, see <a href="https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies">Policies</a>.</p> </li> </ul> <ul> <li> <p>Index: Can be created with the Index API.</p> </li> </ul>
FacetStyle'STATIC' | 'DYNAMIC'

There are two different styles that you can define on any given facet, <code>Static</code> and <code>Dynamic</code>. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

Response

Success

CreateFacetResponse required