SSOAdmin / Client / list_regions

list_regions¶

SSOAdmin.Client.list_regions(**kwargs)¶

Lists all enabled Regions of an IAM Identity Center instance, including those that are being added or removed. This operation returns Regions with ACTIVE, ADDING, or REMOVING status.

The following actions are related to ListRegions:

Request Syntax

response = client.list_regions(
    InstanceArn='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

InstanceArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the IAM Identity Center instance.
MaxResults (integer) – The maximum number of results to return in a single call. Default is 100.
NextToken (string) – The pagination token for the list API. Initially the value is null. Use the output of previous API calls to make subsequent calls.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- Regions (list) –
  
  The list of Regions enabled in the IAM Identity Center instance, including Regions with ACTIVE, ADDING, or REMOVING status.
  - (dict) –
    
    Contains information about an enabled Region of an IAM Identity Center instance, including the Region name, status, date added, and whether it is the primary Region.
    - 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 extension 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 instance creation time.
    - IsPrimaryRegion (boolean) –
      
      Indicates whether this is the primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed.
- NextToken (string) –
  
  The pagination token to be used in subsequent calls. If the value is null, then there are no more entries.

Exceptions

SSOAdmin.Client.exceptions.ThrottlingException
SSOAdmin.Client.exceptions.InternalServerException
SSOAdmin.Client.exceptions.AccessDeniedException
SSOAdmin.Client.exceptions.ValidationException