Amazon Cloud Directory
API Reference


Does the following:

  1. Adds new Attributes, Rules, or ObjectTypes.

  2. Updates existing Attributes, Rules, or ObjectTypes.

  3. Deletes existing Attributes, Rules, or ObjectTypes.

Request Syntax

PUT /amazonclouddirectory/2017-01-11/facet HTTP/1.1 x-amz-data-partition: SchemaArn Content-type: application/json { "AttributeUpdates": [ { "Action": "string", "Attribute": { "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.


The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see Arn Examples.

Request Body

The request accepts the following data in JSON format.


List of attributes that need to be updated in a given schema Facet. Each attribute is followed by AttributeAction, which specifies the type of update operation to perform.

Type: Array of FacetAttributeUpdate objects

Required: No


The name of the facet.

Type: String

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

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

Required: Yes


The object type that is associated with the facet. See CreateFacet:ObjectType for more details.

Type: String


Required: No

Response Syntax

HTTP/1.1 200

Response Elements

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


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


Access denied. Check your permissions.

HTTP Status Code: 403


The specified Facet could not be found.

HTTP Status Code: 400


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


Indicates that the provided ARN value is not valid.

HTTP Status Code: 400


An attempt to modify a Facet resulted in an invalid schema exception.

HTTP Status Code: 400


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

HTTP Status Code: 400


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

HTTP Status Code: 400


The specified resource could not be found.

HTTP Status Code: 404


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


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: