You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ApplicationInsights::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for Amazon CloudWatch Application Insights. To construct a client, you need to configure a :region and :credentials.

applicationinsights = Aws::ApplicationInsights::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

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

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::ApplicationInsights::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::ApplicationInsights::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

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

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    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. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :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 and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#create_application(options = {}) ⇒ Types::CreateApplicationResponse

Adds an application that is created from a resource group.

Examples:

Request syntax with placeholder values


resp = client.create_application({
  resource_group_name: "ResourceGroupName", # required
  ops_center_enabled: false,
  ops_item_sns_topic_arn: "OpsItemSNSTopicArn",
})

Response structure


resp.application_info.resource_group_name #=> String
resp.application_info.life_cycle #=> String
resp.application_info.ops_item_sns_topic_arn #=> String
resp.application_info.ops_center_enabled #=> true/false
resp.application_info.remarks #=> String

Options Hash (options):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :ops_center_enabled (Boolean)

    When set to true, creates opsItems for any problems detected on an application.

  • :ops_item_sns_topic_arn (String)

    The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.

Returns:

See Also:

#create_component(options = {}) ⇒ Struct

Creates a custom component by grouping similar standalone instances to monitor.

Examples:

Request syntax with placeholder values


resp = client.create_component({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
  resource_list: ["ResourceARN"], # required
})

Options Hash (options):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :component_name (required, String)

    The name of the component.

  • :resource_list (required, Array<String>)

    The list of resource ARNs that belong to the component.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_application(options = {}) ⇒ Struct

Removes the specified application from monitoring. Does not delete the application.

Examples:

Request syntax with placeholder values


resp = client.delete_application({
  resource_group_name: "ResourceGroupName", # required
})

Options Hash (options):

  • :resource_group_name (required, String)

    The name of the resource group.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#delete_component(options = {}) ⇒ Struct

Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status.

Examples:

Request syntax with placeholder values


resp = client.delete_component({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
})

Options Hash (options):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :component_name (required, String)

    The name of the component.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#describe_application(options = {}) ⇒ Types::DescribeApplicationResponse

Describes the application.

Examples:

Request syntax with placeholder values


resp = client.describe_application({
  resource_group_name: "ResourceGroupName", # required
})

Response structure


resp.application_info.resource_group_name #=> String
resp.application_info.life_cycle #=> String
resp.application_info.ops_item_sns_topic_arn #=> String
resp.application_info.ops_center_enabled #=> true/false
resp.application_info.remarks #=> String

Options Hash (options):

  • :resource_group_name (required, String)

    The name of the resource group.

Returns:

See Also:

#describe_component(options = {}) ⇒ Types::DescribeComponentResponse

Describes a component and lists the resources that are grouped together in a component.

Examples:

Request syntax with placeholder values


resp = client.describe_component({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
})

Response structure


resp.application_component.component_name #=> String
resp.application_component.resource_type #=> String
resp.application_component.tier #=> String
resp.application_component.monitor #=> true/false
resp.resource_list #=> Array
resp.resource_list[0] #=> String

Options Hash (options):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :component_name (required, String)

    The name of the component.

Returns:

See Also:

#describe_component_configuration(options = {}) ⇒ Types::DescribeComponentConfigurationResponse

Describes the monitoring configuration of the component.

Examples:

Request syntax with placeholder values


resp = client.describe_component_configuration({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
})

Response structure


resp.monitor #=> true/false
resp.tier #=> String
resp.component_configuration #=> String

Options Hash (options):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :component_name (required, String)

    The name of the component.

Returns:

See Also:

#describe_component_configuration_recommendation(options = {}) ⇒ Types::DescribeComponentConfigurationRecommendationResponse

Describes the recommended monitoring configuration of the component.

Examples:

Request syntax with placeholder values


resp = client.describe_component_configuration_recommendation({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
  tier: "Tier", # required
})

Response structure


resp.component_configuration #=> String

Options Hash (options):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :component_name (required, String)

    The name of the component.

  • :tier (required, String)

    The tier of the application component. Supported tiers include DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT.

