Menu
Amazon Cloud Directory
API Reference

ListObjectParents

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

Request Syntax

Copy
POST /amazonclouddirectory/2017-01-11/object/parent HTTP/1.1 x-amz-data-partition: DirectoryArn x-amz-consistency-level: ConsistencyLevel Content-type: application/json { "MaxResults": number, "NextToken": "string", "ObjectReference": { "Selector": "string" } }

URI Request Parameters

The request requires the following URI parameters.

ConsistencyLevel

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

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see Arn Examples.

Request Body

The request accepts the following data in JSON format.

MaxResults

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

The pagination token.

Type: String

Required: No

ObjectReference

The reference that identifies the object for which parent objects are being listed.

Type: ObjectReference object

Required: Yes

Response Syntax

Copy
HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Parents": { "string" : "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

The pagination token.

Type: String

Parents

The parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value.

Type: String to string map

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [^\/\[\]\(\):\{\}#@!?\s\\;]+

Errors

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

AccessDeniedException

Access denied. Check your permissions.

HTTP Status Code: 403

CannotListParentOfRootException

Cannot list the parents of a Directory root.

HTTP Status Code: 400

DirectoryNotEnabledException

An operation can only operate on a directory that is not enabled.

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

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