CloudWatchInternetMonitor / Client / create_monitor

create_monitor

CloudWatchInternetMonitor.Client.create_monitor(**kwargs)

Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: Amazon Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services that are specific to the city-networks, that is, the locations and ASNs (typically internet service providers or ISPs), where clients access your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.

When you create a monitor, you set a maximum limit for the number of city-networks where client traffic is monitored. The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. You can change the maximum at any time by updating your monitor. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_monitor(
    MonitorName='string',
    Resources=[
        'string',
    ],
    ClientToken='string',
    Tags={
        'string': 'string'
    },
    MaxCityNetworksToMonitor=123,
    InternetMeasurementsLogDelivery={
        'S3Config': {
            'BucketName': 'string',
            'BucketPrefix': 'string',
            'LogDeliveryStatus': 'ENABLED'|'DISABLED'
        }
    },
    TrafficPercentageToMonitor=123,
    HealthEventsConfig={
        'AvailabilityScoreThreshold': 123.0,
        'PerformanceScoreThreshold': 123.0
    }
)

Parameters:

• MonitorName (string) –

  [REQUIRED]

  The name of the monitor.

• Resources (list) –

  The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).

  You can add a combination of Amazon Virtual Private Clouds (VPCs) and Amazon CloudFront distributions, or you can add Amazon WorkSpaces directories. You can’t add all three types of resources.

  Note

  If you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

  • (string) –

• ClientToken (string) –

  A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don’t reuse the same client token for other API requests.

  This field is autopopulated if not provided.

• Tags (dict) –

  The tags for a monitor. You can add a maximum of 50 tags in Internet 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 network or ASN, such as an internet service provider (ISP), that clients access the resources through. This limit helps 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 an Amazon S3 bucket in addition to 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 that you want to monitor with this monitor.

• HealthEventsConfig (dict) –

  Defines the health event threshold percentages, for performance score and availability score. Internet Monitor creates a health event when there’s an internet issue that affects your application end users where a health score percentage is at or below a set threshold. If you don’t set a health event threshold, the default calue is 95%.

  • AvailabilityScoreThreshold (float) –

    The health event threshold percentage set for availability scores.

  • PerformanceScoreThreshold (float) –

    The health event threshold percentage set for performance scores.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Status': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'
}

Response Structure

• (dict) –

  • Arn (string) –

    The Amazon Resource Name (ARN) of the monitor.

  • Status (string) –

    The status of a monitor.

Exceptions

• CloudWatchInternetMonitor.Client.exceptions.InternalServerException

• CloudWatchInternetMonitor.Client.exceptions.AccessDeniedException

• CloudWatchInternetMonitor.Client.exceptions.ThrottlingException

• CloudWatchInternetMonitor.Client.exceptions.ConflictException

• CloudWatchInternetMonitor.Client.exceptions.LimitExceededException

• CloudWatchInternetMonitor.Client.exceptions.ValidationException