Get v20210603monitorsmonitorname — internetmonitor

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1416106112.8 KB

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.

get/v20210603/Monitors/{MonitorName}

Path parameters

MonitorNamestring required

The name of the monitor.

Query parameters

LinkedAccountIdstring

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 <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cwim-cross-account.html">Internet Monitor cross-account observability</a> in the Amazon CloudWatch Internet Monitor User Guide.

Response

Success

MonitorNamestring required

The name of the monitor.

MonitorArnstring required

The Amazon Resource Name (ARN) of the monitor.

ResourcesArn[] required

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

Status'PENDING' | 'ACTIVE' | 'INACTIVE' | 'ERROR' required

The status of the monitor.

CreatedAtstring date-time required

The time when the monitor was created.

ModifiedAtstring date-time required

The last time that the monitor was modified.

The health of the data processing for the monitor.

ProcessingStatusInfostring

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

Tagsobject

The tags that have been added to monitor.

MaxCityNetworksToMonitorinteger

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 <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMCityNetworksMaximum.html">Choosing a city-network maximum value </a> in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

TrafficPercentageToMonitorinteger

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 <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/IMTrafficPercentage.html">Choosing an application traffic percentage to monitor </a> in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.