:doc:`EKS <../../eks>` / Paginator / ListInsights

************
ListInsights
************



.. py:class:: EKS.Paginator.ListInsights

  ::

    
    paginator = client.get_paginator('list_insights')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`EKS.Client.list_insights`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/eks-2017-11-01/ListInsights>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          clusterName='string',
          filter={
              'categories': [
                  'UPGRADE_READINESS'|'MISCONFIGURATION',
              ],
              'kubernetesVersions': [
                  'string',
              ],
              'statuses': [
                  'PASSING'|'WARNING'|'ERROR'|'UNKNOWN',
              ]
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type clusterName: string
    :param clusterName: **[REQUIRED]** 

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

      

    
    :type filter: dict
    :param filter: 

      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. The following lists the available categories:

         

        
        * ``UPGRADE_READINESS``: Amazon EKS identifies issues that could impact your ability to upgrade to new versions of Kubernetes. These are called upgrade insights.
         
        * ``MISCONFIGURATION``: Amazon EKS identifies misconfiguration in your EKS Hybrid Nodes setup that could impair functionality of your cluster or workloads. These are called configuration 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) --* 

        
    
    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'insights': [
                {
                    'id': 'string',
                    'name': 'string',
                    'category': 'UPGRADE_READINESS'|'MISCONFIGURATION',
                    '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.

          
    