EKS / Client / list_insights
list_insights#
- EKS.Client.list_insights(**kwargs)#
Returns a list of all insights checked for against the specified cluster. You can filter which insights are returned by category, associated Kubernetes version, and status.
See also: AWS API Documentation
Request Syntax
response = client.list_insights( clusterName='string', filter={ 'categories': [ 'UPGRADE_READINESS', ], 'kubernetesVersions': [ 'string', ], 'statuses': [ 'PASSING'|'WARNING'|'ERROR'|'UNKNOWN', ] }, maxResults=123, nextToken='string' )
- Parameters:
clusterName (string) –
[REQUIRED]
The name of the Amazon EKS cluster associated with the insights.
filter (dict) –
The criteria to filter your list of insights for your cluster. You can filter which insights are returned by category, associated Kubernetes version, and status.
categories (list) –
The categories to use to filter insights.
(string) –
kubernetesVersions (list) –
The Kubernetes versions to use to filter the insights.
(string) –
statuses (list) –
The statuses to use to filter the insights.
(string) –
maxResults (integer) – The maximum number of identity provider configurations returned by
ListInsights
in paginated output. When you use this parameter,ListInsights
returns onlymaxResults
results in a single page along with anextToken
response element. You can see the remaining results of the initial request by sending anotherListInsights
request with the returnednextToken
value. This value can be between 1 and 100. If you don’t use this parameter,ListInsights
returns up to 100 results and anextToken
value, if applicable.nextToken (string) – The
nextToken
value returned from a previous paginatedListInsights
request. When the results of aListInsights
request exceedmaxResults
, you can use this value to retrieve the next page of results. This value isnull
when there are no more results to return.
- Return type:
dict
- Returns:
Response Syntax
{ 'insights': [ { 'id': 'string', 'name': 'string', 'category': 'UPGRADE_READINESS', 'kubernetesVersion': 'string', 'lastRefreshTime': datetime(2015, 1, 1), 'lastTransitionTime': datetime(2015, 1, 1), 'description': 'string', 'insightStatus': { 'status': 'PASSING'|'WARNING'|'ERROR'|'UNKNOWN', 'reason': 'string' } }, ], 'nextToken': 'string' }
Response Structure
(dict) –
insights (list) –
The returned list of insights.
(dict) –
The summarized description of the insight.
id (string) –
The ID of the insight.
name (string) –
The name of the insight.
category (string) –
The category of the insight.
kubernetesVersion (string) –
The Kubernetes minor version associated with an insight if applicable.
lastRefreshTime (datetime) –
The time Amazon EKS last successfully completed a refresh of this insight check on the cluster.
lastTransitionTime (datetime) –
The time the status of the insight last changed.
description (string) –
The description of the insight which includes alert criteria, remediation recommendation, and additional resources (contains Markdown).
insightStatus (dict) –
An object containing more detail on the status of the insight.
status (string) –
The status of the resource.
reason (string) –
Explanation on the reasoning for the status of the resource.
nextToken (string) –
The
nextToken
value to include in a futureListInsights
request. When the results of aListInsights
request exceedmaxResults
, you can use this value to retrieve the next page of results. This value isnull
when there are no more results to return.
Exceptions
EKS.Client.exceptions.ServerException
EKS.Client.exceptions.ResourceNotFoundException
EKS.Client.exceptions.InvalidRequestException
EKS.Client.exceptions.InvalidParameterException