aws-sdk-aiops 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 +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-aiops/client.rb +1106 -0
- data/lib/aws-sdk-aiops/client_api.rb +404 -0
- data/lib/aws-sdk-aiops/customizations.rb +0 -0
- data/lib/aws-sdk-aiops/endpoint_parameters.rb +69 -0
- data/lib/aws-sdk-aiops/endpoint_provider.rb +50 -0
- data/lib/aws-sdk-aiops/endpoints.rb +20 -0
- data/lib/aws-sdk-aiops/errors.rb +186 -0
- data/lib/aws-sdk-aiops/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-aiops/resource.rb +26 -0
- data/lib/aws-sdk-aiops/types.rb +713 -0
- data/lib/aws-sdk-aiops/waiters.rb +15 -0
- data/lib/aws-sdk-aiops.rb +62 -0
- data/sig/client.rbs +219 -0
- data/sig/errors.rbs +44 -0
- data/sig/resource.rbs +84 -0
- data/sig/types.rbs +193 -0
- data/sig/waiters.rbs +13 -0
- metadata +97 -0
@@ -0,0 +1,1106 @@
|
|
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'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration'
|
12
|
+
require 'aws-sdk-core/plugins/logging'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token'
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id'
|
26
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin'
|
28
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin'
|
29
|
+
require 'aws-sdk-core/plugins/transfer_encoding'
|
30
|
+
require 'aws-sdk-core/plugins/http_checksum'
|
31
|
+
require 'aws-sdk-core/plugins/checksum_algorithm'
|
32
|
+
require 'aws-sdk-core/plugins/request_compression'
|
33
|
+
require 'aws-sdk-core/plugins/defaults_mode'
|
34
|
+
require 'aws-sdk-core/plugins/recursion_detection'
|
35
|
+
require 'aws-sdk-core/plugins/telemetry'
|
36
|
+
require 'aws-sdk-core/plugins/sign'
|
37
|
+
require 'aws-sdk-core/plugins/protocols/rest_json'
|
38
|
+
|
39
|
+
module Aws::AIOps
|
40
|
+
# An API client for AIOps. To construct a client, you need to configure a `:region` and `:credentials`.
|
41
|
+
#
|
42
|
+
# client = Aws::AIOps::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 = :aiops
|
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::AIOps::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
|
+
# When `true`, the SDK will not prepend the modeled host prefix to the endpoint.
|
204
|
+
#
|
205
|
+
# @option options [Boolean] :disable_request_compression (false)
|
206
|
+
# When set to 'true' the request body will not be compressed
|
207
|
+
# for supported operations.
|
208
|
+
#
|
209
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
210
|
+
# Normally you should not configure the `:endpoint` option
|
211
|
+
# directly. This is normally constructed from the `:region`
|
212
|
+
# option. Configuring `:endpoint` is normally reserved for
|
213
|
+
# connecting to test or custom endpoints. The endpoint should
|
214
|
+
# be a URI formatted like:
|
215
|
+
#
|
216
|
+
# 'http://example.com'
|
217
|
+
# 'https://example.com'
|
218
|
+
# 'http://example.com:123'
|
219
|
+
#
|
220
|
+
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
221
|
+
# Used for the maximum size limit of the LRU cache storing endpoints data
|
222
|
+
# for endpoint discovery enabled operations. Defaults to 1000.
|
223
|
+
#
|
224
|
+
# @option options [Integer] :endpoint_cache_max_threads (10)
|
225
|
+
# Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
|
226
|
+
#
|
227
|
+
# @option options [Integer] :endpoint_cache_poll_interval (60)
|
228
|
+
# When :endpoint_discovery and :active_endpoint_cache is enabled,
|
229
|
+
# Use this option to config the time interval in seconds for making
|
230
|
+
# requests fetching endpoints information. Defaults to 60 sec.
|
231
|
+
#
|
232
|
+
# @option options [Boolean] :endpoint_discovery (false)
|
233
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
234
|
+
#
|
235
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
236
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
237
|
+
# variables and the shared configuration file.
|
238
|
+
#
|
239
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
240
|
+
# The log formatter.
|
241
|
+
#
|
242
|
+
# @option options [Symbol] :log_level (:info)
|
243
|
+
# The log level to send messages to the `:logger` at.
|
244
|
+
#
|
245
|
+
# @option options [Logger] :logger
|
246
|
+
# The Logger instance to send log messages to. If this option
|
247
|
+
# is not set, logging will be disabled.
|
248
|
+
#
|
249
|
+
# @option options [Integer] :max_attempts (3)
|
250
|
+
# An integer representing the maximum number attempts that will be made for
|
251
|
+
# a single request, including the initial attempt. For example,
|
252
|
+
# setting this value to 5 will result in a request being retried up to
|
253
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
254
|
+
#
|
255
|
+
# @option options [String] :profile ("default")
|
256
|
+
# Used when loading credentials from the shared credentials file
|
257
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
258
|
+
#
|
259
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
260
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
261
|
+
#
|
262
|
+
# * `when_supported` - (default) When set, a checksum will be
|
263
|
+
# calculated for all request payloads of operations modeled with the
|
264
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
265
|
+
# `requestAlgorithmMember` is modeled.
|
266
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
267
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
268
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
269
|
+
# is modeled and supplied.
|
270
|
+
#
|
271
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
272
|
+
# The minimum size in bytes that triggers compression for request
|
273
|
+
# bodies. The value must be non-negative integer value between 0
|
274
|
+
# and 10485780 bytes inclusive.
|
275
|
+
#
|
276
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
277
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
278
|
+
#
|
279
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
280
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
281
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
282
|
+
# are supported.
|
283
|
+
# * `when_required` - When set, checksum validation is not performed on
|
284
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
285
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
286
|
+
#
|
287
|
+
# @option options [Proc] :retry_backoff
|
288
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
289
|
+
# This option is only used in the `legacy` retry mode.
|
290
|
+
#
|
291
|
+
# @option options [Float] :retry_base_delay (0.3)
|
292
|
+
# The base delay in seconds used by the default backoff function. This option
|
293
|
+
# is only used in the `legacy` retry mode.
|
294
|
+
#
|
295
|
+
# @option options [Symbol] :retry_jitter (:none)
|
296
|
+
# A delay randomiser function used by the default backoff function.
|
297
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
298
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
299
|
+
# in the `legacy` retry mode.
|
300
|
+
#
|
301
|
+
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
302
|
+
#
|
303
|
+
# @option options [Integer] :retry_limit (3)
|
304
|
+
# The maximum number of times to retry failed requests. Only
|
305
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
306
|
+
# are retried. Generally, these are throttling errors, data
|
307
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
308
|
+
# endpoint discovery, and errors from expired credentials.
|
309
|
+
# This option is only used in the `legacy` retry mode.
|
310
|
+
#
|
311
|
+
# @option options [Integer] :retry_max_delay (0)
|
312
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
313
|
+
# used by the default backoff function. This option is only used in the
|
314
|
+
# `legacy` retry mode.
|
315
|
+
#
|
316
|
+
# @option options [String] :retry_mode ("legacy")
|
317
|
+
# Specifies which retry algorithm to use. Values are:
|
318
|
+
#
|
319
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
320
|
+
# no retry mode is provided.
|
321
|
+
#
|
322
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
323
|
+
# This includes support for retry quotas, which limit the number of
|
324
|
+
# unsuccessful retries a client can make.
|
325
|
+
#
|
326
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
327
|
+
# functionality of `standard` mode along with automatic client side
|
328
|
+
# throttling. This is a provisional mode that may change behavior
|
329
|
+
# in the future.
|
330
|
+
#
|
331
|
+
# @option options [String] :sdk_ua_app_id
|
332
|
+
# A unique and opaque application ID that is appended to the
|
333
|
+
# User-Agent header as app/sdk_ua_app_id. It should have a
|
334
|
+
# maximum length of 50. This variable is sourced from environment
|
335
|
+
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
|
336
|
+
#
|
337
|
+
# @option options [String] :secret_access_key
|
338
|
+
#
|
339
|
+
# @option options [String] :session_token
|
340
|
+
#
|
341
|
+
# @option options [Array] :sigv4a_signing_region_set
|
342
|
+
# A list of regions that should be signed with SigV4a signing. When
|
343
|
+
# not passed, a default `:sigv4a_signing_region_set` is searched for
|
344
|
+
# in the following locations:
|
345
|
+
#
|
346
|
+
# * `Aws.config[:sigv4a_signing_region_set]`
|
347
|
+
# * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
|
348
|
+
# * `~/.aws/config`
|
349
|
+
#
|
350
|
+
# @option options [Boolean] :stub_responses (false)
|
351
|
+
# Causes the client to return stubbed responses. By default
|
352
|
+
# fake responses are generated and returned. You can specify
|
353
|
+
# the response data to return or errors to raise by calling
|
354
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
355
|
+
#
|
356
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
357
|
+
# requests are made, and retries are disabled.
|
358
|
+
#
|
359
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
360
|
+
# Allows you to provide a telemetry provider, which is used to
|
361
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
362
|
+
# will not record or emit any telemetry data. The SDK supports the
|
363
|
+
# following telemetry providers:
|
364
|
+
#
|
365
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
366
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
367
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
368
|
+
#
|
369
|
+
# @option options [Aws::TokenProvider] :token_provider
|
370
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
371
|
+
# following classes:
|
372
|
+
#
|
373
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
374
|
+
# tokens.
|
375
|
+
#
|
376
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
377
|
+
# access token generated from `aws login`.
|
378
|
+
#
|
379
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
380
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
381
|
+
#
|
382
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
383
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
384
|
+
# will be used if available.
|
385
|
+
#
|
386
|
+
# @option options [Boolean] :use_fips_endpoint
|
387
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
388
|
+
# When a `fips` region is used, the region is normalized and this config
|
389
|
+
# is set to `true`.
|
390
|
+
#
|
391
|
+
# @option options [Boolean] :validate_params (true)
|
392
|
+
# When `true`, request parameters are validated before
|
393
|
+
# sending the request.
|
394
|
+
#
|
395
|
+
# @option options [Aws::AIOps::EndpointProvider] :endpoint_provider
|
396
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to
|
397
|
+
# `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
|
398
|
+
# `Aws::AIOps::EndpointParameters`.
|
399
|
+
#
|
400
|
+
# @option options [Float] :http_continue_timeout (1)
|
401
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
402
|
+
# request body. This option has no effect unless the request has "Expect"
|
403
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
404
|
+
# behaviour. This value can safely be set per request on the session.
|
405
|
+
#
|
406
|
+
# @option options [Float] :http_idle_timeout (5)
|
407
|
+
# The number of seconds a connection is allowed to sit idle before it
|
408
|
+
# is considered stale. Stale connections are closed and removed from the
|
409
|
+
# pool before making a request.
|
410
|
+
#
|
411
|
+
# @option options [Float] :http_open_timeout (15)
|
412
|
+
# The default number of seconds to wait for response data.
|
413
|
+
# This value can safely be set per-request on the session.
|
414
|
+
#
|
415
|
+
# @option options [URI::HTTP,String] :http_proxy
|
416
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
417
|
+
#
|
418
|
+
# @option options [Float] :http_read_timeout (60)
|
419
|
+
# The default number of seconds to wait for response data.
|
420
|
+
# This value can safely be set per-request on the session.
|
421
|
+
#
|
422
|
+
# @option options [Boolean] :http_wire_trace (false)
|
423
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
424
|
+
#
|
425
|
+
# @option options [Proc] :on_chunk_received
|
426
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
427
|
+
# of the response body is received. It provides three arguments: the chunk,
|
428
|
+
# the number of bytes received, and the total number of
|
429
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
430
|
+
#
|
431
|
+
# @option options [Proc] :on_chunk_sent
|
432
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
433
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
434
|
+
# the number of bytes read from the body, and the total number of
|
435
|
+
# bytes in the body.
|
436
|
+
#
|
437
|
+
# @option options [Boolean] :raise_response_errors (true)
|
438
|
+
# When `true`, response errors are raised.
|
439
|
+
#
|
440
|
+
# @option options [String] :ssl_ca_bundle
|
441
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
442
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
443
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
444
|
+
#
|
445
|
+
# @option options [String] :ssl_ca_directory
|
446
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
447
|
+
# authority files for verifying peer certificates. If you do
|
448
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
449
|
+
# default will be used if available.
|
450
|
+
#
|
451
|
+
# @option options [String] :ssl_ca_store
|
452
|
+
# Sets the X509::Store to verify peer certificate.
|
453
|
+
#
|
454
|
+
# @option options [OpenSSL::X509::Certificate] :ssl_cert
|
455
|
+
# Sets a client certificate when creating http connections.
|
456
|
+
#
|
457
|
+
# @option options [OpenSSL::PKey] :ssl_key
|
458
|
+
# Sets a client key when creating http connections.
|
459
|
+
#
|
460
|
+
# @option options [Float] :ssl_timeout
|
461
|
+
# Sets the SSL timeout in seconds
|
462
|
+
#
|
463
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
464
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
465
|
+
#
|
466
|
+
def initialize(*args)
|
467
|
+
super
|
468
|
+
end
|
469
|
+
|
470
|
+
# @!group API Operations
|
471
|
+
|
472
|
+
# Creates an *investigation group* in your account. Creating an
|
473
|
+
# investigation group is a one-time setup task for each Region in your
|
474
|
+
# account. It is a necessary task to be able to perform investigations.
|
475
|
+
#
|
476
|
+
# Settings in the investigation group help you centrally manage the
|
477
|
+
# common properties of your investigations, such as the following:
|
478
|
+
#
|
479
|
+
# * Who can access the investigations
|
480
|
+
#
|
481
|
+
# * Whether investigation data is encrypted with a customer managed Key
|
482
|
+
# Management Service key.
|
483
|
+
#
|
484
|
+
# * How long investigations and their data are retained by default.
|
485
|
+
#
|
486
|
+
# Currently, you can have one investigation group in each Region in your
|
487
|
+
# account. Each investigation in a Region is a part of the investigation
|
488
|
+
# group in that Region
|
489
|
+
#
|
490
|
+
# To create an investigation group and set up Amazon Q Developer
|
491
|
+
# operational investigations, you must be signed in to an IAM principal
|
492
|
+
# that has the either the `AIOpsConsoleAdminPolicy` or the
|
493
|
+
# `AdministratorAccess` IAM policy attached, or to an account that has
|
494
|
+
# similar permissions.
|
495
|
+
#
|
496
|
+
# You can configure CloudWatch alarms to start investigations and add
|
497
|
+
# events to investigations. If you create your investigation group with
|
498
|
+
# `CreateInvestigationGroup` and you want to enable alarms to do this,
|
499
|
+
# you must use [PutInvestigationGroupPolicy][1] to create a resource
|
500
|
+
# policy that grants this permission to CloudWatch alarms.
|
501
|
+
#
|
502
|
+
# For more information about configuring CloudWatch alarms to work with
|
503
|
+
# Amazon Q Developer operational investigations, see
|
504
|
+
#
|
505
|
+
#
|
506
|
+
#
|
507
|
+
# [1]: https://docs.aws.amazon.com/operationalinvestigations/latest/AmazonQDeveloperOperationalInvestigationsAPIReference/API_PutInvestigationGroupPolicy.html
|
508
|
+
#
|
509
|
+
# @option params [required, String] :name
|
510
|
+
# A name for the investigation group.
|
511
|
+
#
|
512
|
+
# @option params [required, String] :role_arn
|
513
|
+
# Specify the ARN of the IAM role that Amazon Q Developer operational
|
514
|
+
# investigations will use when it gathers investigation data. The
|
515
|
+
# permissions in this role determine which of your resources that Amazon
|
516
|
+
# Q Developer operational investigations will have access to during
|
517
|
+
# investigations.
|
518
|
+
#
|
519
|
+
# For more information, see [How to control what data Amazon Q has
|
520
|
+
# access to during investigations][1].
|
521
|
+
#
|
522
|
+
#
|
523
|
+
#
|
524
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-Security-Data
|
525
|
+
#
|
526
|
+
# @option params [Types::EncryptionConfiguration] :encryption_configuration
|
527
|
+
# Use this structure if you want to use a customer managed KMS key to
|
528
|
+
# encrypt your investigation data. If you omit this parameter, Amazon Q
|
529
|
+
# Developer operational investigations will use an Amazon Web Services
|
530
|
+
# key to encrypt the data. For more information, see [Encryption of
|
531
|
+
# investigation data][1].
|
532
|
+
#
|
533
|
+
#
|
534
|
+
#
|
535
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-KMS
|
536
|
+
#
|
537
|
+
# @option params [Integer] :retention_in_days
|
538
|
+
# Specify how long that investigation data is kept. For more
|
539
|
+
# information, see [Operational investigation data retention][1].
|
540
|
+
#
|
541
|
+
# If you omit this parameter, the default of 90 days is used.
|
542
|
+
#
|
543
|
+
#
|
544
|
+
#
|
545
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Retention.html
|
546
|
+
#
|
547
|
+
# @option params [Hash<String,String>] :tags
|
548
|
+
# A list of key-value pairs to associate with the investigation group.
|
549
|
+
# You can associate as many as 50 tags with an investigation group. To
|
550
|
+
# be able to associate tags when you create the investigation group, you
|
551
|
+
# must have the `cloudwatch:TagResource` permission.
|
552
|
+
#
|
553
|
+
# Tags can help you organize and categorize your resources. You can also
|
554
|
+
# use them to scope user permissions by granting a user permission to
|
555
|
+
# access or change only resources with certain tag values.
|
556
|
+
#
|
557
|
+
# @option params [Array<String>] :tag_key_boundaries
|
558
|
+
# Enter the existing custom tag keys for custom applications in your
|
559
|
+
# system. Resource tags help Amazon Q narrow the search space when it is
|
560
|
+
# unable to discover definite relationships between resources. For
|
561
|
+
# example, to discover that an Amazon ECS service depends on an Amazon
|
562
|
+
# RDS database, Amazon Q can discover this relationship using data
|
563
|
+
# sources such as X-Ray and CloudWatch Application Signals. However, if
|
564
|
+
# you haven't deployed these features, Amazon Q will attempt to
|
565
|
+
# identify possible relationships. Tag boundaries can be used to narrow
|
566
|
+
# the resources that will be discovered by Amazon Q in these cases.
|
567
|
+
#
|
568
|
+
# You don't need to enter tags created by myApplications or
|
569
|
+
# CloudFormation, because Amazon Q can automatically detect those tags.
|
570
|
+
#
|
571
|
+
# @option params [Hash<String,Array>] :chatbot_notification_channel
|
572
|
+
# Use this structure to integrate Amazon Q Developer operational
|
573
|
+
# investigations with Amazon Q in chat applications. This structure is a
|
574
|
+
# string array. For the first string, specify the ARN of an Amazon SNS
|
575
|
+
# topic. For the array of strings, specify the ARNs of one or more
|
576
|
+
# Amazon Q in chat applications configurations that you want to
|
577
|
+
# associate with that topic. For more information about these
|
578
|
+
# configuration ARNs, see [Getting started with Amazon Q in chat
|
579
|
+
# applications][1] and [Resource type defined by Amazon Web Services
|
580
|
+
# Chatbot][2].
|
581
|
+
#
|
582
|
+
#
|
583
|
+
#
|
584
|
+
# [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/getting-started.html
|
585
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awschatbot.html#awschatbot-resources-for-iam-policies
|
586
|
+
#
|
587
|
+
# @option params [Boolean] :is_cloud_trail_event_history_enabled
|
588
|
+
# Specify `true` to enable Amazon Q Developer operational investigations
|
589
|
+
# to have access to change events that are recorded by CloudTrail. The
|
590
|
+
# default is `true`.
|
591
|
+
#
|
592
|
+
# @return [Types::CreateInvestigationGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
593
|
+
#
|
594
|
+
# * {Types::CreateInvestigationGroupOutput#arn #arn} => String
|
595
|
+
#
|
596
|
+
# @example Request syntax with placeholder values
|
597
|
+
#
|
598
|
+
# resp = client.create_investigation_group({
|
599
|
+
# name: "StringWithPatternAndLengthLimits", # required
|
600
|
+
# role_arn: "RoleArn", # required
|
601
|
+
# encryption_configuration: {
|
602
|
+
# type: "AWS_OWNED_KEY", # accepts AWS_OWNED_KEY, CUSTOMER_MANAGED_KMS_KEY
|
603
|
+
# kms_key_id: "KmsKeyId",
|
604
|
+
# },
|
605
|
+
# retention_in_days: 1,
|
606
|
+
# tags: {
|
607
|
+
# "TagKey" => "TagValue",
|
608
|
+
# },
|
609
|
+
# tag_key_boundaries: ["TagKey"],
|
610
|
+
# chatbot_notification_channel: {
|
611
|
+
# "SNSTopicArn" => ["ChatConfigurationArn"],
|
612
|
+
# },
|
613
|
+
# is_cloud_trail_event_history_enabled: false,
|
614
|
+
# })
|
615
|
+
#
|
616
|
+
# @example Response structure
|
617
|
+
#
|
618
|
+
# resp.arn #=> String
|
619
|
+
#
|
620
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/aiops-2018-05-10/CreateInvestigationGroup AWS API Documentation
|
621
|
+
#
|
622
|
+
# @overload create_investigation_group(params = {})
|
623
|
+
# @param [Hash] params ({})
|
624
|
+
def create_investigation_group(params = {}, options = {})
|
625
|
+
req = build_request(:create_investigation_group, params)
|
626
|
+
req.send_request(options)
|
627
|
+
end
|
628
|
+
|
629
|
+
# Deletes the specified investigation group from your account. You can
|
630
|
+
# currently have one investigation group per Region in your account.
|
631
|
+
# After you delete an investigation group, you can later create a new
|
632
|
+
# investigation group in the same Region.
|
633
|
+
#
|
634
|
+
# @option params [required, String] :identifier
|
635
|
+
# Specify either the name or the ARN of the investigation group that you
|
636
|
+
# want to delete.
|
637
|
+
#
|
638
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
639
|
+
#
|
640
|
+
# @example Request syntax with placeholder values
|
641
|
+
#
|
642
|
+
# resp = client.delete_investigation_group({
|
643
|
+
# identifier: "InvestigationGroupIdentifier", # required
|
644
|
+
# })
|
645
|
+
#
|
646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/aiops-2018-05-10/DeleteInvestigationGroup AWS API Documentation
|
647
|
+
#
|
648
|
+
# @overload delete_investigation_group(params = {})
|
649
|
+
# @param [Hash] params ({})
|
650
|
+
def delete_investigation_group(params = {}, options = {})
|
651
|
+
req = build_request(:delete_investigation_group, params)
|
652
|
+
req.send_request(options)
|
653
|
+
end
|
654
|
+
|
655
|
+
# Removes the IAM resource policy from being associated with the
|
656
|
+
# investigation group that you specify.
|
657
|
+
#
|
658
|
+
# @option params [required, String] :identifier
|
659
|
+
# Specify either the name or the ARN of the investigation group that you
|
660
|
+
# want to remove the policy from.
|
661
|
+
#
|
662
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
663
|
+
#
|
664
|
+
# @example Request syntax with placeholder values
|
665
|
+
#
|
666
|
+
# resp = client.delete_investigation_group_policy({
|
667
|
+
# identifier: "InvestigationGroupIdentifier", # required
|
668
|
+
# })
|
669
|
+
#
|
670
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/aiops-2018-05-10/DeleteInvestigationGroupPolicy AWS API Documentation
|
671
|
+
#
|
672
|
+
# @overload delete_investigation_group_policy(params = {})
|
673
|
+
# @param [Hash] params ({})
|
674
|
+
def delete_investigation_group_policy(params = {}, options = {})
|
675
|
+
req = build_request(:delete_investigation_group_policy, params)
|
676
|
+
req.send_request(options)
|
677
|
+
end
|
678
|
+
|
679
|
+
# Returns the configuration information for the specified investigation
|
680
|
+
# group.
|
681
|
+
#
|
682
|
+
# @option params [required, String] :identifier
|
683
|
+
# Specify either the name or the ARN of the investigation group that you
|
684
|
+
# want to view.
|
685
|
+
#
|
686
|
+
# @return [Types::GetInvestigationGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
687
|
+
#
|
688
|
+
# * {Types::GetInvestigationGroupResponse#created_by #created_by} => String
|
689
|
+
# * {Types::GetInvestigationGroupResponse#created_at #created_at} => Time
|
690
|
+
# * {Types::GetInvestigationGroupResponse#last_modified_by #last_modified_by} => String
|
691
|
+
# * {Types::GetInvestigationGroupResponse#last_modified_at #last_modified_at} => Time
|
692
|
+
# * {Types::GetInvestigationGroupResponse#name #name} => String
|
693
|
+
# * {Types::GetInvestigationGroupResponse#arn #arn} => String
|
694
|
+
# * {Types::GetInvestigationGroupResponse#role_arn #role_arn} => String
|
695
|
+
# * {Types::GetInvestigationGroupResponse#encryption_configuration #encryption_configuration} => Types::EncryptionConfiguration
|
696
|
+
# * {Types::GetInvestigationGroupResponse#retention_in_days #retention_in_days} => Integer
|
697
|
+
# * {Types::GetInvestigationGroupResponse#chatbot_notification_channel #chatbot_notification_channel} => Hash<String,Array<String>>
|
698
|
+
# * {Types::GetInvestigationGroupResponse#tag_key_boundaries #tag_key_boundaries} => Array<String>
|
699
|
+
# * {Types::GetInvestigationGroupResponse#is_cloud_trail_event_history_enabled #is_cloud_trail_event_history_enabled} => Boolean
|
700
|
+
#
|
701
|
+
# @example Request syntax with placeholder values
|
702
|
+
#
|
703
|
+
# resp = client.get_investigation_group({
|
704
|
+
# identifier: "InvestigationGroupIdentifier", # required
|
705
|
+
# })
|
706
|
+
#
|
707
|
+
# @example Response structure
|
708
|
+
#
|
709
|
+
# resp.created_by #=> String
|
710
|
+
# resp.created_at #=> Time
|
711
|
+
# resp.last_modified_by #=> String
|
712
|
+
# resp.last_modified_at #=> Time
|
713
|
+
# resp.name #=> String
|
714
|
+
# resp.arn #=> String
|
715
|
+
# resp.role_arn #=> String
|
716
|
+
# resp.encryption_configuration.type #=> String, one of "AWS_OWNED_KEY", "CUSTOMER_MANAGED_KMS_KEY"
|
717
|
+
# resp.encryption_configuration.kms_key_id #=> String
|
718
|
+
# resp.retention_in_days #=> Integer
|
719
|
+
# resp.chatbot_notification_channel #=> Hash
|
720
|
+
# resp.chatbot_notification_channel["SNSTopicArn"] #=> Array
|
721
|
+
# resp.chatbot_notification_channel["SNSTopicArn"][0] #=> String
|
722
|
+
# resp.tag_key_boundaries #=> Array
|
723
|
+
# resp.tag_key_boundaries[0] #=> String
|
724
|
+
# resp.is_cloud_trail_event_history_enabled #=> Boolean
|
725
|
+
#
|
726
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/aiops-2018-05-10/GetInvestigationGroup AWS API Documentation
|
727
|
+
#
|
728
|
+
# @overload get_investigation_group(params = {})
|
729
|
+
# @param [Hash] params ({})
|
730
|
+
def get_investigation_group(params = {}, options = {})
|
731
|
+
req = build_request(:get_investigation_group, params)
|
732
|
+
req.send_request(options)
|
733
|
+
end
|
734
|
+
|
735
|
+
# Returns the IAM resource policy that is associated with the specified
|
736
|
+
# investigation group.
|
737
|
+
#
|
738
|
+
# @option params [required, String] :identifier
|
739
|
+
# Specify either the name or the ARN of the investigation group that you
|
740
|
+
# want to view the policy of.
|
741
|
+
#
|
742
|
+
# @return [Types::GetInvestigationGroupPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
743
|
+
#
|
744
|
+
# * {Types::GetInvestigationGroupPolicyResponse#investigation_group_arn #investigation_group_arn} => String
|
745
|
+
# * {Types::GetInvestigationGroupPolicyResponse#policy #policy} => String
|
746
|
+
#
|
747
|
+
# @example Request syntax with placeholder values
|
748
|
+
#
|
749
|
+
# resp = client.get_investigation_group_policy({
|
750
|
+
# identifier: "InvestigationGroupIdentifier", # required
|
751
|
+
# })
|
752
|
+
#
|
753
|
+
# @example Response structure
|
754
|
+
#
|
755
|
+
# resp.investigation_group_arn #=> String
|
756
|
+
# resp.policy #=> String
|
757
|
+
#
|
758
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/aiops-2018-05-10/GetInvestigationGroupPolicy AWS API Documentation
|
759
|
+
#
|
760
|
+
# @overload get_investigation_group_policy(params = {})
|
761
|
+
# @param [Hash] params ({})
|
762
|
+
def get_investigation_group_policy(params = {}, options = {})
|
763
|
+
req = build_request(:get_investigation_group_policy, params)
|
764
|
+
req.send_request(options)
|
765
|
+
end
|
766
|
+
|
767
|
+
# Returns the ARN and name of each investigation group in the account.
|
768
|
+
#
|
769
|
+
# @option params [String] :next_token
|
770
|
+
# Include this value, if it was returned by the previous operation, to
|
771
|
+
# get the next set of service operations.
|
772
|
+
#
|
773
|
+
# @option params [Integer] :max_results
|
774
|
+
# The maximum number of results to return in one operation. If you omit
|
775
|
+
# this parameter, the default of 50 is used.
|
776
|
+
#
|
777
|
+
# @return [Types::ListInvestigationGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
778
|
+
#
|
779
|
+
# * {Types::ListInvestigationGroupsOutput#next_token #next_token} => String
|
780
|
+
# * {Types::ListInvestigationGroupsOutput#investigation_groups #investigation_groups} => Array<Types::ListInvestigationGroupsModel>
|
781
|
+
#
|
782
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
783
|
+
#
|
784
|
+
# @example Request syntax with placeholder values
|
785
|
+
#
|
786
|
+
# resp = client.list_investigation_groups({
|
787
|
+
# next_token: "SensitiveStringWithLengthLimits",
|
788
|
+
# max_results: 1,
|
789
|
+
# })
|
790
|
+
#
|
791
|
+
# @example Response structure
|
792
|
+
#
|
793
|
+
# resp.next_token #=> String
|
794
|
+
# resp.investigation_groups #=> Array
|
795
|
+
# resp.investigation_groups[0].arn #=> String
|
796
|
+
# resp.investigation_groups[0].name #=> String
|
797
|
+
#
|
798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/aiops-2018-05-10/ListInvestigationGroups AWS API Documentation
|
799
|
+
#
|
800
|
+
# @overload list_investigation_groups(params = {})
|
801
|
+
# @param [Hash] params ({})
|
802
|
+
def list_investigation_groups(params = {}, options = {})
|
803
|
+
req = build_request(:list_investigation_groups, params)
|
804
|
+
req.send_request(options)
|
805
|
+
end
|
806
|
+
|
807
|
+
# Displays the tags associated with a Amazon Q Developer operational
|
808
|
+
# investigations resource. Currently, investigation groups support
|
809
|
+
# tagging.
|
810
|
+
#
|
811
|
+
# @option params [required, String] :resource_arn
|
812
|
+
# The ARN of the Amazon Q Developer operational investigations resource
|
813
|
+
# that you want to view tags for. You can use the
|
814
|
+
# [ListInvestigationGroups][1] operation to find the ARNs of
|
815
|
+
# investigation groups.
|
816
|
+
#
|
817
|
+
# The ARN format for an investigation group is
|
818
|
+
# `arn:aws:aiops:Region:account-id:investigation-group:investigation-group-id
|
819
|
+
# `.
|
820
|
+
#
|
821
|
+
#
|
822
|
+
#
|
823
|
+
# [1]: https://docs.aws.amazon.com/operationalinvestigations/latest/AmazonQDeveloperOperationalInvestigationsAPIReference/API_ListInvestigationGroups.html
|
824
|
+
#
|
825
|
+
# @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
826
|
+
#
|
827
|
+
# * {Types::ListTagsForResourceOutput#tags #tags} => Hash<String,String>
|
828
|
+
#
|
829
|
+
# @example Request syntax with placeholder values
|
830
|
+
#
|
831
|
+
# resp = client.list_tags_for_resource({
|
832
|
+
# resource_arn: "String", # required
|
833
|
+
# })
|
834
|
+
#
|
835
|
+
# @example Response structure
|
836
|
+
#
|
837
|
+
# resp.tags #=> Hash
|
838
|
+
# resp.tags["TagKey"] #=> String
|
839
|
+
#
|
840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/aiops-2018-05-10/ListTagsForResource AWS API Documentation
|
841
|
+
#
|
842
|
+
# @overload list_tags_for_resource(params = {})
|
843
|
+
# @param [Hash] params ({})
|
844
|
+
def list_tags_for_resource(params = {}, options = {})
|
845
|
+
req = build_request(:list_tags_for_resource, params)
|
846
|
+
req.send_request(options)
|
847
|
+
end
|
848
|
+
|
849
|
+
# Creates an IAM resource policy and assigns it to the specified
|
850
|
+
# investigation group.
|
851
|
+
#
|
852
|
+
# If you create your investigation group with `CreateInvestigationGroup`
|
853
|
+
# and you want to enable CloudWatch alarms to create investigations and
|
854
|
+
# add events to investigations, you must use this operation to create a
|
855
|
+
# policy similar to this example.
|
856
|
+
#
|
857
|
+
# `{ "Version": "2008-10-17", "Statement": [{ "Effect": "Allow",
|
858
|
+
# "Principal": { "Service": "aiops.alarms.cloudwatch.amazonaws.com" },
|
859
|
+
# "Action": ["aiops:CreateInvestigation",
|
860
|
+
# "aiops:CreateInvestigationEvent"], "Resource": "*", "Condition": {
|
861
|
+
# "StringEquals": { "aws:SourceAccount": "account-id" }, "ArnLike": {
|
862
|
+
# "aws:SourceArn": "arn:aws:cloudwatch:region:account-id:alarm:*" } } }]
|
863
|
+
# }`
|
864
|
+
#
|
865
|
+
# @option params [required, String] :identifier
|
866
|
+
# Specify either the name or the ARN of the investigation group that you
|
867
|
+
# want to assign the policy to.
|
868
|
+
#
|
869
|
+
# @option params [required, String] :policy
|
870
|
+
# The policy, in JSON format.
|
871
|
+
#
|
872
|
+
# @return [Types::PutInvestigationGroupPolicyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
873
|
+
#
|
874
|
+
# * {Types::PutInvestigationGroupPolicyResponse#investigation_group_arn #investigation_group_arn} => String
|
875
|
+
#
|
876
|
+
# @example Request syntax with placeholder values
|
877
|
+
#
|
878
|
+
# resp = client.put_investigation_group_policy({
|
879
|
+
# identifier: "InvestigationGroupIdentifier", # required
|
880
|
+
# policy: "InvestigationGroupPolicyDocument", # required
|
881
|
+
# })
|
882
|
+
#
|
883
|
+
# @example Response structure
|
884
|
+
#
|
885
|
+
# resp.investigation_group_arn #=> String
|
886
|
+
#
|
887
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/aiops-2018-05-10/PutInvestigationGroupPolicy AWS API Documentation
|
888
|
+
#
|
889
|
+
# @overload put_investigation_group_policy(params = {})
|
890
|
+
# @param [Hash] params ({})
|
891
|
+
def put_investigation_group_policy(params = {}, options = {})
|
892
|
+
req = build_request(:put_investigation_group_policy, params)
|
893
|
+
req.send_request(options)
|
894
|
+
end
|
895
|
+
|
896
|
+
# Assigns one or more tags (key-value pairs) to the specified resource.
|
897
|
+
#
|
898
|
+
# Tags can help you organize and categorize your resources. You can also
|
899
|
+
# use them to scope user permissions by granting a user permission to
|
900
|
+
# access or change only resources with certain tag values.
|
901
|
+
#
|
902
|
+
# Tags don't have any semantic meaning to Amazon Web Services and are
|
903
|
+
# interpreted strictly as strings of characters.
|
904
|
+
#
|
905
|
+
# You can associate as many as 50 tags with a resource.
|
906
|
+
#
|
907
|
+
# @option params [required, String] :resource_arn
|
908
|
+
# The Amazon Resource Name (ARN) of the resource that you want to apply
|
909
|
+
# the tags to. You can use the [ListInvestigationGroups][1] operation to
|
910
|
+
# find the ARNs of investigation groups.
|
911
|
+
#
|
912
|
+
#
|
913
|
+
#
|
914
|
+
# [1]: https://docs.aws.amazon.com/operationalinvestigations/latest/AmazonQDeveloperOperationalInvestigationsAPIReference/API_ListInvestigationGroups.html
|
915
|
+
#
|
916
|
+
# @option params [required, Hash<String,String>] :tags
|
917
|
+
# The list of key-value pairs to associate with the resource.
|
918
|
+
#
|
919
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
920
|
+
#
|
921
|
+
# @example Request syntax with placeholder values
|
922
|
+
#
|
923
|
+
# resp = client.tag_resource({
|
924
|
+
# resource_arn: "String", # required
|
925
|
+
# tags: { # required
|
926
|
+
# "TagKey" => "TagValue",
|
927
|
+
# },
|
928
|
+
# })
|
929
|
+
#
|
930
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/aiops-2018-05-10/TagResource AWS API Documentation
|
931
|
+
#
|
932
|
+
# @overload tag_resource(params = {})
|
933
|
+
# @param [Hash] params ({})
|
934
|
+
def tag_resource(params = {}, options = {})
|
935
|
+
req = build_request(:tag_resource, params)
|
936
|
+
req.send_request(options)
|
937
|
+
end
|
938
|
+
|
939
|
+
# Removes one or more tags from the specified resource.
|
940
|
+
#
|
941
|
+
# @option params [required, String] :resource_arn
|
942
|
+
# The Amazon Resource Name (ARN) of the resource that you want to remove
|
943
|
+
# the tags from. You can use the [ListInvestigationGroups][1] operation
|
944
|
+
# to find the ARNs of investigation groups.
|
945
|
+
#
|
946
|
+
#
|
947
|
+
#
|
948
|
+
# [1]: https://docs.aws.amazon.com/operationalinvestigations/latest/AmazonQDeveloperOperationalInvestigationsAPIReference/API_ListInvestigationGroups.html
|
949
|
+
#
|
950
|
+
# @option params [required, Array<String>] :tag_keys
|
951
|
+
# The list of tag keys to remove from the resource.
|
952
|
+
#
|
953
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
954
|
+
#
|
955
|
+
# @example Request syntax with placeholder values
|
956
|
+
#
|
957
|
+
# resp = client.untag_resource({
|
958
|
+
# resource_arn: "String", # required
|
959
|
+
# tag_keys: ["TagKey"], # required
|
960
|
+
# })
|
961
|
+
#
|
962
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/aiops-2018-05-10/UntagResource AWS API Documentation
|
963
|
+
#
|
964
|
+
# @overload untag_resource(params = {})
|
965
|
+
# @param [Hash] params ({})
|
966
|
+
def untag_resource(params = {}, options = {})
|
967
|
+
req = build_request(:untag_resource, params)
|
968
|
+
req.send_request(options)
|
969
|
+
end
|
970
|
+
|
971
|
+
# Updates the configuration of the specified investigation group.
|
972
|
+
#
|
973
|
+
# @option params [required, String] :identifier
|
974
|
+
# Specify either the name or the ARN of the investigation group that you
|
975
|
+
# want to modify.
|
976
|
+
#
|
977
|
+
# @option params [String] :role_arn
|
978
|
+
# Specify this field if you want to change the IAM role that Amazon Q
|
979
|
+
# Developer operational investigations will use when it gathers
|
980
|
+
# investigation data. To do so, specify the ARN of the new role.
|
981
|
+
#
|
982
|
+
# The permissions in this role determine which of your resources that
|
983
|
+
# Amazon Q Developer operational investigations will have access to
|
984
|
+
# during investigations.
|
985
|
+
#
|
986
|
+
# For more information, see [EHow to control what data Amazon Q has
|
987
|
+
# access to during investigations][1].
|
988
|
+
#
|
989
|
+
#
|
990
|
+
#
|
991
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-Security-Data
|
992
|
+
#
|
993
|
+
# @option params [Types::EncryptionConfiguration] :encryption_configuration
|
994
|
+
# Use this structure if you want to use a customer managed KMS key to
|
995
|
+
# encrypt your investigation data. If you omit this parameter, Amazon Q
|
996
|
+
# Developer operational investigations will use an Amazon Web Services
|
997
|
+
# key to encrypt the data. For more information, see [Encryption of
|
998
|
+
# investigation data][1].
|
999
|
+
#
|
1000
|
+
#
|
1001
|
+
#
|
1002
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Investigations-Security.html#Investigations-KMS
|
1003
|
+
#
|
1004
|
+
# @option params [Array<String>] :tag_key_boundaries
|
1005
|
+
# Enter the existing custom tag keys for custom applications in your
|
1006
|
+
# system. Resource tags help Amazon Q narrow the search space when it is
|
1007
|
+
# unable to discover definite relationships between resources. For
|
1008
|
+
# example, to discover that an Amazon ECS service depends on an Amazon
|
1009
|
+
# RDS database, Amazon Q can discover this relationship using data
|
1010
|
+
# sources such as X-Ray and CloudWatch Application Signals. However, if
|
1011
|
+
# you haven't deployed these features, Amazon Q will attempt to
|
1012
|
+
# identify possible relationships. Tag boundaries can be used to narrow
|
1013
|
+
# the resources that will be discovered by Amazon Q in these cases.
|
1014
|
+
#
|
1015
|
+
# You don't need to enter tags created by myApplications or
|
1016
|
+
# CloudFormation, because Amazon Q can automatically detect those tags.
|
1017
|
+
#
|
1018
|
+
# @option params [Hash<String,Array>] :chatbot_notification_channel
|
1019
|
+
# Use this structure to integrate Amazon Q Developer operational
|
1020
|
+
# investigations with Amazon Q in chat applications. This structure is a
|
1021
|
+
# string array. For the first string, specify the ARN of an Amazon SNS
|
1022
|
+
# topic. For the array of strings, specify the ARNs of one or more
|
1023
|
+
# Amazon Q in chat applications configurations that you want to
|
1024
|
+
# associate with that topic. For more information about these
|
1025
|
+
# configuration ARNs, see [Getting started with Amazon Q in chat
|
1026
|
+
# applications][1] and [Resource type defined by Amazon Web Services
|
1027
|
+
# Chatbot][2].
|
1028
|
+
#
|
1029
|
+
#
|
1030
|
+
#
|
1031
|
+
# [1]: https://docs.aws.amazon.com/chatbot/latest/adminguide/getting-started.html
|
1032
|
+
# [2]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awschatbot.html#awschatbot-resources-for-iam-policies
|
1033
|
+
#
|
1034
|
+
# @option params [Boolean] :is_cloud_trail_event_history_enabled
|
1035
|
+
# Specify `true` to enable Amazon Q Developer operational investigations
|
1036
|
+
# to have access to change events that are recorded by CloudTrail. The
|
1037
|
+
# default is `true`.
|
1038
|
+
#
|
1039
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1040
|
+
#
|
1041
|
+
# @example Request syntax with placeholder values
|
1042
|
+
#
|
1043
|
+
# resp = client.update_investigation_group({
|
1044
|
+
# identifier: "InvestigationGroupIdentifier", # required
|
1045
|
+
# role_arn: "RoleArn",
|
1046
|
+
# encryption_configuration: {
|
1047
|
+
# type: "AWS_OWNED_KEY", # accepts AWS_OWNED_KEY, CUSTOMER_MANAGED_KMS_KEY
|
1048
|
+
# kms_key_id: "KmsKeyId",
|
1049
|
+
# },
|
1050
|
+
# tag_key_boundaries: ["TagKey"],
|
1051
|
+
# chatbot_notification_channel: {
|
1052
|
+
# "SNSTopicArn" => ["ChatConfigurationArn"],
|
1053
|
+
# },
|
1054
|
+
# is_cloud_trail_event_history_enabled: false,
|
1055
|
+
# })
|
1056
|
+
#
|
1057
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/aiops-2018-05-10/UpdateInvestigationGroup AWS API Documentation
|
1058
|
+
#
|
1059
|
+
# @overload update_investigation_group(params = {})
|
1060
|
+
# @param [Hash] params ({})
|
1061
|
+
def update_investigation_group(params = {}, options = {})
|
1062
|
+
req = build_request(:update_investigation_group, params)
|
1063
|
+
req.send_request(options)
|
1064
|
+
end
|
1065
|
+
|
1066
|
+
# @!endgroup
|
1067
|
+
|
1068
|
+
# @param params ({})
|
1069
|
+
# @api private
|
1070
|
+
def build_request(operation_name, params = {})
|
1071
|
+
handlers = @handlers.for(operation_name)
|
1072
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
1073
|
+
Aws::Telemetry.module_to_tracer_name('Aws::AIOps')
|
1074
|
+
)
|
1075
|
+
context = Seahorse::Client::RequestContext.new(
|
1076
|
+
operation_name: operation_name,
|
1077
|
+
operation: config.api.operation(operation_name),
|
1078
|
+
client: self,
|
1079
|
+
params: params,
|
1080
|
+
config: config,
|
1081
|
+
tracer: tracer
|
1082
|
+
)
|
1083
|
+
context[:gem_name] = 'aws-sdk-aiops'
|
1084
|
+
context[:gem_version] = '1.0.0'
|
1085
|
+
Seahorse::Client::Request.new(handlers, context)
|
1086
|
+
end
|
1087
|
+
|
1088
|
+
# @api private
|
1089
|
+
# @deprecated
|
1090
|
+
def waiter_names
|
1091
|
+
[]
|
1092
|
+
end
|
1093
|
+
|
1094
|
+
class << self
|
1095
|
+
|
1096
|
+
# @api private
|
1097
|
+
attr_reader :identifier
|
1098
|
+
|
1099
|
+
# @api private
|
1100
|
+
def errors_module
|
1101
|
+
Errors
|
1102
|
+
end
|
1103
|
+
|
1104
|
+
end
|
1105
|
+
end
|
1106
|
+
end
|