SSOAdmin / Client / remove_region

remove_region

SSOAdmin.Client.remove_region(**kwargs)

Removes an additional Region from an IAM Identity Center instance. This operation initiates an asynchronous workflow to clean up IAM Identity Center resources in the specified additional Region. The Region status is set to REMOVING and the Region record is deleted when the workflow completes. The request must be made from the primary Region. The target Region cannot be the primary Region, and no other add or remove Region workflows can be in progress.

The following actions are related to RemoveRegion:

See also: AWS API Documentation

Request Syntax

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

  • InstanceArn (string) –

    [REQUIRED]

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

  • RegionName (string) –

    [REQUIRED]

    The name of the Amazon Web Services Region to remove from 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). The primary Region cannot be removed.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Status (string) –

      The status of the Region after the remove operation. The status is REMOVING when the asynchronous workflow is in progress. The Region record is deleted when the workflow completes.

Exceptions

  • SSOAdmin.Client.exceptions.ThrottlingException

  • SSOAdmin.Client.exceptions.InternalServerException

  • SSOAdmin.Client.exceptions.ResourceNotFoundException

  • SSOAdmin.Client.exceptions.AccessDeniedException

  • SSOAdmin.Client.exceptions.ValidationException

  • SSOAdmin.Client.exceptions.ConflictException