query_results_workload_insights_top_contributors

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

Overview

Name	query_results_workload_insights_top_contributors
Type	Resource
Id	aws.networkflowmonitor.query_results_workload_insights_top_contributors

Fields

The following fields are returned by SELECT queries:

get_query_results_workload_insights_top_contributors

Name	Datatype	Description
account_id	string	The account ID for a specific row of data. (pattern: <code>[0-9]{12}</code>)
local_az	string	The identifier for the Availability Zone where the local resource is located.
local_region	string	The Amazon Web Services Region where the local resource is located.
local_subnet_arn	string	The Amazon Resource Name (ARN) of a local subnet.
local_subnet_id	string	The subnet identifier for the local resource. (pattern: <code>subnet-[a-zA-Z0-9]{8,32}</code>)
local_vpc_arn	string	The Amazon Resource Name (ARN) of a local VPC.
local_vpc_id	string	The identifier for the VPC for the local resource. (pattern: <code>vpc-[a-zA-Z0-9]{8,32}</code>)
remote_identifier	string	The identifier of a remote resource. For a VPC or subnet, this identifier is the VPC Amazon Resource Name (ARN) or subnet ARN. For an Availability Zone, this identifier is the AZ name, for example, us-west-2b. For an Amazon Web Services Region , this identifier is the Region name, for example, us-west-2.
value	integer (int64)	The value for a metric.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_query_results_workload_insights_top_contributors	select	scope_id, query_id, region	nextToken, maxResults	Return the data for a query with the Network Flow Monitor query interface. You 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 a scope for workload insights. Workload insights provide a high level view of network flow performance data collected by agents. To return the data for the top contributors, see GetQueryResultsWorkloadInsightsTopContributorsData. Create a query ID for this call by calling the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributors. Use the scope ID that was returned for your account by CreateScope. 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 create 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.
maxResults	integer	The number of query results that you want to return with this call.
nextToken	string	The token for the next set of results. You receive this token from a previous call.

SELECT examples

get_query_results_workload_insights_top_contributors

Return the data for a query with the Network Flow Monitor query interface. You 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 a scope for workload insights. Workload insights provide a high level view of network flow performance data collected by agents. To return the data for the top contributors, see GetQueryResultsWorkloadInsightsTopContributorsData. Create a query ID for this call by calling the corresponding API call to start the query, StartQueryWorkloadInsightsTopContributors. Use the scope ID that was returned for your account by CreateScope. 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
account_id,
local_az,
local_region,
local_subnet_arn,
local_subnet_id,
local_vpc_arn,
local_vpc_id,
remote_identifier,
value
FROM aws.networkflowmonitor.query_results_workload_insights_top_contributors
WHERE scope_id = '{{ scope_id }}' -- required
AND query_id = '{{ query_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;