NetworkFlowMonitor / Client / get_query_status_monitor_top_contributors

get_query_status_monitor_top_contributors

NetworkFlowMonitor.Client.get_query_status_monitor_top_contributors(**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 for a monitor.

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 reviewStartQueryWorkloadInsightsTopContributorsData the results. Use the same query ID that you used for the corresponding API call to start the query, StartQueryMonitorTopContributors.

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.

See also: AWS API Documentation

Request Syntax

response = client.get_query_status_monitor_top_contributors(
    monitorName='string',
    queryId='string'
)
Parameters:

  • monitorName (string) –

    [REQUIRED]

    The name of the monitor.

  • 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