Menu
Amazon Cloud Directory
API Reference

ListDirectories

Lists directories created within an account.

Request Syntax

POST /amazonclouddirectory/2017-01-11/directory/list HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string",
   "state": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to retrieve.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

The pagination token.

Type: String

Required: No

state

The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

Type: String

Valid Values: ENABLED | DISABLED | DELETED

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "Directories": [ 
      { 
         "CreationDateTime": number,
         "DirectoryArn": "string",
         "Name": "string",
         "State": "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.

Directories

Lists all directories that are associated with your account in pagination fashion.

Type: Array of Directory objects

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

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

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

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/directory/list HTTP/1.1 Host: clouddirectory.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 0 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20171016/us-west-2/clouddirectory/aws4_request, SignedHeaders=host;x-amz-date, Signature=3e25d9a79eca5d22f81ae7ef6ed3d3b1a7280201839584196e680029893b8694 X-Amz-Date: 20171016T233810Z User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8

Example Response

Copy
HTTP/1.1 200 OK x-amzn-RequestId: 12ade21c-b2cb-11e7-bd9d-f9e3493b0666 Date: Mon, 16 Oct 2017 23:38:11 GMT x-amzn-RequestId: 12ade21c-b2cb-11e7-bd9d-f9e3493b0666 Content-Type: application/json Content-Length: 893 { "Directories": [{ "CreationDateTime": 1.506121791167E9, "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/Ae89hOKmw0bRpvYgW8EAsus", "Name": "ExampleCD4", "State": "ENABLED" }, { "CreationDateTime": 1.485473189746E9, "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AXQXDXvdgkOWktRXV4HnRa8", "Name": "testCD", "State": "DELETED" }, { "CreationDateTime": 1.506115781186E9, "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY", "Name": "ExampleCD", "State": "ENABLED" }, { "CreationDateTime": 1.506118003859E9, "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AfMr4qym1kZTvwqOafAYfqI", "Name": "ExampleCD2", "State": "ENABLED" }, { "CreationDateTime": 1.485477107925E9, "DirectoryArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AWeI1yjiB0SylWVTvQklCD0", "Name": "testCD2", "State": "DELETED" }], "NextToken": null }

See Also

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