EKS / Client / list_updates

list_updates#

EKS.Client.list_updates(**kwargs)#

Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region.

See also: AWS API Documentation

Request Syntax

response = client.list_updates(
    name='string',
    nodegroupName='string',
    addonName='string',
    nextToken='string',
    maxResults=123
)
Parameters:
  • name (string) –

    [REQUIRED]

    The name of the Amazon EKS cluster to list updates for.

  • nodegroupName (string) – The name of the Amazon EKS managed node group to list updates for.

  • addonName (string) – The names of the installed add-ons that have available updates.

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

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • updateIds (list) –

      A list of all the updates for the specified cluster and Region.

      • (string) –

    • nextToken (string) –

      The nextToken value to include in a future ListUpdates request. When the results of a ListUpdates 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.ResourceNotFoundException