CognitoIdentityProvider / Paginator / ListIdentityProviders

ListIdentityProviders#

class CognitoIdentityProvider.Paginator.ListIdentityProviders#

paginator = client.get_paginator('list_identity_providers')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from CognitoIdentityProvider.Client.list_identity_providers().

Request Syntax

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

Parameters:

UserPoolId (string) –
[REQUIRED]

The user pool ID.
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

{
    'Providers': [
        {
            'ProviderName': 'string',
            'ProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC',
            'LastModifiedDate': datetime(2015, 1, 1),
            'CreationDate': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

(dict) –
- Providers (list) –
  
  A list of IdP objects.
  - (dict) –
    
    A container for IdP details.
    - ProviderName (string) –
      
      The IdP name.
    - ProviderType (string) –
      
      The IdP type.
    - LastModifiedDate (datetime) –
      
      The date the provider was last modified.
    - CreationDate (datetime) –
      
      The date and time, in ISO 8601 format, when the item was created.