query_status_workload_insights_top_contributors

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

Overview

Name	query_status_workload_insights_top_contributors
Type	Resource
Id	aws.networkflowmonitor.query_status_workload_insights_top_contributors

Fields

The following fields are returned by SELECT queries:

get_query_status_workload_insights_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_workload_insights_top_contributors	select	scope_id, query_id, region		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. 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.

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
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)
scope_id	string	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.

SELECT examples

get_query_status_workload_insights_top_contributors

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

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