WorkSpacesWeb / Client / list_identity_providers

list_identity_providers#

WorkSpacesWeb.Client.list_identity_providers(**kwargs)#

Retrieves a list of identity providers for a specific web portal.

See also: AWS API Documentation

Request Syntax

response = client.list_identity_providers(
    maxResults=123,
    nextToken='string',
    portalArn='string'
)
Parameters:

  • maxResults (integer) – The maximum number of results to be included in the next page.

  • nextToken (string) – The pagination token used to retrieve the next page of results for this operation.

  • portalArn (string) –

    [REQUIRED]

    The ARN of the web portal.

Return type:

dict

Returns:

Response Syntax

{
    'identityProviders': [
        {
            'identityProviderArn': 'string',
            'identityProviderName': 'string',
            'identityProviderType': 'SAML'|'Facebook'|'Google'|'LoginWithAmazon'|'SignInWithApple'|'OIDC'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • identityProviders (list) –

      The identity providers.

      • (dict) –

        The summary of the identity provider.

        • identityProviderArn (string) –

          The ARN of the identity provider.

        • identityProviderName (string) –

          The identity provider name.

        • identityProviderType (string) –

          The identity provider type.

    • nextToken (string) –

      The pagination token used to retrieve the next page of results for this operation.

Exceptions

  • WorkSpacesWeb.Client.exceptions.InternalServerException

  • WorkSpacesWeb.Client.exceptions.AccessDeniedException

  • WorkSpacesWeb.Client.exceptions.ThrottlingException

  • WorkSpacesWeb.Client.exceptions.ValidationException