EKS / Client / list_identity_provider_configs

list_identity_provider_configs#

EKS.Client.list_identity_provider_configs(**kwargs)#

A list of identity provider configurations.

See also: AWS API Documentation

Request Syntax

response = client.list_identity_provider_configs(
    clusterName='string',
    maxResults=123,
    nextToken='string'
)
Parameters:
  • clusterName (string) –

    [REQUIRED]

    The cluster name that you want to list identity provider configurations for.

  • maxResults (integer) – The maximum number of identity provider configurations returned by ListIdentityProviderConfigs in paginated output. When you use this parameter, ListIdentityProviderConfigs returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListIdentityProviderConfigs request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListIdentityProviderConfigs returns up to 100 results and a nextToken value, if applicable.

  • nextToken (string) – The nextToken value returned from a previous paginated IdentityProviderConfigsRequest where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Return type:

dict

Returns:

Response Syntax

{
    'identityProviderConfigs': [
        {
            'type': 'string',
            'name': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • identityProviderConfigs (list) –

      The identity provider configurations for the cluster.

      • (dict) –

        An object representing an identity provider configuration.

        • type (string) –

          The type of the identity provider configuration. The only type available is oidc.

        • name (string) –

          The name of the identity provider configuration.

    • nextToken (string) –

      The nextToken value returned from a previous paginated ListIdentityProviderConfigsResponse where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Exceptions

  • EKS.Client.exceptions.InvalidParameterException

  • EKS.Client.exceptions.ClientException

  • EKS.Client.exceptions.ServerException

  • EKS.Client.exceptions.ServiceUnavailableException

  • EKS.Client.exceptions.ResourceNotFoundException