EKS / Client / list_addons

list_addons#

EKS.Client.list_addons(**kwargs)#

Lists the installed add-ons.

See also: AWS API Documentation

Request Syntax

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

    [REQUIRED]

    The name of the cluster.

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

  • nextToken (string) –

    The nextToken value returned from a previous paginated ListAddonsRequest 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.

    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

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

Response Structure

  • (dict) –

    • addons (list) –

      A list of installed add-ons.

      • (string) –

    • nextToken (string) –

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

      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.InvalidRequestException

  • EKS.Client.exceptions.ClientException

  • EKS.Client.exceptions.ResourceNotFoundException

  • EKS.Client.exceptions.ServerException