NetworkFlowMonitor / Client / get_query_status_workload_insights_top_contributors_data

get_query_status_workload_insights_top_contributors_data

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, related to a scope (for workload insights) or a monitor.

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

See also: AWS API Documentation

Request Syntax

response = client.get_query_status_workload_insights_top_contributors_data(
    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. A scope ID is returned from a CreateScope API call.

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

      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