# WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE require 'seahorse/client/plugins/content_length.rb' require 'aws-sdk-core/plugins/credentials_configuration.rb' require 'aws-sdk-core/plugins/logging.rb' require 'aws-sdk-core/plugins/param_converter.rb' require 'aws-sdk-core/plugins/param_validator.rb' require 'aws-sdk-core/plugins/user_agent.rb' require 'aws-sdk-core/plugins/helpful_socket_errors.rb' require 'aws-sdk-core/plugins/retry_errors.rb' require 'aws-sdk-core/plugins/global_configuration.rb' require 'aws-sdk-core/plugins/regional_endpoint.rb' require 'aws-sdk-core/plugins/endpoint_discovery.rb' require 'aws-sdk-core/plugins/endpoint_pattern.rb' require 'aws-sdk-core/plugins/response_paging.rb' require 'aws-sdk-core/plugins/stub_responses.rb' require 'aws-sdk-core/plugins/idempotency_token.rb' require 'aws-sdk-core/plugins/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/client_metrics_plugin.rb' require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb' require 'aws-sdk-core/plugins/transfer_encoding.rb' require 'aws-sdk-core/plugins/signature_v4.rb' require 'aws-sdk-core/plugins/protocols/json_rpc.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:applicationinsights) module Aws::ApplicationInsights class Client < Seahorse::Client::Base include Aws::ClientStubs @identifier = :applicationinsights set_api(ClientApi::API) add_plugin(Seahorse::Client::Plugins::ContentLength) add_plugin(Aws::Plugins::CredentialsConfiguration) add_plugin(Aws::Plugins::Logging) add_plugin(Aws::Plugins::ParamConverter) add_plugin(Aws::Plugins::ParamValidator) add_plugin(Aws::Plugins::UserAgent) add_plugin(Aws::Plugins::HelpfulSocketErrors) add_plugin(Aws::Plugins::RetryErrors) add_plugin(Aws::Plugins::GlobalConfiguration) add_plugin(Aws::Plugins::RegionalEndpoint) add_plugin(Aws::Plugins::EndpointDiscovery) add_plugin(Aws::Plugins::EndpointPattern) add_plugin(Aws::Plugins::ResponsePaging) add_plugin(Aws::Plugins::StubResponses) add_plugin(Aws::Plugins::IdempotencyToken) add_plugin(Aws::Plugins::JsonvalueConverter) add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) add_plugin(Aws::Plugins::TransferEncoding) add_plugin(Aws::Plugins::SignatureV4) add_plugin(Aws::Plugins::Protocols::JsonRpc) # @overload initialize(options) # @param [Hash] options # @option options [required, Aws::CredentialProvider] :credentials # 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. # # @option options [required, String] :region # The AWS region to connect to. The configured `:region` is # used to determine the service `:endpoint`. When not passed, # a default `:region` is search for in the following locations: # # * `Aws.config[:region]` # * `ENV['AWS_REGION']` # * `ENV['AMAZON_REGION']` # * `ENV['AWS_DEFAULT_REGION']` # * `~/.aws/credentials` # * `~/.aws/config` # # @option options [String] :access_key_id # # @option options [Boolean] :active_endpoint_cache (false) # When set to `true`, a thread polling for endpoints will be running in # the background every 60 secs (default). Defaults to `false`. # # @option options [Boolean] :client_side_monitoring (false) # When `true`, client-side metrics will be collected for all API requests from # this client. # # @option options [String] :client_side_monitoring_client_id ("") # Allows you to provide an identifier for this client which will be attached to # all generated client side metrics. Defaults to an empty string. # # @option options [String] :client_side_monitoring_host ("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. # # @option options [Integer] :client_side_monitoring_port (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. # # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) # Allows you to provide a custom client-side monitoring publisher class. By default, # will use the Client Side Monitoring Agent Publisher. # # @option options [Boolean] :convert_params (true) # When `true`, an attempt is made to coerce request parameters into # the required types. # # @option options [Boolean] :disable_host_prefix_injection (false) # Set to true to disable SDK automatically adding host prefix # to default service endpoint when available. # # @option options [String] :endpoint # The client endpoint is normally constructed from the `:region` # option. You should only configure an `:endpoint` when connecting # to test endpoints. This should be avalid HTTP(S) URI. # # @option options [Integer] :endpoint_cache_max_entries (1000) # Used for the maximum size limit of the LRU cache storing endpoints data # for endpoint discovery enabled operations. Defaults to 1000. # # @option options [Integer] :endpoint_cache_max_threads (10) # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. # # @option options [Integer] :endpoint_cache_poll_interval (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. # # @option options [Boolean] :endpoint_discovery (false) # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`. # # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) # The log formatter. # # @option options [Symbol] :log_level (:info) # The log level to send messages to the `:logger` at. # # @option options [Logger] :logger # The Logger instance to send log messages to. If this option # is not set, logging will be disabled. # # @option options [String] :profile ("default") # Used when loading credentials from the shared credentials file # at HOME/.aws/credentials. When not specified, 'default' is used. # # @option options [Float] :retry_base_delay (0.3) # The base delay in seconds used by the default backoff function. # # @option options [Symbol] :retry_jitter (: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. # # @see https://www.awsarchitectureblog.com/2015/03/backoff.html # # @option options [Integer] :retry_limit (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. # # @option options [Integer] :retry_max_delay (0) # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Boolean] :simple_json (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. # # @option options [Boolean] :stub_responses (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. # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # # @option options [URI::HTTP,String] :http_proxy A proxy to send # requests through. Formatted like 'http://proxy.com:123'. # # @option options [Float] :http_open_timeout (15) The number of # seconds to wait when opening a HTTP session before rasing a # `Timeout::Error`. # # @option options [Integer] :http_read_timeout (60) The default # number of seconds to wait for response data. This value can # safely be set # per-request on the session yeidled by {#session_for}. # # @option options [Float] :http_idle_timeout (5) The number of # seconds a connection is allowed to sit idble before it is # considered stale. Stale connections are closed and removed # from the pool before making a request. # # @option options [Float] :http_continue_timeout (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 yeidled by {#session_for}. # # @option options [Boolean] :http_wire_trace (false) When `true`, # HTTP debug output will be sent to the `:logger`. # # @option options [Boolean] :ssl_verify_peer (true) When `true`, # SSL peer certificates are verified when establishing a # connection. # # @option options [String] :ssl_ca_bundle 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. # # @option options [String] :ssl_ca_directory 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. # def initialize(*args) super end # @!group API Operations # Adds an application that is created from a resource group. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [Boolean] :ops_center_enabled # When set to `true`, creates opsItems for any problems detected on an # application. # # @option params [String] :ops_item_sns_topic_arn # The SNS topic provided to Application Insights that is associated to # the created opsItem. Allows you to receive notifications for updates # to the opsItem. # # @option params [Array] :tags # 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. # # @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateApplicationResponse#application_info #application_info} => Types::ApplicationInfo # # @example Request syntax with placeholder values # # resp = client.create_application({ # resource_group_name: "ResourceGroupName", # required # ops_center_enabled: false, # ops_item_sns_topic_arn: "OpsItemSNSTopicArn", # tags: [ # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # }) # # @example 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.remarks #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/CreateApplication AWS API Documentation # # @overload create_application(params = {}) # @param [Hash] params ({}) def create_application(params = {}, options = {}) req = build_request(:create_application, params) req.send_request(options) end # Creates a custom component by grouping similar standalone instances to # monitor. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [required, String] :component_name # The name of the component. # # @option params [required, Array] :resource_list # The list of resource ARNs that belong to the component. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.create_component({ # resource_group_name: "ResourceGroupName", # required # component_name: "ComponentName", # required # resource_list: ["ResourceARN"], # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/CreateComponent AWS API Documentation # # @overload create_component(params = {}) # @param [Hash] params ({}) def create_component(params = {}, options = {}) req = build_request(:create_component, params) req.send_request(options) end # Adds an log pattern to a `LogPatternSet`. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [required, String] :pattern_set_name # The name of the log pattern set. # # @option params [required, String] :pattern_name # The name of the log pattern. # # @option params [required, String] :pattern # The log pattern. # # @option params [required, Integer] :rank # Rank of the log pattern. # # @return [Types::CreateLogPatternResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateLogPatternResponse#log_pattern #log_pattern} => Types::LogPattern # * {Types::CreateLogPatternResponse#resource_group_name #resource_group_name} => String # # @example 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 # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/CreateLogPattern AWS API Documentation # # @overload create_log_pattern(params = {}) # @param [Hash] params ({}) def create_log_pattern(params = {}, options = {}) req = build_request(:create_log_pattern, params) req.send_request(options) end # Removes the specified application from monitoring. Does not delete the # application. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_application({ # resource_group_name: "ResourceGroupName", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DeleteApplication AWS API Documentation # # @overload delete_application(params = {}) # @param [Hash] params ({}) def delete_application(params = {}, options = {}) req = build_request(:delete_application, params) req.send_request(options) end # 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. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [required, String] :component_name # The name of the component. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_component({ # resource_group_name: "ResourceGroupName", # required # component_name: "ComponentName", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DeleteComponent AWS API Documentation # # @overload delete_component(params = {}) # @param [Hash] params ({}) def delete_component(params = {}, options = {}) req = build_request(:delete_component, params) req.send_request(options) end # Removes the specified log pattern from a `LogPatternSet`. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [required, String] :pattern_set_name # The name of the log pattern set. # # @option params [required, String] :pattern_name # The name of the log pattern. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_log_pattern({ # resource_group_name: "ResourceGroupName", # required # pattern_set_name: "LogPatternSetName", # required # pattern_name: "LogPatternName", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DeleteLogPattern AWS API Documentation # # @overload delete_log_pattern(params = {}) # @param [Hash] params ({}) def delete_log_pattern(params = {}, options = {}) req = build_request(:delete_log_pattern, params) req.send_request(options) end # Describes the application. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @return [Types::DescribeApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeApplicationResponse#application_info #application_info} => Types::ApplicationInfo # # @example Request syntax with placeholder values # # resp = client.describe_application({ # resource_group_name: "ResourceGroupName", # required # }) # # @example 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.remarks #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeApplication AWS API Documentation # # @overload describe_application(params = {}) # @param [Hash] params ({}) def describe_application(params = {}, options = {}) req = build_request(:describe_application, params) req.send_request(options) end # Describes a component and lists the resources that are grouped # together in a component. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [required, String] :component_name # The name of the component. # # @return [Types::DescribeComponentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeComponentResponse#application_component #application_component} => Types::ApplicationComponent # * {Types::DescribeComponentResponse#resource_list #resource_list} => Array<String> # # @example Request syntax with placeholder values # # resp = client.describe_component({ # resource_group_name: "ResourceGroupName", # required # component_name: "ComponentName", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeComponent AWS API Documentation # # @overload describe_component(params = {}) # @param [Hash] params ({}) def describe_component(params = {}, options = {}) req = build_request(:describe_component, params) req.send_request(options) end # Describes the monitoring configuration of the component. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [required, String] :component_name # The name of the component. # # @return [Types::DescribeComponentConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeComponentConfigurationResponse#monitor #monitor} => Boolean # * {Types::DescribeComponentConfigurationResponse#tier #tier} => String # * {Types::DescribeComponentConfigurationResponse#component_configuration #component_configuration} => String # # @example Request syntax with placeholder values # # resp = client.describe_component_configuration({ # resource_group_name: "ResourceGroupName", # required # component_name: "ComponentName", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeComponentConfiguration AWS API Documentation # # @overload describe_component_configuration(params = {}) # @param [Hash] params ({}) def describe_component_configuration(params = {}, options = {}) req = build_request(:describe_component_configuration, params) req.send_request(options) end # Describes the recommended monitoring configuration of the component. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [required, String] :component_name # The name of the component. # # @option params [required, String] :tier # The tier of the application component. Supported tiers include # `DOT_NET_CORE`, `DOT_NET_WORKER`, `DOT_NET_WEB`, `SQL_SERVER`, and # `DEFAULT`. # # @return [Types::DescribeComponentConfigurationRecommendationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeComponentConfigurationRecommendationResponse#component_configuration #component_configuration} => String # # @example 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 # }) # # @example Response structure # # resp.component_configuration #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeComponentConfigurationRecommendation AWS API Documentation # # @overload describe_component_configuration_recommendation(params = {}) # @param [Hash] params ({}) def describe_component_configuration_recommendation(params = {}, options = {}) req = build_request(:describe_component_configuration_recommendation, params) req.send_request(options) end # Describe a specific log pattern from a `LogPatternSet`. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [required, String] :pattern_set_name # The name of the log pattern set. # # @option params [required, String] :pattern_name # The name of the log pattern. # # @return [Types::DescribeLogPatternResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeLogPatternResponse#resource_group_name #resource_group_name} => String # * {Types::DescribeLogPatternResponse#log_pattern #log_pattern} => Types::LogPattern # # @example Request syntax with placeholder values # # resp = client.describe_log_pattern({ # resource_group_name: "ResourceGroupName", # required # pattern_set_name: "LogPatternSetName", # required # pattern_name: "LogPatternName", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeLogPattern AWS API Documentation # # @overload describe_log_pattern(params = {}) # @param [Hash] params ({}) def describe_log_pattern(params = {}, options = {}) req = build_request(:describe_log_pattern, params) req.send_request(options) end # Describes an anomaly or error with the application. # # @option params [required, String] :observation_id # The ID of the observation. # # @return [Types::DescribeObservationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeObservationResponse#observation #observation} => Types::Observation # # @example Request syntax with placeholder values # # resp = client.describe_observation({ # observation_id: "ObservationId", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeObservation AWS API Documentation # # @overload describe_observation(params = {}) # @param [Hash] params ({}) def describe_observation(params = {}, options = {}) req = build_request(:describe_observation, params) req.send_request(options) end # Describes an application problem. # # @option params [required, String] :problem_id # The ID of the problem. # # @return [Types::DescribeProblemResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeProblemResponse#problem #problem} => Types::Problem # # @example Request syntax with placeholder values # # resp = client.describe_problem({ # problem_id: "ProblemId", # required # }) # # @example 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" # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeProblem AWS API Documentation # # @overload describe_problem(params = {}) # @param [Hash] params ({}) def describe_problem(params = {}, options = {}) req = build_request(:describe_problem, params) req.send_request(options) end # Describes the anomalies or errors associated with the problem. # # @option params [required, String] :problem_id # The ID of the problem. # # @return [Types::DescribeProblemObservationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeProblemObservationsResponse#related_observations #related_observations} => Types::RelatedObservations # # @example Request syntax with placeholder values # # resp = client.describe_problem_observations({ # problem_id: "ProblemId", # required # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeProblemObservations AWS API Documentation # # @overload describe_problem_observations(params = {}) # @param [Hash] params ({}) def describe_problem_observations(params = {}, options = {}) req = build_request(:describe_problem_observations, params) req.send_request(options) end # Lists the IDs of the applications that you are monitoring. # # @option params [Integer] :max_results # The maximum number of results to return in a single call. To retrieve # the remaining results, make another call with the returned `NextToken` # value. # # @option params [String] :next_token # The token to request the next page of results. # # @return [Types::ListApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListApplicationsResponse#application_info_list #application_info_list} => Array<Types::ApplicationInfo> # * {Types::ListApplicationsResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.list_applications({ # max_results: 1, # next_token: "PaginationToken", # }) # # @example 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].remarks #=> String # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/ListApplications AWS API Documentation # # @overload list_applications(params = {}) # @param [Hash] params ({}) def list_applications(params = {}, options = {}) req = build_request(:list_applications, params) req.send_request(options) end # Lists the auto-grouped, standalone, and custom components of the # application. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [Integer] :max_results # The maximum number of results to return in a single call. To retrieve # the remaining results, make another call with the returned `NextToken` # value. # # @option params [String] :next_token # The token to request the next page of results. # # @return [Types::ListComponentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListComponentsResponse#application_component_list #application_component_list} => Array<Types::ApplicationComponent> # * {Types::ListComponentsResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.list_components({ # resource_group_name: "ResourceGroupName", # required # max_results: 1, # next_token: "PaginationToken", # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/ListComponents AWS API Documentation # # @overload list_components(params = {}) # @param [Hash] params ({}) def list_components(params = {}, options = {}) req = build_request(:list_components, params) req.send_request(options) end # Lists the log pattern sets in the specific application. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [Integer] :max_results # The maximum number of results to return in a single call. To retrieve # the remaining results, make another call with the returned `NextToken` # value. # # @option params [String] :next_token # The token to request the next page of results. # # @return [Types::ListLogPatternSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListLogPatternSetsResponse#resource_group_name #resource_group_name} => String # * {Types::ListLogPatternSetsResponse#log_pattern_sets #log_pattern_sets} => Array<String> # * {Types::ListLogPatternSetsResponse#next_token #next_token} => String # # @example Request syntax with placeholder values # # resp = client.list_log_pattern_sets({ # resource_group_name: "ResourceGroupName", # required # max_results: 1, # next_token: "PaginationToken", # }) # # @example Response structure # # resp.resource_group_name #=> String # resp.log_pattern_sets #=> Array # resp.log_pattern_sets[0] #=> String # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/ListLogPatternSets AWS API Documentation # # @overload list_log_pattern_sets(params = {}) # @param [Hash] params ({}) def list_log_pattern_sets(params = {}, options = {}) req = build_request(:list_log_pattern_sets, params) req.send_request(options) end # Lists the log patterns in the specific log `LogPatternSet`. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [String] :pattern_set_name # The name of the log pattern set. # # @option params [Integer] :max_results # The maximum number of results to return in a single call. To retrieve # the remaining results, make another call with the returned `NextToken` # value. # # @option params [String] :next_token # The token to request the next page of results. # # @return [Types::ListLogPatternsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListLogPatternsResponse#resource_group_name #resource_group_name} => String # * {Types::ListLogPatternsResponse#log_patterns #log_patterns} => Array<Types::LogPattern> # * {Types::ListLogPatternsResponse#next_token #next_token} => String # # @example 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", # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/ListLogPatterns AWS API Documentation # # @overload list_log_patterns(params = {}) # @param [Hash] params ({}) def list_log_patterns(params = {}, options = {}) req = build_request(:list_log_patterns, params) req.send_request(options) end # Lists the problems with your application. # # @option params [String] :resource_group_name # The name of the resource group. # # @option params [Time,DateTime,Date,Integer,String] :start_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. # # @option params [Time,DateTime,Date,Integer,String] :end_time # The time when the problem ended, in epoch seconds. If not specified, # problems within the past seven days are returned. # # @option params [Integer] :max_results # The maximum number of results to return in a single call. To retrieve # the remaining results, make another call with the returned `NextToken` # value. # # @option params [String] :next_token # The token to request the next page of results. # # @return [Types::ListProblemsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListProblemsResponse#problem_list #problem_list} => Array<Types::Problem> # * {Types::ListProblemsResponse#next_token #next_token} => String # # @example 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", # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/ListProblems AWS API Documentation # # @overload list_problems(params = {}) # @param [Hash] params ({}) def list_problems(params = {}, options = {}) req = build_request(:list_problems, params) req.send_request(options) end # 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. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the application that you want to # retrieve tag information for. # # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForResourceResponse#tags #tags} => Array<Types::Tag> # # @example Request syntax with placeholder values # # resp = client.list_tags_for_resource({ # resource_arn: "AmazonResourceName", # required # }) # # @example Response structure # # resp.tags #=> Array # resp.tags[0].key #=> String # resp.tags[0].value #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/ListTagsForResource AWS API Documentation # # @overload list_tags_for_resource(params = {}) # @param [Hash] params ({}) def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end # 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. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the application that you want to add # one or more tags to. # # @option params [required, Array] :tags # 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. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.tag_resource({ # resource_arn: "AmazonResourceName", # required # tags: [ # required # { # key: "TagKey", # required # value: "TagValue", # required # }, # ], # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/TagResource AWS API Documentation # # @overload tag_resource(params = {}) # @param [Hash] params ({}) def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end # Remove one or more tags (keys and values) from a specified # application. # # @option params [required, String] :resource_arn # The Amazon Resource Name (ARN) of the application that you want to # remove one or more tags from. # # @option params [required, Array] :tag_keys # 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. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.untag_resource({ # resource_arn: "AmazonResourceName", # required # tag_keys: ["TagKey"], # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/UntagResource AWS API Documentation # # @overload untag_resource(params = {}) # @param [Hash] params ({}) def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end # Updates the application. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [Boolean] :ops_center_enabled # When set to `true`, creates opsItems for any problems detected on an # application. # # @option params [String] :ops_item_sns_topic_arn # The SNS topic provided to Application Insights that is associated to # the created opsItem. Allows you to receive notifications for updates # to the opsItem. # # @option params [Boolean] :remove_sns_topic # Disassociates the SNS topic from the opsItem created for detected # problems. # # @return [Types::UpdateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateApplicationResponse#application_info #application_info} => Types::ApplicationInfo # # @example 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, # }) # # @example 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.remarks #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/UpdateApplication AWS API Documentation # # @overload update_application(params = {}) # @param [Hash] params ({}) def update_application(params = {}, options = {}) req = build_request(:update_application, params) req.send_request(options) end # Updates the custom component name and/or the list of resources that # make up the component. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [required, String] :component_name # The name of the component. # # @option params [String] :new_component_name # The new name of the component. # # @option params [Array] :resource_list # The list of resource ARNs that belong to the component. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example 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"], # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/UpdateComponent AWS API Documentation # # @overload update_component(params = {}) # @param [Hash] params ({}) def update_component(params = {}, options = {}) req = build_request(:update_component, params) req.send_request(options) end # 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`. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [required, String] :component_name # The name of the component. # # @option params [Boolean] :monitor # Indicates whether the application component is monitored. # # @option params [String] :tier # The tier of the application component. Supported tiers include # `DOT_NET_WORKER`, `DOT_NET_WEB`, `DOT_NET_CORE`, `SQL_SERVER`, and # `DEFAULT`. # # @option params [String] :component_configuration # 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][1]. 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][2]. # # # # [1]: https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/working-with-json.html # [2]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/component-config.html # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example 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", # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/UpdateComponentConfiguration AWS API Documentation # # @overload update_component_configuration(params = {}) # @param [Hash] params ({}) def update_component_configuration(params = {}, options = {}) req = build_request(:update_component_configuration, params) req.send_request(options) end # Adds a log pattern to a `LogPatternSet`. # # @option params [required, String] :resource_group_name # The name of the resource group. # # @option params [required, String] :pattern_set_name # The name of the log pattern set. # # @option params [required, String] :pattern_name # The name of the log pattern. # # @option params [String] :pattern # The log pattern. # # @option params [Integer] :rank # Rank of the log pattern. # # @return [Types::UpdateLogPatternResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateLogPatternResponse#resource_group_name #resource_group_name} => String # * {Types::UpdateLogPatternResponse#log_pattern #log_pattern} => Types::LogPattern # # @example 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, # }) # # @example 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 # # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/UpdateLogPattern AWS API Documentation # # @overload update_log_pattern(params = {}) # @param [Hash] params ({}) def update_log_pattern(params = {}, options = {}) req = build_request(:update_log_pattern, params) req.send_request(options) end # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-applicationinsights' context[:gem_version] = '1.5.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated def waiter_names [] end class << self # @api private attr_reader :identifier # @api private def errors_module Errors end end end end