Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeRegions

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.

DirectoryId

The identifier of the directory.

Type: String

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

Required: Yes

NextToken

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

Type: String

Required: No

RegionName

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.

NextToken

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

RegionsDescription

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

Type: Array of RegionDescription objects

Errors

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

AccessDeniedException

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

HTTP Status Code: 400

ClientException

A client exception has occurred.

HTTP Status Code: 400

DirectoryDoesNotExistException

The specified directory does not exist in the system.

HTTP Status Code: 400

InvalidNextTokenException

The NextToken value is not valid.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 400

ServiceException

An exception has occurred in AWS Directory Service.

HTTP Status Code: 500

UnsupportedOperationException

The operation is not supported.

HTTP Status Code: 400