CloudWatchNetworkMonitor / Client / create_probe

create_probe#

CloudWatchNetworkMonitor.Client.create_probe(**kwargs)#

Create a probe within a monitor. Once you create a probe, and it begins monitoring your network traffic, you’ll incur billing charges for that probe. This action requires the monitorName parameter. Run ListMonitors to get a list of monitor names. Note the name of the monitorName you want to create the probe for.

See also: AWS API Documentation

Request Syntax

response = client.create_probe(
    monitorName='string',
    probe={
        'sourceArn': 'string',
        'destination': 'string',
        'destinationPort': 123,
        'protocol': 'TCP'|'ICMP',
        'packetSize': 123,
        'tags': {
            'string': 'string'
        }
    },
    clientToken='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • monitorName (string) –

    [REQUIRED]

    The name of the monitor to associated with the probe.

  • probe (dict) –

    [REQUIRED]

    Describes the details of an individual probe for a monitor.

    • sourceArn (string) – [REQUIRED]

      The ARN of the subnet.

    • destination (string) – [REQUIRED]

      The destination IP address. This must be either IPV4 or IPV6.

    • destinationPort (integer) –

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

    • protocol (string) – [REQUIRED]

      The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.

    • packetSize (integer) –

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

    • tags (dict) –

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

      • (string) –

        • (string) –

  • clientToken (string) –

    Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

    This field is autopopulated if not provided.

  • tags (dict) –

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

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    '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'
    }
}

Response Structure

  • (dict) –

    • probeId (string) –

      The ID of the probe for which details are returned.

    • probeArn (string) –

      The ARN of the probe.

    • sourceArn (string) –

      The ARN of the probe.

    • destination (string) –

      The destination IP address for the monitor. This must be either an IPv4 or IPv6 address.

    • destinationPort (integer) –

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

    • protocol (string) –

      The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.

    • packetSize (integer) –

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

    • addressFamily (string) –

      Indicates whether the IP address is IPV4 or IPV6.

    • vpcId (string) –

      The ID of the source VPC or subnet.

    • state (string) –

      The state of the probe.

    • createdAt (datetime) –

      The time and date that the probe was created.

    • modifiedAt (datetime) –

      The time and date when the probe was last modified.

    • tags (dict) –

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

      • (string) –

        • (string) –

Exceptions