aws-sdk-lookoutmetrics 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: d9e3a56331d8114beca6f737fdb21dee3f719b1357f629c02354c5ca114e16ab
4
+ data.tar.gz: a59ff8680a2ba99201d8d49fc1be3be383e3cce6ca85816b7aef403d4e026386
5
+ SHA512:
6
+ metadata.gz: 49402a984fa81e4775f79cf53f0ba8e63d10c583efb21278b12fd4e7f0dea2259beb16ae0f07eb73acc25246ee5f3f6b0af6a737031942b341a55f76706264b9
7
+ data.tar.gz: 9cae4139c20e979cb0de8d6aafceda0ad7ee16407fdacb58d5ebe1f2eb57263e853753016dff302b9a05f7de12942d515bc3f8592793b8d8c7ecafff76a24160
data/CHANGELOG.md ADDED
@@ -0,0 +1,8 @@
1
+ Unreleased Changes
2
+ ------------------
3
+
4
+ 1.0.0 (2021-03-25)
5
+ ------------------
6
+
7
+ * Feature - Initial release of `aws-sdk-lookoutmetrics`.
8
+
data/LICENSE.txt ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 1.0.0
@@ -0,0 +1,53 @@
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
+
11
+ require 'aws-sdk-core'
12
+ require 'aws-sigv4'
13
+
14
+ require_relative 'aws-sdk-lookoutmetrics/types'
15
+ require_relative 'aws-sdk-lookoutmetrics/client_api'
16
+ require_relative 'aws-sdk-lookoutmetrics/client'
17
+ require_relative 'aws-sdk-lookoutmetrics/errors'
18
+ require_relative 'aws-sdk-lookoutmetrics/resource'
19
+ require_relative 'aws-sdk-lookoutmetrics/customizations'
20
+
21
+ # This module provides support for Amazon Lookout for Metrics. This module is available in the
22
+ # `aws-sdk-lookoutmetrics` gem.
23
+ #
24
+ # # Client
25
+ #
26
+ # The {Client} class provides one method for each API operation. Operation
27
+ # methods each accept a hash of request parameters and return a response
28
+ # structure.
29
+ #
30
+ # lookout_metrics = Aws::LookoutMetrics::Client.new
31
+ # resp = lookout_metrics.activate_anomaly_detector(params)
32
+ #
33
+ # See {Client} for more information.
34
+ #
35
+ # # Errors
36
+ #
37
+ # Errors returned from Amazon Lookout for Metrics are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
39
+ #
40
+ # begin
41
+ # # do stuff
42
+ # rescue Aws::LookoutMetrics::Errors::ServiceError
43
+ # # rescues all Amazon Lookout for Metrics API errors
44
+ # end
45
+ #
46
+ # See {Errors} for more information.
47
+ #
48
+ # @!group service
49
+ module Aws::LookoutMetrics
50
+
51
+ GEM_VERSION = '1.0.0'
52
+
53
+ end
@@ -0,0 +1,1637 @@
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/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:lookoutmetrics)
34
+
35
+ module Aws::LookoutMetrics
36
+ # An API client for LookoutMetrics. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::LookoutMetrics::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :lookoutmetrics
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::RestJson)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
87
+ #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
123
+ #
124
+ # @option options [required, String] :region
125
+ # The AWS region to connect to. The configured `:region` is
126
+ # used to determine the service `:endpoint`. When not passed,
127
+ # a default `:region` is searched for in the following locations:
128
+ #
129
+ # * `Aws.config[:region]`
130
+ # * `ENV['AWS_REGION']`
131
+ # * `ENV['AMAZON_REGION']`
132
+ # * `ENV['AWS_DEFAULT_REGION']`
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ #
136
+ # @option options [String] :access_key_id
137
+ #
138
+ # @option options [Boolean] :active_endpoint_cache (false)
139
+ # When set to `true`, a thread polling for endpoints will be running in
140
+ # the background every 60 secs (default). Defaults to `false`.
141
+ #
142
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
143
+ # Used only in `adaptive` retry mode. When true, the request will sleep
144
+ # until there is sufficent client side capacity to retry the request.
145
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
146
+ # not retry instead of sleeping.
147
+ #
148
+ # @option options [Boolean] :client_side_monitoring (false)
149
+ # When `true`, client-side metrics will be collected for all API requests from
150
+ # this client.
151
+ #
152
+ # @option options [String] :client_side_monitoring_client_id ("")
153
+ # Allows you to provide an identifier for this client which will be attached to
154
+ # all generated client side metrics. Defaults to an empty string.
155
+ #
156
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
157
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
158
+ # side monitoring agent is running on, where client metrics will be published via UDP.
159
+ #
160
+ # @option options [Integer] :client_side_monitoring_port (31000)
161
+ # Required for publishing client metrics. The port that the client side monitoring
162
+ # agent is running on, where client metrics will be published via UDP.
163
+ #
164
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
165
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
166
+ # will use the Client Side Monitoring Agent Publisher.
167
+ #
168
+ # @option options [Boolean] :convert_params (true)
169
+ # When `true`, an attempt is made to coerce request parameters into
170
+ # the required types.
171
+ #
172
+ # @option options [Boolean] :correct_clock_skew (true)
173
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
+ # a clock skew correction and retry requests with skewed client clocks.
175
+ #
176
+ # @option options [Boolean] :disable_host_prefix_injection (false)
177
+ # Set to true to disable SDK automatically adding host prefix
178
+ # to default service endpoint when available.
179
+ #
180
+ # @option options [String] :endpoint
181
+ # The client endpoint is normally constructed from the `:region`
182
+ # option. You should only configure an `:endpoint` when connecting
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
184
+ #
185
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
186
+ # Used for the maximum size limit of the LRU cache storing endpoints data
187
+ # for endpoint discovery enabled operations. Defaults to 1000.
188
+ #
189
+ # @option options [Integer] :endpoint_cache_max_threads (10)
190
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
191
+ #
192
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
193
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
194
+ # Use this option to config the time interval in seconds for making
195
+ # requests fetching endpoints information. Defaults to 60 sec.
196
+ #
197
+ # @option options [Boolean] :endpoint_discovery (false)
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
199
+ #
200
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
201
+ # The log formatter.
202
+ #
203
+ # @option options [Symbol] :log_level (:info)
204
+ # The log level to send messages to the `:logger` at.
205
+ #
206
+ # @option options [Logger] :logger
207
+ # The Logger instance to send log messages to. If this option
208
+ # is not set, logging will be disabled.
209
+ #
210
+ # @option options [Integer] :max_attempts (3)
211
+ # An integer representing the maximum number attempts that will be made for
212
+ # a single request, including the initial attempt. For example,
213
+ # setting this value to 5 will result in a request being retried up to
214
+ # 4 times. Used in `standard` and `adaptive` retry modes.
215
+ #
216
+ # @option options [String] :profile ("default")
217
+ # Used when loading credentials from the shared credentials file
218
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
219
+ #
220
+ # @option options [Proc] :retry_backoff
221
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
222
+ # This option is only used in the `legacy` retry mode.
223
+ #
224
+ # @option options [Float] :retry_base_delay (0.3)
225
+ # The base delay in seconds used by the default backoff function. This option
226
+ # is only used in the `legacy` retry mode.
227
+ #
228
+ # @option options [Symbol] :retry_jitter (:none)
229
+ # A delay randomiser function used by the default backoff function.
230
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
231
+ # otherwise a Proc that takes and returns a number. This option is only used
232
+ # in the `legacy` retry mode.
233
+ #
234
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
235
+ #
236
+ # @option options [Integer] :retry_limit (3)
237
+ # The maximum number of times to retry failed requests. Only
238
+ # ~ 500 level server errors and certain ~ 400 level client errors
239
+ # are retried. Generally, these are throttling errors, data
240
+ # checksum errors, networking errors, timeout errors, auth errors,
241
+ # endpoint discovery, and errors from expired credentials.
242
+ # This option is only used in the `legacy` retry mode.
243
+ #
244
+ # @option options [Integer] :retry_max_delay (0)
245
+ # The maximum number of seconds to delay between retries (0 for no limit)
246
+ # used by the default backoff function. This option is only used in the
247
+ # `legacy` retry mode.
248
+ #
249
+ # @option options [String] :retry_mode ("legacy")
250
+ # Specifies which retry algorithm to use. Values are:
251
+ #
252
+ # * `legacy` - The pre-existing retry behavior. This is default value if
253
+ # no retry mode is provided.
254
+ #
255
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
256
+ # This includes support for retry quotas, which limit the number of
257
+ # unsuccessful retries a client can make.
258
+ #
259
+ # * `adaptive` - An experimental retry mode that includes all the
260
+ # functionality of `standard` mode along with automatic client side
261
+ # throttling. This is a provisional mode that may change behavior
262
+ # in the future.
263
+ #
264
+ #
265
+ # @option options [String] :secret_access_key
266
+ #
267
+ # @option options [String] :session_token
268
+ #
269
+ # @option options [Boolean] :stub_responses (false)
270
+ # Causes the client to return stubbed responses. By default
271
+ # fake responses are generated and returned. You can specify
272
+ # the response data to return or errors to raise by calling
273
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
274
+ #
275
+ # ** Please note ** When response stubbing is enabled, no HTTP
276
+ # requests are made, and retries are disabled.
277
+ #
278
+ # @option options [Boolean] :validate_params (true)
279
+ # When `true`, request parameters are validated before
280
+ # sending the request.
281
+ #
282
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
283
+ # requests through. Formatted like 'http://proxy.com:123'.
284
+ #
285
+ # @option options [Float] :http_open_timeout (15) The number of
286
+ # seconds to wait when opening a HTTP session before raising a
287
+ # `Timeout::Error`.
288
+ #
289
+ # @option options [Integer] :http_read_timeout (60) The default
290
+ # number of seconds to wait for response data. This value can
291
+ # safely be set per-request on the session.
292
+ #
293
+ # @option options [Float] :http_idle_timeout (5) The number of
294
+ # seconds a connection is allowed to sit idle before it is
295
+ # considered stale. Stale connections are closed and removed
296
+ # from the pool before making a request.
297
+ #
298
+ # @option options [Float] :http_continue_timeout (1) The number of
299
+ # seconds to wait for a 100-continue response before sending the
300
+ # request body. This option has no effect unless the request has
301
+ # "Expect" header set to "100-continue". Defaults to `nil` which
302
+ # disables this behaviour. This value can safely be set per
303
+ # request on the session.
304
+ #
305
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
306
+ # HTTP debug output will be sent to the `:logger`.
307
+ #
308
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
309
+ # SSL peer certificates are verified when establishing a
310
+ # connection.
311
+ #
312
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
313
+ # certificate authority bundle file that should be used when
314
+ # verifying peer certificates. If you do not pass
315
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
316
+ # will be used if available.
317
+ #
318
+ # @option options [String] :ssl_ca_directory Full path of the
319
+ # directory that contains the unbundled SSL certificate
320
+ # authority files for verifying peer certificates. If you do
321
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
322
+ # system default will be used if available.
323
+ #
324
+ def initialize(*args)
325
+ super
326
+ end
327
+
328
+ # @!group API Operations
329
+
330
+ # Activates an anomaly detector.
331
+ #
332
+ # @option params [required, String] :anomaly_detector_arn
333
+ # The ARN of the anomaly detector.
334
+ #
335
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
336
+ #
337
+ # @example Request syntax with placeholder values
338
+ #
339
+ # resp = client.activate_anomaly_detector({
340
+ # anomaly_detector_arn: "Arn", # required
341
+ # })
342
+ #
343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ActivateAnomalyDetector AWS API Documentation
344
+ #
345
+ # @overload activate_anomaly_detector(params = {})
346
+ # @param [Hash] params ({})
347
+ def activate_anomaly_detector(params = {}, options = {})
348
+ req = build_request(:activate_anomaly_detector, params)
349
+ req.send_request(options)
350
+ end
351
+
352
+ # Runs a backtest for anomaly detection for the specified resource.
353
+ #
354
+ # @option params [required, String] :anomaly_detector_arn
355
+ # The Amazon Resource Name (ARN) of the anomaly detector.
356
+ #
357
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
358
+ #
359
+ # @example Request syntax with placeholder values
360
+ #
361
+ # resp = client.back_test_anomaly_detector({
362
+ # anomaly_detector_arn: "Arn", # required
363
+ # })
364
+ #
365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/BackTestAnomalyDetector AWS API Documentation
366
+ #
367
+ # @overload back_test_anomaly_detector(params = {})
368
+ # @param [Hash] params ({})
369
+ def back_test_anomaly_detector(params = {}, options = {})
370
+ req = build_request(:back_test_anomaly_detector, params)
371
+ req.send_request(options)
372
+ end
373
+
374
+ # Creates an alert for an anomaly detector.
375
+ #
376
+ # @option params [required, String] :alert_name
377
+ # The name of the alert.
378
+ #
379
+ # @option params [required, Integer] :alert_sensitivity_threshold
380
+ # An integer from 0 to 100 specifying the alert sensitivity threshold.
381
+ #
382
+ # @option params [String] :alert_description
383
+ # A description of the alert.
384
+ #
385
+ # @option params [required, String] :anomaly_detector_arn
386
+ # The ARN of the detector to which the alert is attached.
387
+ #
388
+ # @option params [required, Types::Action] :action
389
+ # Action that will be triggered when there is an alert.
390
+ #
391
+ # @option params [Hash<String,String>] :tags
392
+ # A list of [tags][1] to apply to the alert.
393
+ #
394
+ #
395
+ #
396
+ # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
397
+ #
398
+ # @return [Types::CreateAlertResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
399
+ #
400
+ # * {Types::CreateAlertResponse#alert_arn #alert_arn} => String
401
+ #
402
+ # @example Request syntax with placeholder values
403
+ #
404
+ # resp = client.create_alert({
405
+ # alert_name: "AlertName", # required
406
+ # alert_sensitivity_threshold: 1, # required
407
+ # alert_description: "AlertDescription",
408
+ # anomaly_detector_arn: "Arn", # required
409
+ # action: { # required
410
+ # sns_configuration: {
411
+ # role_arn: "Arn", # required
412
+ # sns_topic_arn: "Arn", # required
413
+ # },
414
+ # lambda_configuration: {
415
+ # role_arn: "Arn", # required
416
+ # lambda_arn: "Arn", # required
417
+ # },
418
+ # },
419
+ # tags: {
420
+ # "TagKey" => "TagValue",
421
+ # },
422
+ # })
423
+ #
424
+ # @example Response structure
425
+ #
426
+ # resp.alert_arn #=> String
427
+ #
428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CreateAlert AWS API Documentation
429
+ #
430
+ # @overload create_alert(params = {})
431
+ # @param [Hash] params ({})
432
+ def create_alert(params = {}, options = {})
433
+ req = build_request(:create_alert, params)
434
+ req.send_request(options)
435
+ end
436
+
437
+ # Creates an anomaly detector.
438
+ #
439
+ # @option params [required, String] :anomaly_detector_name
440
+ # The name of the detector.
441
+ #
442
+ # @option params [String] :anomaly_detector_description
443
+ # A description of the detector.
444
+ #
445
+ # @option params [required, Types::AnomalyDetectorConfig] :anomaly_detector_config
446
+ # Contains information about the configuration of the anomaly detector.
447
+ #
448
+ # @option params [String] :kms_key_arn
449
+ # The ARN of the KMS key to use to encrypt your data.
450
+ #
451
+ # @option params [Hash<String,String>] :tags
452
+ # A list of [tags][1] to apply to the anomaly detector.
453
+ #
454
+ #
455
+ #
456
+ # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
457
+ #
458
+ # @return [Types::CreateAnomalyDetectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
459
+ #
460
+ # * {Types::CreateAnomalyDetectorResponse#anomaly_detector_arn #anomaly_detector_arn} => String
461
+ #
462
+ # @example Request syntax with placeholder values
463
+ #
464
+ # resp = client.create_anomaly_detector({
465
+ # anomaly_detector_name: "AnomalyDetectorName", # required
466
+ # anomaly_detector_description: "AnomalyDetectorDescription",
467
+ # anomaly_detector_config: { # required
468
+ # anomaly_detector_frequency: "P1D", # accepts P1D, PT1H, PT10M, PT5M
469
+ # },
470
+ # kms_key_arn: "KmsKeyArn",
471
+ # tags: {
472
+ # "TagKey" => "TagValue",
473
+ # },
474
+ # })
475
+ #
476
+ # @example Response structure
477
+ #
478
+ # resp.anomaly_detector_arn #=> String
479
+ #
480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CreateAnomalyDetector AWS API Documentation
481
+ #
482
+ # @overload create_anomaly_detector(params = {})
483
+ # @param [Hash] params ({})
484
+ def create_anomaly_detector(params = {}, options = {})
485
+ req = build_request(:create_anomaly_detector, params)
486
+ req.send_request(options)
487
+ end
488
+
489
+ # Creates a dataset.
490
+ #
491
+ # @option params [required, String] :anomaly_detector_arn
492
+ # The ARN of the anomaly detector that will use the dataset.
493
+ #
494
+ # @option params [required, String] :metric_set_name
495
+ # The name of the dataset.
496
+ #
497
+ # @option params [String] :metric_set_description
498
+ # A description of the dataset you are creating.
499
+ #
500
+ # @option params [required, Array<Types::Metric>] :metric_list
501
+ # A list of metrics that the dataset will contain.
502
+ #
503
+ # @option params [Integer] :offset
504
+ # After an interval ends, the amount of time that the detector waits
505
+ # before importing data.
506
+ #
507
+ # @option params [Types::TimestampColumn] :timestamp_column
508
+ # Contains information about the column used for tracking time in your
509
+ # source data.
510
+ #
511
+ # @option params [Array<String>] :dimension_list
512
+ # A list of the fields you want to treat as dimensions.
513
+ #
514
+ # @option params [String] :metric_set_frequency
515
+ # The frequency with which the source data will be analyzed for
516
+ # anomalies.
517
+ #
518
+ # @option params [required, Types::MetricSource] :metric_source
519
+ # Contains information about how the source data should be interpreted.
520
+ #
521
+ # @option params [String] :timezone
522
+ # The time zone in which your source data was recorded.
523
+ #
524
+ # @option params [Hash<String,String>] :tags
525
+ # A list of [tags][1] to apply to the dataset.
526
+ #
527
+ #
528
+ #
529
+ # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
530
+ #
531
+ # @return [Types::CreateMetricSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
532
+ #
533
+ # * {Types::CreateMetricSetResponse#metric_set_arn #metric_set_arn} => String
534
+ #
535
+ # @example Request syntax with placeholder values
536
+ #
537
+ # resp = client.create_metric_set({
538
+ # anomaly_detector_arn: "Arn", # required
539
+ # metric_set_name: "MetricSetName", # required
540
+ # metric_set_description: "MetricSetDescription",
541
+ # metric_list: [ # required
542
+ # {
543
+ # metric_name: "ColumnName", # required
544
+ # aggregation_function: "AVG", # required, accepts AVG, SUM
545
+ # namespace: "Namespace",
546
+ # },
547
+ # ],
548
+ # offset: 1,
549
+ # timestamp_column: {
550
+ # column_name: "ColumnName",
551
+ # column_format: "DateTimeFormat",
552
+ # },
553
+ # dimension_list: ["ColumnName"],
554
+ # metric_set_frequency: "P1D", # accepts P1D, PT1H, PT10M, PT5M
555
+ # metric_source: { # required
556
+ # s3_source_config: {
557
+ # role_arn: "Arn", # required
558
+ # templated_path_list: ["TemplatedPath"],
559
+ # historical_data_path_list: ["HistoricalDataPath"],
560
+ # file_format_descriptor: {
561
+ # csv_format_descriptor: {
562
+ # file_compression: "NONE", # accepts NONE, GZIP
563
+ # charset: "Charset",
564
+ # contains_header: false,
565
+ # delimiter: "Delimiter",
566
+ # header_list: ["ColumnName"],
567
+ # quote_symbol: "QuoteSymbol",
568
+ # },
569
+ # json_format_descriptor: {
570
+ # file_compression: "NONE", # accepts NONE, GZIP
571
+ # charset: "Charset",
572
+ # },
573
+ # },
574
+ # },
575
+ # app_flow_config: {
576
+ # role_arn: "Arn", # required
577
+ # flow_name: "FlowName", # required
578
+ # },
579
+ # cloud_watch_config: {
580
+ # role_arn: "Arn", # required
581
+ # },
582
+ # rds_source_config: {
583
+ # db_instance_identifier: "RDSDatabaseIdentifier", # required
584
+ # database_host: "DatabaseHost", # required
585
+ # database_port: 1, # required
586
+ # secret_manager_arn: "PoirotSecretManagerArn", # required
587
+ # database_name: "RDSDatabaseName", # required
588
+ # table_name: "TableName", # required
589
+ # role_arn: "Arn", # required
590
+ # vpc_configuration: { # required
591
+ # subnet_id_list: ["SubnetId"], # required
592
+ # security_group_id_list: ["SecurityGroupId"], # required
593
+ # },
594
+ # },
595
+ # redshift_source_config: {
596
+ # cluster_identifier: "RedshiftClusterIdentifier", # required
597
+ # database_host: "DatabaseHost", # required
598
+ # database_port: 1, # required
599
+ # secret_manager_arn: "PoirotSecretManagerArn", # required
600
+ # database_name: "RedshiftDatabaseName", # required
601
+ # table_name: "TableName", # required
602
+ # role_arn: "Arn", # required
603
+ # vpc_configuration: { # required
604
+ # subnet_id_list: ["SubnetId"], # required
605
+ # security_group_id_list: ["SecurityGroupId"], # required
606
+ # },
607
+ # },
608
+ # },
609
+ # timezone: "Timezone",
610
+ # tags: {
611
+ # "TagKey" => "TagValue",
612
+ # },
613
+ # })
614
+ #
615
+ # @example Response structure
616
+ #
617
+ # resp.metric_set_arn #=> String
618
+ #
619
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CreateMetricSet AWS API Documentation
620
+ #
621
+ # @overload create_metric_set(params = {})
622
+ # @param [Hash] params ({})
623
+ def create_metric_set(params = {}, options = {})
624
+ req = build_request(:create_metric_set, params)
625
+ req.send_request(options)
626
+ end
627
+
628
+ # Deletes an alert.
629
+ #
630
+ # @option params [required, String] :alert_arn
631
+ # The ARN of the alert to delete.
632
+ #
633
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
634
+ #
635
+ # @example Request syntax with placeholder values
636
+ #
637
+ # resp = client.delete_alert({
638
+ # alert_arn: "Arn", # required
639
+ # })
640
+ #
641
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DeleteAlert AWS API Documentation
642
+ #
643
+ # @overload delete_alert(params = {})
644
+ # @param [Hash] params ({})
645
+ def delete_alert(params = {}, options = {})
646
+ req = build_request(:delete_alert, params)
647
+ req.send_request(options)
648
+ end
649
+
650
+ # Deletes a detector. Deleting an anomaly detector will delete all of
651
+ # its corresponding resources including any configured datasets and
652
+ # alerts.
653
+ #
654
+ # @option params [required, String] :anomaly_detector_arn
655
+ # The ARN of the detector to delete.
656
+ #
657
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
658
+ #
659
+ # @example Request syntax with placeholder values
660
+ #
661
+ # resp = client.delete_anomaly_detector({
662
+ # anomaly_detector_arn: "Arn", # required
663
+ # })
664
+ #
665
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DeleteAnomalyDetector AWS API Documentation
666
+ #
667
+ # @overload delete_anomaly_detector(params = {})
668
+ # @param [Hash] params ({})
669
+ def delete_anomaly_detector(params = {}, options = {})
670
+ req = build_request(:delete_anomaly_detector, params)
671
+ req.send_request(options)
672
+ end
673
+
674
+ # Describes an alert.
675
+ #
676
+ # @option params [required, String] :alert_arn
677
+ # The ARN of the alert to describe.
678
+ #
679
+ # @return [Types::DescribeAlertResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
680
+ #
681
+ # * {Types::DescribeAlertResponse#alert #alert} => Types::Alert
682
+ #
683
+ # @example Request syntax with placeholder values
684
+ #
685
+ # resp = client.describe_alert({
686
+ # alert_arn: "Arn", # required
687
+ # })
688
+ #
689
+ # @example Response structure
690
+ #
691
+ # resp.alert.action.sns_configuration.role_arn #=> String
692
+ # resp.alert.action.sns_configuration.sns_topic_arn #=> String
693
+ # resp.alert.action.lambda_configuration.role_arn #=> String
694
+ # resp.alert.action.lambda_configuration.lambda_arn #=> String
695
+ # resp.alert.alert_description #=> String
696
+ # resp.alert.alert_arn #=> String
697
+ # resp.alert.anomaly_detector_arn #=> String
698
+ # resp.alert.alert_name #=> String
699
+ # resp.alert.alert_sensitivity_threshold #=> Integer
700
+ # resp.alert.alert_type #=> String, one of "SNS", "LAMBDA"
701
+ # resp.alert.alert_status #=> String, one of "ACTIVE", "INACTIVE"
702
+ # resp.alert.last_modification_time #=> Time
703
+ # resp.alert.creation_time #=> Time
704
+ #
705
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeAlert AWS API Documentation
706
+ #
707
+ # @overload describe_alert(params = {})
708
+ # @param [Hash] params ({})
709
+ def describe_alert(params = {}, options = {})
710
+ req = build_request(:describe_alert, params)
711
+ req.send_request(options)
712
+ end
713
+
714
+ # Returns information about the status of the specified anomaly
715
+ # detection jobs.
716
+ #
717
+ # @option params [required, String] :anomaly_detector_arn
718
+ # The Amazon Resource Name (ARN) of the anomaly detector.
719
+ #
720
+ # @option params [String] :timestamp
721
+ # The timestamp of the anomaly detection job.
722
+ #
723
+ # @option params [Integer] :max_results
724
+ # The number of items to return in the response.
725
+ #
726
+ # @option params [String] :next_token
727
+ # Specify the pagination token that's returned by a previous request to
728
+ # retrieve the next page of results.
729
+ #
730
+ # @return [Types::DescribeAnomalyDetectionExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
731
+ #
732
+ # * {Types::DescribeAnomalyDetectionExecutionsResponse#execution_list #execution_list} => Array&lt;Types::ExecutionStatus&gt;
733
+ # * {Types::DescribeAnomalyDetectionExecutionsResponse#next_token #next_token} => String
734
+ #
735
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
736
+ #
737
+ # @example Request syntax with placeholder values
738
+ #
739
+ # resp = client.describe_anomaly_detection_executions({
740
+ # anomaly_detector_arn: "Arn", # required
741
+ # timestamp: "TimestampString",
742
+ # max_results: 1,
743
+ # next_token: "NextToken",
744
+ # })
745
+ #
746
+ # @example Response structure
747
+ #
748
+ # resp.execution_list #=> Array
749
+ # resp.execution_list[0].timestamp #=> String
750
+ # resp.execution_list[0].status #=> String, one of "PENDING", "IN_PROGRESS", "COMPLETED", "FAILED", "FAILED_TO_SCHEDULE"
751
+ # resp.execution_list[0].failure_reason #=> String
752
+ # resp.next_token #=> String
753
+ #
754
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeAnomalyDetectionExecutions AWS API Documentation
755
+ #
756
+ # @overload describe_anomaly_detection_executions(params = {})
757
+ # @param [Hash] params ({})
758
+ def describe_anomaly_detection_executions(params = {}, options = {})
759
+ req = build_request(:describe_anomaly_detection_executions, params)
760
+ req.send_request(options)
761
+ end
762
+
763
+ # Describes a detector.
764
+ #
765
+ # @option params [required, String] :anomaly_detector_arn
766
+ # The ARN of the detector to describe.
767
+ #
768
+ # @return [Types::DescribeAnomalyDetectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
769
+ #
770
+ # * {Types::DescribeAnomalyDetectorResponse#anomaly_detector_arn #anomaly_detector_arn} => String
771
+ # * {Types::DescribeAnomalyDetectorResponse#anomaly_detector_name #anomaly_detector_name} => String
772
+ # * {Types::DescribeAnomalyDetectorResponse#anomaly_detector_description #anomaly_detector_description} => String
773
+ # * {Types::DescribeAnomalyDetectorResponse#anomaly_detector_config #anomaly_detector_config} => Types::AnomalyDetectorConfigSummary
774
+ # * {Types::DescribeAnomalyDetectorResponse#creation_time #creation_time} => Time
775
+ # * {Types::DescribeAnomalyDetectorResponse#last_modification_time #last_modification_time} => Time
776
+ # * {Types::DescribeAnomalyDetectorResponse#status #status} => String
777
+ # * {Types::DescribeAnomalyDetectorResponse#failure_reason #failure_reason} => String
778
+ # * {Types::DescribeAnomalyDetectorResponse#kms_key_arn #kms_key_arn} => String
779
+ #
780
+ # @example Request syntax with placeholder values
781
+ #
782
+ # resp = client.describe_anomaly_detector({
783
+ # anomaly_detector_arn: "Arn", # required
784
+ # })
785
+ #
786
+ # @example Response structure
787
+ #
788
+ # resp.anomaly_detector_arn #=> String
789
+ # resp.anomaly_detector_name #=> String
790
+ # resp.anomaly_detector_description #=> String
791
+ # resp.anomaly_detector_config.anomaly_detector_frequency #=> String, one of "P1D", "PT1H", "PT10M", "PT5M"
792
+ # resp.creation_time #=> Time
793
+ # resp.last_modification_time #=> Time
794
+ # resp.status #=> String, one of "ACTIVE", "ACTIVATING", "DELETING", "FAILED", "INACTIVE", "BACK_TEST_ACTIVATING", "BACK_TEST_ACTIVE", "BACK_TEST_COMPLETE"
795
+ # resp.failure_reason #=> String
796
+ # resp.kms_key_arn #=> String
797
+ #
798
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeAnomalyDetector AWS API Documentation
799
+ #
800
+ # @overload describe_anomaly_detector(params = {})
801
+ # @param [Hash] params ({})
802
+ def describe_anomaly_detector(params = {}, options = {})
803
+ req = build_request(:describe_anomaly_detector, params)
804
+ req.send_request(options)
805
+ end
806
+
807
+ # Describes a dataset.
808
+ #
809
+ # @option params [required, String] :metric_set_arn
810
+ # The ARN of the dataset.
811
+ #
812
+ # @return [Types::DescribeMetricSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
813
+ #
814
+ # * {Types::DescribeMetricSetResponse#metric_set_arn #metric_set_arn} => String
815
+ # * {Types::DescribeMetricSetResponse#anomaly_detector_arn #anomaly_detector_arn} => String
816
+ # * {Types::DescribeMetricSetResponse#metric_set_name #metric_set_name} => String
817
+ # * {Types::DescribeMetricSetResponse#metric_set_description #metric_set_description} => String
818
+ # * {Types::DescribeMetricSetResponse#creation_time #creation_time} => Time
819
+ # * {Types::DescribeMetricSetResponse#last_modification_time #last_modification_time} => Time
820
+ # * {Types::DescribeMetricSetResponse#offset #offset} => Integer
821
+ # * {Types::DescribeMetricSetResponse#metric_list #metric_list} => Array&lt;Types::Metric&gt;
822
+ # * {Types::DescribeMetricSetResponse#timestamp_column #timestamp_column} => Types::TimestampColumn
823
+ # * {Types::DescribeMetricSetResponse#dimension_list #dimension_list} => Array&lt;String&gt;
824
+ # * {Types::DescribeMetricSetResponse#metric_set_frequency #metric_set_frequency} => String
825
+ # * {Types::DescribeMetricSetResponse#timezone #timezone} => String
826
+ # * {Types::DescribeMetricSetResponse#metric_source #metric_source} => Types::MetricSource
827
+ #
828
+ # @example Request syntax with placeholder values
829
+ #
830
+ # resp = client.describe_metric_set({
831
+ # metric_set_arn: "Arn", # required
832
+ # })
833
+ #
834
+ # @example Response structure
835
+ #
836
+ # resp.metric_set_arn #=> String
837
+ # resp.anomaly_detector_arn #=> String
838
+ # resp.metric_set_name #=> String
839
+ # resp.metric_set_description #=> String
840
+ # resp.creation_time #=> Time
841
+ # resp.last_modification_time #=> Time
842
+ # resp.offset #=> Integer
843
+ # resp.metric_list #=> Array
844
+ # resp.metric_list[0].metric_name #=> String
845
+ # resp.metric_list[0].aggregation_function #=> String, one of "AVG", "SUM"
846
+ # resp.metric_list[0].namespace #=> String
847
+ # resp.timestamp_column.column_name #=> String
848
+ # resp.timestamp_column.column_format #=> String
849
+ # resp.dimension_list #=> Array
850
+ # resp.dimension_list[0] #=> String
851
+ # resp.metric_set_frequency #=> String, one of "P1D", "PT1H", "PT10M", "PT5M"
852
+ # resp.timezone #=> String
853
+ # resp.metric_source.s3_source_config.role_arn #=> String
854
+ # resp.metric_source.s3_source_config.templated_path_list #=> Array
855
+ # resp.metric_source.s3_source_config.templated_path_list[0] #=> String
856
+ # resp.metric_source.s3_source_config.historical_data_path_list #=> Array
857
+ # resp.metric_source.s3_source_config.historical_data_path_list[0] #=> String
858
+ # resp.metric_source.s3_source_config.file_format_descriptor.csv_format_descriptor.file_compression #=> String, one of "NONE", "GZIP"
859
+ # resp.metric_source.s3_source_config.file_format_descriptor.csv_format_descriptor.charset #=> String
860
+ # resp.metric_source.s3_source_config.file_format_descriptor.csv_format_descriptor.contains_header #=> Boolean
861
+ # resp.metric_source.s3_source_config.file_format_descriptor.csv_format_descriptor.delimiter #=> String
862
+ # resp.metric_source.s3_source_config.file_format_descriptor.csv_format_descriptor.header_list #=> Array
863
+ # resp.metric_source.s3_source_config.file_format_descriptor.csv_format_descriptor.header_list[0] #=> String
864
+ # resp.metric_source.s3_source_config.file_format_descriptor.csv_format_descriptor.quote_symbol #=> String
865
+ # resp.metric_source.s3_source_config.file_format_descriptor.json_format_descriptor.file_compression #=> String, one of "NONE", "GZIP"
866
+ # resp.metric_source.s3_source_config.file_format_descriptor.json_format_descriptor.charset #=> String
867
+ # resp.metric_source.app_flow_config.role_arn #=> String
868
+ # resp.metric_source.app_flow_config.flow_name #=> String
869
+ # resp.metric_source.cloud_watch_config.role_arn #=> String
870
+ # resp.metric_source.rds_source_config.db_instance_identifier #=> String
871
+ # resp.metric_source.rds_source_config.database_host #=> String
872
+ # resp.metric_source.rds_source_config.database_port #=> Integer
873
+ # resp.metric_source.rds_source_config.secret_manager_arn #=> String
874
+ # resp.metric_source.rds_source_config.database_name #=> String
875
+ # resp.metric_source.rds_source_config.table_name #=> String
876
+ # resp.metric_source.rds_source_config.role_arn #=> String
877
+ # resp.metric_source.rds_source_config.vpc_configuration.subnet_id_list #=> Array
878
+ # resp.metric_source.rds_source_config.vpc_configuration.subnet_id_list[0] #=> String
879
+ # resp.metric_source.rds_source_config.vpc_configuration.security_group_id_list #=> Array
880
+ # resp.metric_source.rds_source_config.vpc_configuration.security_group_id_list[0] #=> String
881
+ # resp.metric_source.redshift_source_config.cluster_identifier #=> String
882
+ # resp.metric_source.redshift_source_config.database_host #=> String
883
+ # resp.metric_source.redshift_source_config.database_port #=> Integer
884
+ # resp.metric_source.redshift_source_config.secret_manager_arn #=> String
885
+ # resp.metric_source.redshift_source_config.database_name #=> String
886
+ # resp.metric_source.redshift_source_config.table_name #=> String
887
+ # resp.metric_source.redshift_source_config.role_arn #=> String
888
+ # resp.metric_source.redshift_source_config.vpc_configuration.subnet_id_list #=> Array
889
+ # resp.metric_source.redshift_source_config.vpc_configuration.subnet_id_list[0] #=> String
890
+ # resp.metric_source.redshift_source_config.vpc_configuration.security_group_id_list #=> Array
891
+ # resp.metric_source.redshift_source_config.vpc_configuration.security_group_id_list[0] #=> String
892
+ #
893
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeMetricSet AWS API Documentation
894
+ #
895
+ # @overload describe_metric_set(params = {})
896
+ # @param [Hash] params ({})
897
+ def describe_metric_set(params = {}, options = {})
898
+ req = build_request(:describe_metric_set, params)
899
+ req.send_request(options)
900
+ end
901
+
902
+ # Returns details about a group of anomalous metrics.
903
+ #
904
+ # @option params [required, String] :anomaly_group_id
905
+ # The ID of the anomaly group.
906
+ #
907
+ # @option params [required, String] :anomaly_detector_arn
908
+ # The Amazon Resource Name (ARN) of the anomaly detector.
909
+ #
910
+ # @return [Types::GetAnomalyGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
911
+ #
912
+ # * {Types::GetAnomalyGroupResponse#anomaly_group #anomaly_group} => Types::AnomalyGroup
913
+ #
914
+ # @example Request syntax with placeholder values
915
+ #
916
+ # resp = client.get_anomaly_group({
917
+ # anomaly_group_id: "UUID", # required
918
+ # anomaly_detector_arn: "Arn", # required
919
+ # })
920
+ #
921
+ # @example Response structure
922
+ #
923
+ # resp.anomaly_group.start_time #=> String
924
+ # resp.anomaly_group.end_time #=> String
925
+ # resp.anomaly_group.anomaly_group_id #=> String
926
+ # resp.anomaly_group.anomaly_group_score #=> Float
927
+ # resp.anomaly_group.primary_metric_name #=> String
928
+ # resp.anomaly_group.metric_level_impact_list #=> Array
929
+ # resp.anomaly_group.metric_level_impact_list[0].metric_name #=> String
930
+ # resp.anomaly_group.metric_level_impact_list[0].num_time_series #=> Integer
931
+ # resp.anomaly_group.metric_level_impact_list[0].contribution_matrix.dimension_contribution_list #=> Array
932
+ # resp.anomaly_group.metric_level_impact_list[0].contribution_matrix.dimension_contribution_list[0].dimension_name #=> String
933
+ # resp.anomaly_group.metric_level_impact_list[0].contribution_matrix.dimension_contribution_list[0].dimension_value_contribution_list #=> Array
934
+ # resp.anomaly_group.metric_level_impact_list[0].contribution_matrix.dimension_contribution_list[0].dimension_value_contribution_list[0].dimension_value #=> String
935
+ # resp.anomaly_group.metric_level_impact_list[0].contribution_matrix.dimension_contribution_list[0].dimension_value_contribution_list[0].contribution_score #=> Float
936
+ #
937
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetAnomalyGroup AWS API Documentation
938
+ #
939
+ # @overload get_anomaly_group(params = {})
940
+ # @param [Hash] params ({})
941
+ def get_anomaly_group(params = {}, options = {})
942
+ req = build_request(:get_anomaly_group, params)
943
+ req.send_request(options)
944
+ end
945
+
946
+ # Get feedback for an anomaly group.
947
+ #
948
+ # @option params [required, String] :anomaly_detector_arn
949
+ # The Amazon Resource Name (ARN) of the anomaly detector.
950
+ #
951
+ # @option params [required, Types::AnomalyGroupTimeSeries] :anomaly_group_time_series_feedback
952
+ # The anomalous metric and group ID.
953
+ #
954
+ # @option params [Integer] :max_results
955
+ # The maximum number of results to return.
956
+ #
957
+ # @option params [String] :next_token
958
+ # Specify the pagination token that's returned by a previous request to
959
+ # retrieve the next page of results.
960
+ #
961
+ # @return [Types::GetFeedbackResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
962
+ #
963
+ # * {Types::GetFeedbackResponse#anomaly_group_time_series_feedback #anomaly_group_time_series_feedback} => Array&lt;Types::TimeSeriesFeedback&gt;
964
+ # * {Types::GetFeedbackResponse#next_token #next_token} => String
965
+ #
966
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
967
+ #
968
+ # @example Request syntax with placeholder values
969
+ #
970
+ # resp = client.get_feedback({
971
+ # anomaly_detector_arn: "Arn", # required
972
+ # anomaly_group_time_series_feedback: { # required
973
+ # anomaly_group_id: "UUID", # required
974
+ # time_series_id: "TimeSeriesId",
975
+ # },
976
+ # max_results: 1,
977
+ # next_token: "NextToken",
978
+ # })
979
+ #
980
+ # @example Response structure
981
+ #
982
+ # resp.anomaly_group_time_series_feedback #=> Array
983
+ # resp.anomaly_group_time_series_feedback[0].time_series_id #=> String
984
+ # resp.anomaly_group_time_series_feedback[0].is_anomaly #=> Boolean
985
+ # resp.next_token #=> String
986
+ #
987
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetFeedback AWS API Documentation
988
+ #
989
+ # @overload get_feedback(params = {})
990
+ # @param [Hash] params ({})
991
+ def get_feedback(params = {}, options = {})
992
+ req = build_request(:get_feedback, params)
993
+ req.send_request(options)
994
+ end
995
+
996
+ # Returns a selection of sample records from an Amazon S3 datasource.
997
+ #
998
+ # @option params [Types::SampleDataS3SourceConfig] :s3_source_config
999
+ # A datasource bucket in Amazon S3.
1000
+ #
1001
+ # @return [Types::GetSampleDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1002
+ #
1003
+ # * {Types::GetSampleDataResponse#header_values #header_values} => Array&lt;String&gt;
1004
+ # * {Types::GetSampleDataResponse#sample_rows #sample_rows} => Array&lt;Array&lt;String&gt;&gt;
1005
+ #
1006
+ # @example Request syntax with placeholder values
1007
+ #
1008
+ # resp = client.get_sample_data({
1009
+ # s3_source_config: {
1010
+ # role_arn: "Arn", # required
1011
+ # templated_path_list: ["TemplatedPath"],
1012
+ # historical_data_path_list: ["HistoricalDataPath"],
1013
+ # file_format_descriptor: { # required
1014
+ # csv_format_descriptor: {
1015
+ # file_compression: "NONE", # accepts NONE, GZIP
1016
+ # charset: "Charset",
1017
+ # contains_header: false,
1018
+ # delimiter: "Delimiter",
1019
+ # header_list: ["ColumnName"],
1020
+ # quote_symbol: "QuoteSymbol",
1021
+ # },
1022
+ # json_format_descriptor: {
1023
+ # file_compression: "NONE", # accepts NONE, GZIP
1024
+ # charset: "Charset",
1025
+ # },
1026
+ # },
1027
+ # },
1028
+ # })
1029
+ #
1030
+ # @example Response structure
1031
+ #
1032
+ # resp.header_values #=> Array
1033
+ # resp.header_values[0] #=> String
1034
+ # resp.sample_rows #=> Array
1035
+ # resp.sample_rows[0] #=> Array
1036
+ # resp.sample_rows[0][0] #=> String
1037
+ #
1038
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetSampleData AWS API Documentation
1039
+ #
1040
+ # @overload get_sample_data(params = {})
1041
+ # @param [Hash] params ({})
1042
+ def get_sample_data(params = {}, options = {})
1043
+ req = build_request(:get_sample_data, params)
1044
+ req.send_request(options)
1045
+ end
1046
+
1047
+ # Lists the alerts attached to a detector.
1048
+ #
1049
+ # @option params [String] :anomaly_detector_arn
1050
+ # The ARN of the alert's detector.
1051
+ #
1052
+ # @option params [String] :next_token
1053
+ # If the result of the previous request is truncated, the response
1054
+ # includes a `NextToken`. To retrieve the next set of results, use the
1055
+ # token in the next request. Tokens expire after 24 hours.
1056
+ #
1057
+ # @option params [Integer] :max_results
1058
+ # The maximum number of results that will be displayed by the request.
1059
+ #
1060
+ # @return [Types::ListAlertsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1061
+ #
1062
+ # * {Types::ListAlertsResponse#alert_summary_list #alert_summary_list} => Array&lt;Types::AlertSummary&gt;
1063
+ # * {Types::ListAlertsResponse#next_token #next_token} => String
1064
+ #
1065
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1066
+ #
1067
+ # @example Request syntax with placeholder values
1068
+ #
1069
+ # resp = client.list_alerts({
1070
+ # anomaly_detector_arn: "Arn",
1071
+ # next_token: "NextToken",
1072
+ # max_results: 1,
1073
+ # })
1074
+ #
1075
+ # @example Response structure
1076
+ #
1077
+ # resp.alert_summary_list #=> Array
1078
+ # resp.alert_summary_list[0].alert_arn #=> String
1079
+ # resp.alert_summary_list[0].anomaly_detector_arn #=> String
1080
+ # resp.alert_summary_list[0].alert_name #=> String
1081
+ # resp.alert_summary_list[0].alert_sensitivity_threshold #=> Integer
1082
+ # resp.alert_summary_list[0].alert_type #=> String, one of "SNS", "LAMBDA"
1083
+ # resp.alert_summary_list[0].alert_status #=> String, one of "ACTIVE", "INACTIVE"
1084
+ # resp.alert_summary_list[0].last_modification_time #=> Time
1085
+ # resp.alert_summary_list[0].creation_time #=> Time
1086
+ # resp.alert_summary_list[0].tags #=> Hash
1087
+ # resp.alert_summary_list[0].tags["TagKey"] #=> String
1088
+ # resp.next_token #=> String
1089
+ #
1090
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAlerts AWS API Documentation
1091
+ #
1092
+ # @overload list_alerts(params = {})
1093
+ # @param [Hash] params ({})
1094
+ def list_alerts(params = {}, options = {})
1095
+ req = build_request(:list_alerts, params)
1096
+ req.send_request(options)
1097
+ end
1098
+
1099
+ # Lists the detectors in the current AWS Region.
1100
+ #
1101
+ # @option params [Integer] :max_results
1102
+ # The maximum number of results to return.
1103
+ #
1104
+ # @option params [String] :next_token
1105
+ # If the result of the previous request was truncated, the response
1106
+ # includes a `NextToken`. To retrieve the next set of results, use the
1107
+ # token in the next request. Tokens expire after 24 hours.
1108
+ #
1109
+ # @return [Types::ListAnomalyDetectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1110
+ #
1111
+ # * {Types::ListAnomalyDetectorsResponse#anomaly_detector_summary_list #anomaly_detector_summary_list} => Array&lt;Types::AnomalyDetectorSummary&gt;
1112
+ # * {Types::ListAnomalyDetectorsResponse#next_token #next_token} => String
1113
+ #
1114
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1115
+ #
1116
+ # @example Request syntax with placeholder values
1117
+ #
1118
+ # resp = client.list_anomaly_detectors({
1119
+ # max_results: 1,
1120
+ # next_token: "NextToken",
1121
+ # })
1122
+ #
1123
+ # @example Response structure
1124
+ #
1125
+ # resp.anomaly_detector_summary_list #=> Array
1126
+ # resp.anomaly_detector_summary_list[0].anomaly_detector_arn #=> String
1127
+ # resp.anomaly_detector_summary_list[0].anomaly_detector_name #=> String
1128
+ # resp.anomaly_detector_summary_list[0].anomaly_detector_description #=> String
1129
+ # resp.anomaly_detector_summary_list[0].creation_time #=> Time
1130
+ # resp.anomaly_detector_summary_list[0].last_modification_time #=> Time
1131
+ # resp.anomaly_detector_summary_list[0].status #=> String, one of "ACTIVE", "ACTIVATING", "DELETING", "FAILED", "INACTIVE", "BACK_TEST_ACTIVATING", "BACK_TEST_ACTIVE", "BACK_TEST_COMPLETE"
1132
+ # resp.anomaly_detector_summary_list[0].tags #=> Hash
1133
+ # resp.anomaly_detector_summary_list[0].tags["TagKey"] #=> String
1134
+ # resp.next_token #=> String
1135
+ #
1136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAnomalyDetectors AWS API Documentation
1137
+ #
1138
+ # @overload list_anomaly_detectors(params = {})
1139
+ # @param [Hash] params ({})
1140
+ def list_anomaly_detectors(params = {}, options = {})
1141
+ req = build_request(:list_anomaly_detectors, params)
1142
+ req.send_request(options)
1143
+ end
1144
+
1145
+ # Returns a list of anomaly groups.
1146
+ #
1147
+ # @option params [required, String] :anomaly_detector_arn
1148
+ # The Amazon Resource Name (ARN) of the anomaly detector.
1149
+ #
1150
+ # @option params [required, Integer] :sensitivity_threshold
1151
+ # The minimum severity score for inclusion in the output.
1152
+ #
1153
+ # @option params [Integer] :max_results
1154
+ # The maximum number of results to return.
1155
+ #
1156
+ # @option params [String] :next_token
1157
+ # Specify the pagination token that's returned by a previous request to
1158
+ # retrieve the next page of results.
1159
+ #
1160
+ # @return [Types::ListAnomalyGroupSummariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1161
+ #
1162
+ # * {Types::ListAnomalyGroupSummariesResponse#anomaly_group_summary_list #anomaly_group_summary_list} => Array&lt;Types::AnomalyGroupSummary&gt;
1163
+ # * {Types::ListAnomalyGroupSummariesResponse#anomaly_group_statistics #anomaly_group_statistics} => Types::AnomalyGroupStatistics
1164
+ # * {Types::ListAnomalyGroupSummariesResponse#next_token #next_token} => String
1165
+ #
1166
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1167
+ #
1168
+ # @example Request syntax with placeholder values
1169
+ #
1170
+ # resp = client.list_anomaly_group_summaries({
1171
+ # anomaly_detector_arn: "Arn", # required
1172
+ # sensitivity_threshold: 1, # required
1173
+ # max_results: 1,
1174
+ # next_token: "NextToken",
1175
+ # })
1176
+ #
1177
+ # @example Response structure
1178
+ #
1179
+ # resp.anomaly_group_summary_list #=> Array
1180
+ # resp.anomaly_group_summary_list[0].start_time #=> String
1181
+ # resp.anomaly_group_summary_list[0].end_time #=> String
1182
+ # resp.anomaly_group_summary_list[0].anomaly_group_id #=> String
1183
+ # resp.anomaly_group_summary_list[0].anomaly_group_score #=> Float
1184
+ # resp.anomaly_group_summary_list[0].primary_metric_name #=> String
1185
+ # resp.anomaly_group_statistics.evaluation_start_date #=> String
1186
+ # resp.anomaly_group_statistics.total_count #=> Integer
1187
+ # resp.anomaly_group_statistics.itemized_metric_stats_list #=> Array
1188
+ # resp.anomaly_group_statistics.itemized_metric_stats_list[0].metric_name #=> String
1189
+ # resp.anomaly_group_statistics.itemized_metric_stats_list[0].occurrence_count #=> Integer
1190
+ # resp.next_token #=> String
1191
+ #
1192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAnomalyGroupSummaries AWS API Documentation
1193
+ #
1194
+ # @overload list_anomaly_group_summaries(params = {})
1195
+ # @param [Hash] params ({})
1196
+ def list_anomaly_group_summaries(params = {}, options = {})
1197
+ req = build_request(:list_anomaly_group_summaries, params)
1198
+ req.send_request(options)
1199
+ end
1200
+
1201
+ # Gets a list of anomalous metrics for a measure in an anomaly group.
1202
+ #
1203
+ # @option params [required, String] :anomaly_detector_arn
1204
+ # The Amazon Resource Name (ARN) of the anomaly detector.
1205
+ #
1206
+ # @option params [required, String] :anomaly_group_id
1207
+ # The ID of the anomaly group.
1208
+ #
1209
+ # @option params [required, String] :metric_name
1210
+ # The name of the measure field.
1211
+ #
1212
+ # @option params [Integer] :max_results
1213
+ # The maximum number of results to return.
1214
+ #
1215
+ # @option params [String] :next_token
1216
+ # Specify the pagination token that's returned by a previous request to
1217
+ # retrieve the next page of results.
1218
+ #
1219
+ # @return [Types::ListAnomalyGroupTimeSeriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1220
+ #
1221
+ # * {Types::ListAnomalyGroupTimeSeriesResponse#anomaly_group_id #anomaly_group_id} => String
1222
+ # * {Types::ListAnomalyGroupTimeSeriesResponse#metric_name #metric_name} => String
1223
+ # * {Types::ListAnomalyGroupTimeSeriesResponse#timestamp_list #timestamp_list} => Array&lt;String&gt;
1224
+ # * {Types::ListAnomalyGroupTimeSeriesResponse#next_token #next_token} => String
1225
+ # * {Types::ListAnomalyGroupTimeSeriesResponse#time_series_list #time_series_list} => Array&lt;Types::TimeSeries&gt;
1226
+ #
1227
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1228
+ #
1229
+ # @example Request syntax with placeholder values
1230
+ #
1231
+ # resp = client.list_anomaly_group_time_series({
1232
+ # anomaly_detector_arn: "Arn", # required
1233
+ # anomaly_group_id: "UUID", # required
1234
+ # metric_name: "MetricName", # required
1235
+ # max_results: 1,
1236
+ # next_token: "NextToken",
1237
+ # })
1238
+ #
1239
+ # @example Response structure
1240
+ #
1241
+ # resp.anomaly_group_id #=> String
1242
+ # resp.metric_name #=> String
1243
+ # resp.timestamp_list #=> Array
1244
+ # resp.timestamp_list[0] #=> String
1245
+ # resp.next_token #=> String
1246
+ # resp.time_series_list #=> Array
1247
+ # resp.time_series_list[0].time_series_id #=> String
1248
+ # resp.time_series_list[0].dimension_list #=> Array
1249
+ # resp.time_series_list[0].dimension_list[0].dimension_name #=> String
1250
+ # resp.time_series_list[0].dimension_list[0].dimension_value #=> String
1251
+ # resp.time_series_list[0].metric_value_list #=> Array
1252
+ # resp.time_series_list[0].metric_value_list[0] #=> Float
1253
+ #
1254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAnomalyGroupTimeSeries AWS API Documentation
1255
+ #
1256
+ # @overload list_anomaly_group_time_series(params = {})
1257
+ # @param [Hash] params ({})
1258
+ def list_anomaly_group_time_series(params = {}, options = {})
1259
+ req = build_request(:list_anomaly_group_time_series, params)
1260
+ req.send_request(options)
1261
+ end
1262
+
1263
+ # Lists the datasets in the current AWS Region.
1264
+ #
1265
+ # @option params [String] :anomaly_detector_arn
1266
+ # The ARN of the anomaly detector containing the metrics sets to list.
1267
+ #
1268
+ # @option params [Integer] :max_results
1269
+ # The maximum number of results to return.
1270
+ #
1271
+ # @option params [String] :next_token
1272
+ # If the result of the previous request was truncated, the response
1273
+ # includes a `NextToken`. To retrieve the next set of results, use the
1274
+ # token in the next request. Tokens expire after 24 hours.
1275
+ #
1276
+ # @return [Types::ListMetricSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1277
+ #
1278
+ # * {Types::ListMetricSetsResponse#metric_set_summary_list #metric_set_summary_list} => Array&lt;Types::MetricSetSummary&gt;
1279
+ # * {Types::ListMetricSetsResponse#next_token #next_token} => String
1280
+ #
1281
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1282
+ #
1283
+ # @example Request syntax with placeholder values
1284
+ #
1285
+ # resp = client.list_metric_sets({
1286
+ # anomaly_detector_arn: "Arn",
1287
+ # max_results: 1,
1288
+ # next_token: "NextToken",
1289
+ # })
1290
+ #
1291
+ # @example Response structure
1292
+ #
1293
+ # resp.metric_set_summary_list #=> Array
1294
+ # resp.metric_set_summary_list[0].metric_set_arn #=> String
1295
+ # resp.metric_set_summary_list[0].anomaly_detector_arn #=> String
1296
+ # resp.metric_set_summary_list[0].metric_set_description #=> String
1297
+ # resp.metric_set_summary_list[0].metric_set_name #=> String
1298
+ # resp.metric_set_summary_list[0].creation_time #=> Time
1299
+ # resp.metric_set_summary_list[0].last_modification_time #=> Time
1300
+ # resp.metric_set_summary_list[0].tags #=> Hash
1301
+ # resp.metric_set_summary_list[0].tags["TagKey"] #=> String
1302
+ # resp.next_token #=> String
1303
+ #
1304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListMetricSets AWS API Documentation
1305
+ #
1306
+ # @overload list_metric_sets(params = {})
1307
+ # @param [Hash] params ({})
1308
+ def list_metric_sets(params = {}, options = {})
1309
+ req = build_request(:list_metric_sets, params)
1310
+ req.send_request(options)
1311
+ end
1312
+
1313
+ # Gets a list of [tags][1] for a detector, dataset, or alert.
1314
+ #
1315
+ #
1316
+ #
1317
+ # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
1318
+ #
1319
+ # @option params [required, String] :resource_arn
1320
+ # The resource's Amazon Resource Name (ARN).
1321
+ #
1322
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1323
+ #
1324
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
1325
+ #
1326
+ # @example Request syntax with placeholder values
1327
+ #
1328
+ # resp = client.list_tags_for_resource({
1329
+ # resource_arn: "Arn", # required
1330
+ # })
1331
+ #
1332
+ # @example Response structure
1333
+ #
1334
+ # resp.tags #=> Hash
1335
+ # resp.tags["TagKey"] #=> String
1336
+ #
1337
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListTagsForResource AWS API Documentation
1338
+ #
1339
+ # @overload list_tags_for_resource(params = {})
1340
+ # @param [Hash] params ({})
1341
+ def list_tags_for_resource(params = {}, options = {})
1342
+ req = build_request(:list_tags_for_resource, params)
1343
+ req.send_request(options)
1344
+ end
1345
+
1346
+ # Add feedback for an anomalous metric.
1347
+ #
1348
+ # @option params [required, String] :anomaly_detector_arn
1349
+ # The Amazon Resource Name (ARN) of the anomaly detector.
1350
+ #
1351
+ # @option params [required, Types::AnomalyGroupTimeSeriesFeedback] :anomaly_group_time_series_feedback
1352
+ # Feedback for an anomalous metric.
1353
+ #
1354
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1355
+ #
1356
+ # @example Request syntax with placeholder values
1357
+ #
1358
+ # resp = client.put_feedback({
1359
+ # anomaly_detector_arn: "Arn", # required
1360
+ # anomaly_group_time_series_feedback: { # required
1361
+ # anomaly_group_id: "UUID", # required
1362
+ # time_series_id: "TimeSeriesId", # required
1363
+ # is_anomaly: false, # required
1364
+ # },
1365
+ # })
1366
+ #
1367
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/PutFeedback AWS API Documentation
1368
+ #
1369
+ # @overload put_feedback(params = {})
1370
+ # @param [Hash] params ({})
1371
+ def put_feedback(params = {}, options = {})
1372
+ req = build_request(:put_feedback, params)
1373
+ req.send_request(options)
1374
+ end
1375
+
1376
+ # Adds [tags][1] to a detector, dataset, or alert.
1377
+ #
1378
+ #
1379
+ #
1380
+ # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
1381
+ #
1382
+ # @option params [required, String] :resource_arn
1383
+ # The resource's Amazon Resource Name (ARN).
1384
+ #
1385
+ # @option params [required, Hash<String,String>] :tags
1386
+ # Tags to apply to the resource. Tag keys and values can contain
1387
+ # letters, numbers, spaces, and the following symbols: `_.:/=+@-`
1388
+ #
1389
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1390
+ #
1391
+ # @example Request syntax with placeholder values
1392
+ #
1393
+ # resp = client.tag_resource({
1394
+ # resource_arn: "Arn", # required
1395
+ # tags: { # required
1396
+ # "TagKey" => "TagValue",
1397
+ # },
1398
+ # })
1399
+ #
1400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/TagResource AWS API Documentation
1401
+ #
1402
+ # @overload tag_resource(params = {})
1403
+ # @param [Hash] params ({})
1404
+ def tag_resource(params = {}, options = {})
1405
+ req = build_request(:tag_resource, params)
1406
+ req.send_request(options)
1407
+ end
1408
+
1409
+ # Removes [tags][1] from a detector, dataset, or alert.
1410
+ #
1411
+ #
1412
+ #
1413
+ # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
1414
+ #
1415
+ # @option params [required, String] :resource_arn
1416
+ # The resource's Amazon Resource Name (ARN).
1417
+ #
1418
+ # @option params [required, Array<String>] :tag_keys
1419
+ # Keys to remove from the resource's tags.
1420
+ #
1421
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1422
+ #
1423
+ # @example Request syntax with placeholder values
1424
+ #
1425
+ # resp = client.untag_resource({
1426
+ # resource_arn: "Arn", # required
1427
+ # tag_keys: ["TagKey"], # required
1428
+ # })
1429
+ #
1430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UntagResource AWS API Documentation
1431
+ #
1432
+ # @overload untag_resource(params = {})
1433
+ # @param [Hash] params ({})
1434
+ def untag_resource(params = {}, options = {})
1435
+ req = build_request(:untag_resource, params)
1436
+ req.send_request(options)
1437
+ end
1438
+
1439
+ # Updates a detector. After activation, you can only change a
1440
+ # detector's ingestion delay and description.
1441
+ #
1442
+ # @option params [required, String] :anomaly_detector_arn
1443
+ # The ARN of the detector to update.
1444
+ #
1445
+ # @option params [String] :kms_key_arn
1446
+ # The Amazon Resource Name (ARN) of an AWS KMS encryption key.
1447
+ #
1448
+ # @option params [String] :anomaly_detector_description
1449
+ # The updated detector description.
1450
+ #
1451
+ # @option params [Types::AnomalyDetectorConfig] :anomaly_detector_config
1452
+ # Contains information about the configuration to which the detector
1453
+ # will be updated.
1454
+ #
1455
+ # @return [Types::UpdateAnomalyDetectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1456
+ #
1457
+ # * {Types::UpdateAnomalyDetectorResponse#anomaly_detector_arn #anomaly_detector_arn} => String
1458
+ #
1459
+ # @example Request syntax with placeholder values
1460
+ #
1461
+ # resp = client.update_anomaly_detector({
1462
+ # anomaly_detector_arn: "Arn", # required
1463
+ # kms_key_arn: "KmsKeyArn",
1464
+ # anomaly_detector_description: "AnomalyDetectorDescription",
1465
+ # anomaly_detector_config: {
1466
+ # anomaly_detector_frequency: "P1D", # accepts P1D, PT1H, PT10M, PT5M
1467
+ # },
1468
+ # })
1469
+ #
1470
+ # @example Response structure
1471
+ #
1472
+ # resp.anomaly_detector_arn #=> String
1473
+ #
1474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateAnomalyDetector AWS API Documentation
1475
+ #
1476
+ # @overload update_anomaly_detector(params = {})
1477
+ # @param [Hash] params ({})
1478
+ def update_anomaly_detector(params = {}, options = {})
1479
+ req = build_request(:update_anomaly_detector, params)
1480
+ req.send_request(options)
1481
+ end
1482
+
1483
+ # Updates a dataset.
1484
+ #
1485
+ # @option params [required, String] :metric_set_arn
1486
+ # The ARN of the dataset to update.
1487
+ #
1488
+ # @option params [String] :metric_set_description
1489
+ # The dataset's description.
1490
+ #
1491
+ # @option params [Array<Types::Metric>] :metric_list
1492
+ # The metric list.
1493
+ #
1494
+ # @option params [Integer] :offset
1495
+ # After an interval ends, the amount of time that the detector waits
1496
+ # before importing data.
1497
+ #
1498
+ # @option params [Types::TimestampColumn] :timestamp_column
1499
+ # The timestamp column.
1500
+ #
1501
+ # @option params [Array<String>] :dimension_list
1502
+ # The dimension list.
1503
+ #
1504
+ # @option params [String] :metric_set_frequency
1505
+ # The dataset's interval.
1506
+ #
1507
+ # @option params [Types::MetricSource] :metric_source
1508
+ # Contains information about source data used to generate a metric.
1509
+ #
1510
+ # @return [Types::UpdateMetricSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1511
+ #
1512
+ # * {Types::UpdateMetricSetResponse#metric_set_arn #metric_set_arn} => String
1513
+ #
1514
+ # @example Request syntax with placeholder values
1515
+ #
1516
+ # resp = client.update_metric_set({
1517
+ # metric_set_arn: "Arn", # required
1518
+ # metric_set_description: "MetricSetDescription",
1519
+ # metric_list: [
1520
+ # {
1521
+ # metric_name: "ColumnName", # required
1522
+ # aggregation_function: "AVG", # required, accepts AVG, SUM
1523
+ # namespace: "Namespace",
1524
+ # },
1525
+ # ],
1526
+ # offset: 1,
1527
+ # timestamp_column: {
1528
+ # column_name: "ColumnName",
1529
+ # column_format: "DateTimeFormat",
1530
+ # },
1531
+ # dimension_list: ["ColumnName"],
1532
+ # metric_set_frequency: "P1D", # accepts P1D, PT1H, PT10M, PT5M
1533
+ # metric_source: {
1534
+ # s3_source_config: {
1535
+ # role_arn: "Arn", # required
1536
+ # templated_path_list: ["TemplatedPath"],
1537
+ # historical_data_path_list: ["HistoricalDataPath"],
1538
+ # file_format_descriptor: {
1539
+ # csv_format_descriptor: {
1540
+ # file_compression: "NONE", # accepts NONE, GZIP
1541
+ # charset: "Charset",
1542
+ # contains_header: false,
1543
+ # delimiter: "Delimiter",
1544
+ # header_list: ["ColumnName"],
1545
+ # quote_symbol: "QuoteSymbol",
1546
+ # },
1547
+ # json_format_descriptor: {
1548
+ # file_compression: "NONE", # accepts NONE, GZIP
1549
+ # charset: "Charset",
1550
+ # },
1551
+ # },
1552
+ # },
1553
+ # app_flow_config: {
1554
+ # role_arn: "Arn", # required
1555
+ # flow_name: "FlowName", # required
1556
+ # },
1557
+ # cloud_watch_config: {
1558
+ # role_arn: "Arn", # required
1559
+ # },
1560
+ # rds_source_config: {
1561
+ # db_instance_identifier: "RDSDatabaseIdentifier", # required
1562
+ # database_host: "DatabaseHost", # required
1563
+ # database_port: 1, # required
1564
+ # secret_manager_arn: "PoirotSecretManagerArn", # required
1565
+ # database_name: "RDSDatabaseName", # required
1566
+ # table_name: "TableName", # required
1567
+ # role_arn: "Arn", # required
1568
+ # vpc_configuration: { # required
1569
+ # subnet_id_list: ["SubnetId"], # required
1570
+ # security_group_id_list: ["SecurityGroupId"], # required
1571
+ # },
1572
+ # },
1573
+ # redshift_source_config: {
1574
+ # cluster_identifier: "RedshiftClusterIdentifier", # required
1575
+ # database_host: "DatabaseHost", # required
1576
+ # database_port: 1, # required
1577
+ # secret_manager_arn: "PoirotSecretManagerArn", # required
1578
+ # database_name: "RedshiftDatabaseName", # required
1579
+ # table_name: "TableName", # required
1580
+ # role_arn: "Arn", # required
1581
+ # vpc_configuration: { # required
1582
+ # subnet_id_list: ["SubnetId"], # required
1583
+ # security_group_id_list: ["SecurityGroupId"], # required
1584
+ # },
1585
+ # },
1586
+ # },
1587
+ # })
1588
+ #
1589
+ # @example Response structure
1590
+ #
1591
+ # resp.metric_set_arn #=> String
1592
+ #
1593
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateMetricSet AWS API Documentation
1594
+ #
1595
+ # @overload update_metric_set(params = {})
1596
+ # @param [Hash] params ({})
1597
+ def update_metric_set(params = {}, options = {})
1598
+ req = build_request(:update_metric_set, params)
1599
+ req.send_request(options)
1600
+ end
1601
+
1602
+ # @!endgroup
1603
+
1604
+ # @param params ({})
1605
+ # @api private
1606
+ def build_request(operation_name, params = {})
1607
+ handlers = @handlers.for(operation_name)
1608
+ context = Seahorse::Client::RequestContext.new(
1609
+ operation_name: operation_name,
1610
+ operation: config.api.operation(operation_name),
1611
+ client: self,
1612
+ params: params,
1613
+ config: config)
1614
+ context[:gem_name] = 'aws-sdk-lookoutmetrics'
1615
+ context[:gem_version] = '1.0.0'
1616
+ Seahorse::Client::Request.new(handlers, context)
1617
+ end
1618
+
1619
+ # @api private
1620
+ # @deprecated
1621
+ def waiter_names
1622
+ []
1623
+ end
1624
+
1625
+ class << self
1626
+
1627
+ # @api private
1628
+ attr_reader :identifier
1629
+
1630
+ # @api private
1631
+ def errors_module
1632
+ Errors
1633
+ end
1634
+
1635
+ end
1636
+ end
1637
+ end