Skip to content

ListInsightsRequest

Source code in docs_src/capo_eks/types/list_insights_request.py 
13
14
15
16
17
18
19
20
21
22
23
class ListInsightsRequest(TypedDict, closed=True):
    cluster_name: "capo_eks.types.string.String"
    """<p>The name of the Amazon EKS cluster associated with the insights.</p>"""
    filter: NotRequired["capo_eks.types.insights_filter.InsightsFilter"]
    """<p>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.</p>"""
    max_results: NotRequired[
        "capo_eks.types.list_insights_max_results.ListInsightsMaxResults"
    ]
    """<p>The maximum number of identity provider configurations returned by <code>ListInsights</code> in paginated output. When you use this parameter, <code>ListInsights</code> returns only <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListInsights</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListInsights</code> returns up to 100 results and a <code>nextToken</code> value, if applicable.</p>"""
    next_token: NotRequired["capo_eks.types.string.String"]
    """<p>The <code>nextToken</code> value returned from a previous paginated <code>ListInsights</code> request. When the results of a <code>ListInsights</code> request exceed <code>maxResults</code>, you can use this value to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"""

cluster_name instance-attribute 

cluster_name: String

The name of the Amazon EKS cluster associated with the insights.

filter instance-attribute 

filter: NotRequired[InsightsFilter]

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.

max_results instance-attribute 

max_results: NotRequired[ListInsightsMaxResults]

The maximum number of identity provider configurations returned by ListInsights in paginated output. When you use this parameter, ListInsights 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 ListInsights request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListInsights returns up to 100 results and a nextToken value, if applicable.

next_token instance-attribute 

next_token: NotRequired[String]

The nextToken value returned from a previous paginated ListInsights request. When the results of a ListInsights 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.