query_results_monitor_top_contributors

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

Overview

Name	query_results_monitor_top_contributors
Type	Resource
Id	aws.networkflowmonitor.query_results_monitor_top_contributors

Fields

The following fields are returned by SELECT queries:

get_query_results_monitor_top_contributors

Name	Datatype	Description
destination_category	string	The destination category for a top contributors row. Destination categories can be one of the following: INTRA_AZ: Top contributor network flows within a single Availability Zone INTER_AZ: Top contributor network flows between Availability Zones INTER_REGION: Top contributor network flows between Regions (to the edge of another Region) INTER_VPC: Top contributor network flows between VPCs AWS_SERVICES: Top contributor network flows to or from Amazon Web Services services UNCLASSIFIED: Top contributor network flows that do not have a bucket classification (INTRA_AZ, INTER_AZ, INTER_VPC, UNCLASSIFIED, AMAZON_S3, AMAZON_DYNAMODB, INTER_REGION)
dnat_ip	string	The destination network address translation (DNAT) IP address for a top contributor network flow.
kubernetes_metadata	object	Meta data about Kubernetes resources.
local_az	string	The Availability Zone for the local resource for a top contributor network flow.
local_instance_arn	string	The Amazon Resource Name (ARN) of a local resource.
local_instance_id	string	The instance identifier for the local resource for a top contributor network flow. (pattern: <code>i-[a-zA-Z0-9]{8,32}</code>)
local_ip	string	The IP address of the local resource for a top contributor network flow.
local_region	string	The Amazon Web Services Region for the local resource for a top contributor network flow.
local_subnet_arn	string	The Amazon Resource Name (ARN) of a local subnet.
local_subnet_id	string	The subnet ID for the local resource for a top contributor network flow. (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 VPC ID for a top contributor network flow for the local resource. (pattern: <code>vpc-[a-zA-Z0-9]{8,32}</code>)
remote_az	string	The Availability Zone for the remote resource for a top contributor network flow.
remote_instance_arn	string	The Amazon Resource Name (ARN) of a remote resource.
remote_instance_id	string	The instance identifier for the remote resource for a top contributor network flow. (pattern: <code>i-[a-zA-Z0-9]{8,32}</code>)
remote_ip	string	The IP address of the remote resource for a top contributor network flow.
remote_region	string	The Amazon Web Services Region for the remote resource for a top contributor network flow.
remote_subnet_arn	string	The Amazon Resource Name (ARN) of a remote subnet.
remote_subnet_id	string	The subnet ID for the remote resource for a top contributor network flow. (pattern: <code>subnet-[a-zA-Z0-9]{8,32}</code>)
remote_vpc_arn	string	The Amazon Resource Name (ARN) of a remote VPC.
remote_vpc_id	string	The VPC ID for a top contributor network flow for the remote resource. (pattern: <code>vpc-[a-zA-Z0-9]{8,32}</code>)
snat_ip	string	The secure network address translation (SNAT) IP address for a top contributor network flow.
target_port	integer	The target port.
traversed_constructs	array	The constructs traversed by a network flow.
value	integer (int64)	The value of the metric for a top contributor network flow.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_query_results_monitor_top_contributors	select	monitor_name, 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 specific monitor. Create a query ID for this call by calling the corresponding API call to start the query, StartQueryMonitorTopContributors. 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
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 create a query.
region	string	AWS region (default: us-east-1)
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_monitor_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 specific monitor. Create a query ID for this call by calling the corresponding API call to start the query, StartQueryMonitorTopContributors. 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
destination_category,
dnat_ip,
kubernetes_metadata,
local_az,
local_instance_arn,
local_instance_id,
local_ip,
local_region,
local_subnet_arn,
local_subnet_id,
local_vpc_arn,
local_vpc_id,
remote_az,
remote_instance_arn,
remote_instance_id,
remote_ip,
remote_region,
remote_subnet_arn,
remote_subnet_id,
remote_vpc_arn,
remote_vpc_id,
snat_ip,
target_port,
traversed_constructs,
value
FROM aws.networkflowmonitor.query_results_monitor_top_contributors
WHERE monitor_name = '{{ monitor_name }}' -- required
AND query_id = '{{ query_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;