aws-sdk-observabilityadmin 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,758 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/invocation_id.rb'
26
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
28
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
29
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
30
+ require 'aws-sdk-core/plugins/http_checksum.rb'
31
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
32
+ require 'aws-sdk-core/plugins/request_compression.rb'
33
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
34
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
35
+ require 'aws-sdk-core/plugins/telemetry.rb'
36
+ require 'aws-sdk-core/plugins/sign.rb'
37
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
38
+
39
+ module Aws::ObservabilityAdmin
40
+ # An API client for ObservabilityAdmin. To construct a client, you need to configure a `:region` and `:credentials`.
41
+ #
42
+ # client = Aws::ObservabilityAdmin::Client.new(
43
+ # region: region_name,
44
+ # credentials: credentials,
45
+ # # ...
46
+ # )
47
+ #
48
+ # For details on configuring region and credentials see
49
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
50
+ #
51
+ # See {#initialize} for a full list of supported configuration options.
52
+ class Client < Seahorse::Client::Base
53
+
54
+ include Aws::ClientStubs
55
+
56
+ @identifier = :observabilityadmin
57
+
58
+ set_api(ClientApi::API)
59
+
60
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
61
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
62
+ add_plugin(Aws::Plugins::Logging)
63
+ add_plugin(Aws::Plugins::ParamConverter)
64
+ add_plugin(Aws::Plugins::ParamValidator)
65
+ add_plugin(Aws::Plugins::UserAgent)
66
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
67
+ add_plugin(Aws::Plugins::RetryErrors)
68
+ add_plugin(Aws::Plugins::GlobalConfiguration)
69
+ add_plugin(Aws::Plugins::RegionalEndpoint)
70
+ add_plugin(Aws::Plugins::EndpointDiscovery)
71
+ add_plugin(Aws::Plugins::EndpointPattern)
72
+ add_plugin(Aws::Plugins::ResponsePaging)
73
+ add_plugin(Aws::Plugins::StubResponses)
74
+ add_plugin(Aws::Plugins::IdempotencyToken)
75
+ add_plugin(Aws::Plugins::InvocationId)
76
+ add_plugin(Aws::Plugins::JsonvalueConverter)
77
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
78
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
79
+ add_plugin(Aws::Plugins::TransferEncoding)
80
+ add_plugin(Aws::Plugins::HttpChecksum)
81
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
82
+ add_plugin(Aws::Plugins::RequestCompression)
83
+ add_plugin(Aws::Plugins::DefaultsMode)
84
+ add_plugin(Aws::Plugins::RecursionDetection)
85
+ add_plugin(Aws::Plugins::Telemetry)
86
+ add_plugin(Aws::Plugins::Sign)
87
+ add_plugin(Aws::Plugins::Protocols::RestJson)
88
+ add_plugin(Aws::ObservabilityAdmin::Plugins::Endpoints)
89
+
90
+ # @overload initialize(options)
91
+ # @param [Hash] options
92
+ #
93
+ # @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
94
+ # A list of plugins to apply to the client. Each plugin is either a
95
+ # class name or an instance of a plugin class.
96
+ #
97
+ # @option options [required, Aws::CredentialProvider] :credentials
98
+ # Your AWS credentials. This can be an instance of any one of the
99
+ # following classes:
100
+ #
101
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
102
+ # credentials.
103
+ #
104
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
105
+ # shared file, such as `~/.aws/config`.
106
+ #
107
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ #
109
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
110
+ # assume a role after providing credentials via the web.
111
+ #
112
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
113
+ # access token generated from `aws login`.
114
+ #
115
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
116
+ # process that outputs to stdout.
117
+ #
118
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
119
+ # from an EC2 IMDS on an EC2 instance.
120
+ #
121
+ # * `Aws::ECSCredentials` - Used for loading credentials from
122
+ # instances running in ECS.
123
+ #
124
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
125
+ # from the Cognito Identity service.
126
+ #
127
+ # When `:credentials` are not configured directly, the following
128
+ # locations will be searched for credentials:
129
+ #
130
+ # * `Aws.config[:credentials]`
131
+ # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
132
+ # `:account_id` options.
133
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
134
+ # ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
135
+ # * `~/.aws/credentials`
136
+ # * `~/.aws/config`
137
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
138
+ # are very aggressive. Construct and pass an instance of
139
+ # `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
140
+ # enable retries and extended timeouts. Instance profile credential
141
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
142
+ # to true.
143
+ #
144
+ # @option options [required, String] :region
145
+ # The AWS region to connect to. The configured `:region` is
146
+ # used to determine the service `:endpoint`. When not passed,
147
+ # a default `:region` is searched for in the following locations:
148
+ #
149
+ # * `Aws.config[:region]`
150
+ # * `ENV['AWS_REGION']`
151
+ # * `ENV['AMAZON_REGION']`
152
+ # * `ENV['AWS_DEFAULT_REGION']`
153
+ # * `~/.aws/credentials`
154
+ # * `~/.aws/config`
155
+ #
156
+ # @option options [String] :access_key_id
157
+ #
158
+ # @option options [String] :account_id
159
+ #
160
+ # @option options [Boolean] :active_endpoint_cache (false)
161
+ # When set to `true`, a thread polling for endpoints will be running in
162
+ # the background every 60 secs (default). Defaults to `false`.
163
+ #
164
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
165
+ # Used only in `adaptive` retry mode. When true, the request will sleep
166
+ # until there is sufficent client side capacity to retry the request.
167
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
168
+ # not retry instead of sleeping.
169
+ #
170
+ # @option options [Boolean] :client_side_monitoring (false)
171
+ # When `true`, client-side metrics will be collected for all API requests from
172
+ # this client.
173
+ #
174
+ # @option options [String] :client_side_monitoring_client_id ("")
175
+ # Allows you to provide an identifier for this client which will be attached to
176
+ # all generated client side metrics. Defaults to an empty string.
177
+ #
178
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
179
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
180
+ # side monitoring agent is running on, where client metrics will be published via UDP.
181
+ #
182
+ # @option options [Integer] :client_side_monitoring_port (31000)
183
+ # Required for publishing client metrics. The port that the client side monitoring
184
+ # agent is running on, where client metrics will be published via UDP.
185
+ #
186
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
187
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
188
+ # will use the Client Side Monitoring Agent Publisher.
189
+ #
190
+ # @option options [Boolean] :convert_params (true)
191
+ # When `true`, an attempt is made to coerce request parameters into
192
+ # the required types.
193
+ #
194
+ # @option options [Boolean] :correct_clock_skew (true)
195
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
196
+ # a clock skew correction and retry requests with skewed client clocks.
197
+ #
198
+ # @option options [String] :defaults_mode ("legacy")
199
+ # See {Aws::DefaultsModeConfiguration} for a list of the
200
+ # accepted modes and the configuration defaults that are included.
201
+ #
202
+ # @option options [Boolean] :disable_host_prefix_injection (false)
203
+ # Set to true to disable SDK automatically adding host prefix
204
+ # to default service endpoint when available.
205
+ #
206
+ # @option options [Boolean] :disable_request_compression (false)
207
+ # When set to 'true' the request body will not be compressed
208
+ # for supported operations.
209
+ #
210
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
211
+ # Normally you should not configure the `:endpoint` option
212
+ # directly. This is normally constructed from the `:region`
213
+ # option. Configuring `:endpoint` is normally reserved for
214
+ # connecting to test or custom endpoints. The endpoint should
215
+ # be a URI formatted like:
216
+ #
217
+ # 'http://example.com'
218
+ # 'https://example.com'
219
+ # 'http://example.com:123'
220
+ #
221
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
222
+ # Used for the maximum size limit of the LRU cache storing endpoints data
223
+ # for endpoint discovery enabled operations. Defaults to 1000.
224
+ #
225
+ # @option options [Integer] :endpoint_cache_max_threads (10)
226
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
227
+ #
228
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
229
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
230
+ # Use this option to config the time interval in seconds for making
231
+ # requests fetching endpoints information. Defaults to 60 sec.
232
+ #
233
+ # @option options [Boolean] :endpoint_discovery (false)
234
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
235
+ #
236
+ # @option options [Boolean] :ignore_configured_endpoint_urls
237
+ # Setting to true disables use of endpoint URLs provided via environment
238
+ # variables and the shared configuration file.
239
+ #
240
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
241
+ # The log formatter.
242
+ #
243
+ # @option options [Symbol] :log_level (:info)
244
+ # The log level to send messages to the `:logger` at.
245
+ #
246
+ # @option options [Logger] :logger
247
+ # The Logger instance to send log messages to. If this option
248
+ # is not set, logging will be disabled.
249
+ #
250
+ # @option options [Integer] :max_attempts (3)
251
+ # An integer representing the maximum number attempts that will be made for
252
+ # a single request, including the initial attempt. For example,
253
+ # setting this value to 5 will result in a request being retried up to
254
+ # 4 times. Used in `standard` and `adaptive` retry modes.
255
+ #
256
+ # @option options [String] :profile ("default")
257
+ # Used when loading credentials from the shared credentials file
258
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
259
+ #
260
+ # @option options [Integer] :request_min_compression_size_bytes (10240)
261
+ # The minimum size in bytes that triggers compression for request
262
+ # bodies. The value must be non-negative integer value between 0
263
+ # and 10485780 bytes inclusive.
264
+ #
265
+ # @option options [Proc] :retry_backoff
266
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
267
+ # This option is only used in the `legacy` retry mode.
268
+ #
269
+ # @option options [Float] :retry_base_delay (0.3)
270
+ # The base delay in seconds used by the default backoff function. This option
271
+ # is only used in the `legacy` retry mode.
272
+ #
273
+ # @option options [Symbol] :retry_jitter (:none)
274
+ # A delay randomiser function used by the default backoff function.
275
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
276
+ # otherwise a Proc that takes and returns a number. This option is only used
277
+ # in the `legacy` retry mode.
278
+ #
279
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
280
+ #
281
+ # @option options [Integer] :retry_limit (3)
282
+ # The maximum number of times to retry failed requests. Only
283
+ # ~ 500 level server errors and certain ~ 400 level client errors
284
+ # are retried. Generally, these are throttling errors, data
285
+ # checksum errors, networking errors, timeout errors, auth errors,
286
+ # endpoint discovery, and errors from expired credentials.
287
+ # This option is only used in the `legacy` retry mode.
288
+ #
289
+ # @option options [Integer] :retry_max_delay (0)
290
+ # The maximum number of seconds to delay between retries (0 for no limit)
291
+ # used by the default backoff function. This option is only used in the
292
+ # `legacy` retry mode.
293
+ #
294
+ # @option options [String] :retry_mode ("legacy")
295
+ # Specifies which retry algorithm to use. Values are:
296
+ #
297
+ # * `legacy` - The pre-existing retry behavior. This is default value if
298
+ # no retry mode is provided.
299
+ #
300
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
301
+ # This includes support for retry quotas, which limit the number of
302
+ # unsuccessful retries a client can make.
303
+ #
304
+ # * `adaptive` - An experimental retry mode that includes all the
305
+ # functionality of `standard` mode along with automatic client side
306
+ # throttling. This is a provisional mode that may change behavior
307
+ # in the future.
308
+ #
309
+ # @option options [String] :sdk_ua_app_id
310
+ # A unique and opaque application ID that is appended to the
311
+ # User-Agent header as app/sdk_ua_app_id. It should have a
312
+ # maximum length of 50. This variable is sourced from environment
313
+ # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
314
+ #
315
+ # @option options [String] :secret_access_key
316
+ #
317
+ # @option options [String] :session_token
318
+ #
319
+ # @option options [Array] :sigv4a_signing_region_set
320
+ # A list of regions that should be signed with SigV4a signing. When
321
+ # not passed, a default `:sigv4a_signing_region_set` is searched for
322
+ # in the following locations:
323
+ #
324
+ # * `Aws.config[:sigv4a_signing_region_set]`
325
+ # * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
326
+ # * `~/.aws/config`
327
+ #
328
+ # @option options [Boolean] :stub_responses (false)
329
+ # Causes the client to return stubbed responses. By default
330
+ # fake responses are generated and returned. You can specify
331
+ # the response data to return or errors to raise by calling
332
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
333
+ #
334
+ # ** Please note ** When response stubbing is enabled, no HTTP
335
+ # requests are made, and retries are disabled.
336
+ #
337
+ # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
338
+ # Allows you to provide a telemetry provider, which is used to
339
+ # emit telemetry data. By default, uses `NoOpTelemetryProvider` which
340
+ # will not record or emit any telemetry data. The SDK supports the
341
+ # following telemetry providers:
342
+ #
343
+ # * OpenTelemetry (OTel) - To use the OTel provider, install and require the
344
+ # `opentelemetry-sdk` gem and then, pass in an instance of a
345
+ # `Aws::Telemetry::OTelProvider` for telemetry provider.
346
+ #
347
+ # @option options [Aws::TokenProvider] :token_provider
348
+ # A Bearer Token Provider. This can be an instance of any one of the
349
+ # following classes:
350
+ #
351
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
352
+ # tokens.
353
+ #
354
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
355
+ # access token generated from `aws login`.
356
+ #
357
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
358
+ # will be used to search for tokens configured for your profile in shared configuration files.
359
+ #
360
+ # @option options [Boolean] :use_dualstack_endpoint
361
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
362
+ # will be used if available.
363
+ #
364
+ # @option options [Boolean] :use_fips_endpoint
365
+ # When set to `true`, fips compatible endpoints will be used if available.
366
+ # When a `fips` region is used, the region is normalized and this config
367
+ # is set to `true`.
368
+ #
369
+ # @option options [Boolean] :validate_params (true)
370
+ # When `true`, request parameters are validated before
371
+ # sending the request.
372
+ #
373
+ # @option options [Aws::ObservabilityAdmin::EndpointProvider] :endpoint_provider
374
+ # The endpoint provider used to resolve endpoints. Any object that responds to
375
+ # `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
376
+ # `Aws::ObservabilityAdmin::EndpointParameters`.
377
+ #
378
+ # @option options [Float] :http_continue_timeout (1)
379
+ # The number of seconds to wait for a 100-continue response before sending the
380
+ # request body. This option has no effect unless the request has "Expect"
381
+ # header set to "100-continue". Defaults to `nil` which disables this
382
+ # behaviour. This value can safely be set per request on the session.
383
+ #
384
+ # @option options [Float] :http_idle_timeout (5)
385
+ # The number of seconds a connection is allowed to sit idle before it
386
+ # is considered stale. Stale connections are closed and removed from the
387
+ # pool before making a request.
388
+ #
389
+ # @option options [Float] :http_open_timeout (15)
390
+ # The default number of seconds to wait for response data.
391
+ # This value can safely be set per-request on the session.
392
+ #
393
+ # @option options [URI::HTTP,String] :http_proxy
394
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
395
+ #
396
+ # @option options [Float] :http_read_timeout (60)
397
+ # The default number of seconds to wait for response data.
398
+ # This value can safely be set per-request on the session.
399
+ #
400
+ # @option options [Boolean] :http_wire_trace (false)
401
+ # When `true`, HTTP debug output will be sent to the `:logger`.
402
+ #
403
+ # @option options [Proc] :on_chunk_received
404
+ # When a Proc object is provided, it will be used as callback when each chunk
405
+ # of the response body is received. It provides three arguments: the chunk,
406
+ # the number of bytes received, and the total number of
407
+ # bytes in the response (or nil if the server did not send a `content-length`).
408
+ #
409
+ # @option options [Proc] :on_chunk_sent
410
+ # When a Proc object is provided, it will be used as callback when each chunk
411
+ # of the request body is sent. It provides three arguments: the chunk,
412
+ # the number of bytes read from the body, and the total number of
413
+ # bytes in the body.
414
+ #
415
+ # @option options [Boolean] :raise_response_errors (true)
416
+ # When `true`, response errors are raised.
417
+ #
418
+ # @option options [String] :ssl_ca_bundle
419
+ # Full path to the SSL certificate authority bundle file that should be used when
420
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
421
+ # `:ssl_ca_directory` the the system default will be used if available.
422
+ #
423
+ # @option options [String] :ssl_ca_directory
424
+ # Full path of the directory that contains the unbundled SSL certificate
425
+ # authority files for verifying peer certificates. If you do
426
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
427
+ # default will be used if available.
428
+ #
429
+ # @option options [String] :ssl_ca_store
430
+ # Sets the X509::Store to verify peer certificate.
431
+ #
432
+ # @option options [OpenSSL::X509::Certificate] :ssl_cert
433
+ # Sets a client certificate when creating http connections.
434
+ #
435
+ # @option options [OpenSSL::PKey] :ssl_key
436
+ # Sets a client key when creating http connections.
437
+ #
438
+ # @option options [Float] :ssl_timeout
439
+ # Sets the SSL timeout in seconds
440
+ #
441
+ # @option options [Boolean] :ssl_verify_peer (true)
442
+ # When `true`, SSL peer certificates are verified when establishing a connection.
443
+ #
444
+ def initialize(*args)
445
+ super
446
+ end
447
+
448
+ # @!group API Operations
449
+
450
+ # Returns the current onboarding status of the telemetry config feature,
451
+ # including the status of the feature and reason the feature failed to
452
+ # start or stop.
453
+ #
454
+ # @return [Types::GetTelemetryEvaluationStatusOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
455
+ #
456
+ # * {Types::GetTelemetryEvaluationStatusOutput#status #status} => String
457
+ # * {Types::GetTelemetryEvaluationStatusOutput#failure_reason #failure_reason} => String
458
+ #
459
+ # @example Response structure
460
+ #
461
+ # resp.status #=> String, one of "NOT_STARTED", "STARTING", "FAILED_START", "RUNNING", "STOPPING", "FAILED_STOP", "STOPPED"
462
+ # resp.failure_reason #=> String
463
+ #
464
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/GetTelemetryEvaluationStatus AWS API Documentation
465
+ #
466
+ # @overload get_telemetry_evaluation_status(params = {})
467
+ # @param [Hash] params ({})
468
+ def get_telemetry_evaluation_status(params = {}, options = {})
469
+ req = build_request(:get_telemetry_evaluation_status, params)
470
+ req.send_request(options)
471
+ end
472
+
473
+ # This returns the onboarding status of the telemetry configuration
474
+ # feature for the organization. It can only be called by a Management
475
+ # Account of an AWS Organization or an assigned Delegated Admin Account
476
+ # of AWS CloudWatch telemetry config.
477
+ #
478
+ # @return [Types::GetTelemetryEvaluationStatusForOrganizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
479
+ #
480
+ # * {Types::GetTelemetryEvaluationStatusForOrganizationOutput#status #status} => String
481
+ # * {Types::GetTelemetryEvaluationStatusForOrganizationOutput#failure_reason #failure_reason} => String
482
+ #
483
+ # @example Response structure
484
+ #
485
+ # resp.status #=> String, one of "NOT_STARTED", "STARTING", "FAILED_START", "RUNNING", "STOPPING", "FAILED_STOP", "STOPPED"
486
+ # resp.failure_reason #=> String
487
+ #
488
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/GetTelemetryEvaluationStatusForOrganization AWS API Documentation
489
+ #
490
+ # @overload get_telemetry_evaluation_status_for_organization(params = {})
491
+ # @param [Hash] params ({})
492
+ def get_telemetry_evaluation_status_for_organization(params = {}, options = {})
493
+ req = build_request(:get_telemetry_evaluation_status_for_organization, params)
494
+ req.send_request(options)
495
+ end
496
+
497
+ # Returns a list of telemetry configurations for AWS resources supported
498
+ # by telemetry config. For more information, see [Auditing CloudWatch
499
+ # telemetry configurations][1].
500
+ #
501
+ #
502
+ #
503
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html
504
+ #
505
+ # @option params [String] :resource_identifier_prefix
506
+ # A string used to filter resources which have a `ResourceIdentifier`
507
+ # starting with the `ResourceIdentifierPrefix`.
508
+ #
509
+ # @option params [Array<String>] :resource_types
510
+ # A list of resource types used to filter resources supported by
511
+ # telemetry config. If this parameter is provided, the resources will be
512
+ # returned in the same order used in the request.
513
+ #
514
+ # @option params [Hash<String,String>] :telemetry_configuration_state
515
+ # A key-value pair to filter resources based on the telemetry type and
516
+ # the state of the telemetry configuration. The key is the telemetry
517
+ # type and the value is the state.
518
+ #
519
+ # @option params [Hash<String,String>] :resource_tags
520
+ # A key-value pair to filter resources based on tags associated with the
521
+ # resource. For more information about tags, see [What are tags?][1]
522
+ #
523
+ #
524
+ #
525
+ # [1]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/what-are-tags.html
526
+ #
527
+ # @option params [Integer] :max_results
528
+ # A number field used to limit the number of results within the returned
529
+ # list.
530
+ #
531
+ # @option params [String] :next_token
532
+ # The token for the next set of items to return. A previous call
533
+ # generates this token.
534
+ #
535
+ # @return [Types::ListResourceTelemetryOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
536
+ #
537
+ # * {Types::ListResourceTelemetryOutput#telemetry_configurations #telemetry_configurations} => Array&lt;Types::TelemetryConfiguration&gt;
538
+ # * {Types::ListResourceTelemetryOutput#next_token #next_token} => String
539
+ #
540
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
541
+ #
542
+ # @example Request syntax with placeholder values
543
+ #
544
+ # resp = client.list_resource_telemetry({
545
+ # resource_identifier_prefix: "ResourceIdentifierPrefix",
546
+ # resource_types: ["AWS::EC2::Instance"], # accepts AWS::EC2::Instance, AWS::EC2::VPC, AWS::Lambda::Function
547
+ # telemetry_configuration_state: {
548
+ # "Logs" => "Enabled", # accepts Enabled, Disabled, NotApplicable
549
+ # },
550
+ # resource_tags: {
551
+ # "TagKey" => "TagValue",
552
+ # },
553
+ # max_results: 1,
554
+ # next_token: "NextToken",
555
+ # })
556
+ #
557
+ # @example Response structure
558
+ #
559
+ # resp.telemetry_configurations #=> Array
560
+ # resp.telemetry_configurations[0].account_identifier #=> String
561
+ # resp.telemetry_configurations[0].telemetry_configuration_state #=> Hash
562
+ # resp.telemetry_configurations[0].telemetry_configuration_state["TelemetryType"] #=> String, one of "Enabled", "Disabled", "NotApplicable"
563
+ # resp.telemetry_configurations[0].resource_type #=> String, one of "AWS::EC2::Instance", "AWS::EC2::VPC", "AWS::Lambda::Function"
564
+ # resp.telemetry_configurations[0].resource_identifier #=> String
565
+ # resp.telemetry_configurations[0].resource_tags #=> Hash
566
+ # resp.telemetry_configurations[0].resource_tags["String"] #=> String
567
+ # resp.telemetry_configurations[0].last_update_time_stamp #=> Integer
568
+ # resp.next_token #=> String
569
+ #
570
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/ListResourceTelemetry AWS API Documentation
571
+ #
572
+ # @overload list_resource_telemetry(params = {})
573
+ # @param [Hash] params ({})
574
+ def list_resource_telemetry(params = {}, options = {})
575
+ req = build_request(:list_resource_telemetry, params)
576
+ req.send_request(options)
577
+ end
578
+
579
+ # Returns a list of telemetry configurations for AWS resources supported
580
+ # by telemetry config in the organization.
581
+ #
582
+ # @option params [Array<String>] :account_identifiers
583
+ # A list of AWS account IDs used to filter the resources to those
584
+ # associated with the specified accounts.
585
+ #
586
+ # @option params [String] :resource_identifier_prefix
587
+ # A string used to filter resources in the organization which have a
588
+ # `ResourceIdentifier` starting with the `ResourceIdentifierPrefix`.
589
+ #
590
+ # @option params [Array<String>] :resource_types
591
+ # A list of resource types used to filter resources in the organization.
592
+ # If this parameter is provided, the resources will be returned in the
593
+ # same order used in the request.
594
+ #
595
+ # @option params [Hash<String,String>] :telemetry_configuration_state
596
+ # A key-value pair to filter resources in the organization based on the
597
+ # telemetry type and the state of the telemetry configuration. The key
598
+ # is the telemetry type and the value is the state.
599
+ #
600
+ # @option params [Hash<String,String>] :resource_tags
601
+ # A key-value pair to filter resources in the organization based on tags
602
+ # associated with the resource. Fore more information about tags, see
603
+ # [What are tags?][1]
604
+ #
605
+ #
606
+ #
607
+ # [1]: https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/what-are-tags.html
608
+ #
609
+ # @option params [Integer] :max_results
610
+ # A number field used to limit the number of results within the returned
611
+ # list.
612
+ #
613
+ # @option params [String] :next_token
614
+ # The token for the next set of items to return. A previous call
615
+ # provides this token.
616
+ #
617
+ # @return [Types::ListResourceTelemetryForOrganizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
618
+ #
619
+ # * {Types::ListResourceTelemetryForOrganizationOutput#telemetry_configurations #telemetry_configurations} => Array&lt;Types::TelemetryConfiguration&gt;
620
+ # * {Types::ListResourceTelemetryForOrganizationOutput#next_token #next_token} => String
621
+ #
622
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
623
+ #
624
+ # @example Request syntax with placeholder values
625
+ #
626
+ # resp = client.list_resource_telemetry_for_organization({
627
+ # account_identifiers: ["AccountIdentifier"],
628
+ # resource_identifier_prefix: "ResourceIdentifierPrefix",
629
+ # resource_types: ["AWS::EC2::Instance"], # accepts AWS::EC2::Instance, AWS::EC2::VPC, AWS::Lambda::Function
630
+ # telemetry_configuration_state: {
631
+ # "Logs" => "Enabled", # accepts Enabled, Disabled, NotApplicable
632
+ # },
633
+ # resource_tags: {
634
+ # "TagKey" => "TagValue",
635
+ # },
636
+ # max_results: 1,
637
+ # next_token: "NextToken",
638
+ # })
639
+ #
640
+ # @example Response structure
641
+ #
642
+ # resp.telemetry_configurations #=> Array
643
+ # resp.telemetry_configurations[0].account_identifier #=> String
644
+ # resp.telemetry_configurations[0].telemetry_configuration_state #=> Hash
645
+ # resp.telemetry_configurations[0].telemetry_configuration_state["TelemetryType"] #=> String, one of "Enabled", "Disabled", "NotApplicable"
646
+ # resp.telemetry_configurations[0].resource_type #=> String, one of "AWS::EC2::Instance", "AWS::EC2::VPC", "AWS::Lambda::Function"
647
+ # resp.telemetry_configurations[0].resource_identifier #=> String
648
+ # resp.telemetry_configurations[0].resource_tags #=> Hash
649
+ # resp.telemetry_configurations[0].resource_tags["String"] #=> String
650
+ # resp.telemetry_configurations[0].last_update_time_stamp #=> Integer
651
+ # resp.next_token #=> String
652
+ #
653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/ListResourceTelemetryForOrganization AWS API Documentation
654
+ #
655
+ # @overload list_resource_telemetry_for_organization(params = {})
656
+ # @param [Hash] params ({})
657
+ def list_resource_telemetry_for_organization(params = {}, options = {})
658
+ req = build_request(:list_resource_telemetry_for_organization, params)
659
+ req.send_request(options)
660
+ end
661
+
662
+ # This action begins onboarding onboarding the caller AWS account to the
663
+ # telemetry config feature.
664
+ #
665
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
666
+ #
667
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/StartTelemetryEvaluation AWS API Documentation
668
+ #
669
+ # @overload start_telemetry_evaluation(params = {})
670
+ # @param [Hash] params ({})
671
+ def start_telemetry_evaluation(params = {}, options = {})
672
+ req = build_request(:start_telemetry_evaluation, params)
673
+ req.send_request(options)
674
+ end
675
+
676
+ # This actions begins onboarding the organization and all member
677
+ # accounts to the telemetry config feature.
678
+ #
679
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
680
+ #
681
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/StartTelemetryEvaluationForOrganization AWS API Documentation
682
+ #
683
+ # @overload start_telemetry_evaluation_for_organization(params = {})
684
+ # @param [Hash] params ({})
685
+ def start_telemetry_evaluation_for_organization(params = {}, options = {})
686
+ req = build_request(:start_telemetry_evaluation_for_organization, params)
687
+ req.send_request(options)
688
+ end
689
+
690
+ # This action begins offboarding the caller AWS account from the
691
+ # telemetry config feature.
692
+ #
693
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
694
+ #
695
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/StopTelemetryEvaluation AWS API Documentation
696
+ #
697
+ # @overload stop_telemetry_evaluation(params = {})
698
+ # @param [Hash] params ({})
699
+ def stop_telemetry_evaluation(params = {}, options = {})
700
+ req = build_request(:stop_telemetry_evaluation, params)
701
+ req.send_request(options)
702
+ end
703
+
704
+ # This action offboards the Organization of the caller AWS account from
705
+ # thef telemetry config feature.
706
+ #
707
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
708
+ #
709
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/StopTelemetryEvaluationForOrganization AWS API Documentation
710
+ #
711
+ # @overload stop_telemetry_evaluation_for_organization(params = {})
712
+ # @param [Hash] params ({})
713
+ def stop_telemetry_evaluation_for_organization(params = {}, options = {})
714
+ req = build_request(:stop_telemetry_evaluation_for_organization, params)
715
+ req.send_request(options)
716
+ end
717
+
718
+ # @!endgroup
719
+
720
+ # @param params ({})
721
+ # @api private
722
+ def build_request(operation_name, params = {})
723
+ handlers = @handlers.for(operation_name)
724
+ tracer = config.telemetry_provider.tracer_provider.tracer(
725
+ Aws::Telemetry.module_to_tracer_name('Aws::ObservabilityAdmin')
726
+ )
727
+ context = Seahorse::Client::RequestContext.new(
728
+ operation_name: operation_name,
729
+ operation: config.api.operation(operation_name),
730
+ client: self,
731
+ params: params,
732
+ config: config,
733
+ tracer: tracer
734
+ )
735
+ context[:gem_name] = 'aws-sdk-observabilityadmin'
736
+ context[:gem_version] = '1.0.0'
737
+ Seahorse::Client::Request.new(handlers, context)
738
+ end
739
+
740
+ # @api private
741
+ # @deprecated
742
+ def waiter_names
743
+ []
744
+ end
745
+
746
+ class << self
747
+
748
+ # @api private
749
+ attr_reader :identifier
750
+
751
+ # @api private
752
+ def errors_module
753
+ Errors
754
+ end
755
+
756
+ end
757
+ end
758
+ end