Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1416106112.8 KB

Gets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, and all the information related to the event, by location.

The information returned includes the impact on performance, availability, and round-trip time, information about the network providers (ASNs), the event type, and so on.

Information rolled up at the global traffic level is also returned, including the impact type and total traffic impact.

get/v20210603/Monitors/{MonitorName}/HealthEvents/{EventId}

Path parameters

MonitorNamestring required

The name of the monitor.

EventIdstring required

The internally-generated identifier of a health event. Because <code>EventID</code> contains the forward slash (“/”) character, you must URL-encode the <code>EventID</code> field in the request URL.

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

EventArnstring required

The Amazon Resource Name (ARN) of the event.

EventIdstring required

The internally-generated identifier of a health event.

StartedAtstring date-time required

The time when a health event started.

EndedAtstring date-time

The time when a health event was resolved. If the health event is still active, the end time is not set.

CreatedAtstring date-time

The time when a health event was created.

LastUpdatedAtstring date-time required

The time when a health event was last updated or recalculated.

Status'ACTIVE' | 'RESOLVED' required

The status of a health event.

PercentOfTotalTrafficImpactednumber double

The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network.

ImpactType'AVAILABILITY' | 'PERFORMANCE' | 'LOCAL_AVAILABILITY' | 'LOCAL_PERFORMANCE' required

The type of impairment of a specific health event.

HealthScoreThresholdnumber double

The threshold percentage for a health score that 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.