:doc:`EKS <../../eks>` / Client / describe_insight

****************
describe_insight
****************



.. py:method:: EKS.Client.describe_insight(**kwargs)

  

  Returns details about an insight that you specify using its ID.

  

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


  **Request Syntax**
  ::

    response = client.describe_insight(
        clusterName='string',
        id='string'
    )
    
  :type clusterName: string
  :param clusterName: **[REQUIRED]** 

    The name of the cluster to describe the insight for.

    

  
  :type id: string
  :param id: **[REQUIRED]** 

    The identity of the insight to describe.

    

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

    
    ::

      {
          'insight': {
              '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'
              },
              'recommendation': 'string',
              'additionalInfo': {
                  'string': 'string'
              },
              'resources': [
                  {
                      'insightStatus': {
                          'status': 'PASSING'|'WARNING'|'ERROR'|'UNKNOWN',
                          'reason': 'string'
                      },
                      'kubernetesResourceUri': 'string',
                      'arn': 'string'
                  },
              ],
              'categorySpecificSummary': {
                  'deprecationDetails': [
                      {
                          'usage': 'string',
                          'replacedWith': 'string',
                          'stopServingVersion': 'string',
                          'startServingReplacementVersion': 'string',
                          'clientStats': [
                              {
                                  'userAgent': 'string',
                                  'numberOfRequestsLast30Days': 123,
                                  'lastRequestTime': datetime(2015, 1, 1)
                              },
                          ]
                      },
                  ],
                  'addonCompatibilityDetails': [
                      {
                          'name': 'string',
                          'compatibleVersions': [
                              'string',
                          ]
                      },
                  ]
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **insight** *(dict) --* 

        The full 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 resource.

          
          

          - **status** *(string) --* 

            The status of the resource.

            
          

          - **reason** *(string) --* 

            Explanation on the reasoning for the status of the resource.

            
      
        

        - **recommendation** *(string) --* 

          A summary of how to remediate the finding of this insight if applicable.

          
        

        - **additionalInfo** *(dict) --* 

          Links to sources that provide additional context on the insight.

          
          

          - *(string) --* 
            

            - *(string) --* 
      
    
        

        - **resources** *(list) --* 

          The details about each resource listed in the insight check result.

          
          

          - *(dict) --* 

            Returns information about the resource being evaluated.

            
            

            - **insightStatus** *(dict) --* 

              An object containing more detail on the status of the insight resource.

              
              

              - **status** *(string) --* 

                The status of the resource.

                
              

              - **reason** *(string) --* 

                Explanation on the reasoning for the status of the resource.

                
          
            

            - **kubernetesResourceUri** *(string) --* 

              The Kubernetes resource URI if applicable.

              
            

            - **arn** *(string) --* 

              The Amazon Resource Name (ARN) if applicable.

              
        
      
        

        - **categorySpecificSummary** *(dict) --* 

          Summary information that relates to the category of the insight. Currently only returned with certain insights having category ``UPGRADE_READINESS``.

          
          

          - **deprecationDetails** *(list) --* 

            The summary information about deprecated resource usage for an insight check in the ``UPGRADE_READINESS`` category.

            
            

            - *(dict) --* 

              The summary information about deprecated resource usage for an insight check in the ``UPGRADE_READINESS`` category.

              
              

              - **usage** *(string) --* 

                The deprecated version of the resource.

                
              

              - **replacedWith** *(string) --* 

                The newer version of the resource to migrate to if applicable.

                
              

              - **stopServingVersion** *(string) --* 

                The version of the software where the deprecated resource version will stop being served.

                
              

              - **startServingReplacementVersion** *(string) --* 

                The version of the software where the newer resource version became available to migrate to if applicable.

                
              

              - **clientStats** *(list) --* 

                Details about Kubernetes clients using the deprecated resources.

                
                

                - *(dict) --* 

                  Details about clients using the deprecated resources.

                  
                  

                  - **userAgent** *(string) --* 

                    The user agent of the Kubernetes client using the deprecated resource.

                    
                  

                  - **numberOfRequestsLast30Days** *(integer) --* 

                    The number of requests from the Kubernetes client seen over the last 30 days.

                    
                  

                  - **lastRequestTime** *(datetime) --* 

                    The timestamp of the last request seen from the Kubernetes client.

                    
              
            
          
        
          

          - **addonCompatibilityDetails** *(list) --* 

            A list of ``AddonCompatibilityDetail`` objects for Amazon EKS add-ons.

            
            

            - *(dict) --* 

              The summary information about the Amazon EKS add-on compatibility for the next Kubernetes version for an insight check in the ``UPGRADE_READINESS`` category.

              
              

              - **name** *(string) --* 

                The name of the Amazon EKS add-on.

                
              

              - **compatibleVersions** *(list) --* 

                The list of compatible Amazon EKS add-on versions for the next Kubernetes version.

                
                

                - *(string) --* 
            
          
        
      
    
  
  **Exceptions**
  
  *   :py:class:`EKS.Client.exceptions.ServerException`

  
  *   :py:class:`EKS.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`EKS.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`EKS.Client.exceptions.InvalidParameterException`

  