Home Original page

Client — AWS SDK for Ruby V3

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.


480
481
482
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 480

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.


527
528
529
530
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 527

def add_workload(params = {}, options = {})
  req = build_request(:add_workload, params)
  req.send_request(options)
end

#create_application(params = {}) ⇒ Types::CreateApplicationResponse

Adds an application that is created from a resource group.


618
619
620
621
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 618

def create_application(params = {}, options = {})
  req = build_request(:create_application, params)
  req.send_request(options)
end

#create_component(params = {}) ⇒ Struct

Creates a custom component by grouping similar standalone instances to monitor.


649
650
651
652
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 649

def create_component(params = {}, options = {})
  req = build_request(:create_component, params)
  req.send_request(options)
end

#create_log_pattern(params = {}) ⇒ Types::CreateLogPatternResponse

Adds an log pattern to a LogPatternSet.


709
710
711
712
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 709

def create_log_pattern(params = {}, options = {})
  req = build_request(:create_log_pattern, params)
  req.send_request(options)
end

#delete_application(params = {}) ⇒ Struct

Removes the specified application from monitoring. Does not delete the application.


732
733
734
735
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 732

def delete_application(params = {}, options = {})
  req = build_request(:delete_application, params)
  req.send_request(options)
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.


760
761
762
763
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 760

def delete_component(params = {}, options = {})
  req = build_request(:delete_component, params)
  req.send_request(options)
end

#delete_log_pattern(params = {}) ⇒ Struct

Removes the specified log pattern from a LogPatternSet.


790
791
792
793
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 790

def delete_log_pattern(params = {}, options = {})
  req = build_request(:delete_log_pattern, params)
  req.send_request(options)
end

#describe_application(params = {}) ⇒ Types::DescribeApplicationResponse

Describes the application.


832
833
834
835
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 832

def describe_application(params = {}, options = {})
  req = build_request(:describe_application, params)
  req.send_request(options)
end

#describe_component(params = {}) ⇒ Types::DescribeComponentResponse

Describes a component and lists the resources that are grouped together in a component.


880
881
882
883
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 880

def describe_component(params = {}, options = {})
  req = build_request(:describe_component, params)
  req.send_request(options)
end

#describe_component_configuration(params = {}) ⇒ Types::DescribeComponentConfigurationResponse

Describes the monitoring configuration of the component.


920
921
922
923
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 920

def describe_component_configuration(params = {}, options = {})
  req = build_request(:describe_component_configuration, params)
  req.send_request(options)
end

#describe_component_configuration_recommendation(params = {}) ⇒ Types::DescribeComponentConfigurationRecommendationResponse

Describes the recommended monitoring configuration of the component.


966
967
968
969
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 966

def describe_component_configuration_recommendation(params = {}, options = {})
  req = build_request(:describe_component_configuration_recommendation, params)
  req.send_request(options)
end

#describe_log_pattern(params = {}) ⇒ Types::DescribeLogPatternResponse

Describe a specific log pattern from a LogPatternSet.


1013
1014
1015
1016
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1013

def describe_log_pattern(params = {}, options = {})
  req = build_request(:describe_log_pattern, params)
  req.send_request(options)
end

#describe_observation(params = {}) ⇒ Types::DescribeObservationResponse

Describes an anomaly or error with the application.


1089
1090
1091
1092
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1089

def describe_observation(params = {}, options = {})
  req = build_request(:describe_observation, params)
  req.send_request(options)
end

#describe_problem(params = {}) ⇒ Types::DescribeProblemResponse

Describes an application problem.


1140
1141
1142
1143
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1140

def describe_problem(params = {}, options = {})
  req = build_request(:describe_problem, params)
  req.send_request(options)
end

#describe_problem_observations(params = {}) ⇒ Types::DescribeProblemObservationsResponse

Describes the anomalies or errors associated with the problem.


1217
1218
1219
1220
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1217

def describe_problem_observations(params = {}, options = {})
  req = build_request(:describe_problem_observations, params)
  req.send_request(options)
end

#describe_workload(params = {}) ⇒ Types::DescribeWorkloadResponse

Describes a workload and its configuration.


1263
1264
1265
1266
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1263

def describe_workload(params = {}, options = {})
  req = build_request(:describe_workload, params)
  req.send_request(options)
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.


1316
1317
1318
1319
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1316

def list_applications(params = {}, options = {})
  req = build_request(:list_applications, params)
  req.send_request(options)
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.


1372
1373
1374
1375
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1372

def list_components(params = {}, options = {})
  req = build_request(:list_components, params)
  req.send_request(options)
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.


1458
1459
1460
1461
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1458

def list_configuration_history(params = {}, options = {})
  req = build_request(:list_configuration_history, params)
  req.send_request(options)
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.


1509
1510
1511
1512
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1509

def list_log_pattern_sets(params = {}, options = {})
  req = build_request(:list_log_pattern_sets, params)
  req.send_request(options)
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.


1567
1568
1569
1570
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1567

def list_log_patterns(params = {}, options = {})
  req = build_request(:list_log_patterns, params)
  req.send_request(options)
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.


1654
1655
1656
1657
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1654

def list_problems(params = {}, options = {})
  req = build_request(:list_problems, params)
  req.send_request(options)
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.


1690
1691
1692
1693
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1690

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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.


1746
1747
1748
1749
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1746

def list_workloads(params = {}, options = {})
  req = build_request(:list_workloads, params)
  req.send_request(options)
end

#remove_workload(params = {}) ⇒ Struct

Remove workload from a component.


1776
1777
1778
1779
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1776

def remove_workload(params = {}, options = {})
  req = build_request(:remove_workload, params)
  req.send_request(options)
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.


1820
1821
1822
1823
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1820

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Remove one or more tags (keys and values) from a specified application.


1854
1855
1856
1857
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1854

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_application(params = {}) ⇒ Types::UpdateApplicationResponse 


1928
1929
1930
1931
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1928

def update_application(params = {}, options = {})
  req = build_request(:update_application, params)
  req.send_request(options)
end

#update_component(params = {}) ⇒ Struct

Updates the custom component name and/or the list of resources that make up the component.


1963
1964
1965
1966
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 1963

def update_component(params = {}, options = {})
  req = build_request(:update_component, params)
  req.send_request(options)
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.


2019
2020
2021
2022
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2019

def update_component_configuration(params = {}, options = {})
  req = build_request(:update_component_configuration, params)
  req.send_request(options)
end

#update_log_pattern(params = {}) ⇒ Types::UpdateLogPatternResponse

Adds a log pattern to a LogPatternSet.


2079
2080
2081
2082
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2079

def update_log_pattern(params = {}, options = {})
  req = build_request(:update_log_pattern, params)
  req.send_request(options)
end

#update_problem(params = {}) ⇒ Struct

Updates the visibility of the problem or specifies the problem as RESOLVED.


2114
2115
2116
2117
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2114

def update_problem(params = {}, options = {})
  req = build_request(:update_problem, params)
  req.send_request(options)
end

#update_workload(params = {}) ⇒ Types::UpdateWorkloadResponse

Adds a workload to a component. Each component can have at most five workloads.


2164
2165
2166
2167
 
# File 'gems/aws-sdk-applicationinsights/lib/aws-sdk-applicationinsights/client.rb', line 2164

def update_workload(params = {}, options = {})
  req = build_request(:update_workload, params)
  req.send_request(options)
end