List Health Events

cloudwatchinternetmonitor_list_health_events

R Documentation

Lists all health events for a monitor in Amazon CloudWatch Internet Monitor

Description

Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end times, and the status.

Health events that have start times during the time frame that is requested are not included in the list of health events.

Usage

cloudwatchinternetmonitor_list_health_events(MonitorName, StartTime,
  EndTime, NextToken, MaxResults, EventStatus, LinkedAccountId)

Arguments

MonitorName

[required] The name of the monitor.

StartTime

The time when a health event started.

EndTime

The time when a health event ended. If the health event is still ongoing, then the end time is not set.

NextToken

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

MaxResults

The number of health event objects that you want to return with this call.

EventStatus

The status of a health event.

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(
  HealthEvents = list(
    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
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_health_events(
  MonitorName = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  NextToken = "string",
  MaxResults = 123,
  EventStatus = "ACTIVE"|"RESOLVED",
  LinkedAccountId = "string"
)