EKS / Client / list_addons
list_addons#
- EKS.Client.list_addons(**kwargs)#
Lists the available 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 onlymaxResults
results in a single page along with anextToken
response element. You can see the remaining results of the initial request by sending anotherListAddonsRequest
request with the returnednextToken
value. This value can be between 1 and 100. If you don’t use this parameter,ListAddonsRequest
returns up to 100 results and anextToken
value, if applicable.nextToken (string) –
The
nextToken
value returned from a previous paginatedListAddonsRequest
wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
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 available add-ons.
(string) –
nextToken (string) –
The
nextToken
value returned from a previous paginatedListAddonsResponse
wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
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.
Exceptions
EKS.Client.exceptions.InvalidParameterException
EKS.Client.exceptions.InvalidRequestException
EKS.Client.exceptions.ClientException
EKS.Client.exceptions.ResourceNotFoundException
EKS.Client.exceptions.ServerException