Class: Aws::NetworkMonitor::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-networkmonitor/lib/aws-sdk-networkmonitor/client.rb

Overview

An API client for NetworkMonitor. To construct a client, you need to configure a :region and :credentials.

client = Aws::NetworkMonitor::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only when disable_clock_skew_correction is not set.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::NetworkMonitor::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::NetworkMonitor::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



478
479
480
 
# File 'gems/aws-sdk-networkmonitor/lib/aws-sdk-networkmonitor/client.rb', line 478

def initialize(*args)
  super
end

Instance Method Details

#create_monitor(params = {}) ⇒ Types::CreateMonitorOutput

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.

Examples:

Request syntax with placeholder values


resp = client.create_monitor({
  monitor_name: "ResourceName", # required
  probes: [
    {
      source_arn: "Arn", # required
      destination: "Destination", # required
      destination_port: 1,
      protocol: "TCP", # required, accepts TCP, ICMP
      packet_size: 1,
      probe_tags: {
        "TagKey" => "TagValue",
      },
    },
  ],
  aggregation_period: 1,
  client_token: "String",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.monitor_arn #=> String
resp.monitor_name #=> String
resp.state #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING"
resp.aggregation_period #=> Integer
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :monitor_name (required, String) —

    The name identifying the monitor. It can contain only letters, underscores (_), or dashes (-), and can be up to 200 characters.

  • :probes (Array<Types::CreateMonitorProbeInput>) —

    Displays a list of all of the probes created for a monitor.

  • :aggregation_period (Integer) —

    The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either 30 or 60. 60 is the default if no period is chosen.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



574
575
576
577
 
# File 'gems/aws-sdk-networkmonitor/lib/aws-sdk-networkmonitor/client.rb', line 574

def create_monitor(params = {}, options = {})
  req = build_request(:create_monitor, params)
  req.send_request(options)
end

#create_probe(params = {}) ⇒ Types::CreateProbeOutput

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.

Examples:

Request syntax with placeholder values


resp = client.create_probe({
  monitor_name: "ResourceName", # required
  probe: { # required
    source_arn: "Arn", # required
    destination: "Destination", # required
    destination_port: 1,
    protocol: "TCP", # required, accepts TCP, ICMP
    packet_size: 1,
    tags: {
      "TagKey" => "TagValue",
    },
  },
  client_token: "String",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.probe_id #=> String
resp.probe_arn #=> String
resp.source_arn #=> String
resp.destination #=> String
resp.destination_port #=> Integer
resp.protocol #=> String, one of "TCP", "ICMP"
resp.packet_size #=> Integer
resp.address_family #=> String, one of "IPV4", "IPV6"
resp.vpc_id #=> String
resp.state #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING", "DELETED"
resp.created_at #=> Time
resp.modified_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :monitor_name (required, String) —

    The name of the monitor to associated with the probe.

  • :probe (required, Types::ProbeInput) —

    Describes the details of an individual probe for a monitor.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



658
659
660
661
 
# File 'gems/aws-sdk-networkmonitor/lib/aws-sdk-networkmonitor/client.rb', line 658

def create_probe(params = {}, options = {})
  req = build_request(:create_probe, params)
  req.send_request(options)
end

#delete_monitor(params = {}) ⇒ Struct

Deletes a specified monitor.

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

Examples:

Request syntax with placeholder values


resp = client.delete_monitor({
  monitor_name: "ResourceName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :monitor_name (required, String) —

    The name of the monitor to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



683
684
685
686
 
# File 'gems/aws-sdk-networkmonitor/lib/aws-sdk-networkmonitor/client.rb', line 683

def delete_monitor(params = {}, options = {})
  req = build_request(:delete_monitor, params)
  req.send_request(options)
end

#delete_probe(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_probe({
  monitor_name: "ResourceName", # required
  probe_id: "ProbeId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :monitor_name (required, String) —

    The name of the monitor to delete.

  • :probe_id (required, String) —

    The ID of the probe to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



715
716
717
718
 
# File 'gems/aws-sdk-networkmonitor/lib/aws-sdk-networkmonitor/client.rb', line 715

def delete_probe(params = {}, options = {})
  req = build_request(:delete_probe, params)
  req.send_request(options)
end

#get_monitor(params = {}) ⇒ Types::GetMonitorOutput

Returns details about a specific monitor.

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

Examples:

Request syntax with placeholder values


resp = client.get_monitor({
  monitor_name: "ResourceName", # required
})

Response structure


resp.monitor_arn #=> String
resp.monitor_name #=> String
resp.state #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING"
resp.aggregation_period #=> Integer
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.probes #=> Array
resp.probes[0].probe_id #=> String
resp.probes[0].probe_arn #=> String
resp.probes[0].source_arn #=> String
resp.probes[0].destination #=> String
resp.probes[0].destination_port #=> Integer
resp.probes[0].protocol #=> String, one of "TCP", "ICMP"
resp.probes[0].packet_size #=> Integer
resp.probes[0].address_family #=> String, one of "IPV4", "IPV6"
resp.probes[0].vpc_id #=> String
resp.probes[0].state #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING", "DELETED"
resp.probes[0].created_at #=> Time
resp.probes[0].modified_at #=> Time
resp.probes[0].tags #=> Hash
resp.probes[0].tags["TagKey"] #=> String
resp.created_at #=> Time
resp.modified_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :monitor_name (required, String) —

    The name of the monitor that details are returned for.

Returns:

See Also:



775
776
777
778
 
# File 'gems/aws-sdk-networkmonitor/lib/aws-sdk-networkmonitor/client.rb', line 775

def get_monitor(params = {}, options = {})
  req = build_request(:get_monitor, params)
  req.send_request(options)
end

#get_probe(params = {}) ⇒ Types::GetProbeOutput

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.

Examples:

Request syntax with placeholder values


resp = client.get_probe({
  monitor_name: "ResourceName", # required
  probe_id: "ProbeId", # required
})

Response structure


resp.probe_id #=> String
resp.probe_arn #=> String
resp.source_arn #=> String
resp.destination #=> String
resp.destination_port #=> Integer
resp.protocol #=> String, one of "TCP", "ICMP"
resp.packet_size #=> Integer
resp.address_family #=> String, one of "IPV4", "IPV6"
resp.vpc_id #=> String
resp.state #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING", "DELETED"
resp.created_at #=> Time
resp.modified_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :monitor_name (required, String) —

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

  • :probe_id (required, 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.

Returns:

See Also:



837
838
839
840
 
# File 'gems/aws-sdk-networkmonitor/lib/aws-sdk-networkmonitor/client.rb', line 837

def get_probe(params = {}, options = {})
  req = build_request(:get_probe, params)
  req.send_request(options)
end

#list_monitors(params = {}) ⇒ Types::ListMonitorsOutput

Returns a list of all of your monitors.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_monitors({
  next_token: "PaginationToken",
  max_results: 1,
  state: "String",
})

Response structure


resp.monitors #=> Array
resp.monitors[0].monitor_arn #=> String
resp.monitors[0].monitor_name #=> String
resp.monitors[0].state #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING"
resp.monitors[0].aggregation_period #=> Integer
resp.monitors[0].tags #=> Hash
resp.monitors[0].tags["TagKey"] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next page of results.

  • :max_results (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.

Returns:

See Also:



888
889
890
891
 
# File 'gems/aws-sdk-networkmonitor/lib/aws-sdk-networkmonitor/client.rb', line 888

def list_monitors(params = {}, options = {})
  req = build_request(:list_monitors, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

Lists the tags assigned to this resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The

Returns:

See Also:



917
918
919
920
 
# File 'gems/aws-sdk-networkmonitor/lib/aws-sdk-networkmonitor/client.rb', line 917

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds key-value pairs to a monitor or probe.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the monitor or probe to tag.

  • :tags (required, Hash<String,String>) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



945
946
947
948
 
# File 'gems/aws-sdk-networkmonitor/lib/aws-sdk-networkmonitor/client.rb', line 945

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tag_keys (required, Array<String>) —

    The key-value pa

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



971
972
973
974
 
# File 'gems/aws-sdk-networkmonitor/lib/aws-sdk-networkmonitor/client.rb', line 971

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_monitor(params = {}) ⇒ Types::UpdateMonitorOutput

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.

Examples:

Request syntax with placeholder values


resp = client.update_monitor({
  monitor_name: "ResourceName", # required
  aggregation_period: 1, # required
})

Response structure


resp.monitor_arn #=> String
resp.monitor_name #=> String
resp.state #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING"
resp.aggregation_period #=> Integer
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :monitor_name (required, String) —

    The name of the monitor to update.

  • :aggregation_period (required, Integer) —

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

Returns:

See Also:



1016
1017
1018
1019
 
# File 'gems/aws-sdk-networkmonitor/lib/aws-sdk-networkmonitor/client.rb', line 1016

def update_monitor(params = {}, options = {})
  req = build_request(:update_monitor, params)
  req.send_request(options)
end

#update_probe(params = {}) ⇒ Types::UpdateProbeOutput

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.

Examples:

Request syntax with placeholder values


resp = client.update_probe({
  monitor_name: "ResourceName", # required
  probe_id: "ProbeId", # required
  state: "PENDING", # accepts PENDING, ACTIVE, INACTIVE, ERROR, DELETING, DELETED
  destination: "Destination",
  destination_port: 1,
  protocol: "TCP", # accepts TCP, ICMP
  packet_size: 1,
})

Response structure


resp.probe_id #=> String
resp.probe_arn #=> String
resp.source_arn #=> String
resp.destination #=> String
resp.destination_port #=> Integer
resp.protocol #=> String, one of "TCP", "ICMP"
resp.packet_size #=> Integer
resp.address_family #=> String, one of "IPV4", "IPV6"
resp.vpc_id #=> String
resp.state #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING", "DELETED"
resp.created_at #=> Time
resp.modified_at #=> Time
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :monitor_name (required, String) —

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

  • :probe_id (required, String) —

    The ID of the probe to update.

  • :state (String) —

    The state of the probe update.

  • :destination (String) —

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

  • :destination_port (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.

  • :packet_size (Integer) —

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

Returns:

See Also:



1118
1119
1120
1121
 
# File 'gems/aws-sdk-networkmonitor/lib/aws-sdk-networkmonitor/client.rb', line 1118

def update_probe(params = {}, options = {})
  req = build_request(:update_probe, params)
  req.send_request(options)
end