Menu
Amazon Cloud Directory
API Reference

AddFacetToObject

Adds a new Facet to an object. An object can have more than one facet applied on it.

Request Syntax

PUT /amazonclouddirectory/2017-01-11/object/facets HTTP/1.1
x-amz-data-partition: DirectoryArn
Content-type: application/json

{
   "ObjectAttributeList": [ 
      { 
         "Key": { 
            "FacetName": "string",
            "Name": "string",
            "SchemaArn": "string"
         },
         "Value": { 
            "BinaryValue": blob,
            "BooleanValue": boolean,
            "DatetimeValue": number,
            "NumberValue": "string",
            "StringValue": "string"
         }
      }
   ],
   "ObjectReference": { 
      "Selector": "string"
   },
   "SchemaFacet": { 
      "FacetName": "string",
      "SchemaArn": "string"
   }
}

URI Request Parameters

The request requires the following URI parameters.

DirectoryArn

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

Request Body

The request accepts the following data in JSON format.

ObjectAttributeList

Attributes on the facet that you are adding to the object.

Type: Array of AttributeKeyAndValue objects

Required: No

ObjectReference

A reference to the object you are adding the specified facet to.

Type: ObjectReference object

Required: Yes

SchemaFacet

Identifiers for the facet that you are adding to the object.

Type: SchemaFacet object

Required: Yes

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.

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

DirectoryNotEnabledException

An operation can only operate on a directory that is not enabled.

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

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

Examples

The following examples are formatted for legibility.

Example Request

Copy
PUT /amazonclouddirectory/2017-01-11/object/facets HTTP/1.1 Host: clouddirectory.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 232 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20171009/us-west-2/clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=2cf0b34e6e7305c27f7ec762255196d937ef036d0e665e452a0e1bd79ae25106 x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY X-Amz-Date: 20171009T164125Z User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8 { "ObjectReference": { "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWmspn1fxfQmSQaaVKSbvEiQ" }, "SchemaFacet": { "SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1", "FacetName": "node1" } }

Example Response

Copy
HTTP/1.1 200 OK x-amzn-RequestId: b21ee371-ad10-11e7-9e13-5b6a00750e59 Date: Mon, 09 Oct 2017 16:41:26 GMT x-amzn-RequestId: b21ee371-ad10-11e7-9e13-5b6a00750e59 Content-Type: application/json Content-Length: 2 {}

See Also

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