aws-sdk-applicationinsights 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 857d7f5898f9aafe87e103a9775d42954d7d18dc
4
+ data.tar.gz: f532e3daf173e7df5f02bd221cfb87364794f022
5
+ SHA512:
6
+ metadata.gz: c736685d1ca30132ad4af6cb506a2abd4c007a364acd50be0307a6b70db6c9eedfd6205dfe1f52dabbb098703091eb0930d19f3355f44960725e4169c78f0fed
7
+ data.tar.gz: 792541d368d98840b6d04bc494aec0f71b083ef9940cab947f06d95f6ae794086a6910ab290defbcf5724ef46f5745c3bb98edc25e6c55e2bae6b8047d3de9b5
@@ -0,0 +1,47 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'aws-sdk-core'
9
+ require 'aws-sigv4'
10
+
11
+ require_relative 'aws-sdk-applicationinsights/types'
12
+ require_relative 'aws-sdk-applicationinsights/client_api'
13
+ require_relative 'aws-sdk-applicationinsights/client'
14
+ require_relative 'aws-sdk-applicationinsights/errors'
15
+ require_relative 'aws-sdk-applicationinsights/resource'
16
+ require_relative 'aws-sdk-applicationinsights/customizations'
17
+
18
+ # This module provides support for Amazon CloudWatch Application Insights. This module is available in the
19
+ # `aws-sdk-applicationinsights` gem.
20
+ #
21
+ # # Client
22
+ #
23
+ # The {Client} class provides one method for each API operation. Operation
24
+ # methods each accept a hash of request parameters and return a response
25
+ # structure.
26
+ #
27
+ # See {Client} for more information.
28
+ #
29
+ # # Errors
30
+ #
31
+ # Errors returned from Amazon CloudWatch Application Insights all
32
+ # extend {Errors::ServiceError}.
33
+ #
34
+ # begin
35
+ # # do stuff
36
+ # rescue Aws::ApplicationInsights::Errors::ServiceError
37
+ # # rescues all service API errors
38
+ # end
39
+ #
40
+ # See {Errors} for more information.
41
+ #
42
+ # @service
43
+ module Aws::ApplicationInsights
44
+
45
+ GEM_VERSION = '1.0.0'
46
+
47
+ end
@@ -0,0 +1,906 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ require 'seahorse/client/plugins/content_length.rb'
9
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
10
+ require 'aws-sdk-core/plugins/logging.rb'
11
+ require 'aws-sdk-core/plugins/param_converter.rb'
12
+ require 'aws-sdk-core/plugins/param_validator.rb'
13
+ require 'aws-sdk-core/plugins/user_agent.rb'
14
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
15
+ require 'aws-sdk-core/plugins/retry_errors.rb'
16
+ require 'aws-sdk-core/plugins/global_configuration.rb'
17
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
18
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
19
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
20
+ require 'aws-sdk-core/plugins/response_paging.rb'
21
+ require 'aws-sdk-core/plugins/stub_responses.rb'
22
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
23
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/signature_v4.rb'
28
+ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
+
30
+ Aws::Plugins::GlobalConfiguration.add_identifier(:applicationinsights)
31
+
32
+ module Aws::ApplicationInsights
33
+ class Client < Seahorse::Client::Base
34
+
35
+ include Aws::ClientStubs
36
+
37
+ @identifier = :applicationinsights
38
+
39
+ set_api(ClientApi::API)
40
+
41
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
42
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
43
+ add_plugin(Aws::Plugins::Logging)
44
+ add_plugin(Aws::Plugins::ParamConverter)
45
+ add_plugin(Aws::Plugins::ParamValidator)
46
+ add_plugin(Aws::Plugins::UserAgent)
47
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
48
+ add_plugin(Aws::Plugins::RetryErrors)
49
+ add_plugin(Aws::Plugins::GlobalConfiguration)
50
+ add_plugin(Aws::Plugins::RegionalEndpoint)
51
+ add_plugin(Aws::Plugins::EndpointDiscovery)
52
+ add_plugin(Aws::Plugins::EndpointPattern)
53
+ add_plugin(Aws::Plugins::ResponsePaging)
54
+ add_plugin(Aws::Plugins::StubResponses)
55
+ add_plugin(Aws::Plugins::IdempotencyToken)
56
+ add_plugin(Aws::Plugins::JsonvalueConverter)
57
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
+ add_plugin(Aws::Plugins::TransferEncoding)
60
+ add_plugin(Aws::Plugins::SignatureV4)
61
+ add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
+
63
+ # @overload initialize(options)
64
+ # @param [Hash] options
65
+ # @option options [required, Aws::CredentialProvider] :credentials
66
+ # Your AWS credentials. This can be an instance of any one of the
67
+ # following classes:
68
+ #
69
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
70
+ # credentials.
71
+ #
72
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
73
+ # from an EC2 IMDS on an EC2 instance.
74
+ #
75
+ # * `Aws::SharedCredentials` - Used for loading credentials from a
76
+ # shared file, such as `~/.aws/config`.
77
+ #
78
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
79
+ #
80
+ # When `:credentials` are not configured directly, the following
81
+ # locations will be searched for credentials:
82
+ #
83
+ # * `Aws.config[:credentials]`
84
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
85
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
86
+ # * `~/.aws/credentials`
87
+ # * `~/.aws/config`
88
+ # * EC2 IMDS instance profile - When used by default, the timeouts are
89
+ # very aggressive. Construct and pass an instance of
90
+ # `Aws::InstanceProfileCredentails` to enable retries and extended
91
+ # timeouts.
92
+ #
93
+ # @option options [required, String] :region
94
+ # The AWS region to connect to. The configured `:region` is
95
+ # used to determine the service `:endpoint`. When not passed,
96
+ # a default `:region` is search for in the following locations:
97
+ #
98
+ # * `Aws.config[:region]`
99
+ # * `ENV['AWS_REGION']`
100
+ # * `ENV['AMAZON_REGION']`
101
+ # * `ENV['AWS_DEFAULT_REGION']`
102
+ # * `~/.aws/credentials`
103
+ # * `~/.aws/config`
104
+ #
105
+ # @option options [String] :access_key_id
106
+ #
107
+ # @option options [Boolean] :active_endpoint_cache (false)
108
+ # When set to `true`, a thread polling for endpoints will be running in
109
+ # the background every 60 secs (default). Defaults to `false`.
110
+ #
111
+ # @option options [Boolean] :client_side_monitoring (false)
112
+ # When `true`, client-side metrics will be collected for all API requests from
113
+ # this client.
114
+ #
115
+ # @option options [String] :client_side_monitoring_client_id ("")
116
+ # Allows you to provide an identifier for this client which will be attached to
117
+ # all generated client side metrics. Defaults to an empty string.
118
+ #
119
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
120
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
121
+ # side monitoring agent is running on, where client metrics will be published via UDP.
122
+ #
123
+ # @option options [Integer] :client_side_monitoring_port (31000)
124
+ # Required for publishing client metrics. The port that the client side monitoring
125
+ # agent is running on, where client metrics will be published via UDP.
126
+ #
127
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
128
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
129
+ # will use the Client Side Monitoring Agent Publisher.
130
+ #
131
+ # @option options [Boolean] :convert_params (true)
132
+ # When `true`, an attempt is made to coerce request parameters into
133
+ # the required types.
134
+ #
135
+ # @option options [Boolean] :disable_host_prefix_injection (false)
136
+ # Set to true to disable SDK automatically adding host prefix
137
+ # to default service endpoint when available.
138
+ #
139
+ # @option options [String] :endpoint
140
+ # The client endpoint is normally constructed from the `:region`
141
+ # option. You should only configure an `:endpoint` when connecting
142
+ # to test endpoints. This should be avalid HTTP(S) URI.
143
+ #
144
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
145
+ # Used for the maximum size limit of the LRU cache storing endpoints data
146
+ # for endpoint discovery enabled operations. Defaults to 1000.
147
+ #
148
+ # @option options [Integer] :endpoint_cache_max_threads (10)
149
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
150
+ #
151
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
152
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
153
+ # Use this option to config the time interval in seconds for making
154
+ # requests fetching endpoints information. Defaults to 60 sec.
155
+ #
156
+ # @option options [Boolean] :endpoint_discovery (false)
157
+ # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
158
+ #
159
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
+ # The log formatter.
161
+ #
162
+ # @option options [Symbol] :log_level (:info)
163
+ # The log level to send messages to the `:logger` at.
164
+ #
165
+ # @option options [Logger] :logger
166
+ # The Logger instance to send log messages to. If this option
167
+ # is not set, logging will be disabled.
168
+ #
169
+ # @option options [String] :profile ("default")
170
+ # Used when loading credentials from the shared credentials file
171
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
172
+ #
173
+ # @option options [Float] :retry_base_delay (0.3)
174
+ # The base delay in seconds used by the default backoff function.
175
+ #
176
+ # @option options [Symbol] :retry_jitter (:none)
177
+ # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
178
+ #
179
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
+ #
181
+ # @option options [Integer] :retry_limit (3)
182
+ # The maximum number of times to retry failed requests. Only
183
+ # ~ 500 level server errors and certain ~ 400 level client errors
184
+ # are retried. Generally, these are throttling errors, data
185
+ # checksum errors, networking errors, timeout errors and auth
186
+ # errors from expired credentials.
187
+ #
188
+ # @option options [Integer] :retry_max_delay (0)
189
+ # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
190
+ #
191
+ # @option options [String] :secret_access_key
192
+ #
193
+ # @option options [String] :session_token
194
+ #
195
+ # @option options [Boolean] :simple_json (false)
196
+ # Disables request parameter conversion, validation, and formatting.
197
+ # Also disable response data type conversions. This option is useful
198
+ # when you want to ensure the highest level of performance by
199
+ # avoiding overhead of walking request parameters and response data
200
+ # structures.
201
+ #
202
+ # When `:simple_json` is enabled, the request parameters hash must
203
+ # be formatted exactly as the DynamoDB API expects.
204
+ #
205
+ # @option options [Boolean] :stub_responses (false)
206
+ # Causes the client to return stubbed responses. By default
207
+ # fake responses are generated and returned. You can specify
208
+ # the response data to return or errors to raise by calling
209
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
210
+ #
211
+ # ** Please note ** When response stubbing is enabled, no HTTP
212
+ # requests are made, and retries are disabled.
213
+ #
214
+ # @option options [Boolean] :validate_params (true)
215
+ # When `true`, request parameters are validated before
216
+ # sending the request.
217
+ #
218
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
219
+ # requests through. Formatted like 'http://proxy.com:123'.
220
+ #
221
+ # @option options [Float] :http_open_timeout (15) The number of
222
+ # seconds to wait when opening a HTTP session before rasing a
223
+ # `Timeout::Error`.
224
+ #
225
+ # @option options [Integer] :http_read_timeout (60) The default
226
+ # number of seconds to wait for response data. This value can
227
+ # safely be set
228
+ # per-request on the session yeidled by {#session_for}.
229
+ #
230
+ # @option options [Float] :http_idle_timeout (5) The number of
231
+ # seconds a connection is allowed to sit idble before it is
232
+ # considered stale. Stale connections are closed and removed
233
+ # from the pool before making a request.
234
+ #
235
+ # @option options [Float] :http_continue_timeout (1) The number of
236
+ # seconds to wait for a 100-continue response before sending the
237
+ # request body. This option has no effect unless the request has
238
+ # "Expect" header set to "100-continue". Defaults to `nil` which
239
+ # disables this behaviour. This value can safely be set per
240
+ # request on the session yeidled by {#session_for}.
241
+ #
242
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
243
+ # HTTP debug output will be sent to the `:logger`.
244
+ #
245
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
246
+ # SSL peer certificates are verified when establishing a
247
+ # connection.
248
+ #
249
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
250
+ # certificate authority bundle file that should be used when
251
+ # verifying peer certificates. If you do not pass
252
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
253
+ # will be used if available.
254
+ #
255
+ # @option options [String] :ssl_ca_directory Full path of the
256
+ # directory that contains the unbundled SSL certificate
257
+ # authority files for verifying peer certificates. If you do
258
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
259
+ # system default will be used if available.
260
+ #
261
+ def initialize(*args)
262
+ super
263
+ end
264
+
265
+ # @!group API Operations
266
+
267
+ # Adds an application that is created from a resource group.
268
+ #
269
+ # @option params [required, String] :resource_group_name
270
+ # The name of the resource group.
271
+ #
272
+ # @return [Types::CreateApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
273
+ #
274
+ # * {Types::CreateApplicationResponse#application_info #application_info} => Types::ApplicationInfo
275
+ #
276
+ # @example Request syntax with placeholder values
277
+ #
278
+ # resp = client.create_application({
279
+ # resource_group_name: "ResourceGroupName", # required
280
+ # })
281
+ #
282
+ # @example Response structure
283
+ #
284
+ # resp.application_info.resource_group_name #=> String
285
+ # resp.application_info.life_cycle #=> String
286
+ # resp.application_info.remarks #=> String
287
+ #
288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/CreateApplication AWS API Documentation
289
+ #
290
+ # @overload create_application(params = {})
291
+ # @param [Hash] params ({})
292
+ def create_application(params = {}, options = {})
293
+ req = build_request(:create_application, params)
294
+ req.send_request(options)
295
+ end
296
+
297
+ # Creates a custom component by grouping similar standalone instances to
298
+ # monitor.
299
+ #
300
+ # @option params [required, String] :resource_group_name
301
+ # The name of the resource group.
302
+ #
303
+ # @option params [required, String] :component_name
304
+ # The name of the component.
305
+ #
306
+ # @option params [required, Array<String>] :resource_list
307
+ # The list of resource ARNs that belong to the component.
308
+ #
309
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
310
+ #
311
+ # @example Request syntax with placeholder values
312
+ #
313
+ # resp = client.create_component({
314
+ # resource_group_name: "ResourceGroupName", # required
315
+ # component_name: "ComponentName", # required
316
+ # resource_list: ["ResourceARN"], # required
317
+ # })
318
+ #
319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/CreateComponent AWS API Documentation
320
+ #
321
+ # @overload create_component(params = {})
322
+ # @param [Hash] params ({})
323
+ def create_component(params = {}, options = {})
324
+ req = build_request(:create_component, params)
325
+ req.send_request(options)
326
+ end
327
+
328
+ # Removes the specified application from monitoring. Does not delete the
329
+ # application.
330
+ #
331
+ # @option params [required, String] :resource_group_name
332
+ # The name of the resource group.
333
+ #
334
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
335
+ #
336
+ # @example Request syntax with placeholder values
337
+ #
338
+ # resp = client.delete_application({
339
+ # resource_group_name: "ResourceGroupName", # required
340
+ # })
341
+ #
342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DeleteApplication AWS API Documentation
343
+ #
344
+ # @overload delete_application(params = {})
345
+ # @param [Hash] params ({})
346
+ def delete_application(params = {}, options = {})
347
+ req = build_request(:delete_application, params)
348
+ req.send_request(options)
349
+ end
350
+
351
+ # Ungroups a custom component. When you ungroup custom components, all
352
+ # applicable monitors that are set up for the component are removed and
353
+ # the instances revert to their standalone status.
354
+ #
355
+ # @option params [required, String] :resource_group_name
356
+ # The name of the resource group.
357
+ #
358
+ # @option params [required, String] :component_name
359
+ # The name of the component.
360
+ #
361
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
362
+ #
363
+ # @example Request syntax with placeholder values
364
+ #
365
+ # resp = client.delete_component({
366
+ # resource_group_name: "ResourceGroupName", # required
367
+ # component_name: "ComponentName", # required
368
+ # })
369
+ #
370
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DeleteComponent AWS API Documentation
371
+ #
372
+ # @overload delete_component(params = {})
373
+ # @param [Hash] params ({})
374
+ def delete_component(params = {}, options = {})
375
+ req = build_request(:delete_component, params)
376
+ req.send_request(options)
377
+ end
378
+
379
+ # Describes the application.
380
+ #
381
+ # @option params [required, String] :resource_group_name
382
+ # The name of the resource group.
383
+ #
384
+ # @return [Types::DescribeApplicationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
385
+ #
386
+ # * {Types::DescribeApplicationResponse#application_info #application_info} => Types::ApplicationInfo
387
+ #
388
+ # @example Request syntax with placeholder values
389
+ #
390
+ # resp = client.describe_application({
391
+ # resource_group_name: "ResourceGroupName", # required
392
+ # })
393
+ #
394
+ # @example Response structure
395
+ #
396
+ # resp.application_info.resource_group_name #=> String
397
+ # resp.application_info.life_cycle #=> String
398
+ # resp.application_info.remarks #=> String
399
+ #
400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeApplication AWS API Documentation
401
+ #
402
+ # @overload describe_application(params = {})
403
+ # @param [Hash] params ({})
404
+ def describe_application(params = {}, options = {})
405
+ req = build_request(:describe_application, params)
406
+ req.send_request(options)
407
+ end
408
+
409
+ # Describes a component and lists the resources that are grouped
410
+ # together in a component.
411
+ #
412
+ # @option params [required, String] :resource_group_name
413
+ # The name of the resource group.
414
+ #
415
+ # @option params [required, String] :component_name
416
+ # The name of the component.
417
+ #
418
+ # @return [Types::DescribeComponentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
419
+ #
420
+ # * {Types::DescribeComponentResponse#application_component #application_component} => Types::ApplicationComponent
421
+ # * {Types::DescribeComponentResponse#resource_list #resource_list} => Array&lt;String&gt;
422
+ #
423
+ # @example Request syntax with placeholder values
424
+ #
425
+ # resp = client.describe_component({
426
+ # resource_group_name: "ResourceGroupName", # required
427
+ # component_name: "ComponentName", # required
428
+ # })
429
+ #
430
+ # @example Response structure
431
+ #
432
+ # resp.application_component.component_name #=> String
433
+ # resp.application_component.resource_type #=> String
434
+ # resp.application_component.tier #=> String
435
+ # resp.application_component.monitor #=> Boolean
436
+ # resp.resource_list #=> Array
437
+ # resp.resource_list[0] #=> String
438
+ #
439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeComponent AWS API Documentation
440
+ #
441
+ # @overload describe_component(params = {})
442
+ # @param [Hash] params ({})
443
+ def describe_component(params = {}, options = {})
444
+ req = build_request(:describe_component, params)
445
+ req.send_request(options)
446
+ end
447
+
448
+ # Describes the monitoring configuration of the component.
449
+ #
450
+ # @option params [required, String] :resource_group_name
451
+ # The name of the resource group.
452
+ #
453
+ # @option params [required, String] :component_name
454
+ # The name of the component.
455
+ #
456
+ # @return [Types::DescribeComponentConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
457
+ #
458
+ # * {Types::DescribeComponentConfigurationResponse#monitor #monitor} => Boolean
459
+ # * {Types::DescribeComponentConfigurationResponse#tier #tier} => String
460
+ # * {Types::DescribeComponentConfigurationResponse#component_configuration #component_configuration} => String
461
+ #
462
+ # @example Request syntax with placeholder values
463
+ #
464
+ # resp = client.describe_component_configuration({
465
+ # resource_group_name: "ResourceGroupName", # required
466
+ # component_name: "ComponentName", # required
467
+ # })
468
+ #
469
+ # @example Response structure
470
+ #
471
+ # resp.monitor #=> Boolean
472
+ # resp.tier #=> String
473
+ # resp.component_configuration #=> String
474
+ #
475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeComponentConfiguration AWS API Documentation
476
+ #
477
+ # @overload describe_component_configuration(params = {})
478
+ # @param [Hash] params ({})
479
+ def describe_component_configuration(params = {}, options = {})
480
+ req = build_request(:describe_component_configuration, params)
481
+ req.send_request(options)
482
+ end
483
+
484
+ # Describes the recommended monitoring configuration of the component.
485
+ #
486
+ # @option params [required, String] :resource_group_name
487
+ # The name of the resource group.
488
+ #
489
+ # @option params [required, String] :component_name
490
+ # The name of the component.
491
+ #
492
+ # @option params [required, String] :tier
493
+ # The tier of the application component. Supported tiers include
494
+ # `DOT_NET_WORKER`, `DOT_NET_WEB_TIER`, `SQL_SERVER`, and `DEFAULT`.
495
+ #
496
+ # @return [Types::DescribeComponentConfigurationRecommendationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
497
+ #
498
+ # * {Types::DescribeComponentConfigurationRecommendationResponse#component_configuration #component_configuration} => String
499
+ #
500
+ # @example Request syntax with placeholder values
501
+ #
502
+ # resp = client.describe_component_configuration_recommendation({
503
+ # resource_group_name: "ResourceGroupName", # required
504
+ # component_name: "ComponentName", # required
505
+ # tier: "Tier", # required
506
+ # })
507
+ #
508
+ # @example Response structure
509
+ #
510
+ # resp.component_configuration #=> String
511
+ #
512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeComponentConfigurationRecommendation AWS API Documentation
513
+ #
514
+ # @overload describe_component_configuration_recommendation(params = {})
515
+ # @param [Hash] params ({})
516
+ def describe_component_configuration_recommendation(params = {}, options = {})
517
+ req = build_request(:describe_component_configuration_recommendation, params)
518
+ req.send_request(options)
519
+ end
520
+
521
+ # Describes an anomaly or error with the application.
522
+ #
523
+ # @option params [required, String] :observation_id
524
+ # The ID of the observation.
525
+ #
526
+ # @return [Types::DescribeObservationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
527
+ #
528
+ # * {Types::DescribeObservationResponse#observation #observation} => Types::Observation
529
+ #
530
+ # @example Request syntax with placeholder values
531
+ #
532
+ # resp = client.describe_observation({
533
+ # observation_id: "ObservationId", # required
534
+ # })
535
+ #
536
+ # @example Response structure
537
+ #
538
+ # resp.observation.id #=> String
539
+ # resp.observation.start_time #=> Time
540
+ # resp.observation.end_time #=> Time
541
+ # resp.observation.source_type #=> String
542
+ # resp.observation.source_arn #=> String
543
+ # resp.observation.log_group #=> String
544
+ # resp.observation.line_time #=> Time
545
+ # resp.observation.log_text #=> String
546
+ # resp.observation.log_filter #=> String, one of "ERROR", "WARN", "INFO"
547
+ # resp.observation.metric_namespace #=> String
548
+ # resp.observation.metric_name #=> String
549
+ # resp.observation.unit #=> String
550
+ # resp.observation.value #=> Float
551
+ #
552
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeObservation AWS API Documentation
553
+ #
554
+ # @overload describe_observation(params = {})
555
+ # @param [Hash] params ({})
556
+ def describe_observation(params = {}, options = {})
557
+ req = build_request(:describe_observation, params)
558
+ req.send_request(options)
559
+ end
560
+
561
+ # Describes an application problem.
562
+ #
563
+ # @option params [required, String] :problem_id
564
+ # The ID of the problem.
565
+ #
566
+ # @return [Types::DescribeProblemResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
567
+ #
568
+ # * {Types::DescribeProblemResponse#problem #problem} => Types::Problem
569
+ #
570
+ # @example Request syntax with placeholder values
571
+ #
572
+ # resp = client.describe_problem({
573
+ # problem_id: "ProblemId", # required
574
+ # })
575
+ #
576
+ # @example Response structure
577
+ #
578
+ # resp.problem.id #=> String
579
+ # resp.problem.title #=> String
580
+ # resp.problem.insights #=> String
581
+ # resp.problem.status #=> String, one of "IGNORE", "RESOLVED", "PENDING"
582
+ # resp.problem.affected_resource #=> String
583
+ # resp.problem.start_time #=> Time
584
+ # resp.problem.end_time #=> Time
585
+ # resp.problem.severity_level #=> String, one of "LOW", "MEDIUM", "HIGH"
586
+ # resp.problem.resource_group_name #=> String
587
+ # resp.problem.feedback #=> Hash
588
+ # resp.problem.feedback["FeedbackKey"] #=> String, one of "NOT_SPECIFIED", "USEFUL", "NOT_USEFUL"
589
+ #
590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeProblem AWS API Documentation
591
+ #
592
+ # @overload describe_problem(params = {})
593
+ # @param [Hash] params ({})
594
+ def describe_problem(params = {}, options = {})
595
+ req = build_request(:describe_problem, params)
596
+ req.send_request(options)
597
+ end
598
+
599
+ # Describes the anomalies or errors associated with the problem.
600
+ #
601
+ # @option params [required, String] :problem_id
602
+ # The ID of the problem.
603
+ #
604
+ # @return [Types::DescribeProblemObservationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
605
+ #
606
+ # * {Types::DescribeProblemObservationsResponse#related_observations #related_observations} => Types::RelatedObservations
607
+ #
608
+ # @example Request syntax with placeholder values
609
+ #
610
+ # resp = client.describe_problem_observations({
611
+ # problem_id: "ProblemId", # required
612
+ # })
613
+ #
614
+ # @example Response structure
615
+ #
616
+ # resp.related_observations.observation_list #=> Array
617
+ # resp.related_observations.observation_list[0].id #=> String
618
+ # resp.related_observations.observation_list[0].start_time #=> Time
619
+ # resp.related_observations.observation_list[0].end_time #=> Time
620
+ # resp.related_observations.observation_list[0].source_type #=> String
621
+ # resp.related_observations.observation_list[0].source_arn #=> String
622
+ # resp.related_observations.observation_list[0].log_group #=> String
623
+ # resp.related_observations.observation_list[0].line_time #=> Time
624
+ # resp.related_observations.observation_list[0].log_text #=> String
625
+ # resp.related_observations.observation_list[0].log_filter #=> String, one of "ERROR", "WARN", "INFO"
626
+ # resp.related_observations.observation_list[0].metric_namespace #=> String
627
+ # resp.related_observations.observation_list[0].metric_name #=> String
628
+ # resp.related_observations.observation_list[0].unit #=> String
629
+ # resp.related_observations.observation_list[0].value #=> Float
630
+ #
631
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeProblemObservations AWS API Documentation
632
+ #
633
+ # @overload describe_problem_observations(params = {})
634
+ # @param [Hash] params ({})
635
+ def describe_problem_observations(params = {}, options = {})
636
+ req = build_request(:describe_problem_observations, params)
637
+ req.send_request(options)
638
+ end
639
+
640
+ # Lists the IDs of the applications that you are monitoring.
641
+ #
642
+ # @option params [Integer] :max_results
643
+ # The maximum number of results to return in a single call. To retrieve
644
+ # the remaining results, make another call with the returned `NextToken`
645
+ # value.
646
+ #
647
+ # @option params [String] :next_token
648
+ # The token to request the next page of results.
649
+ #
650
+ # @return [Types::ListApplicationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
651
+ #
652
+ # * {Types::ListApplicationsResponse#application_info_list #application_info_list} => Array&lt;Types::ApplicationInfo&gt;
653
+ # * {Types::ListApplicationsResponse#next_token #next_token} => String
654
+ #
655
+ # @example Request syntax with placeholder values
656
+ #
657
+ # resp = client.list_applications({
658
+ # max_results: 1,
659
+ # next_token: "PaginationToken",
660
+ # })
661
+ #
662
+ # @example Response structure
663
+ #
664
+ # resp.application_info_list #=> Array
665
+ # resp.application_info_list[0].resource_group_name #=> String
666
+ # resp.application_info_list[0].life_cycle #=> String
667
+ # resp.application_info_list[0].remarks #=> String
668
+ # resp.next_token #=> String
669
+ #
670
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/ListApplications AWS API Documentation
671
+ #
672
+ # @overload list_applications(params = {})
673
+ # @param [Hash] params ({})
674
+ def list_applications(params = {}, options = {})
675
+ req = build_request(:list_applications, params)
676
+ req.send_request(options)
677
+ end
678
+
679
+ # Lists the auto-grouped, standalone, and custom components of the
680
+ # application.
681
+ #
682
+ # @option params [required, String] :resource_group_name
683
+ # The name of the resource group.
684
+ #
685
+ # @option params [Integer] :max_results
686
+ # The maximum number of results to return in a single call. To retrieve
687
+ # the remaining results, make another call with the returned `NextToken`
688
+ # value.
689
+ #
690
+ # @option params [String] :next_token
691
+ # The token to request the next page of results.
692
+ #
693
+ # @return [Types::ListComponentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
694
+ #
695
+ # * {Types::ListComponentsResponse#application_component_list #application_component_list} => Array&lt;Types::ApplicationComponent&gt;
696
+ # * {Types::ListComponentsResponse#next_token #next_token} => String
697
+ #
698
+ # @example Request syntax with placeholder values
699
+ #
700
+ # resp = client.list_components({
701
+ # resource_group_name: "ResourceGroupName", # required
702
+ # max_results: 1,
703
+ # next_token: "PaginationToken",
704
+ # })
705
+ #
706
+ # @example Response structure
707
+ #
708
+ # resp.application_component_list #=> Array
709
+ # resp.application_component_list[0].component_name #=> String
710
+ # resp.application_component_list[0].resource_type #=> String
711
+ # resp.application_component_list[0].tier #=> String
712
+ # resp.application_component_list[0].monitor #=> Boolean
713
+ # resp.next_token #=> String
714
+ #
715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/ListComponents AWS API Documentation
716
+ #
717
+ # @overload list_components(params = {})
718
+ # @param [Hash] params ({})
719
+ def list_components(params = {}, options = {})
720
+ req = build_request(:list_components, params)
721
+ req.send_request(options)
722
+ end
723
+
724
+ # Lists the problems with your application.
725
+ #
726
+ # @option params [String] :resource_group_name
727
+ # The name of the resource group.
728
+ #
729
+ # @option params [Time,DateTime,Date,Integer,String] :start_time
730
+ # The time when the problem was detected, in epoch seconds. If you
731
+ # don't specify a time frame for the request, problems within the past
732
+ # seven days are returned.
733
+ #
734
+ # @option params [Time,DateTime,Date,Integer,String] :end_time
735
+ # The time when the problem ended, in epoch seconds. If not specified,
736
+ # problems within the past seven days are returned.
737
+ #
738
+ # @option params [Integer] :max_results
739
+ # The maximum number of results to return in a single call. To retrieve
740
+ # the remaining results, make another call with the returned `NextToken`
741
+ # value.
742
+ #
743
+ # @option params [String] :next_token
744
+ # The token to request the next page of results.
745
+ #
746
+ # @return [Types::ListProblemsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
747
+ #
748
+ # * {Types::ListProblemsResponse#problem_list #problem_list} => Array&lt;Types::Problem&gt;
749
+ # * {Types::ListProblemsResponse#next_token #next_token} => String
750
+ #
751
+ # @example Request syntax with placeholder values
752
+ #
753
+ # resp = client.list_problems({
754
+ # resource_group_name: "ResourceGroupName",
755
+ # start_time: Time.now,
756
+ # end_time: Time.now,
757
+ # max_results: 1,
758
+ # next_token: "PaginationToken",
759
+ # })
760
+ #
761
+ # @example Response structure
762
+ #
763
+ # resp.problem_list #=> Array
764
+ # resp.problem_list[0].id #=> String
765
+ # resp.problem_list[0].title #=> String
766
+ # resp.problem_list[0].insights #=> String
767
+ # resp.problem_list[0].status #=> String, one of "IGNORE", "RESOLVED", "PENDING"
768
+ # resp.problem_list[0].affected_resource #=> String
769
+ # resp.problem_list[0].start_time #=> Time
770
+ # resp.problem_list[0].end_time #=> Time
771
+ # resp.problem_list[0].severity_level #=> String, one of "LOW", "MEDIUM", "HIGH"
772
+ # resp.problem_list[0].resource_group_name #=> String
773
+ # resp.problem_list[0].feedback #=> Hash
774
+ # resp.problem_list[0].feedback["FeedbackKey"] #=> String, one of "NOT_SPECIFIED", "USEFUL", "NOT_USEFUL"
775
+ # resp.next_token #=> String
776
+ #
777
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/ListProblems AWS API Documentation
778
+ #
779
+ # @overload list_problems(params = {})
780
+ # @param [Hash] params ({})
781
+ def list_problems(params = {}, options = {})
782
+ req = build_request(:list_problems, params)
783
+ req.send_request(options)
784
+ end
785
+
786
+ # Updates the custom component name and/or the list of resources that
787
+ # make up the component.
788
+ #
789
+ # @option params [required, String] :resource_group_name
790
+ # The name of the resource group.
791
+ #
792
+ # @option params [required, String] :component_name
793
+ # The name of the component.
794
+ #
795
+ # @option params [String] :new_component_name
796
+ # The new name of the component.
797
+ #
798
+ # @option params [Array<String>] :resource_list
799
+ # The list of resource ARNs that belong to the component.
800
+ #
801
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
802
+ #
803
+ # @example Request syntax with placeholder values
804
+ #
805
+ # resp = client.update_component({
806
+ # resource_group_name: "ResourceGroupName", # required
807
+ # component_name: "ComponentName", # required
808
+ # new_component_name: "NewComponentName",
809
+ # resource_list: ["ResourceARN"],
810
+ # })
811
+ #
812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/UpdateComponent AWS API Documentation
813
+ #
814
+ # @overload update_component(params = {})
815
+ # @param [Hash] params ({})
816
+ def update_component(params = {}, options = {})
817
+ req = build_request(:update_component, params)
818
+ req.send_request(options)
819
+ end
820
+
821
+ # Updates the monitoring configurations for the component. The
822
+ # configuration input parameter is an escaped JSON of the configuration
823
+ # and should match the schema of what is returned by
824
+ # `DescribeComponentConfigurationRecommendation`.
825
+ #
826
+ # @option params [required, String] :resource_group_name
827
+ # The name of the resource group.
828
+ #
829
+ # @option params [required, String] :component_name
830
+ # The name of the component.
831
+ #
832
+ # @option params [Boolean] :monitor
833
+ # Indicates whether the application component is monitored.
834
+ #
835
+ # @option params [String] :tier
836
+ # The tier of the application component. Supported tiers include
837
+ # `DOT_NET_WORKER`, `DOT_NET_WEB_TIER`, `SQL_SERVER`, and `DEFAULT`.
838
+ #
839
+ # @option params [String] :component_configuration
840
+ # The configuration settings of the component. The value is the escaped
841
+ # JSON of the configuration. For more information about the JSON format,
842
+ # see [Working with JSON][1]. You can send a request to
843
+ # `DescribeComponentConfigurationRecommendation` to see the recommended
844
+ # configuration for a component.
845
+ #
846
+ #
847
+ #
848
+ # [1]: https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/working-with-json.html
849
+ #
850
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
851
+ #
852
+ # @example Request syntax with placeholder values
853
+ #
854
+ # resp = client.update_component_configuration({
855
+ # resource_group_name: "ResourceGroupName", # required
856
+ # component_name: "ComponentName", # required
857
+ # monitor: false,
858
+ # tier: "Tier",
859
+ # component_configuration: "ComponentConfiguration",
860
+ # })
861
+ #
862
+ # @see http://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/UpdateComponentConfiguration AWS API Documentation
863
+ #
864
+ # @overload update_component_configuration(params = {})
865
+ # @param [Hash] params ({})
866
+ def update_component_configuration(params = {}, options = {})
867
+ req = build_request(:update_component_configuration, params)
868
+ req.send_request(options)
869
+ end
870
+
871
+ # @!endgroup
872
+
873
+ # @param params ({})
874
+ # @api private
875
+ def build_request(operation_name, params = {})
876
+ handlers = @handlers.for(operation_name)
877
+ context = Seahorse::Client::RequestContext.new(
878
+ operation_name: operation_name,
879
+ operation: config.api.operation(operation_name),
880
+ client: self,
881
+ params: params,
882
+ config: config)
883
+ context[:gem_name] = 'aws-sdk-applicationinsights'
884
+ context[:gem_version] = '1.0.0'
885
+ Seahorse::Client::Request.new(handlers, context)
886
+ end
887
+
888
+ # @api private
889
+ # @deprecated
890
+ def waiter_names
891
+ []
892
+ end
893
+
894
+ class << self
895
+
896
+ # @api private
897
+ attr_reader :identifier
898
+
899
+ # @api private
900
+ def errors_module
901
+ Errors
902
+ end
903
+
904
+ end
905
+ end
906
+ end