IdentityStore / Paginator / ListIdentityStores

ListIdentityStores¶

class IdentityStore.Paginator.ListIdentityStores¶

paginator = client.get_paginator('list_identity_stores')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from IdentityStore.Client.list_identity_stores().

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

{
    'IdentityStores': [
        {
            'IdentityStoreId': 'string',
            'IdentityStoreArn': 'string'
        },
    ],

}

Response Structure

(dict) –
- IdentityStores (list) –
  
  A list of IdentityStore objects, each of which contains the identifiers for an identity store that you have access to.
  - (dict) –
    
    A structure that contains the identifiers for an identity store: its globally unique identifier (ID) and Amazon Resource Name (ARN).
    - IdentityStoreId (string) –
      
      The globally unique identifier for the identity store.
    - IdentityStoreArn (string) –
      
      The Amazon Resource Name (ARN) of the identity store. For example, arn:aws:identitystore::111122223333:identitystore/d-1234567890.