EKS / Client / list_nodegroups

list_nodegroups

EKS.Client.list_nodegroups(**kwargs)

Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region. Self-managed node groups aren’t 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 your cluster.

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

• nextToken (string) –

  The nextToken value returned from a previous paginated 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. This value is null when there are no more results to return.

  Note

  This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

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 returned from a previous paginated 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. This value is null when there are no more results to return.

    Note

    This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Exceptions

• EKS.Client.exceptions.InvalidParameterException

• EKS.Client.exceptions.ClientException

• EKS.Client.exceptions.ServerException

• EKS.Client.exceptions.ServiceUnavailableException

• EKS.Client.exceptions.ResourceNotFoundException