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
-
#add_workload(params = {}) ⇒ Types::AddWorkloadResponse
Adds a workload to a component.
-
#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.
-
#describe_workload(params = {}) ⇒ Types::DescribeWorkloadResponse
Describes a workload and its configuration.
-
#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.
-
#list_workloads(params = {}) ⇒ Types::ListWorkloadsResponse
Lists the workloads that are configured on a given component.
-
#remove_workload(params = {}) ⇒ Struct
Remove workload from a component.
-
#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. -
#update_problem(params = {}) ⇒ Struct
Updates the visibility of the problem or specifies the problem as
RESOLVED. -
#update_workload(params = {}) ⇒ Types::UpdateWorkloadResponse
Adds a workload to a component.
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.
486 487 488 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 486 def initialize(*args) super end |
Instance Method Details
#add_workload(params = {}) ⇒ Types::AddWorkloadResponse
Adds a workload to a component. Each component can have at most five workloads.
533 534 535 536 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 533 def add_workload(params = {}, = {}) req = build_request(:add_workload, params) req.send_request() end |
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Adds an application that is created from a resource group.
624 625 626 627 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 624 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.
655 656 657 658 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 655 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.
715 716 717 718 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 715 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.
738 739 740 741 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 738 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.
766 767 768 769 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 766 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.
796 797 798 799 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 796 def delete_log_pattern(params = {}, = {}) req = build_request(:delete_log_pattern, params) req.send_request() end |
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Describes the application.
838 839 840 841 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 838 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.
886 887 888 889 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 886 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.
926 927 928 929 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 926 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.
972 973 974 975 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 972 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.
1019 1020 1021 1022 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1019 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.
1095 1096 1097 1098 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1095 def describe_observation(params = {}, = {}) req = build_request(:describe_observation, params) req.send_request() end |
#describe_problem(params = {}) ⇒ Types::DescribeProblemResponse
Describes an application problem.
1146 1147 1148 1149 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1146 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.
1223 1224 1225 1226 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1223 def describe_problem_observations(params = {}, = {}) req = build_request(:describe_problem_observations, params) req.send_request() end |
#describe_workload(params = {}) ⇒ Types::DescribeWorkloadResponse
Describes a workload and its configuration.
1269 1270 1271 1272 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1269 def describe_workload(params = {}, = {}) req = build_request(:describe_workload, 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.
1322 1323 1324 1325 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1322 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.
1378 1379 1380 1381 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1378 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.
1464 1465 1466 1467 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1464 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.
1515 1516 1517 1518 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1515 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.
1573 1574 1575 1576 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1573 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.
1660 1661 1662 1663 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1660 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.
1696 1697 1698 1699 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1696 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_workloads(params = {}) ⇒ Types::ListWorkloadsResponse
Lists the workloads that are configured on a given component.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1752 1753 1754 1755 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1752 def list_workloads(params = {}, = {}) req = build_request(:list_workloads, params) req.send_request() end |
#remove_workload(params = {}) ⇒ Struct
Remove workload from a component.
1782 1783 1784 1785 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1782 def remove_workload(params = {}, = {}) req = build_request(:remove_workload, 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.
1826 1827 1828 1829 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1826 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.
1860 1861 1862 1863 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1860 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates the application.
1934 1935 1936 1937 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1934 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.
1969 1970 1971 1972 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1969 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.
2025 2026 2027 2028 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2025 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.
2085 2086 2087 2088 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2085 def update_log_pattern(params = {}, = {}) req = build_request(:update_log_pattern, params) req.send_request() end |
#update_problem(params = {}) ⇒ Struct
Updates the visibility of the problem or specifies the problem as
RESOLVED.
2120 2121 2122 2123 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2120 def update_problem(params = {}, = {}) req = build_request(:update_problem, params) req.send_request() end |
#update_workload(params = {}) ⇒ Types::UpdateWorkloadResponse
Adds a workload to a component. Each component can have at most five workloads.
2170 2171 2172 2173 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2170 def update_workload(params = {}, = {}) req = build_request(:update_workload, params) req.send_request() end |