Skip to content

aws.internetmonitor.get_monitor

Example SQL Queries

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

Description

Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.

Table Definition

Column NameColumn Data Type
monitor_name Required Input Column

The name of the monitor.

VARCHAR
linked_account_id Input Column

The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.

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.

_aws_region Input Column

The AWS region to use.

VARCHAR
created_at

The time when the monitor was created.

TIMESTAMP_S
health_events_config

The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.

For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

STRUCT(
"availability_score_threshold" DOUBLE,
"performance_score_threshold" DOUBLE,
"availability_local_health_events_config" STRUCT(
"status" VARCHAR,
"health_score_threshold" DOUBLE,
"min_traffic_impact" DOUBLE
),
"performance_local_health_events_config" STRUCT(
"status" VARCHAR,
"health_score_threshold" DOUBLE,
"min_traffic_impact" DOUBLE
)
)
Show child fields
health_events_config.availability_local_health_events_config

The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.

Show child fields
health_events_config.availability_local_health_events_config.health_score_threshold

The health event threshold percentage set for a local health score.

health_events_config.availability_local_health_events_config.min_traffic_impact

The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

If you don't set a minimum traffic impact threshold, the default value is 0.1%.

health_events_config.availability_local_health_events_config.status

The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED.

health_events_config.availability_score_threshold

The health event threshold percentage set for availability scores.

health_events_config.performance_local_health_events_config

The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.

Show child fields
health_events_config.performance_local_health_events_config.health_score_threshold

The health event threshold percentage set for a local health score.

health_events_config.performance_local_health_events_config.min_traffic_impact

The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

If you don't set a minimum traffic impact threshold, the default value is 0.1%.

health_events_config.performance_local_health_events_config.status

The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED.

health_events_config.performance_score_threshold

The health event threshold percentage set for performance scores.

internet_measurements_log_delivery

Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.

STRUCT(
"s3_config" STRUCT(
"bucket_name" VARCHAR,
"bucket_prefix" VARCHAR,
"log_delivery_status" VARCHAR
)
)
Show child fields
internet_measurements_log_delivery.s3_config

The configuration information for publishing Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is ENABLED or DISABLED, depending on whether you choose to deliver internet measurements to S3 logs.

Show child fields
internet_measurements_log_delivery.s3_config.bucket_name

The Amazon S3 bucket name.

internet_measurements_log_delivery.s3_config.bucket_prefix

The Amazon S3 bucket prefix.

internet_measurements_log_delivery.s3_config.log_delivery_status

The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.

max_city_networks_to_monitor

The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. This limit can help control billing costs.

To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

BIGINT
modified_at

The last time that the monitor was modified.

TIMESTAMP_S
monitor_arn

The Amazon Resource Name (ARN) of the monitor.

VARCHAR
processing_status

The health of the data processing for the monitor.

VARCHAR
processing_status_info

Additional information about the health of the data processing for the monitor.

VARCHAR
resources

The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).

VARCHAR[]
Show child fields
resources[]
status

The status of the monitor.

VARCHAR
tags

The tags that have been added to monitor.

MAP(VARCHAR, VARCHAR)
traffic_percentage_to_monitor

The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.

To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

BIGINT