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.
451 452 453 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 451 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.
498 499 500 501 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 498 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.
584 585 586 587 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 584 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.
615 616 617 618 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 615 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
.
675 676 677 678 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 675 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.
698 699 700 701 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 698 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.
726 727 728 729 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 726 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
.
756 757 758 759 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 756 def delete_log_pattern(params = {}, = {}) req = build_request(:delete_log_pattern, params) req.send_request() end |
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Describes the application.
797 798 799 800 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 797 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.
845 846 847 848 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 845 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.
885 886 887 888 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 885 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.
929 930 931 932 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 929 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
.
976 977 978 979 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 976 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.
1052 1053 1054 1055 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1052 def describe_observation(params = {}, = {}) req = build_request(:describe_observation, params) req.send_request() end |
#describe_problem(params = {}) ⇒ Types::DescribeProblemResponse
Describes an application problem.
1100 1101 1102 1103 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1100 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.
1177 1178 1179 1180 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1177 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.
1223 1224 1225 1226 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1223 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.
1275 1276 1277 1278 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1275 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.
1331 1332 1333 1334 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1331 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.
1417 1418 1419 1420 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1417 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.
1468 1469 1470 1471 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1468 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.
1526 1527 1528 1529 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1526 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.
1612 1613 1614 1615 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1612 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.
1648 1649 1650 1651 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1648 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.
1703 1704 1705 1706 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1703 def list_workloads(params = {}, = {}) req = build_request(:list_workloads, params) req.send_request() end |
#remove_workload(params = {}) ⇒ Struct
Remove workload from a component.
1733 1734 1735 1736 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1733 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.
1777 1778 1779 1780 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1777 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.
1811 1812 1813 1814 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1811 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates the application.
1879 1880 1881 1882 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1879 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.
1914 1915 1916 1917 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1914 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
.
1970 1971 1972 1973 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1970 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
.
2030 2031 2032 2033 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2030 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
.
2065 2066 2067 2068 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2065 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.
2115 2116 2117 2118 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2115 def update_workload(params = {}, = {}) req = build_request(:update_workload, params) req.send_request() end |