DescribeRegions - AWS Directory Service


Provides information about the Regions that are configured for multi-Region replication.

Request Syntax

{ "DirectoryId": "string", "NextToken": "string", "RegionName": "string" }

Request Parameters

The request accepts the following data in JSON format.


The identifier of the directory.

Type: String

Pattern: ^d-[0-9a-f]{10}$

Required: Yes


The DescribeRegionsResult.NextToken value from a previous call to DescribeRegions . Pass null if this is the first call.

Type: String

Required: No


The name of the Region. For example, us-east-1.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 32.

Required: No

Response Syntax

{ "NextToken": "string", "RegionsDescription": [ { "DesiredNumberOfDomainControllers": number, "DirectoryId": "string", "LastUpdatedDateTime": number, "LaunchTime": number, "RegionName": "string", "RegionType": "string", "Status": "string", "StatusLastUpdatedDateTime": number, "VpcSettings": { "SubnetIds": [ "string" ], "VpcId": "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.


If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeRegions to retrieve the next set of items.

Type: String


List of Region information related to the directory for each replicated Region.

Type: Array of RegionDescription objects


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


Client authentication is not available in this region at this time.

HTTP Status Code: 400


A client exception has occurred.

HTTP Status Code: 400


The specified directory does not exist in the system.

HTTP Status Code: 400


The NextToken value is not valid.

HTTP Status Code: 400


One or more parameters are not valid.

HTTP Status Code: 400


An exception has occurred in AWS Directory Service.

HTTP Status Code: 500


The operation is not supported.

HTTP Status Code: 400

See Also

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