Returns:

See Also:

#describe_observation(options = {}) ⇒ Types::DescribeObservationResponse

Describes an anomaly or error with the application.

Examples:

Request syntax with placeholder values


resp = client.describe_observation({
  observation_id: "ObservationId", # required
})

Response structure


resp.observation.id #=> String
resp.observation.start_time #=> Time
resp.observation.end_time #=> Time
resp.observation.source_type #=> String
resp.observation.source_arn #=> String
resp.observation.log_group #=> String
resp.observation.line_time #=> Time
resp.observation.log_text #=> String
resp.observation.log_filter #=> String, one of "ERROR", "WARN", "INFO"
resp.observation.metric_namespace #=> String
resp.observation.metric_name #=> String
resp.observation.unit #=> String
resp.observation.value #=> Float

Options Hash (options):

  • :observation_id (required, String)

    The ID of the observation.

Returns:

See Also:

#describe_problem(options = {}) ⇒ Types::DescribeProblemResponse

Describes an application problem.

Examples:

Request syntax with placeholder values


resp = client.describe_problem({
  problem_id: "ProblemId", # required
})

Response structure


resp.problem.id #=> String
resp.problem.title #=> String
resp.problem.insights #=> String
resp.problem.status #=> String, one of "IGNORE", "RESOLVED", "PENDING"
resp.problem.affected_resource #=> String
resp.problem.start_time #=> Time
resp.problem.end_time #=> Time
resp.problem.severity_level #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.problem.resource_group_name #=> String
resp.problem.feedback #=> Hash
resp.problem.feedback["FeedbackKey"] #=> String, one of "NOT_SPECIFIED", "USEFUL", "NOT_USEFUL"

Options Hash (options):

  • :problem_id (required, String)

    The ID of the problem.

Returns:

See Also:

#describe_problem_observations(options = {}) ⇒ Types::DescribeProblemObservationsResponse

Describes the anomalies or errors associated with the problem.

Examples:

Request syntax with placeholder values


resp = client.describe_problem_observations({
  problem_id: "ProblemId", # required
})

Response structure


resp.related_observations.observation_list #=> Array
resp.related_observations.observation_list[0].id #=> String
resp.related_observations.observation_list[0].start_time #=> Time
resp.related_observations.observation_list[0].end_time #=> Time
resp.related_observations.observation_list[0].source_type #=> String
resp.related_observations.observation_list[0].source_arn #=> String
resp.related_observations.observation_list[0].log_group #=> String
resp.related_observations.observation_list[0].line_time #=> Time
resp.related_observations.observation_list[0].log_text #=> String
resp.related_observations.observation_list[0].log_filter #=> String, one of "ERROR", "WARN", "INFO"
resp.related_observations.observation_list[0].metric_namespace #=> String
resp.related_observations.observation_list[0].metric_name #=> String
resp.related_observations.observation_list[0].unit #=> String
resp.related_observations.observation_list[0].value #=> Float

Options Hash (options):

  • :problem_id (required, String)

    The ID of the problem.

Returns:

See Also:

#list_applications(options = {}) ⇒ Types::ListApplicationsResponse

Lists the IDs of the applications that you are monitoring.

Examples:

Request syntax with placeholder values


