:doc:`NetworkFlowMonitor <../../networkflowmonitor>` / Client / get_query_status_workload_insights_top_contributors_data

********************************************************
get_query_status_workload_insights_top_contributors_data
********************************************************



.. py:method:: NetworkFlowMonitor.Client.get_query_status_workload_insights_top_contributors_data(**kwargs)

  

  Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors data for workload insights.

   

  When you start a query, use this call to check the status of the query to make sure that it has has ``SUCCEEDED`` before you review the results. Use the same query ID that you used for the corresponding API call to start the query, ``StartQueryWorkloadInsightsTopContributorsData``.

   

  Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

   

  The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/networkflowmonitor-2023-04-19/GetQueryStatusWorkloadInsightsTopContributorsData>`_  


  **Request Syntax**
  ::

    response = client.get_query_status_workload_insights_top_contributors_data(
        scopeId='string',
        queryId='string'
    )
    
  :type scopeId: string
  :param scopeId: **[REQUIRED]** 

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a ``CreateScope`` API call.

    

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

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

    

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

    
    ::

      {
          'status': 'QUEUED'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELED'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The status of a query for top contributors data.

         

        
        * ``QUEUED``: The query is scheduled to run.
         
        * ``RUNNING``: The query is in progress but not complete.
         
        * ``SUCCEEDED``: The query completed sucessfully.
         
        * ``FAILED``: The query failed due to an error.
         
        * ``CANCELED``: The query was canceled.
        

        
  
  **Exceptions**
  
  *   :py:class:`NetworkFlowMonitor.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`NetworkFlowMonitor.Client.exceptions.ValidationException`

  
  *   :py:class:`NetworkFlowMonitor.Client.exceptions.ThrottlingException`

  
  *   :py:class:`NetworkFlowMonitor.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`NetworkFlowMonitor.Client.exceptions.InternalServerException`

  