Get Monitor

cloudwatchinternetmonitor_get_monitor

R Documentation

Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name¶

Description¶

Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.

Usage¶

cloudwatchinternetmonitor_get_monitor(MonitorName, LinkedAccountId)

Arguments¶

MonitorName: [required] The name of the monitor.
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(
  MonitorName = "string",
  MonitorArn = "string",
  Resources = list(
    "string"
  ),
  Status = "PENDING"|"ACTIVE"|"INACTIVE"|"ERROR",
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  ModifiedAt = as.POSIXct(
    "2015-01-01"
  ),
  ProcessingStatus = "OK"|"INACTIVE"|"COLLECTING_DATA"|"INSUFFICIENT_DATA"|"FAULT_SERVICE"|"FAULT_ACCESS_CLOUDWATCH",
  ProcessingStatusInfo = "string",
  Tags = list(
    "string"
  ),
  MaxCityNetworksToMonitor = 123,
  InternetMeasurementsLogDelivery = list(
    S3Config = list(
      BucketName = "string",
      BucketPrefix = "string",
      LogDeliveryStatus = "ENABLED"|"DISABLED"
    )
  ),
  TrafficPercentageToMonitor = 123,
  HealthEventsConfig = list(
    AvailabilityScoreThreshold = 123.0,
    PerformanceScoreThreshold = 123.0,
    AvailabilityLocalHealthEventsConfig = list(
      Status = "ENABLED"|"DISABLED",
      HealthScoreThreshold = 123.0,
      MinTrafficImpact = 123.0
    ),
    PerformanceLocalHealthEventsConfig = list(
      Status = "ENABLED"|"DISABLED",
      HealthScoreThreshold = 123.0,
      MinTrafficImpact = 123.0
    )
  )
)

Request syntax¶

svc$get_monitor(
  MonitorName = "string",
  LinkedAccountId = "string"
)