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

Class: Aws::ApplicationInsights::Client

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

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 search 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.

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

  • :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 avalid 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. Defaults to false.

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

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

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

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function.

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

    @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 and auth errors from expired credentials.

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

  • :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 rasing 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 yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 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.

  • :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 yeidled by #session_for.

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



261
262
263
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 261

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,
  ops_item_sns_topic_arn: "OpsItemSNSTopicArn",
})

Response structure


resp.application_info.resource_group_name #=> String
resp.application_info.life_cycle #=> String
resp.application_info.ops_item_sns_topic_arn #=> String
resp.application_info.ops_center_enabled #=> 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.

  • :ops_item_sns_topic_arn (String) —

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

Returns:

See Also:



305
306
307
308
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 305

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:



336
337
338
339
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 336

def create_component(params = {}, options = {})
  req = build_request(:create_component, 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:



359
360
361
362
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 359

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:



387
388
389
390
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 387

def delete_component(params = {}, options = {})
  req = build_request(:delete_component, 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.remarks #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_group_name (required, String) —

    The name of the resource group.

Returns:

See Also:



419
420
421
422
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 419

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



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

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



494
495
496
497
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 494

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: "Tier", # required
})

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_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT.

Returns:

See Also:



531
532
533
534
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 531

def describe_component_configuration_recommendation(params = {}, options = {})
  req = build_request(:describe_component_configuration_recommendation, 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

Parameters:

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

    ({})

Options Hash (params):

  • :observation_id (required, String) —

    The ID of the observation.

Returns:

See Also:



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

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:



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

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

Parameters:

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

    ({})

Options Hash (params):

  • :problem_id (required, String) —

    The ID of the problem.

Returns:

See Also:



650
651
652
653
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 650

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.

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



691
692
693
694
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 691

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.

Examples:

Request syntax with placeholder values


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

Response structure


resp.application_component_list #=> Array
resp.application_component_list[0].component_name #=> String
resp.application_component_list[0].resource_type #=> String
resp.application_component_list[0].tier #=> String
resp.application_component_list[0].monitor #=> 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:



736
737
738
739
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 736

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

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

Lists the problems with your application.

Examples:

Request syntax with placeholder values


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

Response structure


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

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:



798
799
800
801
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 798

def list_problems(params = {}, options = {})
  req = build_request(:list_problems, 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,
  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.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.

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



846
847
848
849
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 846

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:



881
882
883
884
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 881

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: "Tier",
  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, SQL_SERVER, and DEFAULT.

  • :component_configuration (String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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