

Amazon Cloud Directory will no longer be open to new customers starting on November 7, 2025. For alternatives to Cloud Directory, explore [Amazon DynamoDB](https://aws.amazon.com/dynamodb/) and [Amazon Neptune](https://aws.amazon.com/neptune/). If you need help choosing the right alternative for your use case, or for any other questions, contact [AWS Support](https://aws.amazon.com/support/).

# ListAttachedIndices


Lists indices attached to the specified object.

## Request Syntax


```
POST /amazonclouddirectory/2017-01-11/object/indices HTTP/1.1
x-amz-data-partition: DirectoryArn
x-amz-consistency-level: ConsistencyLevel
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string",
   "TargetReference": { 
      "Selector": "string"
   }
}
```

## URI Request Parameters


The request uses the following URI parameters.

 ** [ConsistencyLevel](#API_ListAttachedIndices_RequestSyntax) **   <a name="amazoncds-ListAttachedIndices-request-ConsistencyLevel"></a>
The consistency level to use for this operation.  
Valid Values: `SERIALIZABLE | EVENTUAL` 

 ** [DirectoryArn](#API_ListAttachedIndices_RequestSyntax) **   <a name="amazoncds-ListAttachedIndices-request-DirectoryArn"></a>
The ARN of the directory.  
Required: Yes

## Request Body


The request accepts the following data in JSON format.

 ** [MaxResults](#API_ListAttachedIndices_RequestSyntax) **   <a name="amazoncds-ListAttachedIndices-request-MaxResults"></a>
The maximum number of results to retrieve.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [NextToken](#API_ListAttachedIndices_RequestSyntax) **   <a name="amazoncds-ListAttachedIndices-request-NextToken"></a>
The pagination token.  
Type: String  
Required: No

 ** [TargetReference](#API_ListAttachedIndices_RequestSyntax) **   <a name="amazoncds-ListAttachedIndices-request-TargetReference"></a>
A reference to the object that has indices attached.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

## Response Syntax


```
HTTP/1.1 200
Content-type: application/json

{
   "IndexAttachments": [ 
      { 
         "IndexedAttributes": [ 
            { 
               "Key": { 
                  "FacetName": "string",
                  "Name": "string",
                  "SchemaArn": "string"
               },
               "Value": { 
                  "BinaryValue": blob,
                  "BooleanValue": boolean,
                  "DatetimeValue": number,
                  "NumberValue": "string",
                  "StringValue": "string"
               }
            }
         ],
         "ObjectIdentifier": "string"
      }
   ],
   "NextToken": "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.

 ** [IndexAttachments](#API_ListAttachedIndices_ResponseSyntax) **   <a name="amazoncds-ListAttachedIndices-response-IndexAttachments"></a>
The indices attached to the specified object.  
Type: Array of [IndexAttachment](API_IndexAttachment.md) objects

 ** [NextToken](#API_ListAttachedIndices_ResponseSyntax) **   <a name="amazoncds-ListAttachedIndices-response-NextToken"></a>
The pagination token.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](API_ListDirectories.md) 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](http://status.aws.amazon.com/) 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](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html) 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


This example illustrates one usage of ListAttachedIndices.

```
POST /amazonclouddirectory/2017-01-11/object/indices HTTP/1.1
Host: clouddirectory.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 84
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20171009/us-west-2/clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=0dd23d46d0aa37f61649857fafdafe5a9d52305b03bcda0de2027c074efce9d1
x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY
X-Amz-Date: 20171009T194908Z
User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8

{
	"TargetReference": {
		"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
	}
}
```

### Example Response


This example illustrates one usage of ListAttachedIndices.

```
HTTP/1.1 200 OK
x-amzn-RequestId: eb40bf46-ad2a-11e7-9e13-5b6a00750e59
Date: Mon, 09 Oct 2017 19:49:10 GMT
x-amzn-RequestId: eb40bf46-ad2a-11e7-9e13-5b6a00750e59
Content-Type: application/json
Content-Length: 132

{
	"IndexAttachments": [{
		"IndexedAttributes": [],
		"ObjectIdentifier": "AQGG_ADlfNZBzYHY_JgDt3TW45F26R1HTY2z-stwKBte_Q"
	}],
	"NextToken": null
}
```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/clouddirectory-2017-01-11/ListAttachedIndices) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/clouddirectory-2017-01-11/ListAttachedIndices) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/ListAttachedIndices) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/clouddirectory-2017-01-11/ListAttachedIndices) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/ListAttachedIndices) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/clouddirectory-2017-01-11/ListAttachedIndices) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/clouddirectory-2017-01-11/ListAttachedIndices) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/clouddirectory-2017-01-11/ListAttachedIndices) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/clouddirectory-2017-01-11/ListAttachedIndices) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/ListAttachedIndices) 