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: Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and WorkSpaces directories.

After you create a monitor, you can view the internet performance for your application, scoped to a location, as well as any health events that are impairing traffic. Internet Monitor can also diagnose whether the impairment is on the Amazon Web Services network or is an issue with an internet service provider (ISP).

See also: AWS API Documentation

Request Syntax

response = client.create_monitor(
    MonitorName='string',
    Resources=[
        'string',
    ],
    ClientToken='string',
    Tags={
        'string': 'string'
    },
    MaxCityNetworksToMonitor=123
)

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) –

  [REQUIRED]

  The maximum number of city-network combinations (that is, combinations of a city location and network, such as an ISP) to be monitored for your resources.

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