SSOAdmin / Client / describe_region

describe_region

SSOAdmin.Client.describe_region(**kwargs)

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:

See also: AWS API Documentation

Request Syntax

response = client.describe_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 retrieve information about. 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

{
    'RegionName': 'string',
    'Status': 'ACTIVE'|'ADDING'|'REMOVING',
    'AddedDate': datetime(2015, 1, 1),
    'IsPrimaryRegion': True|False
}

Response Structure

  • (dict) –

    • RegionName (string) –

      The Amazon Web Services Region name.

    • Status (string) –

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

    • AddedDate (datetime) –

      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.

    • IsPrimaryRegion (boolean) –

      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

Exceptions

  • SSOAdmin.Client.exceptions.ThrottlingException

  • SSOAdmin.Client.exceptions.InternalServerException

  • SSOAdmin.Client.exceptions.ResourceNotFoundException

  • SSOAdmin.Client.exceptions.AccessDeniedException

  • SSOAdmin.Client.exceptions.ValidationException