SSOAdmin / Paginator / ListRegions

ListRegions

class SSOAdmin.Paginator.ListRegions

paginator = client.get_paginator('list_regions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SSOAdmin.Client.list_regions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• InstanceArn (string) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

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.