CloudWatchNetworkMonitor / Client / get_monitor

get_monitor

CloudWatchNetworkMonitor.Client.get_monitor(**kwargs)

Returns details about a specific monitor.

This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names.

See also: AWS API Documentation

Request Syntax

response = client.get_monitor(
    monitorName='string'
)

Parameters:

monitorName (string) –

[REQUIRED]

The name of the monitor that details are returned for.

Return type:

dict

Returns:

Response Syntax

{
    'monitorArn': 'string',
    'monitorName': 'string',
    'state': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'|'DELETING',
    'aggregationPeriod': 123,
    'tags': {
        'string': 'string'
    },
    'probes': [
        {
            'probeId': 'string',
            'probeArn': 'string',
            'sourceArn': 'string',
            'destination': 'string',
            'destinationPort': 123,
            'protocol': 'TCP'|'ICMP',
            'packetSize': 123,
            'addressFamily': 'IPV4'|'IPV6',
            'vpcId': 'string',
            'state': 'PENDING'|'ACTIVE'|'INACTIVE'|'ERROR'|'DELETING'|'DELETED',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1),
            'tags': {
                'string': 'string'
            }
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'modifiedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • monitorArn (string) –

    The ARN of the selected monitor.

  • monitorName (string) –

    The name of the monitor.

  • state (string) –

    Lists the status of the state of each monitor.

  • aggregationPeriod (integer) –

    The aggregation period for the specified monitor.

  • tags (dict) –

    The list of key-value pairs assigned to the monitor.

    • (string) –

      • (string) –

  • probes (list) –

    The details about each probe associated with that monitor.

    • (dict) –

      Describes information about a network monitor probe.

      • probeId (string) –

        The ID of the probe.

      • probeArn (string) –

        The ARN of the probe.

      • sourceArn (string) –

        The ARN of the probe source subnet.

      • destination (string) –

        The destination for the probe. This should be either an IPV4 or IPV6.

      • destinationPort (integer) –

        The destination port for the probe. This is required only if the protocol is TCP and must be a number between 1 and 65536.

      • protocol (string) –

        The network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.

      • packetSize (integer) –

        The size of the packets traveling between the source and destination. This must be a number between 56 and

      • addressFamily (string) –

        The IPv4 or IPv6 address for the probe.

      • vpcId (string) –

        The ID of the source VPC subnet.

      • state (string) –

        The state of the probe.

      • createdAt (datetime) –

        The time and date the probe was created.

      • modifiedAt (datetime) –

        The time and date that the probe was last modified.

      • tags (dict) –

        The list of key-value pairs created and assigned to the probe.

        • (string) –

          • (string) –

  • createdAt (datetime) –

    The time and date when the monitor was created.

  • modifiedAt (datetime) –

    The time and date when the monitor was last modified.

Exceptions

• CloudWatchNetworkMonitor.Client.exceptions.AccessDeniedException

• CloudWatchNetworkMonitor.Client.exceptions.ResourceNotFoundException

• CloudWatchNetworkMonitor.Client.exceptions.ThrottlingException

• CloudWatchNetworkMonitor.Client.exceptions.ValidationException

• CloudWatchNetworkMonitor.Client.exceptions.InternalServerException