ListInternetEvents - Amazon CloudWatch Internet Monitor

ListInternetEvents

Lists internet events that cause performance or availability issues for client locations. Amazon CloudWatch Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all AWS customers.

You can constrain the list of internet events returned by providing a start time and end time to define a total time frame for events you want to list. Both start time and end time specify the time when an event started. End time is optional. If you don't include it, the default end time is the current time.

You can also limit the events returned to a specific status (ACTIVE or RESOLVED) or type (PERFORMANCE or AVAILABILITY).

Request Syntax

GET /v20210603/InternetEvents?EndTime=EndTime&EventStatus=EventStatus&EventType=EventType&InternetEventMaxResults=MaxResults&NextToken=NextToken&StartTime=StartTime HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

EndTime

The end time of the time window that you want to get a list of internet events for.

EventStatus

The status of an internet event.

EventType

The type of network impairment.

MaxResults

The number of query results that you want to return with this call.

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

NextToken

The token for the next set of results. You receive this token from a previous call.

StartTime

The start time of the time window that you want to get a list of internet events for.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "InternetEvents": [ { "ClientLocation": { "ASName": "string", "ASNumber": number, "City": "string", "Country": "string", "Latitude": number, "Longitude": number, "Metro": "string", "Subdivision": "string" }, "EndedAt": "string", "EventArn": "string", "EventId": "string", "EventStatus": "string", "EventType": "string", "StartedAt": "string" } ], "NextToken": "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.

InternetEvents

A set of internet events returned for the list operation.

Type: Array of InternetEventSummary objects

NextToken

The token for the next set of results. You receive this token from a previous call.

Type: String

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: