Class: Aws::NetworkFlowMonitor::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-networkflowmonitor/client.rb

Overview

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

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

For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

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`

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

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.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` 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:

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

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

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

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

  • :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::NetworkFlowMonitor::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::NetworkFlowMonitor::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 ‘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.



471
472
473
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 471

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1972
1973
1974
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1972

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1975
1976
1977
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1975

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1945

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::NetworkFlowMonitor')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-networkflowmonitor'
  context[:gem_version] = '1.26.0'
  Seahorse::Client::Request.new(handlers, context)
end

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

Create a monitor for specific network flows between local and remote resources, so that you can monitor network performance for one or several of your workloads. For each monitor, Network Flow Monitor publishes detailed end-to-end performance metrics and a network health indicator (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose.

Examples:

Request syntax with placeholder values


resp = client.create_monitor({
  monitor_name: "ResourceName", # required
  local_resources: [ # required
    {
      type: "AWS::EC2::VPC", # required, accepts AWS::EC2::VPC, AWS::AvailabilityZone, AWS::EC2::Subnet, AWS::Region, AWS::EKS::Cluster
      identifier: "String", # required
    },
  ],
  remote_resources: [
    {
      type: "AWS::EC2::VPC", # required, accepts AWS::EC2::VPC, AWS::AvailabilityZone, AWS::EC2::Subnet, AWS::AWSService, AWS::Region
      identifier: "String", # required
    },
  ],
  scope_arn: "Arn", # required
  client_token: "UuidString",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.monitor_arn #=> String
resp.monitor_name #=> String
resp.monitor_status #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING"
resp.local_resources #=> Array
resp.local_resources[0].type #=> String, one of "AWS::EC2::VPC", "AWS::AvailabilityZone", "AWS::EC2::Subnet", "AWS::Region", "AWS::EKS::Cluster"
resp.local_resources[0].identifier #=> String
resp.remote_resources #=> Array
resp.remote_resources[0].type #=> String, one of "AWS::EC2::VPC", "AWS::AvailabilityZone", "AWS::EC2::Subnet", "AWS::AWSService", "AWS::Region"
resp.remote_resources[0].identifier #=> String
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.

  • :local_resources (required, Array<Types::MonitorLocalResource>) —

    The local resources to monitor. A local resource in a workload is the location of the host, or hosts, where the Network Flow Monitor agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Dynamo DB), the subnet with the EC2 instance that hosts the web service, which also runs the agent, is the local resource.

    Be aware that all local resources must belong to the current Region.

  • :remote_resources (Array<Types::MonitorRemoteResource>) —

    The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.

    When you specify remote resources, be aware that specific combinations of resources are allowed and others are not, including the following constraints:

    • All remote resources that you specify must all belong to a single Region.

    • If you specify Amazon Web Services services as remote resources, any other remote resources that you specify must be in the current Region.

    • When you specify a remote resource for another Region, you can only specify the ‘Region` resource type. You cannot specify a subnet, VPC, or Availability Zone in another Region.

    • If you leave the ‘RemoteResources` parameter empty, the monitor will include all network flows that terminate in the current Region.

  • :scope_arn (required, String) —

    The Amazon Resource Name (ARN) of the scope for the monitor.

  • :client_token (String) —

    A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don’t reuse the same client token for other API requests.

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

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

    The tags for a monitor. You can add a maximum of 200 tags.

Returns:

See Also:



589
590
591
592
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 589

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

#create_scope(params = {}) ⇒ Types::CreateScopeOutput

In Network Flow Monitor, you specify a scope for the service to generate metrics for. By using the scope, Network Flow Monitor can generate a topology of all the resources to measure performance metrics for. When you create a scope, you enable permissions for Network Flow Monitor.

A scope is a Region-account pair or multiple Region-account pairs. Network Flow Monitor uses your scope to determine all the resources (the topology) where Network Flow Monitor will gather network flow performance metrics for you. To provide performance metrics, Network Flow Monitor uses the data that is sent by the Network Flow Monitor agents you install on the resources.

To define the Region-account pairs for your scope, the Network Flow Monitor API uses the following constucts, which allow for future flexibility in defining scopes:

  • Targets, which are arrays of targetResources.

  • *Target resources*, which are Region-targetIdentifier pairs.

  • *Target identifiers*, made up of a targetID (currently always an account ID) and a targetType (currently always an account).

Examples:

Request syntax with placeholder values


resp = client.create_scope({
  targets: [ # required
    {
      target_identifier: { # required
        target_id: { # required
          account_id: "AccountId",
        },
        target_type: "ACCOUNT", # required, accepts ACCOUNT
      },
      region: "AwsRegion", # required
    },
  ],
  client_token: "UuidString",
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.scope_id #=> String
resp.status #=> String, one of "SUCCEEDED", "IN_PROGRESS", "FAILED", "DEACTIVATING", "DEACTIVATED"
resp.scope_arn #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :targets (required, Array<Types::TargetResource>) —

    The targets to define the scope to be monitored. A target is an array of targetResources, which are currently Region-account pairs, defined by targetResource constructs.

  • :client_token (String) —

    A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don’t reuse the same client token for other API requests.

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

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

    The tags for a scope. You can add a maximum of 200 tags.

Returns:

See Also:



673
674
675
676
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 673

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

#delete_monitor(params = {}) ⇒ Struct

Deletes a monitor in Network Flow Monitor.

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:



695
696
697
698
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 695

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

#delete_scope(params = {}) ⇒ Struct

Deletes a scope that has been defined.

Examples:

Request syntax with placeholder values


resp = client.delete_scope({
  scope_id: "ScopeId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :scope_id (required, String) —

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



719
720
721
722
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 719

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

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

Gets information about a monitor in Network Flow Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.

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.monitor_status #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING"
resp.local_resources #=> Array
resp.local_resources[0].type #=> String, one of "AWS::EC2::VPC", "AWS::AvailabilityZone", "AWS::EC2::Subnet", "AWS::Region", "AWS::EKS::Cluster"
resp.local_resources[0].identifier #=> String
resp.remote_resources #=> Array
resp.remote_resources[0].type #=> String, one of "AWS::EC2::VPC", "AWS::AvailabilityZone", "AWS::EC2::Subnet", "AWS::AWSService", "AWS::Region"
resp.remote_resources[0].identifier #=> String
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.

Returns:

See Also:



769
770
771
772
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 769

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

#get_query_results_monitor_top_contributors(params = {}) ⇒ Types::GetQueryResultsMonitorTopContributorsOutput

Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for a specific monitor.

Create a query ID for this call by calling the corresponding API call to start the query, ‘StartQueryMonitorTopContributors`. Use the scope ID that was returned for your account by `CreateScope`.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

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

Examples:

Request syntax with placeholder values


resp = client.get_query_results_monitor_top_contributors({
  monitor_name: "ResourceName", # required
  query_id: "String", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.unit #=> String, one of "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.top_contributors #=> Array
resp.top_contributors[0].local_ip #=> String
resp.top_contributors[0].snat_ip #=> String
resp.top_contributors[0].local_instance_id #=> String
resp.top_contributors[0].local_vpc_id #=> String
resp.top_contributors[0].local_region #=> String
resp.top_contributors[0].local_az #=> String
resp.top_contributors[0].local_subnet_id #=> String
resp.top_contributors[0].target_port #=> Integer
resp.top_contributors[0].destination_category #=> String, one of "INTRA_AZ", "INTER_AZ", "INTER_VPC", "UNCLASSIFIED", "AMAZON_S3", "AMAZON_DYNAMODB", "INTER_REGION"
resp.top_contributors[0].remote_vpc_id #=> String
resp.top_contributors[0].remote_region #=> String
resp.top_contributors[0].remote_az #=> String
resp.top_contributors[0].remote_subnet_id #=> String
resp.top_contributors[0].remote_instance_id #=> String
resp.top_contributors[0].remote_ip #=> String
resp.top_contributors[0].dnat_ip #=> String
resp.top_contributors[0].value #=> Integer
resp.top_contributors[0].traversed_constructs #=> Array
resp.top_contributors[0].traversed_constructs[0].component_id #=> String
resp.top_contributors[0].traversed_constructs[0].component_type #=> String
resp.top_contributors[0].traversed_constructs[0].component_arn #=> String
resp.top_contributors[0].traversed_constructs[0].service_name #=> String
resp.top_contributors[0].kubernetes_metadata.local_service_name #=> String
resp.top_contributors[0].kubernetes_metadata.local_pod_name #=> String
resp.top_contributors[0].kubernetes_metadata.local_pod_namespace #=> String
resp.top_contributors[0].kubernetes_metadata.remote_service_name #=> String
resp.top_contributors[0].kubernetes_metadata.remote_pod_name #=> String
resp.top_contributors[0].kubernetes_metadata.remote_pod_namespace #=> String
resp.top_contributors[0].local_instance_arn #=> String
resp.top_contributors[0].local_subnet_arn #=> String
resp.top_contributors[0].local_vpc_arn #=> String
resp.top_contributors[0].remote_instance_arn #=> String
resp.top_contributors[0].remote_subnet_arn #=> String
resp.top_contributors[0].remote_vpc_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :monitor_name (required, String) —

    The name of the monitor.

  • :query_id (required, String) —

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.

  • :next_token (String) —

    The token for the next set of results. You receive this token from a previous call.

  • :max_results (Integer) —

    The number of query results that you want to return with this call.

Returns:

See Also:



865
866
867
868
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 865

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

#get_query_results_workload_insights_top_contributors(params = {}) ⇒ Types::GetQueryResultsWorkloadInsightsTopContributorsOutput

Return the data for a query with the Network Flow Monitor query interface. You specify the query that you want to return results for by providing a query ID and a monitor name.

This query returns the top contributors for a scope for workload insights. Workload insights provide a high level view of network flow performance data collected by agents. To return the data for the top contributors, see ‘GetQueryResultsWorkloadInsightsTopContributorsData`.

Create a query ID for this call by calling the corresponding API call to start the query, ‘StartQueryWorkloadInsightsTopContributors`. Use the scope ID that was returned for your account by `CreateScope`.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

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

Examples:

Request syntax with placeholder values


resp = client.get_query_results_workload_insights_top_contributors({
  scope_id: "ScopeId", # required
  query_id: "String", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.top_contributors #=> Array
resp.top_contributors[0]. #=> String
resp.top_contributors[0].local_subnet_id #=> String
resp.top_contributors[0].local_az #=> String
resp.top_contributors[0].local_vpc_id #=> String
resp.top_contributors[0].local_region #=> String
resp.top_contributors[0].remote_identifier #=> String
resp.top_contributors[0].value #=> Integer
resp.top_contributors[0].local_subnet_arn #=> String
resp.top_contributors[0].local_vpc_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :scope_id (required, String) —

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

  • :query_id (required, String) —

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.

  • :next_token (String) —

    The token for the next set of results. You receive this token from a previous call.

  • :max_results (Integer) —

    The number of query results that you want to return with this call.

Returns:

See Also:



941
942
943
944
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 941

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

#get_query_results_workload_insights_top_contributors_data(params = {}) ⇒ Types::GetQueryResultsWorkloadInsightsTopContributorsDataOutput

Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a scope ID.

This query returns the data for top contributors for workload insights for a specific scope. Workload insights provide a high level view of network flow performance data collected by agents for a scope. To return just the top contributors, see ‘GetQueryResultsWorkloadInsightsTopContributors`.

Create a query ID for this call by calling the corresponding API call to start the query, ‘StartQueryWorkloadInsightsTopContributorsData`. Use the scope ID that was returned for your account by `CreateScope`.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.

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

Examples:

Request syntax with placeholder values


resp = client.get_query_results_workload_insights_top_contributors_data({
  scope_id: "ScopeId", # required
  query_id: "String", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.unit #=> String, one of "Seconds", "Microseconds", "Milliseconds", "Bytes", "Kilobytes", "Megabytes", "Gigabytes", "Terabytes", "Bits", "Kilobits", "Megabits", "Gigabits", "Terabits", "Percent", "Count", "Bytes/Second", "Kilobytes/Second", "Megabytes/Second", "Gigabytes/Second", "Terabytes/Second", "Bits/Second", "Kilobits/Second", "Megabits/Second", "Gigabits/Second", "Terabits/Second", "Count/Second", "None"
resp.datapoints #=> Array
resp.datapoints[0].timestamps #=> Array
resp.datapoints[0].timestamps[0] #=> Time
resp.datapoints[0].values #=> Array
resp.datapoints[0].values[0] #=> Float
resp.datapoints[0].label #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :scope_id (required, String) —

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

  • :query_id (required, String) —

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.

  • :next_token (String) —

    The token for the next set of results. You receive this token from a previous call.

  • :max_results (Integer) —

    The number of query results that you want to return with this call.

Returns:

See Also:



1018
1019
1020
1021
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1018

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

#get_query_status_monitor_top_contributors(params = {}) ⇒ Types::GetQueryStatusMonitorTopContributorsOutput

Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors for a monitor.

When you create a query, use this call to check the status of the query to make sure that it has has ‘SUCCEEDED` before you review the results. Use the same query ID that you used for the corresponding API call to start (create) the query, `StartQueryMonitorTopContributors`.

When you run a query, use this call to check the status of the query to make sure that the query has ‘SUCCEEDED` before you review the results.

Examples:

Request syntax with placeholder values


resp = client.get_query_status_monitor_top_contributors({
  monitor_name: "ResourceName", # required
  query_id: "String", # required
})

Response structure


resp.status #=> String, one of "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELED"

Parameters:

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

    ({})

Options Hash (params):

  • :monitor_name (required, String) —

    The name of the monitor.

  • :query_id (required, String) —

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

Returns:

See Also:



1063
1064
1065
1066
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1063

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

#get_query_status_workload_insights_top_contributors(params = {}) ⇒ Types::GetQueryStatusWorkloadInsightsTopContributorsOutput

Return the data for a query with the Network Flow Monitor query interface. Specify the query that you want to return results for by providing a query ID and a monitor name. This query returns the top contributors for workload insights.

When you start a query, use this call to check the status of the query to make sure that it has has ‘SUCCEEDED` before you review the results. Use the same query ID that you used for the corresponding API call to start the query, `StartQueryWorkloadInsightsTopContributors`.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

Examples:

Request syntax with placeholder values


resp = client.get_query_status_workload_insights_top_contributors({
  scope_id: "ScopeId", # required
  query_id: "String", # required
})

Response structure


resp.status #=> String, one of "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELED"

Parameters:

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

    ({})

Options Hash (params):

  • :scope_id (required, String) —

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

  • :query_id (required, String) —

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

Returns:

See Also:



1113
1114
1115
1116
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1113

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

#get_query_status_workload_insights_top_contributors_data(params = {}) ⇒ Types::GetQueryStatusWorkloadInsightsTopContributorsDataOutput

Returns the current status of a query for the Network Flow Monitor query interface, for a specified query ID and monitor. This call returns the query status for the top contributors data for workload insights.

When you start a query, use this call to check the status of the query to make sure that it has has ‘SUCCEEDED` before you review the results. Use the same query ID that you used for the corresponding API call to start the query, `StartQueryWorkloadInsightsTopContributorsData`.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

The top contributor network flows overall are for a specific metric type, for example, the number of retransmissions.

Examples:

Request syntax with placeholder values


resp = client.get_query_status_workload_insights_top_contributors_data({
  scope_id: "ScopeId", # required
  query_id: "String", # required
})

Response structure


resp.status #=> String, one of "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELED"

Parameters:

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

    ({})

Options Hash (params):

  • :scope_id (required, String) —

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a ‘CreateScope` API call.

  • :query_id (required, String) —

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to start a query.

Returns:

See Also:



1168
1169
1170
1171
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1168

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

#get_scope(params = {}) ⇒ Types::GetScopeOutput

Gets information about a scope, including the name, status, tags, and target details. The scope in Network Flow Monitor is an account.

Examples:

Request syntax with placeholder values


resp = client.get_scope({
  scope_id: "GetScopeInputScopeIdString", # required
})

Response structure


resp.scope_id #=> String
resp.status #=> String, one of "SUCCEEDED", "IN_PROGRESS", "FAILED", "DEACTIVATING", "DEACTIVATED"
resp.scope_arn #=> String
resp.targets #=> Array
resp.targets[0].target_identifier.target_id. #=> String
resp.targets[0].target_identifier.target_type #=> String, one of "ACCOUNT"
resp.targets[0].region #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :scope_id (required, String) —

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a ‘CreateScope` API call.

Returns:

See Also:



1212
1213
1214
1215
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1212

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

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

List all monitors in an account. Optionally, you can list only monitors that have a specific status, by using the ‘STATUS` parameter.

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: "String",
  max_results: 1,
  monitor_status: "PENDING", # accepts PENDING, ACTIVE, INACTIVE, ERROR, DELETING
})

Response structure


resp.monitors #=> Array
resp.monitors[0].monitor_arn #=> String
resp.monitors[0].monitor_name #=> String
resp.monitors[0].monitor_status #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of results. You receive this token from a previous call.

  • :max_results (Integer) —

    The number of query results that you want to return with this call.

  • :monitor_status (String) —

    The status of a monitor. The status can be one of the following

    • ‘PENDING`: The monitor is in the process of being created.

    • ‘ACTIVE`: The monitor is active.

    • ‘INACTIVE`: The monitor is inactive.

    • ‘ERROR`: Monitor creation failed due to an error.

    • ‘DELETING`: The monitor is in the process of being deleted.

Returns:

See Also:



1267
1268
1269
1270
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1267

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

#list_scopes(params = {}) ⇒ Types::ListScopesOutput

List all the scopes for an account.

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_scopes({
  next_token: "String",
  max_results: 1,
})

Response structure


resp.scopes #=> Array
resp.scopes[0].scope_id #=> String
resp.scopes[0].status #=> String, one of "SUCCEEDED", "IN_PROGRESS", "FAILED", "DEACTIVATING", "DEACTIVATED"
resp.scopes[0].scope_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The token for the next set of results. You receive this token from a previous call.

  • :max_results (Integer) —

    The number of query results that you want to return with this call.

Returns:

See Also:



1307
1308
1309
1310
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1307

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

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

Returns all the tags for a 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 Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



1336
1337
1338
1339
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1336

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

#start_query_monitor_top_contributors(params = {}) ⇒ Types::StartQueryMonitorTopContributorsOutput

Create a query that you can use with the Network Flow Monitor query interface to return the top contributors for a monitor. Specify the monitor that you want to create the query for.

The call returns a query ID that you can use with [ GetQueryResultsMonitorTopContributors] to run the query and return the top contributors for a specific monitor.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.

[1]: docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsMonitorTopContributors.html

Examples:

Request syntax with placeholder values


resp = client.start_query_monitor_top_contributors({
  monitor_name: "ResourceName", # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  metric_name: "ROUND_TRIP_TIME", # required, accepts ROUND_TRIP_TIME, TIMEOUTS, RETRANSMISSIONS, DATA_TRANSFERRED
  destination_category: "INTRA_AZ", # required, accepts INTRA_AZ, INTER_AZ, INTER_VPC, UNCLASSIFIED, AMAZON_S3, AMAZON_DYNAMODB, INTER_REGION
  limit: 1,
})

Response structure


resp.query_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :monitor_name (required, String) —

    The name of the monitor.

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    The timestamp that is the date and time end of the period that you want to retrieve results for with your query.

  • :metric_name (required, String) —

    The metric that you want to query top contributors for. That is, you can specify a metric with this call and return the top contributor network flows, for that type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.

  • :destination_category (required, String) —

    The category that you want to query top contributors for, for a specific monitor. Destination categories can be one of the following:

    • ‘INTRA_AZ`: Top contributor network flows within a single Availability Zone

    • ‘INTER_AZ`: Top contributor network flows between Availability Zones

    • ‘INTER_REGION`: Top contributor network flows between Regions (to the edge of another Region)

    • ‘INTER_VPC`: Top contributor network flows between VPCs

    • ‘AMAZON_S3`: Top contributor network flows to or from Amazon S3

    • ‘AMAZON_DYNAMODB`: Top contributor network flows to or from Amazon Dynamo DB

    • ‘UNCLASSIFIED`: Top contributor network flows that do not have a bucket classification

  • :limit (Integer) —

    The maximum number of top contributors to return.

Returns:

See Also:



1425
1426
1427
1428
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1425

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

#start_query_workload_insights_top_contributors(params = {}) ⇒ Types::StartQueryWorkloadInsightsTopContributorsOutput

Create a query with the Network Flow Monitor query interface that you can run to return workload insights top contributors. Specify the scope that you want to create a query for.

The call returns a query ID that you can use with [ GetQueryResultsWorkloadInsightsTopContributors] to run the query and return the top contributors for the workload insights for a scope.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable APIs for the top contributors that you want to be returned.

[1]: docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsWorkloadInsightsTopContributors.html

Examples:

Request syntax with placeholder values


resp = client.start_query_workload_insights_top_contributors({
  scope_id: "ScopeId", # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  metric_name: "TIMEOUTS", # required, accepts TIMEOUTS, RETRANSMISSIONS, DATA_TRANSFERRED
  destination_category: "INTRA_AZ", # required, accepts INTRA_AZ, INTER_AZ, INTER_VPC, UNCLASSIFIED, AMAZON_S3, AMAZON_DYNAMODB, INTER_REGION
  limit: 1,
})

Response structure


resp.query_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :scope_id (required, String) —

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account. A scope ID is returned from a ‘CreateScope` API call.

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    The timestamp that is the date and time end of the period that you want to retrieve results for with your query.

  • :metric_name (required, String) —

    The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.

  • :destination_category (required, String) —

    The destination category for a top contributors row. Destination categories can be one of the following:

    • ‘INTRA_AZ`: Top contributor network flows within a single Availability Zone

    • ‘INTER_AZ`: Top contributor network flows between Availability Zones

    • ‘INTER_REGION`: Top contributor network flows between Regions (to the edge of another Region)

    • ‘INTER_VPC`: Top contributor network flows between VPCs

    • ‘AWS_SERVICES`: Top contributor network flows to or from Amazon Web Services services

    • ‘UNCLASSIFIED`: Top contributor network flows that do not have a bucket classification

  • :limit (Integer) —

    The maximum number of top contributors to return.

Returns:

See Also:



1514
1515
1516
1517
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1514

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

#start_query_workload_insights_top_contributors_data(params = {}) ⇒ Types::StartQueryWorkloadInsightsTopContributorsDataOutput

Create a query with the Network Flow Monitor query interface that you can run to return data for workload insights top contributors. Specify the scope that you want to create a query for.

The call returns a query ID that you can use with [ GetQueryResultsWorkloadInsightsTopContributorsData] to run the query and return the data for the top contributors for the workload insights for a scope.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

[1]: docs.aws.amazon.com/networkflowmonitor/2.0/APIReference/API_GetQueryResultsWorkloadInsightsTopContributorsData.html

Examples:

Request syntax with placeholder values


resp = client.start_query_workload_insights_top_contributors_data({
  scope_id: "ScopeId", # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  metric_name: "TIMEOUTS", # required, accepts TIMEOUTS, RETRANSMISSIONS, DATA_TRANSFERRED
  destination_category: "INTRA_AZ", # required, accepts INTRA_AZ, INTER_AZ, INTER_VPC, UNCLASSIFIED, AMAZON_S3, AMAZON_DYNAMODB, INTER_REGION
})

Response structure


resp.query_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :scope_id (required, String) —

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

  • :start_time (required, Time, DateTime, Date, Integer, String) —

    The timestamp that is the date and time that is the beginning of the period that you want to retrieve results for with your query.

  • :end_time (required, Time, DateTime, Date, Integer, String) —

    The timestamp that is the date and time end of the period that you want to retrieve results for with your query.

  • :metric_name (required, String) —

    The metric that you want to query top contributors for. That is, you can specify this metric to return the top contributor network flows, for this type of metric, for a monitor and (optionally) within a specific category, such as network flows between Availability Zones.

  • :destination_category (required, String) —

    The destination category for a top contributors. Destination categories can be one of the following:

    • ‘INTRA_AZ`: Top contributor network flows within a single Availability Zone

    • ‘INTER_AZ`: Top contributor network flows between Availability Zones

    • ‘INTER_REGION`: Top contributor network flows between Regions (to the edge of another Region)

    • ‘INTER_VPC`: Top contributor network flows between VPCs

    • ‘AWS_SERVICES`: Top contributor network flows to or from Amazon Web Services services

    • ‘UNCLASSIFIED`: Top contributor network flows that do not have a bucket classification

Returns:

See Also:



1599
1600
1601
1602
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1599

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

#stop_query_monitor_top_contributors(params = {}) ⇒ Struct

Stop a top contributors query for a monitor. Specify the query that you want to stop by providing a query ID and a monitor name.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

Examples:

Request syntax with placeholder values


resp = client.stop_query_monitor_top_contributors({
  monitor_name: "ResourceName", # required
  query_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :monitor_name (required, String) —

    The name of the monitor.

  • :query_id (required, String) —

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1634
1635
1636
1637
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1634

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

#stop_query_workload_insights_top_contributors(params = {}) ⇒ Struct

Stop a top contributors query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

Examples:

Request syntax with placeholder values


resp = client.stop_query_workload_insights_top_contributors({
  scope_id: "ScopeId", # required
  query_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :scope_id (required, String) —

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

  • :query_id (required, String) —

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1671
1672
1673
1674
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1671

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

#stop_query_workload_insights_top_contributors_data(params = {}) ⇒ Struct

Stop a top contributors data query for workload insights. Specify the query that you want to stop by providing a query ID and a scope ID.

Top contributors in Network Flow Monitor are network flows with the highest values for a specific metric type. Top contributors can be across all workload insights, for a given scope, or for a specific monitor. Use the applicable call for the top contributors that you want to be returned.

Examples:

Request syntax with placeholder values


resp = client.stop_query_workload_insights_top_contributors_data({
  scope_id: "ScopeId", # required
  query_id: "String", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :scope_id (required, String) —

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

  • :query_id (required, String) —

    The identifier for the query. A query ID is an internally-generated identifier for a specific query returned from an API call to create a query.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1708
1709
1710
1711
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1708

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

#tag_resource(params = {}) ⇒ Struct

Adds a tag to a resource.

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 Amazon Resource Name (ARN) of the resource.

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

    The tags for a resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1736
1737
1738
1739
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1736

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

#untag_resource(params = {}) ⇒ Struct

Removes a tag from a resource.

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 Amazon Resource Name (ARN) of the resource.

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

    Keys that you specified when you tagged a resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1762
1763
1764
1765
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1762

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

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

Update a monitor to add or remove local or remote resources.

Examples:

Request syntax with placeholder values


resp = client.update_monitor({
  monitor_name: "ResourceName", # required
  local_resources_to_add: [
    {
      type: "AWS::EC2::VPC", # required, accepts AWS::EC2::VPC, AWS::AvailabilityZone, AWS::EC2::Subnet, AWS::Region, AWS::EKS::Cluster
      identifier: "String", # required
    },
  ],
  local_resources_to_remove: [
    {
      type: "AWS::EC2::VPC", # required, accepts AWS::EC2::VPC, AWS::AvailabilityZone, AWS::EC2::Subnet, AWS::Region, AWS::EKS::Cluster
      identifier: "String", # required
    },
  ],
  remote_resources_to_add: [
    {
      type: "AWS::EC2::VPC", # required, accepts AWS::EC2::VPC, AWS::AvailabilityZone, AWS::EC2::Subnet, AWS::AWSService, AWS::Region
      identifier: "String", # required
    },
  ],
  remote_resources_to_remove: [
    {
      type: "AWS::EC2::VPC", # required, accepts AWS::EC2::VPC, AWS::AvailabilityZone, AWS::EC2::Subnet, AWS::AWSService, AWS::Region
      identifier: "String", # required
    },
  ],
  client_token: "UuidString",
})

Response structure


resp.monitor_arn #=> String
resp.monitor_name #=> String
resp.monitor_status #=> String, one of "PENDING", "ACTIVE", "INACTIVE", "ERROR", "DELETING"
resp.local_resources #=> Array
resp.local_resources[0].type #=> String, one of "AWS::EC2::VPC", "AWS::AvailabilityZone", "AWS::EC2::Subnet", "AWS::Region", "AWS::EKS::Cluster"
resp.local_resources[0].identifier #=> String
resp.remote_resources #=> Array
resp.remote_resources[0].type #=> String, one of "AWS::EC2::VPC", "AWS::AvailabilityZone", "AWS::EC2::Subnet", "AWS::AWSService", "AWS::Region"
resp.remote_resources[0].identifier #=> String
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.

  • :local_resources_to_add (Array<Types::MonitorLocalResource>) —

    Additional local resources to specify network flows for a monitor, as an array of resources with identifiers and types. A local resource in a workload is the location of hosts where the Network Flow Monitor agent is installed.

  • :local_resources_to_remove (Array<Types::MonitorLocalResource>) —

    The local resources to remove, as an array of resources with identifiers and types.

  • :remote_resources_to_add (Array<Types::MonitorRemoteResource>) —

    The remote resources to add, as an array of resources with identifiers and types.

    A remote resource is the other endpoint in the flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.

  • :remote_resources_to_remove (Array<Types::MonitorRemoteResource>) —

    The remote resources to remove, as an array of resources with identifiers and types.

    A remote resource is the other endpoint specified for the network flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.

  • :client_token (String) —

    A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don’t reuse the same client token for other API requests.

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

Returns:

See Also:



1868
1869
1870
1871
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1868

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

#update_scope(params = {}) ⇒ Types::UpdateScopeOutput

Update a scope to add or remove resources that you want to be available for Network Flow Monitor to generate metrics for, when you have active agents on those resources sending metrics reports to the Network Flow Monitor backend.

Examples:

Request syntax with placeholder values


resp = client.update_scope({
  scope_id: "ScopeId", # required
  resources_to_add: [
    {
      target_identifier: { # required
        target_id: { # required
          account_id: "AccountId",
        },
        target_type: "ACCOUNT", # required, accepts ACCOUNT
      },
      region: "AwsRegion", # required
    },
  ],
  resources_to_delete: [
    {
      target_identifier: { # required
        target_id: { # required
          account_id: "AccountId",
        },
        target_type: "ACCOUNT", # required, accepts ACCOUNT
      },
      region: "AwsRegion", # required
    },
  ],
})

Response structure


resp.scope_id #=> String
resp.status #=> String, one of "SUCCEEDED", "IN_PROGRESS", "FAILED", "DEACTIVATING", "DEACTIVATED"
resp.scope_arn #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :scope_id (required, String) —

    The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

  • :resources_to_add (Array<Types::TargetResource>) —

    A list of resources to add to a scope.

  • :resources_to_delete (Array<Types::TargetResource>) —

    A list of resources to delete from a scope.

Returns:

See Also:



1936
1937
1938
1939
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1936

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1965
1966
1967
 
# File 'lib/aws-sdk-networkflowmonitor/client.rb', line 1965

def waiter_names
  []
end