Class: Aws::ApplicationInsights::Client

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

Overview

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

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

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

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

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

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

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String)

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

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :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.

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

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be a valid HTTP(S) URI.

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

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

  • :retry_backoff (Proc)

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

  • :retry_base_delay (Float) — default: 0.3

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

  • :retry_jitter (Symbol) — default: :none

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

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

  • :retry_limit (Integer) — default: 3

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

  • :retry_max_delay (Integer) — default: 0

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

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

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is 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 - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

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

  • :validate_params (Boolean) — default: true

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

  • :http_proxy (URI::HTTP, String)

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

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. 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_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_wire_trace (Boolean) — default: false

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

  • :ssl_verify_peer (Boolean) — default: true

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

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



315
316
317
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 315

def initialize(*args)
  super
end

Instance Method Details

#create_application(params = {}) ⇒ 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,
  cwe_monitor_enabled: false,
  ops_item_sns_topic_arn: "OpsItemSNSTopicArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # 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 #=> Boolean
resp.application_info.cwe_monitor_enabled #=> Boolean
resp.application_info.remarks #=> String

Parameters:

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

    ({})

Options Hash (params):

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

  • :cwe_monitor_enabled (Boolean)

    Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.

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

  • :tags (Array<Types::Tag>)

    List of tags to add to the application. tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Returns:

See Also:



377
378
379
380
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 377

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

#create_component(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

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



408
409
410
411
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 408

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

#create_log_pattern(params = {}) ⇒ Types::CreateLogPatternResponse

Adds an log pattern to a LogPatternSet.

Examples:

Request syntax with placeholder values


resp = client.create_log_pattern({
  resource_group_name: "ResourceGroupName", # required
  pattern_set_name: "LogPatternSetName", # required
  pattern_name: "LogPatternName", # required
  pattern: "LogPatternRegex", # required
  rank: 1, # required
})

Response structure


resp.log_pattern.pattern_set_name #=> String
resp.log_pattern.pattern_name #=> String
resp.log_pattern.pattern #=> String
resp.log_pattern.rank #=> Integer
resp.resource_group_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :pattern_set_name (required, String)

    The name of the log pattern set.

  • :pattern_name (required, String)

    The name of the log pattern.

  • :pattern (required, String)

    The log pattern.

  • :rank (required, Integer)

    Rank of the log pattern.

Returns:

See Also:



457
458
459
460
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 457

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

#delete_application(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_group_name (required, String)

    The name of the resource group.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



480
481
482
483
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 480

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

#delete_component(params = {}) ⇒ 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
})

Parameters:

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

    ({})

Options Hash (params):

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



508
509
510
511
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 508

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

#delete_log_pattern(params = {}) ⇒ Struct

Removes the specified log pattern from a LogPatternSet.

Examples:

Request syntax with placeholder values


