Class: AWS.NetworkMonitor

var params = {
  monitorName: 'STRING_VALUE', /* required */
  probe: { /* required */
    destination: 'STRING_VALUE', /* required */
    protocol: TCP | ICMP, /* required */
    sourceArn: 'STRING_VALUE', /* required */
    destinationPort: 'NUMBER_VALUE',
    packetSize: 'NUMBER_VALUE',
    tags: {
      '<TagKey>': 'STRING_VALUE',
      /* '<TagKey>': ... */
    }
  },
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
networkmonitor.createProbe(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • monitorName — (String)

    The name of the monitor to associated with the probe.

  • probe — (map)

    Describes the details of an individual probe for a monitor.

    • sourceArn — required — (String)

      The ARN of the subnet.

    • destination — required — (String)

      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 — required — (String)

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

      Possible values include:
      • "TCP"
      • "ICMP"
    • packetSize — (Integer)

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

    • tags — (map<String>)

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

  • clientToken — (String)

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

    If a token is not provided, the SDK will use a version 4 UUID.
  • tags — (map<String>)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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.

      Possible values include:
      • "TCP"
      • "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.

      Possible values include:
      • "IPV4"
      • "IPV6"
    • vpcId — (String)

      The ID of the source VPC or subnet.

    • state — (String)

      The state of the probe.

      Possible values include:
      • "PENDING"
      • "ACTIVE"
      • "INACTIVE"
      • "ERROR"
      • "DELETING"
      • "DELETED"
    • createdAt — (Date)

      The time and date that the probe was created.

    • modifiedAt — (Date)

      The time and date when the probe was last modified.

    • tags — (map<String>)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  monitorName: 'STRING_VALUE' /* required */
};
networkmonitor.deleteMonitor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • monitorName — (String)

    The name of the monitor to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  monitorName: 'STRING_VALUE', /* required */
  probeId: 'STRING_VALUE' /* required */
};
networkmonitor.deleteProbe(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • monitorName — (String)

    The name of the monitor to delete.

  • probeId — (String)

    The ID of the probe to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  monitorName: 'STRING_VALUE' /* required */
};
networkmonitor.getMonitor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • monitorName — (String)

    The name of the monitor that details are returned for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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.

      Possible values include:
      • "PENDING"
      • "ACTIVE"
      • "INACTIVE"
      • "ERROR"
      • "DELETING"
    • aggregationPeriod — (Integer)

      The aggregation period for the specified monitor.

    • tags — (map<String>)

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

    • probes — (Array<map>)

      The details about each probe associated with that monitor.

      • probeId — (String)

        The ID of the probe.

      • probeArn — (String)

        The ARN of the probe.

      • sourceArn — required — (String)

        The ARN of the probe source subnet.

      • destination — required — (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 — required — (String)

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

        Possible values include:
        • "TCP"
        • "ICMP"
      • 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.

        Possible values include:
        • "IPV4"
        • "IPV6"
      • vpcId — (String)

        The ID of the source VPC subnet.

      • state — (String)

        The state of the probe.

        Possible values include:
        • "PENDING"
        • "ACTIVE"
        • "INACTIVE"
        • "ERROR"
        • "DELETING"
        • "DELETED"
      • createdAt — (Date)

        The time and date the probe was created.

      • modifiedAt — (Date)

        The time and date that the probe was last modified.

      • tags — (map<String>)

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

    • createdAt — (Date)

      The time and date when the monitor was created.

    • modifiedAt — (Date)

      The time and date when the monitor was last modified.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  monitorName: 'STRING_VALUE', /* required */
  probeId: 'STRING_VALUE' /* required */
};
networkmonitor.getProbe(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • monitorName — (String)

    The name of the monitor associated with the probe. Run ListMonitors to get a list of monitor names.

  • probeId — (String)

    The ID of the probe to get information about. Run GetMonitor action to get a list of probes and probe IDs for the monitor.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • 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.

      Possible values include:
      • "TCP"
      • "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.

      Possible values include:
      • "IPV4"
      • "IPV6"
    • vpcId — (String)

      The ID of the source VPC or subnet.

    • state — (String)

      The state of the probe.

      Possible values include:
      • "PENDING"
      • "ACTIVE"
      • "INACTIVE"
      • "ERROR"
      • "DELETING"
      • "DELETED"
    • createdAt — (Date)

      The time and date that the probe was created.

    • modifiedAt — (Date)

      The time and date that the probe was last modified.

    • tags — (map<String>)

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

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  state: 'STRING_VALUE'
};
networkmonitor.listMonitors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    The token for the next page of results.

  • maxResults — (Integer)

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    If MaxResults is given a value larger than 100, only 100 results are returned.

  • state — (String)

    The list of all monitors and their states.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • monitors — (Array<map>)

      Lists individual details about each of your monitors.

      • monitorArn — required — (String)

        The ARN of the monitor.

      • monitorName — required — (String)

        The name of the monitor.

      • state — required — (String)

        The state of the monitor.

        Possible values include:
        • "PENDING"
        • "ACTIVE"
        • "INACTIVE"
        • "ERROR"
        • "DELETING"
      • aggregationPeriod — (Integer)

        The time, in seconds, that metrics are collected and sent to Amazon CloudWatch. Valid values are either 30 or 60.

      • tags — (map<String>)

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

    • nextToken — (String)

      The token for the next page of results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
