EKS / Paginator / ListInsights


class EKS.Paginator.ListInsights#
paginator = client.get_paginator('list_insights')

Creates an iterator that will paginate through responses from EKS.Client.list_insights().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'categories': [
        'kubernetesVersions': [
        'statuses': [
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • clusterName (string) –


    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) –

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



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) –

      A token to resume pagination.