resp = client.delete_log_pattern({
  resource_group_name: "ResourceGroupName", # required
  pattern_set_name: "LogPatternSetName", # required
  pattern_name: "LogPatternName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :pattern_set_name (required, String)

    The name of the log pattern set.

  • :pattern_name (required, String)

    The name of the log pattern.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



538
539
540
541
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 538

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

#describe_application(params = {}) ⇒ 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 #=> Boolean
resp.application_info.cwe_monitor_enabled #=> Boolean
resp.application_info.remarks #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_group_name (required, String)

    The name of the resource group.

Returns:

See Also:



571
572
573
574
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 571

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

#describe_component(params = {}) ⇒ 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, one of "DEFAULT", "DOT_NET_CORE", "DOT_NET_WORKER", "DOT_NET_WEB", "SQL_SERVER"
resp.application_component.monitor #=> Boolean
resp.resource_list #=> Array
resp.resource_list[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :component_name (required, String)

    The name of the component.

Returns:

See Also:



610
611
612
613
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 610

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

#describe_component_configuration(params = {}) ⇒ 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 #=> Boolean
resp.tier #=> String, one of "DEFAULT", "DOT_NET_CORE", "DOT_NET_WORKER", "DOT_NET_WEB", "SQL_SERVER"
resp.component_configuration #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :component_name (required, String)

    The name of the component.

Returns:

See Also:



646
647
648
649
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 646

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

#describe_component_configuration_recommendation(params = {}) ⇒ 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: "DEFAULT", # required, accepts DEFAULT, DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER
})

Response structure


resp.component_configuration #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :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_CORE, DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT.

Returns:

See Also:



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

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

#describe_log_pattern(params = {}) ⇒ Types::DescribeLogPatternResponse

Describe a specific log pattern from a LogPatternSet.

Examples:

Request syntax with placeholder values


resp = client.describe_log_pattern({
  resource_group_name: "ResourceGroupName", # required
  pattern_set_name: "LogPatternSetName", # required
  pattern_name: "LogPatternName", # required
})

Response structure


resp.resource_group_name #=> String
resp.log_pattern.pattern_set_name #=> String
resp.log_pattern.pattern_name #=> String
resp.log_pattern.pattern #=> String
resp.log_pattern.rank #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :pattern_set_name (required, String)

    The name of the log pattern set.

  • :pattern_name (required, String)

    The name of the log pattern.

Returns:

See Also:



725
726
727
728
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 725

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

#describe_observation(params = {}) ⇒ 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
resp.observation.cloud_watch_event_id #=> String
resp.observation.cloud_watch_event_source #=> String, one of "EC2", "CODE_DEPLOY", "HEALTH"
resp.observation.cloud_watch_event_detail_type #=> String
resp.observation.health_event_arn #=> String
resp.observation.health_service #=> String
resp.observation.health_event_type_code #=> String
resp.observation.health_event_type_category #=> String
resp.observation.health_event_description #=> String
resp.observation.code_deploy_deployment_id #=> String
resp.observation.code_deploy_deployment_group #=> String
resp.observation.code_deploy_state #=> String
resp.observation.code_deploy_application #=> String
resp.observation.code_deploy_instance_group_id #=> String
resp.observation.ec2_state #=> String
resp.observation.x_ray_fault_percent #=> Integer
resp.observation.x_ray_throttle_percent #=> Integer
resp.observation.x_ray_error_percent #=> Integer
resp.observation.x_ray_request_count #=> Integer
resp.observation.x_ray_request_average_latency #=> Integer
resp.observation.x_ray_node_name #=> String
resp.observation.x_ray_node_type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :observation_id (required, String)

    The ID of the observation.

Returns:

See Also:



786
787
788
789
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 786

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

#describe_problem(params = {}) ⇒ 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"

Parameters:

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

    ({})

Options Hash (params):

  • :problem_id (required, String)

    The ID of the problem.

Returns:

See Also:



824
825
826
827
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 824

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

#describe_problem_observations(params = {}) ⇒ 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
resp.related_observations.observation_list[0].cloud_watch_event_id #=> String
resp.related_observations.observation_list[0].cloud_watch_event_source #=> String, one of "EC2", "CODE_DEPLOY", "HEALTH"
resp.related_observations.observation_list[0].cloud_watch_event_detail_type #=> String
resp.related_observations.observation_list[0].health_event_arn #=> String
resp.related_observations.observation_list[0].health_service #=> String
resp.related_observations.observation_list[0].health_event_type_code #=> String
resp.related_observations.observation_list[0].health_event_type_category #=> String
resp.related_observations.observation_list[0].health_event_description #=> String
resp.related_observations.observation_list[0].code_deploy_deployment_id #=> String
resp.related_observations.observation_list[0].code_deploy_deployment_group #=> String
resp.related_observations.observation_list[0].code_deploy_state #=> String
resp.related_observations.observation_list[0].code_deploy_application #=> String
resp.related_observations.observation_list[0].code_deploy_instance_group_id #=> String
resp.related_observations.observation_list[0].ec2_state #=> String
resp.related_observations.observation_list[0].x_ray_fault_percent #=> Integer
resp.related_observations.observation_list[0].x_ray_throttle_percent #=> Integer
resp.related_observations.observation_list[0].x_ray_error_percent #=> Integer
resp.related_observations.observation_list[0].x_ray_request_count #=> Integer
resp.related_observations.observation_list[0].x_ray_request_average_latency #=> Integer
resp.related_observations.observation_list[0].x_ray_node_name #=> String
resp.related_observations.observation_list[0].x_ray_node_type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :problem_id (required, String)

    The ID of the problem.

Returns:

See Also:



886
887
888
889
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 886

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

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

Lists the IDs of the applications that you are monitoring.

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_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 #=> Boolean
resp.application_info_list[0].cwe_monitor_enabled #=> Boolean
resp.application_info_list[0].remarks #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



930
931
932
933
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 930

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

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

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

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_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, one of "DEFAULT", "DOT_NET_CORE", "DOT_NET_WORKER", "DOT_NET_WEB", "SQL_SERVER"
resp.application_component_list[0].monitor #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



977
978
979
980
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 977

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

#list_configuration_history(params = {}) ⇒ Types::ListConfigurationHistoryResponse

Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights. Examples of events represented are:

  • INFO: creating a new alarm or updating an alarm threshold.

  • WARN: alarm not created due to insufficient data points used to predict thresholds.

  • ERROR: alarm not created due to permission errors or exceeding quotas.

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_configuration_history({
  resource_group_name: "ResourceGroupName",
  start_time: Time.now,
  end_time: Time.now,
  event_status: "INFO", # accepts INFO, WARN, ERROR
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.event_list #=> Array
resp.event_list[0].monitored_resource_arn #=> String
resp.event_list[0].event_status #=> String, one of "INFO", "WARN", "ERROR"
resp.event_list[0].event_resource_type #=> String, one of "CLOUDWATCH_ALARM", "CLOUDFORMATION", "SSM_ASSOCIATION"
resp.event_list[0].event_time #=> Time
resp.event_list[0].event_detail #=> String
resp.event_list[0].event_resource_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_group_name (String)

    Resource group to which the application belongs.

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

    The start time of the event.

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

    The end time of the event.

  • :event_status (String)

    The status of the configuration update event. Possible values include INFO, WARN, and ERROR.

  • :max_results (Integer)

    The maximum number of results returned by ListConfigurationHistory in paginated output. When this parameter is used, ListConfigurationHistory returns only MaxResults in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another ListConfigurationHistory request with the returned NextToken value. If this parameter is not used, then ListConfigurationHistory returns all results.

  • :next_token (String)

    The NextToken value returned from a previous paginated ListConfigurationHistory request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

Returns:

See Also:



1057
1058
1059
1060
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1057

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

#list_log_pattern_sets(params = {}) ⇒ Types::ListLogPatternSetsResponse

Lists the log pattern sets in the specific application.

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_log_pattern_sets({
  resource_group_name: "ResourceGroupName", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.resource_group_name #=> String
resp.log_pattern_sets #=> Array
resp.log_pattern_sets[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



1102
1103
1104
1105
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1102

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

#list_log_patterns(params = {}) ⇒ Types::ListLogPatternsResponse

Lists the log patterns in the specific log LogPatternSet.

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_log_patterns({
  resource_group_name: "ResourceGroupName", # required
  pattern_set_name: "LogPatternSetName",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.resource_group_name #=> String
resp.log_patterns #=> Array
resp.log_patterns[0].pattern_set_name #=> String
resp.log_patterns[0].pattern_name #=> String
resp.log_patterns[0].pattern #=> String
resp.log_patterns[0].rank #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :pattern_set_name (String)

    The name of the log pattern set.

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



1154
1155
1156
1157
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1154

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

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

Lists the problems with your application.

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_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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_group_name (String)

    The name of the resource group.

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

    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, DateTime, Date, Integer, String)

    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:



1218
1219
1220
1221
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1218

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

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

Retrieve a list of the tags (keys and values) that are associated with a specified application. A tag is a label that you optionally define and associate with an application. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Examples:

Request syntax with placeholder values


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

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the application that you want to retrieve tag information for.

Returns:

See Also:



1254
1255
1256
1257
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1254

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

#tag_resource(params = {}) ⇒ Struct

Add one or more tags (keys and values) to a specified application. A tag is a label that you optionally define and associate with an application. Tags can help you categorize and manage application in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the application that you want to add one or more tags to.

  • :tags (required, Array<Types::Tag>)

    A list of tags that to add to the application. A tag consists of a required tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1298
1299
1300
1301
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1298

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

#untag_resource(params = {}) ⇒ Struct

Remove one or more tags (keys and values) from a specified application.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String)

    The Amazon Resource Name (ARN) of the application that you want to remove one or more tags from.

  • :tag_keys (required, Array<String>)

    The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.

    To remove more than one tag from the application, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1332
1333
1334
1335
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1332

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

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

Updates the application.

Examples:

Request syntax with placeholder values


resp = client.update_application({
  resource_group_name: "ResourceGroupName", # required
  ops_center_enabled: false,
  cwe_monitor_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 #=> Boolean
resp.application_info.cwe_monitor_enabled #=> Boolean
resp.application_info.remarks #=> String

Parameters:

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

    ({})

Options Hash (params):

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

  • :cwe_monitor_enabled (Boolean)

    Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others.

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



1387
1388
1389
1390
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1387

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

#update_component(params = {}) ⇒ 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"],
})

Parameters:

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

    ({})

Options Hash (params):

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



1422
1423
1424
1425
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1422

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

#update_component_configuration(params = {}) ⇒ 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: "DEFAULT", # accepts DEFAULT, DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER
  component_configuration: "ComponentConfiguration",
})

Parameters:

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

    ({})

Options Hash (params):

  • :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, DOT_NET_CORE, 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. For the complete format of the component configuration file, see Component Configuration.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1475
1476
1477
1478
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1475

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

#update_log_pattern(params = {}) ⇒ Types::UpdateLogPatternResponse

Adds a log pattern to a LogPatternSet.

Examples:

Request syntax with placeholder values


resp = client.update_log_pattern({
  resource_group_name: "ResourceGroupName", # required
  pattern_set_name: "LogPatternSetName", # required
  pattern_name: "LogPatternName", # required
  pattern: "LogPatternRegex",
  rank: 1,
})

Response structure


resp.resource_group_name #=> String
resp.log_pattern.pattern_set_name #=> String
resp.log_pattern.pattern_name #=> String
resp.log_pattern.pattern #=> String
resp.log_pattern.rank #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :resource_group_name (required, String)

    The name of the resource group.

  • :pattern_set_name (required, String)

    The name of the log pattern set.

  • :pattern_name (required, String)

    The name of the log pattern.

  • :pattern (String)

    The log pattern.

  • :rank (Integer)

    Rank of the log pattern.

Returns:

See Also:



1524
1525
1526
1527
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1524

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