query_status_workload_insights_top_contributors_datas

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

Overview

Name	query_status_workload_insights_top_contributors_datas
Type	Resource
Id	aws.networkflowmonitor.query_status_workload_insights_top_contributors_datas

Fields

The following fields are returned by SELECT queries:

get_query_status_workload_insights_top_contributors_data

Name	Datatype	Description
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. (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_data	select	scope_id, 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 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. 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. The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.

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. A scope ID is returned from a CreateScope API call.

SELECT examples

get_query_status_workload_insights_top_contributors_data

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. 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. The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.

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