Skip to content
AWS for Query.Farm

aws.networkmonitor.get_probe

Example SQL Queries

SELECT * FROM
aws.networkmonitor.get_probe
WHERE
"monitor_name" = 'VALUE'
AND "probe_id" = 'VALUE';

Description

Returns the details about a probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.

Table Definition

Column NameColumn Data Type
monitor_name Required Input Column

The name of the monitor associated with the probe. Run ListMonitors to get a list of monitor names.

VARCHAR
probe_id Required Input Column

The ID of the probe for which details are returned.

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.

address_family

Indicates whether the IP address is IPV4 or IPV6.

VARCHAR
created_at

The time and date that the probe was created.

TIMESTAMP_S
destination

The destination IP address for the monitor. This must be either an IPv4 or IPv6 address.

VARCHAR
destination_port

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

BIGINT
modified_at

The time and date that the probe was last modified.

TIMESTAMP_S
packet_size

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

BIGINT
probe_arn

The ARN of the probe.

VARCHAR
protocol

The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.

VARCHAR
source_arn

The ARN of the probe.

VARCHAR
state

The state of the probe.

VARCHAR
tags

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

MAP(VARCHAR, VARCHAR)
vpc_id

The ID of the source VPC or subnet.

VARCHAR