CognitoIdentityProvider / Client / list_identity_providers

list_identity_providers#

CognitoIdentityProvider.Client.list_identity_providers(**kwargs)#

Lists information about all IdPs for a user pool.

Note

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Request Syntax

response = client.list_identity_providers(
    UserPoolId='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

UserPoolId (string) –
[REQUIRED]

The user pool ID.
MaxResults (integer) – The maximum number of IdPs to return.
NextToken (string) – A pagination token.

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)
        },
    ],
    'NextToken': 'string'
}

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.
- NextToken (string) –
  
  A pagination token.

Exceptions

CognitoIdentityProvider.Client.exceptions.InvalidParameterException
CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
CognitoIdentityProvider.Client.exceptions.InternalErrorException