Class: Aws::ApplicationInsights::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ApplicationInsights::Client
- 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
API Operations collapse
-
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Adds an application that is created from a resource group.
-
#create_component(params = {}) ⇒ Struct
Creates a custom component by grouping similar standalone instances to monitor.
-
#create_log_pattern(params = {}) ⇒ Types::CreateLogPatternResponse
Adds an log pattern to a
LogPatternSet
. -
#delete_application(params = {}) ⇒ Struct
Removes the specified application from monitoring.
-
#delete_component(params = {}) ⇒ Struct
Ungroups a custom component.
-
#delete_log_pattern(params = {}) ⇒ Struct
Removes the specified log pattern from a
LogPatternSet
. -
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Describes the application.
-
#describe_component(params = {}) ⇒ Types::DescribeComponentResponse
Describes a component and lists the resources that are grouped together in a component.
-
#describe_component_configuration(params = {}) ⇒ Types::DescribeComponentConfigurationResponse
Describes the monitoring configuration of the component.
-
#describe_component_configuration_recommendation(params = {}) ⇒ Types::DescribeComponentConfigurationRecommendationResponse
Describes the recommended monitoring configuration of the component.
-
#describe_log_pattern(params = {}) ⇒ Types::DescribeLogPatternResponse
Describe a specific log pattern from a
LogPatternSet
. -
#describe_observation(params = {}) ⇒ Types::DescribeObservationResponse
Describes an anomaly or error with the application.
-
#describe_problem(params = {}) ⇒ Types::DescribeProblemResponse
Describes an application problem.
-
#describe_problem_observations(params = {}) ⇒ Types::DescribeProblemObservationsResponse
Describes the anomalies or errors associated with the problem.
-
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Lists the IDs of the applications that you are monitoring.
-
#list_components(params = {}) ⇒ Types::ListComponentsResponse
Lists the auto-grouped, standalone, and custom components of the application.
-
#list_configuration_history(params = {}) ⇒ Types::ListConfigurationHistoryResponse
Lists the INFO, WARN, and ERROR events for periodic configuration updates performed by Application Insights.
-
#list_log_pattern_sets(params = {}) ⇒ Types::ListLogPatternSetsResponse
Lists the log pattern sets in the specific application.
-
#list_log_patterns(params = {}) ⇒ Types::ListLogPatternsResponse
Lists the log patterns in the specific log
LogPatternSet
. -
#list_problems(params = {}) ⇒ Types::ListProblemsResponse
Lists the problems with your application.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieve a list of the tags (keys and values) that are associated with a specified application.
-
#tag_resource(params = {}) ⇒ Struct
Add one or more tags (keys and values) to a specified application.
-
#untag_resource(params = {}) ⇒ Struct
Remove one or more tags (keys and values) from a specified application.
-
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates the application.
-
#update_component(params = {}) ⇒ Struct
Updates the custom component name and/or the list of resources that make up the component.
-
#update_component_configuration(params = {}) ⇒ Struct
Updates the monitoring configurations for the component.
-
#update_log_pattern(params = {}) ⇒ Types::UpdateLogPatternResponse
Adds a log pattern to a
LogPatternSet
.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
334 335 336 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Adds an application that is created from a resource group.
396 397 398 399 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 396 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_component(params = {}) ⇒ Struct
Creates a custom component by grouping similar standalone instances to monitor.
427 428 429 430 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 427 def create_component(params = {}, = {}) req = build_request(:create_component, params) req.send_request() end |
#create_log_pattern(params = {}) ⇒ Types::CreateLogPatternResponse
Adds an log pattern to a LogPatternSet
.
487 488 489 490 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 487 def create_log_pattern(params = {}, = {}) req = build_request(:create_log_pattern, params) req.send_request() end |
#delete_application(params = {}) ⇒ Struct
Removes the specified application from monitoring. Does not delete the application.
510 511 512 513 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 510 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() 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.
538 539 540 541 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 538 def delete_component(params = {}, = {}) req = build_request(:delete_component, params) req.send_request() end |
#delete_log_pattern(params = {}) ⇒ Struct
Removes the specified log pattern from a LogPatternSet
.
568 569 570 571 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 568 def delete_log_pattern(params = {}, = {}) req = build_request(:delete_log_pattern, params) req.send_request() end |
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Describes the application.
601 602 603 604 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 601 def describe_application(params = {}, = {}) req = build_request(:describe_application, params) req.send_request() end |
#describe_component(params = {}) ⇒ Types::DescribeComponentResponse
Describes a component and lists the resources that are grouped together in a component.
645 646 647 648 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 645 def describe_component(params = {}, = {}) req = build_request(:describe_component, params) req.send_request() end |
#describe_component_configuration(params = {}) ⇒ Types::DescribeComponentConfigurationResponse
Describes the monitoring configuration of the component.
681 682 683 684 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 681 def describe_component_configuration(params = {}, = {}) req = build_request(:describe_component_configuration, params) req.send_request() end |
#describe_component_configuration_recommendation(params = {}) ⇒ Types::DescribeComponentConfigurationRecommendationResponse
Describes the recommended monitoring configuration of the component.
719 720 721 722 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 719 def describe_component_configuration_recommendation(params = {}, = {}) req = build_request(:describe_component_configuration_recommendation, params) req.send_request() end |
#describe_log_pattern(params = {}) ⇒ Types::DescribeLogPatternResponse
Describe a specific log pattern from a LogPatternSet
.
760 761 762 763 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 760 def describe_log_pattern(params = {}, = {}) req = build_request(:describe_log_pattern, params) req.send_request() end |
#describe_observation(params = {}) ⇒ Types::DescribeObservationResponse
Describes an anomaly or error with the application.
832 833 834 835 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 832 def describe_observation(params = {}, = {}) req = build_request(:describe_observation, params) req.send_request() end |
#describe_problem(params = {}) ⇒ Types::DescribeProblemResponse
Describes an application problem.
870 871 872 873 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 870 def describe_problem(params = {}, = {}) req = build_request(:describe_problem, params) req.send_request() end |
#describe_problem_observations(params = {}) ⇒ Types::DescribeProblemObservationsResponse
Describes the anomalies or errors associated with the problem.
943 944 945 946 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 943 def describe_problem_observations(params = {}, = {}) req = build_request(:describe_problem_observations, params) req.send_request() 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.
987 988 989 990 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 987 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() 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.
1039 1040 1041 1042 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1039 def list_components(params = {}, = {}) req = build_request(:list_components, params) req.send_request() 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.
1119 1120 1121 1122 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1119 def list_configuration_history(params = {}, = {}) req = build_request(:list_configuration_history, params) req.send_request() 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.
1164 1165 1166 1167 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1164 def list_log_pattern_sets(params = {}, = {}) req = build_request(:list_log_pattern_sets, params) req.send_request() 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.
1216 1217 1218 1219 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1216 def list_log_patterns(params = {}, = {}) req = build_request(:list_log_patterns, params) req.send_request() 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.
1280 1281 1282 1283 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1280 def list_problems(params = {}, = {}) req = build_request(:list_problems, params) req.send_request() 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.
1316 1317 1318 1319 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1316 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() 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.
1360 1361 1362 1363 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1360 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove one or more tags (keys and values) from a specified application.
1394 1395 1396 1397 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1394 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates the application.
1449 1450 1451 1452 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1449 def update_application(params = {}, = {}) req = build_request(:update_application, params) req.send_request() end |
#update_component(params = {}) ⇒ Struct
Updates the custom component name and/or the list of resources that make up the component.
1484 1485 1486 1487 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1484 def update_component(params = {}, = {}) req = build_request(:update_component, params) req.send_request() 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
.
1537 1538 1539 1540 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1537 def update_component_configuration(params = {}, = {}) req = build_request(:update_component_configuration, params) req.send_request() end |
#update_log_pattern(params = {}) ⇒ Types::UpdateLogPatternResponse
Adds a log pattern to a LogPatternSet
.
1597 1598 1599 1600 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1597 def update_log_pattern(params = {}, = {}) req = build_request(:update_log_pattern, params) req.send_request() end |