ListRegions

Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.

Request Syntax


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

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Maximum number of regions to return in a single API call. Enables pagination of region results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 25.

Required: No

Pagination token for retrieving subsequent pages of region results.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No


{
   "NextToken": "string",
   "Regions": [ 
      { 
         "RegionName": "string"
      }
   ]
}

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Token for retrieving additional regions if the result set is paginated.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Collection of AWS regions supported by WorkSpaces Instances.

Type: Array of Region objects

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

AccessDeniedException

Indicates insufficient permissions to perform the requested action.

HTTP Status Code: 400

InternalServerException

Indicates an unexpected server-side error occurred.

HTTP Status Code: 500

ThrottlingException

Indicates the request rate has exceeded limits.

HTTP Status Code: 400

ValidationException

Indicates invalid input parameters in the request.

HTTP Status Code: 400