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/). # ListObjectParentPaths Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see [Directory Structure](https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html). Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined `MaxResults`, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object. ## Request Syntax ``` POST /amazonclouddirectory/2017-01-11/object/parentpaths HTTP/1.1 x-amz-data-partition: DirectoryArn Content-type: application/json { "MaxResults": number, "NextToken": "string", "ObjectReference": { "Selector": "string" } } ``` ## URI Request Parameters The request uses the following URI parameters. ** [DirectoryArn](#API_ListObjectParentPaths_RequestSyntax) ** The ARN of the directory to which the parent path applies. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [MaxResults](#API_ListObjectParentPaths_RequestSyntax) ** 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_ListObjectParentPaths_RequestSyntax) ** The pagination token. Type: String Required: No ** [ObjectReference](#API_ListObjectParentPaths_RequestSyntax) ** The reference that identifies the object whose parent paths are listed. Type: [ObjectReference](API_ObjectReference.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "PathToObjectIdentifiersList": [ { "ObjectIdentifiers": [ "string" ], "Path": "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. ** [NextToken](#API_ListObjectParentPaths_ResponseSyntax) ** The pagination token. Type: String ** [PathToObjectIdentifiersList](#API_ListObjectParentPaths_ResponseSyntax) ** Returns the path to the `ObjectIdentifiers` that are associated with the directory. Type: Array of [PathToObjectIdentifiers](API_PathToObjectIdentifiers.md) objects ## 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 ** 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 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/ListObjectParentPaths) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/clouddirectory-2017-01-11/ListObjectParentPaths) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/clouddirectory-2017-01-11/ListObjectParentPaths) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/clouddirectory-2017-01-11/ListObjectParentPaths) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/clouddirectory-2017-01-11/ListObjectParentPaths) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/clouddirectory-2017-01-11/ListObjectParentPaths) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/clouddirectory-2017-01-11/ListObjectParentPaths) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/clouddirectory-2017-01-11/ListObjectParentPaths) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/clouddirectory-2017-01-11/ListObjectParentPaths) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/clouddirectory-2017-01-11/ListObjectParentPaths)