SSOAdmin / Paginator / ListInstances

ListInstances

class SSOAdmin.Paginator.ListInstances

paginator = client.get_paginator('list_instances')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'Instances': [
        {
            'CreatedDate': datetime(2015, 1, 1),
            'IdentityStoreId': 'string',
            'InstanceArn': 'string',
            'Name': 'string',
            'OwnerAccountId': 'string',
            'Status': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'ACTIVE'
        },
    ],

}

Response Structure

• (dict) –

  • Instances (list) –

    Lists the IAM Identity Center instances that the caller has access to.

    • (dict) –

      Provides information about the IAM Identity Center instance.

      • CreatedDate (datetime) –

        The date and time that the Identity Center instance was created.

      • IdentityStoreId (string) –

        The identifier of the identity store that is connected to the Identity Center instance.

      • InstanceArn (string) –

        The ARN of the Identity Center instance under which the operation will be executed. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.

      • Name (string) –

        The name of the Identity Center instance.

      • OwnerAccountId (string) –

        The Amazon Web Services account ID number of the owner of the Identity Center instance.

      • Status (string) –

        The current status of this Identity Center instance.