Menu
Amazon Cloud Directory
API Reference

CreateFacet

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

Request Syntax

Copy
PUT /amazonclouddirectory/2017-01-11/facet/create HTTP/1.1 x-amz-data-partition: SchemaArn Content-type: application/json { "Attributes": [ { "AttributeDefinition": { "DefaultValue": { "BinaryValue": blob, "BooleanValue": boolean, "DatetimeValue": number, "NumberValue": "string", "StringValue": "string" }, "IsImmutable": boolean, "Rules": { "string" : { "Parameters": { "string" : "string" }, "Type": "string" } }, "Type": "string" }, "AttributeReference": { "TargetAttributeName": "string", "TargetFacetName": "string" }, "Name": "string", "RequiredBehavior": "string" } ], "Name": "string", "ObjectType": "string" }

URI Request Parameters

The request requires the following URI parameters.

SchemaArn

The schema ARN in which the new Facet will be created. For more information, see Arn Examples.

Request Body

The request accepts the following data in JSON format.

Attributes

The attributes that are associated with the Facet.

Type: Array of FacetAttribute objects

Required: No

Name

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9._-]*$

Required: Yes

ObjectType

Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

  • Node: Can have multiple children but one parent.

  • Leaf node: Cannot have children but can have multiple parents.

  • Policy: Allows you to store a policy document and policy type. For more information, see Policies.

  • Index: Can be created with the Index API.

Type: String

Valid Values: NODE | LEAF_NODE | POLICY | INDEX

Required: Yes

Response Syntax

Copy
HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access denied. Check your permissions.

HTTP Status Code: 403

FacetAlreadyExistsException

A facet with the same name already exists.

HTTP Status Code: 400

FacetValidationException

The Facet that you provided was not well formed or could not be validated with the schema.

HTTP Status Code: 400

InternalServiceException

Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.

HTTP Status Code: 500

InvalidArnException

Indicates that the provided ARN value is not valid.

HTTP Status Code: 400

InvalidRuleException

Occurs when any of the rule parameter keys or values are invalid.

HTTP Status Code: 400

LimitExceededException

Indicates that limits are exceeded. See Limits for more information.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

RetryableConflictException

Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

HTTP Status Code: 409

ValidationException

Indicates that your request is malformed in some manner. See the exception message.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: