NetworkFlowMonitor / Client / get_query_status_workload_insights_top_contributors

get_query_status_workload_insights_top_contributors

NetworkFlowMonitor.Client.get_query_status_workload_insights_top_contributors(**kwargs)

Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors 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, StartQueryWorkloadInsightsTopContributors.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type, related to a scope (for workload insights) or a monitor.

See also: AWS API Documentation

Request Syntax

response = client.get_query_status_workload_insights_top_contributors(
    scopeId='string',
    queryId='string'
)
Parameters:

  • scopeId (string) –

    [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.

  • queryId (string) –

    [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.

Return type:

dict

Returns:

Response Syntax

{
    'status': 'QUEUED'|'RUNNING'|'SUCCEEDED'|'FAILED'|'CANCELED'
}

Response Structure

  • (dict) –

    • status (string) –

      When you run a query, use this call to check the status of the query to make sure that the query has SUCCEEDED before you review the results.

      • 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