POST

/#X-Amz-Target=DirectoryService_20150416.DescribeDirectories

http://ds.{region}.amazonaws.com/#X-Amz-Target=DirectoryService_20150416.DescribeDirectories

Obtains information about the directories that belong to this account. You can retrieve information about specific directories by passing the directory identifiers in the <code>DirectoryIds</code> parameter. Otherwise, all directories that belong to the current account are returned. This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>DescribeDirectoriesResult.NextToken</code> member contains a token that you pass in the next call to <a>DescribeDirectories</a> to retrieve the next set of items. You can also specify a maximum number of return results with the <code>Limit</code> parameter.

Access Token Required: API Key

Query Params

Limitstring

Pagination limit

NextTokenstring

Pagination token

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://ds.{region}.amazonaws.com/#X-Amz-Target=DirectoryService_20150416.DescribeDirectories' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}