Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetHealthEvent

Gets information that 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.

Request Syntax


GET /v20210603/Monitors/MonitorName/HealthEvents/EventId?LinkedAccountId=LinkedAccountId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

EventId

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

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9/_.-]+

Required: Yes

LinkedAccountId

The account ID for an account that you've set up cross-account sharing for in 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 Internet Monitor User Guide.

Length Constraints: Fixed length of 12.

MonitorName

The name of the monitor.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": "string",
   "EndedAt": "string",
   "EventArn": "string",
   "EventId": "string",
   "HealthScoreThreshold": number,
   "ImpactedLocations": [ 
      { 
         "ASName": "string",
         "ASNumber": number,
         "CausedBy": { 
            "AsPath": [ 
               { 
                  "ASName": "string",
                  "ASNumber": number
               }
            ],
            "NetworkEventType": "string",
            "Networks": [ 
               { 
                  "ASName": "string",
                  "ASNumber": number
               }
            ]
         },
         "City": "string",
         "Country": "string",
         "CountryCode": "string",
         "InternetHealth": { 
            "Availability": { 
               "ExperienceScore": number,
               "PercentOfClientLocationImpacted": number,
               "PercentOfTotalTrafficImpacted": number
            },
            "Performance": { 
               "ExperienceScore": number,
               "PercentOfClientLocationImpacted": number,
               "PercentOfTotalTrafficImpacted": number,
               "RoundTripTime": { 
                  "P50": number,
                  "P90": number,
                  "P95": number
               }
            }
         },
         "Ipv4Prefixes": [ "string" ],
         "Latitude": number,
         "Longitude": number,
         "Metro": "string",
         "ServiceLocation": "string",
         "Status": "string",
         "Subdivision": "string",
         "SubdivisionCode": "string"
      }
   ],
   "ImpactType": "string",
   "LastUpdatedAt": "string",
   "PercentOfTotalTrafficImpacted": number,
   "StartedAt": "string",
   "Status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreatedAt

The time when a health event was created.

Type: Timestamp

EndedAt

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

Type: Timestamp

EventArn

The Amazon Resource Name (ARN) of the event.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:.*

EventId

The internally-generated identifier of a health event.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9/_.-]+

HealthScoreThreshold

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.

Type: Double

Valid Range: Minimum value of 0. Maximum value of 100.

ImpactedLocations

The locations affected by a health event.

Type: Array of ImpactedLocation objects

ImpactType

The type of impairment of a specific health event.

Type: String

Valid Values: AVAILABILITY | PERFORMANCE | LOCAL_AVAILABILITY | LOCAL_PERFORMANCE

LastUpdatedAt

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

Type: Timestamp

PercentOfTotalTrafficImpacted

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 AWS location using this client network.

Type: Double

StartedAt

The time when a health event started.

Type: Timestamp

Status

The status of a health event.

Type: String

Valid Values: ACTIVE | RESOLVED

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permission to perform this action.

HTTP Status Code: 403

InternalServerException

An internal error occurred.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

Invalid request.

HTTP Status Code: 400