Amazon Cloud Directory
API Reference

AttachToIndex

Attaches the specified object to the specified index.

Request Syntax

PUT /amazonclouddirectory/2017-01-11/index/attach HTTP/1.1 x-amz-data-partition: DirectoryArn Content-type: application/json { "IndexReference": { "Selector": "string" }, "TargetReference": { "Selector": "string" } }

URI Request Parameters

The request requires the following URI parameters.

DirectoryArn

The Amazon Resource Name (ARN) of the directory where the object and index exist.

Request Body

The request accepts the following data in JSON format.

IndexReference

A reference to the index that you are attaching the object to.

Type: ObjectReference object

Required: Yes

TargetReference

A reference to the object that you are attaching to the index.

Type: ObjectReference object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "AttachedObjectIdentifier": "string" }

Response Elements

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

The following data is returned in JSON format by the service.

AttachedObjectIdentifier

The ObjectIdentifier of the object that was attached to the index.

Type: String

Errors

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

AccessDeniedException

Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.

HTTP Status Code: 403

DirectoryNotEnabledException

Operations are only permitted on enabled directories.

HTTP Status Code: 400

IndexedAttributeMissingException

An object has been attempted to be attached to an object that does not have the appropriate attribute value.

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

InvalidAttachmentException

Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.

HTTP Status Code: 400

LimitExceededException

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

HTTP Status Code: 400

LinkNameAlreadyInUseException

Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.

HTTP Status Code: 400

NotIndexException

Indicates that the requested operation can only operate on index objects.

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

PUT /amazonclouddirectory/2017-01-11/index/attach HTTP/1.1 Host: clouddirectory.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 167 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20170927/us-west-2/clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=78d785ce666b33aa8624c62c59be1dca60c49062f91eb216909450ea214c5a56 x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY X-Amz-Date: 20170927T171118Z User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8 { "IndexReference": { "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q" }, "TargetReference": { "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" } }

Example Response

HTTP/1.1 200 OK x-amzn-RequestId: e1458e29-a3a6-11e7-a169-c5bf0acd39f4 Date: Wed, 27 Sep 2017 17:11:18 GMT x-amzn-RequestId: e1458e29-a3a6-11e7-a169-c5bf0acd39f4 Content-Type: application/json Content-Length: 77 { "AttachedObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" }

See Also

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