networkmonitor.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • tags — (map<String>)

      Lists the tags assigned to the resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
networkmonitor.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the monitor or probe to tag.

  • tags — (map<String>)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
networkmonitor.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • resourceArn — (String)

    The ARN of the monitor or probe that the tag should be removed from.

  • tagKeys — (Array<String>)

    The key-value pa

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  aggregationPeriod: 'NUMBER_VALUE', /* required */
  monitorName: 'STRING_VALUE' /* required */
};
networkmonitor.updateMonitor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • monitorName — (String)

    The name of the monitor to update.

  • aggregationPeriod — (Integer)

    The aggregation time, in seconds, to change to. This must be either 30 or 60.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • monitorArn — (String)

      The ARN of the monitor that was updated.

    • monitorName — (String)

      The name of the monitor that was updated.

    • state — (String)

      The state of the updated monitor.

      Possible values include:
      • "PENDING"
      • "ACTIVE"
      • "INACTIVE"
      • "ERROR"
      • "DELETING"
    • aggregationPeriod — (Integer)

      The changed aggregation period.

    • tags — (map<String>)

      The list of key-value pairs associated with the monitor.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  monitorName: 'STRING_VALUE', /* required */
  probeId: 'STRING_VALUE', /* required */
  destination: 'STRING_VALUE',
  destinationPort: 'NUMBER_VALUE',
  packetSize: 'NUMBER_VALUE',
  protocol: TCP | ICMP,
  state: PENDING | ACTIVE | INACTIVE | ERROR | DELETING | DELETED
};
networkmonitor.updateProbe(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • monitorName — (String)

    The name of the monitor that the probe was updated for.

  • probeId — (String)

    The ID of the probe to update.

  • state — (String)

    The state of the probe update.

    Possible values include:
    • "PENDING"
    • "ACTIVE"
    • "INACTIVE"
    • "ERROR"
    • "DELETING"
    • "DELETED"
  • destination — (String)

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

  • destinationPort — (Integer)

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

  • protocol — (String)

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

    Possible values include:
    • "TCP"
    • "ICMP"
  • packetSize — (Integer)

    he updated packets size for network traffic between the source and destination. This must be a number between 56 and 8500.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • probeId — (String)

      The updated ID of the probe.

    • probeArn — (String)

      The updated ARN of the probe.

    • sourceArn — (String)

      The updated ARN of the source subnet.

    • destination — (String)

      The updated destination IP address for the probe.

    • destinationPort — (Integer)

      The updated destination port. This must be a number between 1 and 65536.

    • protocol — (String)

      The updated protocol for the probe.

      Possible values include:
      • "TCP"
      • "ICMP"
    • packetSize — (Integer)

      The updated packet size for the probe.

    • addressFamily — (String)

      The updated IP address family. This must be either IPV4 or IPV6.

      Possible values include:
      • "IPV4"
      • "IPV6"
    • vpcId — (String)

      The updated ID of the source VPC subnet ID.

    • state — (String)

      The state of the updated probe.

      Possible values include:
      • "PENDING"
      • "ACTIVE"
      • "INACTIVE"
      • "ERROR"
      • "DELETING"
      • "DELETED"
    • createdAt — (Date)

      The time and date that the probe was created.

    • modifiedAt — (Date)

      The time and date that the probe was last updated.

    • tags — (map<String>)

      Update tags for a probe.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

• function(err, data) { ... }

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.