CreateMonitor

$result = $client->createMonitor([/* ... */]);
$promise = $client->createMonitorAsync([/* ... */]);

Creates a monitor between a source subnet and destination IP address. Within a monitor you'll create one or more probes that monitor network traffic between your source Amazon Web Services VPC subnets and your destination IP addresses. Each probe then aggregates and sends metrics to Amazon CloudWatch.

You can also create a monitor with probes using this command. For each probe, you define the following:

• source—The subnet IDs where the probes will be created.

• destination— The target destination IP address for the probe.

• destinationPort—Required only if the protocol is TCP.

• protocol—The communication protocol between the source and destination. This will be either TCP or ICMP.

• packetSize—The size of the packets. This must be a number between 56 and 8500.

• (Optional) tags —Key-value pairs created and assigned to the probe.

Parameter Syntax

$result = $client->createMonitor([
    'aggregationPeriod' => <integer>,
    'clientToken' => '<string>',
    'monitorName' => '<string>', // REQUIRED
    'probes' => [
        [
            'destination' => '<string>', // REQUIRED
            'destinationPort' => <integer>,
            'packetSize' => <integer>,
            'probeTags' => ['<string>', ...],
            'protocol' => 'TCP|ICMP', // REQUIRED
            'sourceArn' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'aggregationPeriod' => <integer>,
    'monitorArn' => '<string>',
    'monitorName' => '<string>',
    'state' => 'PENDING|ACTIVE|INACTIVE|ERROR|DELETING',
    'tags' => ['<string>', ...],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling

ValidationException:

One of the parameters for the request is not valid.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ConflictException:

This operation attempted to create a resource that already exists.

ServiceQuotaExceededException:

This request exceeds a service quota.

CreateProbe

$result = $client->createProbe([/* ... */]);
$promise = $client->createProbeAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createProbe([
    'clientToken' => '<string>',
    'monitorName' => '<string>', // REQUIRED
    'probe' => [ // REQUIRED
        'destination' => '<string>', // REQUIRED
        'destinationPort' => <integer>,
        'packetSize' => <integer>,
        'protocol' => 'TCP|ICMP', // REQUIRED
        'sourceArn' => '<string>', // REQUIRED
        'tags' => ['<string>', ...],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'addressFamily' => 'IPV4|IPV6',
    'createdAt' => <DateTime>,
    'destination' => '<string>',
    'destinationPort' => <integer>,
    'modifiedAt' => <DateTime>,
    'packetSize' => <integer>,
    'probeArn' => '<string>',
    'probeId' => '<string>',
    'protocol' => 'TCP|ICMP',
    'sourceArn' => '<string>',
    'state' => 'PENDING|ACTIVE|INACTIVE|ERROR|DELETING|DELETED',
    'tags' => ['<string>', ...],
    'vpcId' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The request was denied due to request throttling

ValidationException:

One of the parameters for the request is not valid.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ServiceQuotaExceededException:

This request exceeds a service quota.

DeleteMonitor

$result = $client->deleteMonitor([/* ... */]);
$promise = $client->deleteMonitorAsync([/* ... */]);

Deletes a specified monitor.

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

Parameter Syntax

$result = $client->deleteMonitor([
    'monitorName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The request was denied due to request throttling

ValidationException:

One of the parameters for the request is not valid.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

DeleteProbe

$result = $client->deleteProbe([/* ... */]);
$promise = $client->deleteProbeAsync([/* ... */]);

Deletes the specified probe. Once a probe is deleted you'll no longer incur any billing fees for that probe.

This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs. You can only delete a single probe at a time using this action.

Parameter Syntax

$result = $client->deleteProbe([
    'monitorName' => '<string>', // REQUIRED
    'probeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The request was denied due to request throttling

ValidationException:

One of the parameters for the request is not valid.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ServiceQuotaExceededException:

This request exceeds a service quota.

GetMonitor

$result = $client->getMonitor([/* ... */]);
$promise = $client->getMonitorAsync([/* ... */]);

Returns details about a specific monitor.

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

Parameter Syntax

$result = $client->getMonitor([
    'monitorName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'aggregationPeriod' => <integer>,
    'createdAt' => <DateTime>,
    'modifiedAt' => <DateTime>,
    'monitorArn' => '<string>',
    'monitorName' => '<string>',
    'probes' => [
        [
            'addressFamily' => 'IPV4|IPV6',
            'createdAt' => <DateTime>,
            'destination' => '<string>',
            'destinationPort' => <integer>,
            'modifiedAt' => <DateTime>,
            'packetSize' => <integer>,
            'probeArn' => '<string>',
            'probeId' => '<string>',
            'protocol' => 'TCP|ICMP',
            'sourceArn' => '<string>',
            'state' => 'PENDING|ACTIVE|INACTIVE|ERROR|DELETING|DELETED',
            'tags' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        // ...
    ],
    'state' => 'PENDING|ACTIVE|INACTIVE|ERROR|DELETING',
    'tags' => ['<string>', ...],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The request was denied due to request throttling

ValidationException:

One of the parameters for the request is not valid.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

GetProbe

$result = $client->getProbe([/* ... */]);
$promise = $client->getProbeAsync([/* ... */]);

Returns the details about a probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.

Parameter Syntax

$result = $client->getProbe([
    'monitorName' => '<string>', // REQUIRED
    'probeId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'addressFamily' => 'IPV4|IPV6',
    'createdAt' => <DateTime>,
    'destination' => '<string>',
    'destinationPort' => <integer>,
    'modifiedAt' => <DateTime>,
    'packetSize' => <integer>,
    'probeArn' => '<string>',
    'probeId' => '<string>',
    'protocol' => 'TCP|ICMP',
    'sourceArn' => '<string>',
    'state' => 'PENDING|ACTIVE|INACTIVE|ERROR|DELETING|DELETED',
    'tags' => ['<string>', ...],
    'vpcId' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The request was denied due to request throttling

ValidationException:

One of the parameters for the request is not valid.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ListMonitors

$result = $client->listMonitors([/* ... */]);
$promise = $client->listMonitorsAsync([/* ... */]);

Returns a list of all of your monitors.

Parameter Syntax

$result = $client->listMonitors([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'state' => '<string>',
]);

Parameter Details

Result Syntax

[
    'monitors' => [
        [
            'aggregationPeriod' => <integer>,
            'monitorArn' => '<string>',
            'monitorName' => '<string>',
            'state' => 'PENDING|ACTIVE|INACTIVE|ERROR|DELETING',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ThrottlingException:

The request was denied due to request throttling

ValidationException:

One of the parameters for the request is not valid.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags assigned to this resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The request was denied due to request throttling

ValidationException:

One of the parameters for the request is not valid.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ConflictException:

This operation attempted to create a resource that already exists.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds key-value pairs to a monitor or probe.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The request was denied due to request throttling

ValidationException:

One of the parameters for the request is not valid.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ConflictException:

This operation attempted to create a resource that already exists.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a key-value pair from a monitor or probe.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The request was denied due to request throttling

ValidationException:

One of the parameters for the request is not valid.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ConflictException:

This operation attempted to create a resource that already exists.

UpdateMonitor

$result = $client->updateMonitor([/* ... */]);
$promise = $client->updateMonitorAsync([/* ... */]);

Updates the aggregationPeriod for a monitor. Monitors support an aggregationPeriod of either 30 or 60 seconds. This action requires the monitorName and probeId parameter. Run ListMonitors to get a list of monitor names.

Parameter Syntax

$result = $client->updateMonitor([
    'aggregationPeriod' => <integer>, // REQUIRED
    'monitorName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'aggregationPeriod' => <integer>,
    'monitorArn' => '<string>',
    'monitorName' => '<string>',
    'state' => 'PENDING|ACTIVE|INACTIVE|ERROR|DELETING',
    'tags' => ['<string>', ...],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The request was denied due to request throttling

ValidationException:

One of the parameters for the request is not valid.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ServiceQuotaExceededException:

This request exceeds a service quota.

UpdateProbe

$result = $client->updateProbe([/* ... */]);
$promise = $client->updateProbeAsync([/* ... */]);

Updates a monitor probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.

You can update the following para create a monitor with probes using this command. For each probe, you define the following:

• state—The state of the probe.

• destination— The target destination IP address for the probe.

• destinationPort—Required only if the protocol is TCP.

• protocol—The communication protocol between the source and destination. This will be either TCP or ICMP.

• packetSize—The size of the packets. This must be a number between 56 and 8500.

• (Optional) tags —Key-value pairs created and assigned to the probe.

Parameter Syntax

$result = $client->updateProbe([
    'destination' => '<string>',
    'destinationPort' => <integer>,
    'monitorName' => '<string>', // REQUIRED
    'packetSize' => <integer>,
    'probeId' => '<string>', // REQUIRED
    'protocol' => 'TCP|ICMP',
    'state' => 'PENDING|ACTIVE|INACTIVE|ERROR|DELETING|DELETED',
]);

Parameter Details

Result Syntax

[
    'addressFamily' => 'IPV4|IPV6',
    'createdAt' => <DateTime>,
    'destination' => '<string>',
    'destinationPort' => <integer>,
    'modifiedAt' => <DateTime>,
    'packetSize' => <integer>,
    'probeArn' => '<string>',
    'probeId' => '<string>',
    'protocol' => 'TCP|ICMP',
    'sourceArn' => '<string>',
    'state' => 'PENDING|ACTIVE|INACTIVE|ERROR|DELETING|DELETED',
    'tags' => ['<string>', ...],
    'vpcId' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

ResourceNotFoundException:

The specified resource does not exist.

ThrottlingException:

The request was denied due to request throttling

ValidationException:

One of the parameters for the request is not valid.

InternalServerException:

The request processing has failed because of an unknown error, exception or failure.

ServiceQuotaExceededException:

This request exceeds a service quota.