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.
419 420 421 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 419 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.
466 467 468 469 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 466 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.
552 553 554 555 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 552 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.
583 584 585 586 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 583 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
.
643 644 645 646 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 643 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.
666 667 668 669 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 666 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.
694 695 696 697 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 694 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
.
724 725 726 727 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 724 def delete_log_pattern(params = {}, = {}) req = build_request(:delete_log_pattern, params) req.send_request() end |
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Describes the application.
765 766 767 768 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 765 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.
813 814 815 816 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 813 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.
853 854 855 856 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 853 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.
897 898 899 900 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 897 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
.
944 945 946 947 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 944 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.
1020 1021 1022 1023 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1020 def describe_observation(params = {}, = {}) req = build_request(:describe_observation, params) req.send_request() end |
#describe_problem(params = {}) ⇒ Types::DescribeProblemResponse
Describes an application problem.
1068 1069 1070 1071 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1068 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.
1145 1146 1147 1148 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1145 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.
1191 1192 1193 1194 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1191 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.
1243 1244 1245 1246 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1243 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.
1299 1300 1301 1302 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1299 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.
1385 1386 1387 1388 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1385 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.
1436 1437 1438 1439 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1436 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.
1494 1495 1496 1497 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1494 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.
1580 1581 1582 1583 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1580 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.
1616 1617 1618 1619 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1616 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.
1671 1672 1673 1674 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1671 def list_workloads(params = {}, = {}) req = build_request(:list_workloads, params) req.send_request() end |
#remove_workload(params = {}) ⇒ Struct
Remove workload from a component.
1701 1702 1703 1704 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1701 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.
1745 1746 1747 1748 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1745 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.
1779 1780 1781 1782 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1779 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates the application.
1847 1848 1849 1850 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1847 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.
1882 1883 1884 1885 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1882 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
.
1938 1939 1940 1941 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1938 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
.
1998 1999 2000 2001 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1998 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
.
2033 2034 2035 2036 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2033 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.
2083 2084 2085 2086 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2083 def update_workload(params = {}, = {}) req = build_request(:update_workload, params) req.send_request() end |