CloudWatchInternetMonitor / Client / get_monitor

get_monitor#

CloudWatchInternetMonitor.Client.get_monitor(**kwargs)#

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.

Request Syntax

response = client.get_monitor(
    MonitorName='string',
    LinkedAccountId='string'
)

Parameters:

MonitorName (string) –
[REQUIRED]

The name of the monitor.
LinkedAccountId (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'MonitorName': 'string',
    'MonitorArn': 'string',
    'Resources': [
        'string',
    ],
    'Status': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR',
    'CreatedAt': datetime(2015, 1, 1),
    'ModifiedAt': datetime(2015, 1, 1),
    'ProcessingStatus': 'OK'|'INACTIVE'|'COLLECTING_DATA'|'INSUFFICIENT_DATA'|'FAULT_SERVICE'|'FAULT_ACCESS_CLOUDWATCH',
    'ProcessingStatusInfo': 'string',
    'Tags': {
        'string': 'string'
    },
    'MaxCityNetworksToMonitor': 123,
    'InternetMeasurementsLogDelivery': {
        'S3Config': {
            'BucketName': 'string',
            'BucketPrefix': 'string',
            'LogDeliveryStatus': 'ENABLED'|'DISABLED'
        }
    },
    'TrafficPercentageToMonitor': 123,
    'HealthEventsConfig': {
        'AvailabilityScoreThreshold': 123.0,
        'PerformanceScoreThreshold': 123.0,
        'AvailabilityLocalHealthEventsConfig': {
            'Status': 'ENABLED'|'DISABLED',
            'HealthScoreThreshold': 123.0,
            'MinTrafficImpact': 123.0
        },
        'PerformanceLocalHealthEventsConfig': {
            'Status': 'ENABLED'|'DISABLED',
            'HealthScoreThreshold': 123.0,
            'MinTrafficImpact': 123.0
        }
    }
}

Response Structure

(dict) –
- MonitorName (string) –
  
  The name of the monitor.
- MonitorArn (string) –
  
  The Amazon Resource Name (ARN) of the monitor.
- Resources (list) –
  
  The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).
  - (string) –
- Status (string) –
  
  The status of the monitor.
- CreatedAt (datetime) –
  
  The time when the monitor was created.
- ModifiedAt (datetime) –
  
  The last time that the monitor was modified.
- ProcessingStatus (string) –
  
  The health of the data processing for the monitor.
- ProcessingStatusInfo (string) –
  
  Additional information about the health of the data processing for the monitor.
- Tags (dict) –
  
  The tags that have been added to monitor.
  - (string) –
    - (string) –
- MaxCityNetworksToMonitor (integer) –
  
  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 Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
- InternetMeasurementsLogDelivery (dict) –
  
  Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.
  - S3Config (dict) –
    
    The configuration information for publishing Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is ENABLED or DISABLED, depending on whether you choose to deliver internet measurements to S3 logs.
    - BucketName (string) –
      
      The Amazon S3 bucket name.
    - BucketPrefix (string) –
      
      The Amazon S3 bucket prefix.
    - LogDeliveryStatus (string) –
      
      The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.
- TrafficPercentageToMonitor (integer) –
  
  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 Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
- HealthEventsConfig (dict) –
  
  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.
  - AvailabilityScoreThreshold (float) –
    
    The health event threshold percentage set for availability scores.
  - PerformanceScoreThreshold (float) –
    
    The health event threshold percentage set for performance scores.
  - AvailabilityLocalHealthEventsConfig (dict) –
    
    The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.
    - Status (string) –
      
      The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED.
    - HealthScoreThreshold (float) –
      
      The health event threshold percentage set for a local health score.
    - MinTrafficImpact (float) –
      
      The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.
      
      If you don’t set a minimum traffic impact threshold, the default value is 0.1%.
  - PerformanceLocalHealthEventsConfig (dict) –
    
    The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.
    - Status (string) –
      
      The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED.
    - HealthScoreThreshold (float) –
      
      The health event threshold percentage set for a local health score.
    - MinTrafficImpact (float) –
      
      The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.
      
      If you don’t set a minimum traffic impact threshold, the default value is 0.1%.

Exceptions

CloudWatchInternetMonitor.Client.exceptions.InternalServerException
CloudWatchInternetMonitor.Client.exceptions.AccessDeniedException
CloudWatchInternetMonitor.Client.exceptions.ThrottlingException
CloudWatchInternetMonitor.Client.exceptions.ValidationException