Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListRegions

Lists all enabled Regions of an IAM Identity Center instance, including those that are being added or removed. This operation returns Regions with ACTIVE, ADDING, or REMOVING status.

The following actions are related to ListRegions:

Request Syntax


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

Request Parameters

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

The request accepts the following data in JSON format.

InstanceArn

The Amazon Resource Name (ARN) of the IAM Identity Center instance.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 1224.

Pattern: arn:aws(-[a-z]{1,5}){0,3}:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}

Required: Yes

MaxResults

The maximum number of results to return in a single call. Default is 100.

Type: Integer

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

Required: No

NextToken

The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Type: String

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

Pattern: [-a-zA-Z0-9+=/_]*

Required: No

Response Syntax


{
   "NextToken": "string",
   "Regions": [ 
      { 
         "AddedDate": number,
         "IsPrimaryRegion": boolean,
         "RegionName": "string",
         "Status": "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

The pagination token to be used in subsequent calls. If the value is null, then there are no more entries.

Type: String

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

Pattern: [-a-zA-Z0-9+=/_]*

Regions

The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status.

Type: Array of RegionMetadata objects

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

Reason: The reason for the access denied exception.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception, or failure with an internal server.

HTTP Status Code: 500

ThrottlingException

Indicates that the principal has crossed the throttling limits of the API operations.

Reason: The reason for the throttling exception.

HTTP Status Code: 400

ValidationException

The request failed because it contains a syntax error.

Reason: The reason for the validation exception.

HTTP Status Code: 400