Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

DetachFromIndex

Detaches the specified object from the specified index.

Request Syntax


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

{
   "IndexReference": { 
      "Selector": "string"
   },
   "TargetReference": { 
      "Selector": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

DirectoryArn

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

IndexReference

A reference to the index object.

Type: ObjectReference object

Required: Yes

TargetReference

A reference to the object being detached from the index.

Type: ObjectReference object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DetachedObjectIdentifier": "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.

DetachedObjectIdentifier

The ObjectIdentifier of the object that was detached from 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

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

NotIndexException

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

HTTP Status Code: 400

ObjectAlreadyDetachedException

Indicates that the object is not attached to the index.

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

This example illustrates one usage of DetachFromIndex.


PUT /amazonclouddirectory/2017-01-11/index/detach HTTP/1.1
Host: clouddirectory.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 167
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20171009/us-west-2/clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=78a7d77e2d49bc312be21f048fd10742dc50c838314696f2f58e99658137773b
x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY
X-Amz-Date: 20171009T195357Z
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

This example illustrates one usage of DetachFromIndex.


HTTP/1.1 200 OK
x-amzn-RequestId: 9746ae70-ad2b-11e7-81c0-7b48a7696e76
Date: Mon, 09 Oct 2017 19:53:59 GMT
x-amzn-RequestId: 9746ae70-ad2b-11e7-81c0-7b48a7696e76
Content-Type: application/json
Content-Length: 77

{
	"DetachedObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
}