Add Region

ssoadmin_add_region

R Documentation

Adds a Region to an IAM Identity Center instance¶

Description¶

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 add_region:

remove_region
describe_region
list_regions

Usage¶

ssoadmin_add_region(InstanceArn, RegionName)

Arguments¶

InstanceArn

[required] The Amazon Resource Name (ARN) of the IAM Identity Center instance to replicate to the target Region.

RegionName

[required] The name of the Amazon Web Services Region to add to the IAM Identity Center instance. The Region name must be 1-32 characters long and follow the pattern of Amazon Web Services Region names (for example, us-east-1).

Value¶

A list with the following syntax:

list(
  Status = "ACTIVE"|"ADDING"|"REMOVING"
)

Request syntax¶

svc$add_region(
  InstanceArn = "string",
  RegionName = "string"
)