Get Health Event

cloudwatchinternetmonitor_get_health_event

R Documentation

Gets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor

Description

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.

Usage

cloudwatchinternetmonitor_get_health_event(MonitorName, EventId,
  LinkedAccountId)

Arguments

MonitorName

[required] The name of the monitor.

EventId

[required] 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.

LinkedAccountId

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 Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.

Value

A list with the following syntax:

list(
  EventArn = "string",
  EventId = "string",
  StartedAt = as.POSIXct(
    "2015-01-01"
  ),
  EndedAt = as.POSIXct(
    "2015-01-01"
  ),
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  LastUpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  ImpactedLocations = list(
    list(
      ASName = "string",
      ASNumber = 123,
      Country = "string",
      Subdivision = "string",
      Metro = "string",
      City = "string",
      Latitude = 123.0,
      Longitude = 123.0,
      CountryCode = "string",
      SubdivisionCode = "string",
      ServiceLocation = "string",
      Status = "ACTIVE"|"RESOLVED",
      CausedBy = list(
        Networks = list(
          list(
            ASName = "string",
            ASNumber = 123
          )
        ),
        AsPath = list(
          list(
            ASName = "string",
            ASNumber = 123
          )
        ),
        NetworkEventType = "AWS"|"Internet"
      ),
      InternetHealth = list(
        Availability = list(
          ExperienceScore = 123.0,
          PercentOfTotalTrafficImpacted = 123.0,
          PercentOfClientLocationImpacted = 123.0
        ),
        Performance = list(
          ExperienceScore = 123.0,
          PercentOfTotalTrafficImpacted = 123.0,
          PercentOfClientLocationImpacted = 123.0,
          RoundTripTime = list(
            P50 = 123.0,
            P90 = 123.0,
            P95 = 123.0
          )
        )
      ),
      Ipv4Prefixes = list(
        "string"
      )
    )
  ),
  Status = "ACTIVE"|"RESOLVED",
  PercentOfTotalTrafficImpacted = 123.0,
  ImpactType = "AVAILABILITY"|"PERFORMANCE"|"LOCAL_AVAILABILITY"|"LOCAL_PERFORMANCE",
  HealthScoreThreshold = 123.0
)

Request syntax

svc$get_health_event(
  MonitorName = "string",
  EventId = "string",
  LinkedAccountId = "string"
)