resp = client.list_applications({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.application_info_list #=> Array
resp.application_info_list[0].resource_group_name #=> String
resp.application_info_list[0].life_cycle #=> String
resp.application_info_list[0].ops_item_sns_topic_arn #=> String
resp.application_info_list[0].ops_center_enabled #=> true/false
resp.application_info_list[0].remarks #=> String
resp.next_token #=> String

Options Hash (options):

  • :max_results (Integer)

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

  • :next_token (String)

    The token to request the next page of results.

Returns:

See Also:

#list_components(options = {}) ⇒ Types::ListComponentsResponse

Lists the auto-grouped, standalone, and custom components of the application.

Examples:

Request syntax with placeholder values


resp = client.list_components({
  resource_group_name: "ResourceGroupName", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.application_component_list #=> Array
resp.application_component_list[0].component_name #=> String
resp.application_component_list[0].resource_type #=> String
resp.application_component_list[0].tier #=> String
resp.application_component_list[0].monitor #=> true/false
resp.next_token #=> String

Options Hash (options):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :max_results (Integer)

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

  • :next_token (String)

    The token to request the next page of results.

Returns:

See Also:

#list_problems(options = {}) ⇒ Types::ListProblemsResponse

Lists the problems with your application.

Examples:

Request syntax with placeholder values


resp = client.list_problems({
  resource_group_name: "ResourceGroupName",
  start_time: Time.now,
  end_time: Time.now,
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.problem_list #=> Array
resp.problem_list[0].id #=> String
resp.problem_list[0].title #=> String
resp.problem_list[0].insights #=> String
resp.problem_list[0].status #=> String, one of "IGNORE", "RESOLVED", "PENDING"
resp.problem_list[0].affected_resource #=> String
resp.problem_list[0].start_time #=> Time
resp.problem_list[0].end_time #=> Time
resp.problem_list[0].severity_level #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.problem_list[0].resource_group_name #=> String
resp.problem_list[0].feedback #=> Hash
resp.problem_list[0].feedback["FeedbackKey"] #=> String, one of "NOT_SPECIFIED", "USEFUL", "NOT_USEFUL"
resp.next_token #=> String

Options Hash (options):

  • :resource_group_name (String)

    The name of the resource group.

  • :start_time (Time)

    The time when the problem was detected, in epoch seconds. If you don\'t specify a time frame for the request, problems within the past seven days are returned.

  • :end_time (Time)

    The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.

  • :max_results (Integer)

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

  • :next_token (String)

    The token to request the next page of results.

Returns:

See Also:

#update_application(options = {}) ⇒ Types::UpdateApplicationResponse

Updates the application.

Examples:

Request syntax with placeholder values


resp = client.update_application({
  resource_group_name: "ResourceGroupName", # required
  ops_center_enabled: false,
  ops_item_sns_topic_arn: "OpsItemSNSTopicArn",
  remove_sns_topic: false,
})

Response structure


resp.application_info.resource_group_name #=> String
resp.application_info.life_cycle #=> String
resp.application_info.ops_item_sns_topic_arn #=> String
resp.application_info.ops_center_enabled #=> true/false
resp.application_info.remarks #=> String

Options Hash (options):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :ops_center_enabled (Boolean)

    When set to true, creates opsItems for any problems detected on an application.

  • :ops_item_sns_topic_arn (String)

    The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.

  • :remove_sns_topic (Boolean)

    Disassociates the SNS topic from the opsItem created for detected problems.

Returns:

See Also:

#update_component(options = {}) ⇒ Struct

Updates the custom component name and/or the list of resources that make up the component.

Examples:

Request syntax with placeholder values


resp = client.update_component({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
  new_component_name: "NewComponentName",
  resource_list: ["ResourceARN"],
})

Options Hash (options):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :component_name (required, String)

    The name of the component.

  • :new_component_name (String)

    The new name of the component.

  • :resource_list (Array<String>)

    The list of resource ARNs that belong to the component.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_component_configuration(options = {}) ⇒ Struct

Updates the monitoring configurations for the component. The configuration input parameter is an escaped JSON of the configuration and should match the schema of what is returned by DescribeComponentConfigurationRecommendation.

Examples:

Request syntax with placeholder values


resp = client.update_component_configuration({
  resource_group_name: "ResourceGroupName", # required
  component_name: "ComponentName", # required
  monitor: false,
  tier: "Tier",
  component_configuration: "ComponentConfiguration",
})

Options Hash (options):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :component_name (required, String)

    The name of the component.

  • :monitor (Boolean)

    Indicates whether the application component is monitored.

  • :tier (String)

    The tier of the application component. Supported tiers include DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT.

  • :component_configuration (String)

    The configuration settings of the component. The value is the escaped JSON of the configuration. For more information about the JSON format, see Working with JSON. You can send a request to DescribeComponentConfigurationRecommendation to see the recommended configuration for a component.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.