Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetMonitor

Gets information about a monitor in 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.

Request Syntax


GET /v20210603/Monitors/MonitorName?LinkedAccountId=LinkedAccountId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

LinkedAccountId

The account ID for an account that you've set up cross-account sharing for in 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 Internet Monitor User Guide.

Length Constraints: Fixed length of 12.

MonitorName

The name of the monitor.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CreatedAt": "string",
   "HealthEventsConfig": { 
      "AvailabilityLocalHealthEventsConfig": { 
         "HealthScoreThreshold": number,
         "MinTrafficImpact": number,
         "Status": "string"
      },
      "AvailabilityScoreThreshold": number,
      "PerformanceLocalHealthEventsConfig": { 
         "HealthScoreThreshold": number,
         "MinTrafficImpact": number,
         "Status": "string"
      },
      "PerformanceScoreThreshold": number
   },
   "InternetMeasurementsLogDelivery": { 
      "S3Config": { 
         "BucketName": "string",
         "BucketPrefix": "string",
         "LogDeliveryStatus": "string"
      }
   },
   "MaxCityNetworksToMonitor": number,
   "ModifiedAt": "string",
   "MonitorArn": "string",
   "MonitorName": "string",
   "ProcessingStatus": "string",
   "ProcessingStatusInfo": "string",
   "Resources": [ "string" ],
   "Status": "string",
   "Tags": { 
      "string" : "string" 
   },
   "TrafficPercentageToMonitor": number
}

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.

CreatedAt

The time when the monitor was created.

Type: Timestamp

HealthEventsConfig

The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.

For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

Type: HealthEventsConfig object

InternetMeasurementsLogDelivery

Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.

Type: InternetMeasurementsLogDelivery object

MaxCityNetworksToMonitor

The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. This limit can help control billing costs.

To learn more, see Choosing a city-network maximum value in the Internet Monitor section of the CloudWatch User Guide.

Type: Integer

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

ModifiedAt

The last time that the monitor was modified.

Type: Timestamp

MonitorArn

The Amazon Resource Name (ARN) of the monitor.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 512.

Pattern: arn:.*

MonitorName

The name of the monitor.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9_.-]+

ProcessingStatus

The health of the data processing for the monitor.

Type: String

ProcessingStatusInfo

Additional information about the health of the data processing for the monitor.

Type: String

Resources

The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).

Type: Array of strings

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:.*

Status

The status of the monitor.

Type: String

Valid Values: PENDING | ACTIVE | INACTIVE | ERROR

Tags

The tags that have been added to monitor.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

TrafficPercentageToMonitor

The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.

To learn more, see Choosing an application traffic percentage to monitor in the Internet Monitor section of the CloudWatch User Guide.

Type: Integer

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

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