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.
429 430 431 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 429 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.
476 477 478 479 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 476 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.
562 563 564 565 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 562 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.
593 594 595 596 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 593 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
.
653 654 655 656 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 653 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.
676 677 678 679 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 676 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.
704 705 706 707 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 704 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
.
734 735 736 737 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 734 def delete_log_pattern(params = {}, = {}) req = build_request(:delete_log_pattern, params) req.send_request() end |
#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse
Describes the application.
775 776 777 778 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 775 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.
823 824 825 826 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 823 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.
863 864 865 866 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 863 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.
907 908 909 910 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 907 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
.
954 955 956 957 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 954 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.
1030 1031 1032 1033 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1030 def describe_observation(params = {}, = {}) req = build_request(:describe_observation, params) req.send_request() end |
#describe_problem(params = {}) ⇒ Types::DescribeProblemResponse
Describes an application problem.
1078 1079 1080 1081 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1078 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.
1155 1156 1157 1158 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1155 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.
1201 1202 1203 1204 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1201 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.
1253 1254 1255 1256 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1253 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.
1309 1310 1311 1312 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1309 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.
1395 1396 1397 1398 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1395 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.
1446 1447 1448 1449 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1446 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.
1504 1505 1506 1507 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1504 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.
1590 1591 1592 1593 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1590 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.
1626 1627 1628 1629 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1626 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.
1681 1682 1683 1684 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1681 def list_workloads(params = {}, = {}) req = build_request(:list_workloads, params) req.send_request() end |
#remove_workload(params = {}) ⇒ Struct
Remove workload from a component.
1711 1712 1713 1714 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1711 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.
1755 1756 1757 1758 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1755 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.
1789 1790 1791 1792 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1789 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_application(params = {}) ⇒ Types::UpdateApplicationResponse
Updates the application.
1857 1858 1859 1860 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1857 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.
1892 1893 1894 1895 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1892 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
.
1948 1949 1950 1951 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1948 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
.
2008 2009 2010 2011 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2008 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
.
2043 2044 2045 2046 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2043 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.
2093 2094 2095 2096 |
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2093 def update_workload(params = {}, = {}) req = build_request(:update_workload, params) req.send_request() end |