Menu
Amazon Cloud Directory
API Reference

ListObjectChildren

Returns a paginated list of child objects that are associated with a given object.

Request Syntax

POST /amazonclouddirectory/2017-01-11/object/children 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 child objects are being listed.

Type: ObjectReference object

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

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

Children

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

Type: String to string map

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

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

NextToken

The pagination token.

Type: String

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

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

NotNodeException

Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren for a leaf node object.

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

Copy
POST /amazonclouddirectory/2017-01-11/object/children HTTP/1.1 Host: clouddirectory.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 84 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20171017/us-west-2/clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=8c56f415f53f259c6c7a7ba5c5d8b9924ba5341dbb17eb84e23235f5fd3eca0e x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY X-Amz-Date: 20171017T223103Z User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8 { "ObjectReference": { "Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw" } }

Example Response

Copy
HTTP/1.1 200 OK x-amzn-RequestId: dcafb249-b38a-11e7-a973-b71cf1107b43 Date: Tue, 17 Oct 2017 22:31:04 GMT x-amzn-RequestId: dcafb249-b38a-11e7-a973-b71cf1107b43 Content-Type: application/json Content-Length: 88 { "Children": { "link2": "AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA" }, "NextToken": null }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: