EKS / Client / list_nodegroups

list_nodegroups#

EKS.Client.list_nodegroups(**kwargs)#

Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region. Self-managed node groups are not listed.

See also: AWS API Documentation

Request Syntax

response = client.list_nodegroups(
    clusterName='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • clusterName (string) –

    [REQUIRED]

    The name of the Amazon EKS cluster that you would like to list node groups in.

  • maxResults (integer) – The maximum number of node group results returned by ListNodegroups in paginated output. When you use this parameter, ListNodegroups 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 ListNodegroups request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListNodegroups returns up to 100 results and a nextToken value if applicable.

  • nextToken (string) – The nextToken value returned from a previous paginated ListNodegroups request 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

{
    'nodegroups': [
        'string',
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • nodegroups (list) –

      A list of all of the node groups associated with the specified cluster.

      • (string) –

    • nextToken (string) –

      The nextToken value to include in a future ListNodegroups request. When the results of a ListNodegroups request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

  • EKS.Client.exceptions.InvalidParameterException

  • EKS.Client.exceptions.ClientException

  • EKS.Client.exceptions.ServerException

  • EKS.Client.exceptions.ServiceUnavailableException

  • EKS.Client.exceptions.ResourceNotFoundException