AWS API Changes

2024/04/19 - Amazon CloudWatch Internet Monitor - 2 new api methods

Changes This update introduces the GetInternetEvent and ListInternetEvents APIs, which provide access to internet events displayed on the Amazon CloudWatch Internet Weather Map.

ListInternetEvents (new)

Link ¶

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 Amazon Web Services 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).

See also: AWS API Documentation

Request Syntax

client.list_internet_events(
    NextToken='string',
    MaxResults=123,
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    EventStatus='string',
    EventType='string'
)

type NextToken:

string

param NextToken:

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

type MaxResults:

integer

param MaxResults:

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

type StartTime:

datetime

param StartTime:

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

type EndTime:

datetime

param EndTime:

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

type EventStatus:

string

param EventStatus:

The status of an internet event.

type EventType:

string

param EventType:

The type of network impairment.

rtype:

dict

returns:

Response Syntax

{
    'InternetEvents': [
        {
            'EventId': 'string',
            'EventArn': 'string',
            'StartedAt': datetime(2015, 1, 1),
            'EndedAt': datetime(2015, 1, 1),
            'ClientLocation': {
                'ASName': 'string',
                'ASNumber': 123,
                'Country': 'string',
                'Subdivision': 'string',
                'Metro': 'string',
                'City': 'string',
                'Latitude': 123.0,
                'Longitude': 123.0
            },
            'EventType': 'AVAILABILITY'|'PERFORMANCE',
            'EventStatus': 'ACTIVE'|'RESOLVED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- InternetEvents (list) --
  
  A set of internet events returned for the list operation.
  - (dict) --
    
    A summary of information about an internet event in Amazon CloudWatch Internet Monitor. Internet events are issues that cause performance degradation or availability problems for impacted Amazon Web Services client locations. Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.
    - EventId (string) --
      
      The internally-generated identifier of an internet event.
    - EventArn (string) --
      
      The Amazon Resource Name (ARN) of the internet event.
    - StartedAt (datetime) --
      
      The time when an internet event started.
    - EndedAt (datetime) --
      
      The time when an internet event ended. If the event hasn't ended yet, this value is empty.
    - ClientLocation (dict) --
      
      The impacted location, such as a city, that Amazon Web Services clients access application resources from.
      - ASName (string) --
        
        The name of the internet service provider (ISP) or network (ASN).
      - ASNumber (integer) --
        
        The Autonomous System Number (ASN) of the network at an impacted location.
      - Country (string) --
        
        The name of the country where the internet event is located.
      - Subdivision (string) --
        
        The subdivision location where the health event is located. The subdivision usually maps to states in most countries (including the United States). For United Kingdom, it maps to a country (England, Scotland, Wales) or province (Northern Ireland).
      - Metro (string) --
        
        The metro area where the health event is located.
        
        Metro indicates a metropolitan region in the United States, such as the region around New York City. In non-US countries, this is a second-level subdivision. For example, in the United Kingdom, it could be a county, a London borough, a unitary authority, council area, and so on.
      - City (string) --
        
        The name of the city where the internet event is located.
      - Latitude (float) --
        
        The latitude where the internet event is located.
      - Longitude (float) --
        
        The longitude where the internet event is located.
    - EventType (string) --
      
      The type of network impairment.
    - EventStatus (string) --
      
      The status of an internet event.
- NextToken (string) --
  
  The token for the next set of results. You receive this token from a previous call.

GetInternetEvent (new)

Link ¶

Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event. Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.

The information returned here includes the impacted location, when the event started and (if the event is over) ended, the type of event ( PERFORMANCE or AVAILABILITY), and the status ( ACTIVE or RESOLVED).

See also: AWS API Documentation

Request Syntax

client.get_internet_event(
    EventId='string'
)

type EventId:

string

param EventId:

[REQUIRED]

The EventId of the internet event to return information for.

rtype:

dict

returns:

Response Syntax

{
    'EventId': 'string',
    'EventArn': 'string',
    'StartedAt': datetime(2015, 1, 1),
    'EndedAt': datetime(2015, 1, 1),
    'ClientLocation': {
        'ASName': 'string',
        'ASNumber': 123,
        'Country': 'string',
        'Subdivision': 'string',
        'Metro': 'string',
        'City': 'string',
        'Latitude': 123.0,
        'Longitude': 123.0
    },
    'EventType': 'AVAILABILITY'|'PERFORMANCE',
    'EventStatus': 'ACTIVE'|'RESOLVED'
}

Response Structure

(dict) --
- EventId (string) --
  
  The internally-generated identifier of an internet event.
- EventArn (string) --
  
  The Amazon Resource Name (ARN) of the internet event.
- StartedAt (datetime) --
  
  The time when the internet event started.
- EndedAt (datetime) --
  
  The time when the internet event ended. If the event hasn't ended yet, this value is empty.
- ClientLocation (dict) --
  
  The impacted location, such as a city, where clients access Amazon Web Services application resources.
  - ASName (string) --
    
    The name of the internet service provider (ISP) or network (ASN).
  - ASNumber (integer) --
    
    The Autonomous System Number (ASN) of the network at an impacted location.
  - Country (string) --
    
    The name of the country where the internet event is located.
  - Subdivision (string) --
    
    The subdivision location where the health event is located. The subdivision usually maps to states in most countries (including the United States). For United Kingdom, it maps to a country (England, Scotland, Wales) or province (Northern Ireland).
  - Metro (string) --
    
    The metro area where the health event is located.
    
    Metro indicates a metropolitan region in the United States, such as the region around New York City. In non-US countries, this is a second-level subdivision. For example, in the United Kingdom, it could be a county, a London borough, a unitary authority, council area, and so on.
  - City (string) --
    
    The name of the city where the internet event is located.
  - Latitude (float) --
    
    The latitude where the internet event is located.
  - Longitude (float) --
    
    The longitude where the internet event is located.
- EventType (string) --
  
  The type of network impairment.
- EventStatus (string) --
  
  The status of the internet event.