Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

AddRegion

Adds a Region to an IAM Identity Center instance. This operation initiates an asynchronous workflow to replicate the IAM Identity Center instance to the target Region. The Region status is set to ADDING at first and changes to ACTIVE when the workflow completes.

To use this operation, your IAM Identity Center instance and the target Region must meet the requirements described in the IAM Identity Center User Guide.

The following actions are related to AddRegion:

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 to replicate to the target Region.

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 add to the IAM Identity Center instance. 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


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

Status

The status of the Region after the Add operation. The status is ADDING when the asynchronous workflow is in progress and changes to ACTIVE when complete.

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

ConflictException

Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this 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

ServiceQuotaExceededException

Indicates that the principal has crossed the permitted number of resources that can be created.

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