Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeRegion

Retrieves details about a specific Region enabled in an IAM Identity Center instance. Details include the Region name, current status (ACTIVE, ADDING, or REMOVING), the date when the Region was added, and whether it is the primary Region. The request must be made from one of the enabled Regions of the IAM Identity Center instance.

The following actions are related to DescribeRegion:

Request Syntax


{
   "InstanceArn": "string",
   "RegionName": "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

RegionName

The name of the AWS Region to retrieve information about. The Region name must be 1-32 characters long and follow the pattern of AWS Region names (for example, us-east-1).

Type: String

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

Pattern: ([a-z]+-){2,3}\d

Required: Yes

Response Syntax


{
   "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.

AddedDate

The timestamp when the Region was added to the IAM Identity Center instance. For the primary Region, this is the IAM Identity Center instance creation time.

Type: Timestamp

IsPrimaryRegion

Indicates whether this is the primary Region where the IAM Identity Center instance was originally enabled. For more information on the difference between the primary Region and additional Regions, see IAM Identity Center User Guide

Type: Boolean

RegionName

The AWS Region name.

Type: String

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

Pattern: ([a-z]+-){2,3}\d

Status

The current status of the Region. Valid values are ACTIVE (Region is operational), ADDING (Region replication workflow is in progress), or REMOVING (Region removal workflow is in progress).

Type: String

Valid Values: ACTIVE | ADDING | REMOVING

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

ResourceNotFoundException

Indicates that a requested resource is not found.

Reason: The reason for the resource not found exception.

HTTP Status Code: 400

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