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/).

# ListObjectParents
<a name="API_ListObjectParents"></a>

Lists parent objects that are associated with a given object in pagination fashion.

## Request Syntax
<a name="API_ListObjectParents_RequestSyntax"></a>

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

{
   "IncludeAllLinksToEachParent": boolean,
   "MaxResults": number,
   "NextToken": "string",
   "ObjectReference": { 
      "Selector": "string"
   }
}
```

## URI Request Parameters
<a name="API_ListObjectParents_RequestParameters"></a>

The request uses the following URI parameters.

 ** [ConsistencyLevel](#API_ListObjectParents_RequestSyntax) **   <a name="amazoncds-ListObjectParents-request-ConsistencyLevel"></a>
Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.  
Valid Values: `SERIALIZABLE | EVENTUAL` 

 ** [DirectoryArn](#API_ListObjectParents_RequestSyntax) **   <a name="amazoncds-ListObjectParents-request-DirectoryArn"></a>
The Amazon Resource Name (ARN) that is associated with the [Directory](API_Directory.md) where the object resides. For more information, see [Arn Examples](arns.md).  
Required: Yes

## Request Body
<a name="API_ListObjectParents_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [IncludeAllLinksToEachParent](#API_ListObjectParents_RequestSyntax) **   <a name="amazoncds-ListObjectParents-request-IncludeAllLinksToEachParent"></a>
When set to True, returns all [ListObjectParents:ParentLinks](#amazoncds-ListObjectParents-response-ParentLinks). There could be multiple links between a parent-child pair.  
Type: Boolean  
Required: No

 ** [MaxResults](#API_ListObjectParents_RequestSyntax) **   <a name="amazoncds-ListObjectParents-request-MaxResults"></a>
The maximum number of items to be retrieved in a single call. This is an approximate number.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

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

 ** [ObjectReference](#API_ListObjectParents_RequestSyntax) **   <a name="amazoncds-ListObjectParents-request-ObjectReference"></a>
The reference that identifies the object for which parent objects are being listed.  
Type: [ObjectReference](API_ObjectReference.md) object  
Required: Yes

## Response Syntax
<a name="API_ListObjectParents_ResponseSyntax"></a>

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

{
   "NextToken": "string",
   "ParentLinks": [ 
      { 
         "LinkName": "string",
         "ObjectIdentifier": "string"
      }
   ],
   "Parents": { 
      "string" : "string" 
   }
}
```

## Response Elements
<a name="API_ListObjectParents_ResponseElements"></a>

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

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

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

 ** [ParentLinks](#API_ListObjectParents_ResponseSyntax) **   <a name="amazoncds-ListObjectParents-response-ParentLinks"></a>
Returns a list of parent reference and LinkName Tuples.  
Type: Array of [ObjectIdentifierAndLinkNameTuple](API_ObjectIdentifierAndLinkNameTuple.md) objects

 ** [Parents](#API_ListObjectParents_ResponseSyntax) **   <a name="amazoncds-ListObjectParents-response-Parents"></a>
The parent structure, which is a map with key as the `ObjectIdentifier` and LinkName as the value.  
Type: String to string map  
Value Length Constraints: Minimum length of 1. Maximum length of 64.  
Value Pattern: `[^\/\[\]\(\):\{\}#@!?\s\\;]+` 

## Errors
<a name="API_ListObjectParents_Errors"></a>

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

 ** CannotListParentOfRootException **   
Cannot list the parents of a [Directory](API_Directory.md) root.  
HTTP Status Code: 400

 ** 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

 ** InvalidNextTokenException **   
Indicates that the `NextToken` 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

## See Also
<a name="API_ListObjectParents_SeeAlso"></a>

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/ListObjectParents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/clouddirectory-2017-01-11/ListObjectParents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/ListObjectParents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/clouddirectory-2017-01-11/ListObjectParents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/ListObjectParents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/clouddirectory-2017-01-11/ListObjectParents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/clouddirectory-2017-01-11/ListObjectParents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/clouddirectory-2017-01-11/ListObjectParents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/clouddirectory-2017-01-11/ListObjectParents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/ListObjectParents)