SSOAdmin / Client / add_region

add_region

SSOAdmin.Client.add_region(**kwargs)

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:

See also: AWS API Documentation

Request Syntax

response = client.add_region(
    InstanceArn='string',
    RegionName='string'
)
Parameters:

  • InstanceArn (string) –

    [REQUIRED]

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

  • RegionName (string) –

    [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).

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'ACTIVE'|'ADDING'|'REMOVING'
}

Response Structure

  • (dict) –

    • Status (string) –

      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.

Exceptions

  • SSOAdmin.Client.exceptions.ServiceQuotaExceededException

  • SSOAdmin.Client.exceptions.ThrottlingException

  • SSOAdmin.Client.exceptions.InternalServerException

  • SSOAdmin.Client.exceptions.AccessDeniedException

  • SSOAdmin.Client.exceptions.ValidationException

  • SSOAdmin.Client.exceptions.ConflictException