query_status_monitor_top_contributors

Creates, updates, deletes, gets or lists a query_status_monitor_top_contributors resource.

Overview

Name	query_status_monitor_top_contributors
Type	Resource
Id	aws.networkflowmonitor.query_status_monitor_top_contributors

Fields

The following fields are returned by SELECT queries:

get_query_status_monitor_top_contributors

Name	Datatype	Description
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. (QUEUED, RUNNING, SUCCEEDED, FAILED, CANCELED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_query_status_monitor_top_contributors	select	monitor_name, query_id, region		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 create 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 (create) 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
monitor_name	string	The name of the monitor.
query_id	string	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.
region	string	AWS region (default: us-east-1)

SELECT examples

get_query_status_monitor_top_contributors

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 create 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 (create) 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.

SELECT
status
FROM aws.networkflowmonitor.query_status_monitor_top_contributors
WHERE monitor_name = '{{ monitor_name }}' -- required
AND query_id = '{{ query_id }}' -- required
AND region = '{{ region }}' -- required
;