Skip to content

aws.networkmonitor.get_monitor

Example SQL Queries

SELECT * FROM
aws.networkmonitor.get_monitor
WHERE
"monitor_name" = 'VALUE';

Description

Returns details about a specific monitor.

This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names.

Table Definition

Column NameColumn Data Type
monitor_name Required Input Column

The name of the monitor.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

aggregation_period

The aggregation period for the specified monitor.

BIGINT
created_at

The time and date when the monitor was created.

TIMESTAMP_S
modified_at

The time and date when the monitor was last modified.

TIMESTAMP_S
monitor_arn

The ARN of the selected monitor.

VARCHAR
probes

The details about each probe associated with that monitor.

STRUCT(
"probe_id" VARCHAR,
"probe_arn" VARCHAR,
"source_arn" VARCHAR,
"destination" VARCHAR,
"destination_port" BIGINT,
"protocol" VARCHAR,
"packet_size" BIGINT,
"address_family" VARCHAR,
"vpc_id" VARCHAR,
"state" VARCHAR,
"created_at" TIMESTAMP_S,
"modified_at" TIMESTAMP_S,
"tags" MAP(VARCHAR, VARCHAR)
)[]
Show child fields
probes[]
Show child fields
probes[].address_family

The IPv4 or IPv6 address for the probe.

probes[].created_at

The time and date the probe was created.

probes[].destination

The destination for the probe. This should be either an IPV4 or IPV6.

probes[].destination_port

The destination port for the probe. This is required only if the protocol is TCP and must be a number between 1 and 65536.

probes[].modified_at

The time and date that the probe was last modified.

probes[].packet_size

The size of the packets traveling between the source and destination. This must be a number between 56 and

probes[].probe_arn

The ARN of the probe.

probes[].probe_id

The ID of the probe.

probes[].protocol

The network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.

probes[].source_arn

The ARN of the probe source subnet.

probes[].state

The state of the probe.

probes[].tags

The list of key-value pairs created and assigned to the probe.

probes[].vpc_id

The ID of the source VPC subnet.

state

Lists the status of the state of each monitor.

VARCHAR
tags

The list of key-value pairs assigned to the monitor.

MAP(VARCHAR, VARCHAR)