:doc:`CognitoIdentityProvider <../../cognito-idp>` / Paginator / ListIdentityProviders

*********************
ListIdentityProviders
*********************



.. py:class:: CognitoIdentityProvider.Paginator.ListIdentityProviders

  ::

    
    paginator = client.get_paginator('list_identity_providers')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CognitoIdentityProvider.Client.list_identity_providers`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListIdentityProviders>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          UserPoolId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type UserPoolId: string
    :param UserPoolId: **[REQUIRED]** 

      The ID of the user pool where you want to list IdPs.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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) --* 

          An array of the IdPs in your user pool. For each, the response includes identifiers, the IdP name and type, and trust-relationship details like the issuer URL.

          
          

          - *(dict) --* 

            The details of a user pool identity provider (IdP), including name and type.

            
            

            - **ProviderName** *(string) --* 

              The name of the IdP, for example ``MySAMLProvider``.

              
            

            - **ProviderType** *(string) --* 

              The type of the provider, for example ``SAML``. Amazon Cognito supports SAML 2.0, OIDC, and social IdPs. User pools list supported social IdPs by name in this response parameter: Facebook, Google, Login with Amazon, and Sign in with Apple.

              
            

            - **LastModifiedDate** *(datetime) --* 

              The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java ``Date`` object.

              
            

            - **CreationDate** *(datetime) --* 

              The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java ``Date`` object.

              
        
      
    