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.
File without changes
@@ -0,0 +1,200 @@
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
+ module Aws::LookoutMetrics
11
+
12
+ # When LookoutMetrics returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::LookoutMetrics::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all LookoutMetrics errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::LookoutMetrics::Errors::ServiceError
20
+ # # rescues all LookoutMetrics API errors
21
+ # end
22
+ #
23
+ #
24
+ # ## Request Context
25
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
26
+ # information about the request that generated the error.
27
+ # See {Seahorse::Client::RequestContext} for more information.
28
+ #
29
+ # ## Error Classes
30
+ # * {AccessDeniedException}
31
+ # * {ConflictException}
32
+ # * {InternalServerException}
33
+ # * {ResourceNotFoundException}
34
+ # * {ServiceQuotaExceededException}
35
+ # * {TooManyRequestsException}
36
+ # * {ValidationException}
37
+ #
38
+ # Additionally, error classes are dynamically generated for service errors based on the error code
39
+ # if they are not defined above.
40
+ module Errors
41
+
42
+ extend Aws::Errors::DynamicErrors
43
+
44
+ class AccessDeniedException < ServiceError
45
+
46
+ # @param [Seahorse::Client::RequestContext] context
47
+ # @param [String] message
48
+ # @param [Aws::LookoutMetrics::Types::AccessDeniedException] data
49
+ def initialize(context, message, data = Aws::EmptyStructure.new)
50
+ super(context, message, data)
51
+ end
52
+
53
+ # @return [String]
54
+ def message
55
+ @message || @data[:message]
56
+ end
57
+ end
58
+
59
+ class ConflictException < ServiceError
60
+
61
+ # @param [Seahorse::Client::RequestContext] context
62
+ # @param [String] message
63
+ # @param [Aws::LookoutMetrics::Types::ConflictException] data
64
+ def initialize(context, message, data = Aws::EmptyStructure.new)
65
+ super(context, message, data)
66
+ end
67
+
68
+ # @return [String]
69
+ def message
70
+ @message || @data[:message]
71
+ end
72
+
73
+ # @return [String]
74
+ def resource_id
75
+ @data[:resource_id]
76
+ end
77
+
78
+ # @return [String]
79
+ def resource_type
80
+ @data[:resource_type]
81
+ end
82
+ end
83
+
84
+ class InternalServerException < ServiceError
85
+
86
+ # @param [Seahorse::Client::RequestContext] context
87
+ # @param [String] message
88
+ # @param [Aws::LookoutMetrics::Types::InternalServerException] data
89
+ def initialize(context, message, data = Aws::EmptyStructure.new)
90
+ super(context, message, data)
91
+ end
92
+
93
+ # @return [String]
94
+ def message
95
+ @message || @data[:message]
96
+ end
97
+ end
98
+
99
+ class ResourceNotFoundException < ServiceError
100
+
101
+ # @param [Seahorse::Client::RequestContext] context
102
+ # @param [String] message
103
+ # @param [Aws::LookoutMetrics::Types::ResourceNotFoundException] data
104
+ def initialize(context, message, data = Aws::EmptyStructure.new)
105
+ super(context, message, data)
106
+ end
107
+
108
+ # @return [String]
109
+ def message
110
+ @message || @data[:message]
111
+ end
112
+
113
+ # @return [String]
114
+ def resource_id
115
+ @data[:resource_id]
116
+ end
117
+
118
+ # @return [String]
119
+ def resource_type
120
+ @data[:resource_type]
121
+ end
122
+ end
123
+
124
+ class ServiceQuotaExceededException < ServiceError
125
+
126
+ # @param [Seahorse::Client::RequestContext] context
127
+ # @param [String] message
128
+ # @param [Aws::LookoutMetrics::Types::ServiceQuotaExceededException] data
129
+ def initialize(context, message, data = Aws::EmptyStructure.new)
130
+ super(context, message, data)
131
+ end
132
+
133
+ # @return [String]
134
+ def message
135
+ @message || @data[:message]
136
+ end
137
+
138
+ # @return [String]
139
+ def resource_id
140
+ @data[:resource_id]
141
+ end
142
+
143
+ # @return [String]
144
+ def resource_type
145
+ @data[:resource_type]
146
+ end
147
+
148
+ # @return [String]
149
+ def quota_code
150
+ @data[:quota_code]
151
+ end
152
+
153
+ # @return [String]
154
+ def service_code
155
+ @data[:service_code]
156
+ end
157
+ end
158
+
159
+ class TooManyRequestsException < ServiceError
160
+
161
+ # @param [Seahorse::Client::RequestContext] context
162
+ # @param [String] message
163
+ # @param [Aws::LookoutMetrics::Types::TooManyRequestsException] data
164
+ def initialize(context, message, data = Aws::EmptyStructure.new)
165
+ super(context, message, data)
166
+ end
167
+
168
+ # @return [String]
169
+ def message
170
+ @message || @data[:message]
171
+ end
172
+ end
173
+
174
+ class ValidationException < ServiceError
175
+
176
+ # @param [Seahorse::Client::RequestContext] context
177
+ # @param [String] message
178
+ # @param [Aws::LookoutMetrics::Types::ValidationException] data
179
+ def initialize(context, message, data = Aws::EmptyStructure.new)
180
+ super(context, message, data)
181
+ end
182
+
183
+ # @return [String]
184
+ def message
185
+ @message || @data[:message]
186
+ end
187
+
188
+ # @return [String]
189
+ def reason
190
+ @data[:reason]
191
+ end
192
+
193
+ # @return [String]
194
+ def fields
195
+ @data[:fields]
196
+ end
197
+ end
198
+
199
+ end
200
+ end
@@ -0,0 +1,26 @@
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
+ module Aws::LookoutMetrics
11
+
12
+ class Resource
13
+
14
+ # @param options ({})
15
+ # @option options [Client] :client
16
+ def initialize(options = {})
17
+ @client = options[:client] || Client.new(options)
18
+ end
19
+
20
+ # @return [Client]
21
+ def client
22
+ @client
23
+ end
24
+
25
+ end
26
+ end
@@ -0,0 +1,2847 @@
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
+ module Aws::LookoutMetrics
11
+ module Types
12
+
13
+ # You do not have sufficient permissions to perform this action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # A configuration that specifies the action to perform when anomalies
27
+ # are detected.
28
+ #
29
+ # @note When making an API call, you may pass Action
30
+ # data as a hash:
31
+ #
32
+ # {
33
+ # sns_configuration: {
34
+ # role_arn: "Arn", # required
35
+ # sns_topic_arn: "Arn", # required
36
+ # },
37
+ # lambda_configuration: {
38
+ # role_arn: "Arn", # required
39
+ # lambda_arn: "Arn", # required
40
+ # },
41
+ # }
42
+ #
43
+ # @!attribute [rw] sns_configuration
44
+ # A configuration for an Amazon SNS channel.
45
+ # @return [Types::SNSConfiguration]
46
+ #
47
+ # @!attribute [rw] lambda_configuration
48
+ # A configuration for an AWS Lambda channel.
49
+ # @return [Types::LambdaConfiguration]
50
+ #
51
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/Action AWS API Documentation
52
+ #
53
+ class Action < Struct.new(
54
+ :sns_configuration,
55
+ :lambda_configuration)
56
+ SENSITIVE = []
57
+ include Aws::Structure
58
+ end
59
+
60
+ # @note When making an API call, you may pass ActivateAnomalyDetectorRequest
61
+ # data as a hash:
62
+ #
63
+ # {
64
+ # anomaly_detector_arn: "Arn", # required
65
+ # }
66
+ #
67
+ # @!attribute [rw] anomaly_detector_arn
68
+ # The ARN of the anomaly detector.
69
+ # @return [String]
70
+ #
71
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ActivateAnomalyDetectorRequest AWS API Documentation
72
+ #
73
+ class ActivateAnomalyDetectorRequest < Struct.new(
74
+ :anomaly_detector_arn)
75
+ SENSITIVE = []
76
+ include Aws::Structure
77
+ end
78
+
79
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ActivateAnomalyDetectorResponse AWS API Documentation
80
+ #
81
+ class ActivateAnomalyDetectorResponse < Aws::EmptyStructure; end
82
+
83
+ # A configuration for Amazon SNS-integrated notifications.
84
+ #
85
+ # @!attribute [rw] action
86
+ # Action that will be triggered when there is an alert.
87
+ # @return [Types::Action]
88
+ #
89
+ # @!attribute [rw] alert_description
90
+ # A description of the alert.
91
+ # @return [String]
92
+ #
93
+ # @!attribute [rw] alert_arn
94
+ # The ARN of the alert.
95
+ # @return [String]
96
+ #
97
+ # @!attribute [rw] anomaly_detector_arn
98
+ # The ARN of the detector to which the alert is attached.
99
+ # @return [String]
100
+ #
101
+ # @!attribute [rw] alert_name
102
+ # The name of the alert.
103
+ # @return [String]
104
+ #
105
+ # @!attribute [rw] alert_sensitivity_threshold
106
+ # The minimum severity for an anomaly to trigger the alert.
107
+ # @return [Integer]
108
+ #
109
+ # @!attribute [rw] alert_type
110
+ # The type of the alert.
111
+ # @return [String]
112
+ #
113
+ # @!attribute [rw] alert_status
114
+ # The status of the alert.
115
+ # @return [String]
116
+ #
117
+ # @!attribute [rw] last_modification_time
118
+ # The time at which the alert was last modified.
119
+ # @return [Time]
120
+ #
121
+ # @!attribute [rw] creation_time
122
+ # The time at which the alert was created.
123
+ # @return [Time]
124
+ #
125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/Alert AWS API Documentation
126
+ #
127
+ class Alert < Struct.new(
128
+ :action,
129
+ :alert_description,
130
+ :alert_arn,
131
+ :anomaly_detector_arn,
132
+ :alert_name,
133
+ :alert_sensitivity_threshold,
134
+ :alert_type,
135
+ :alert_status,
136
+ :last_modification_time,
137
+ :creation_time)
138
+ SENSITIVE = []
139
+ include Aws::Structure
140
+ end
141
+
142
+ # Provides a summary of an alert's configuration.
143
+ #
144
+ # @!attribute [rw] alert_arn
145
+ # The ARN of the alert.
146
+ # @return [String]
147
+ #
148
+ # @!attribute [rw] anomaly_detector_arn
149
+ # The ARN of the detector to which the alert is attached.
150
+ # @return [String]
151
+ #
152
+ # @!attribute [rw] alert_name
153
+ # The name of the alert.
154
+ # @return [String]
155
+ #
156
+ # @!attribute [rw] alert_sensitivity_threshold
157
+ # The minimum severity for an anomaly to trigger the alert.
158
+ # @return [Integer]
159
+ #
160
+ # @!attribute [rw] alert_type
161
+ # The type of the alert.
162
+ # @return [String]
163
+ #
164
+ # @!attribute [rw] alert_status
165
+ # The status of the alert.
166
+ # @return [String]
167
+ #
168
+ # @!attribute [rw] last_modification_time
169
+ # The time at which the alert was last modified.
170
+ # @return [Time]
171
+ #
172
+ # @!attribute [rw] creation_time
173
+ # The time at which the alert was created.
174
+ # @return [Time]
175
+ #
176
+ # @!attribute [rw] tags
177
+ # The alert's [tags][1].
178
+ #
179
+ #
180
+ #
181
+ # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
182
+ # @return [Hash<String,String>]
183
+ #
184
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/AlertSummary AWS API Documentation
185
+ #
186
+ class AlertSummary < Struct.new(
187
+ :alert_arn,
188
+ :anomaly_detector_arn,
189
+ :alert_name,
190
+ :alert_sensitivity_threshold,
191
+ :alert_type,
192
+ :alert_status,
193
+ :last_modification_time,
194
+ :creation_time,
195
+ :tags)
196
+ SENSITIVE = []
197
+ include Aws::Structure
198
+ end
199
+
200
+ # Contains information about a detector's configuration.
201
+ #
202
+ # @note When making an API call, you may pass AnomalyDetectorConfig
203
+ # data as a hash:
204
+ #
205
+ # {
206
+ # anomaly_detector_frequency: "P1D", # accepts P1D, PT1H, PT10M, PT5M
207
+ # }
208
+ #
209
+ # @!attribute [rw] anomaly_detector_frequency
210
+ # The frequency at which the detector analyzes its source data.
211
+ # @return [String]
212
+ #
213
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/AnomalyDetectorConfig AWS API Documentation
214
+ #
215
+ class AnomalyDetectorConfig < Struct.new(
216
+ :anomaly_detector_frequency)
217
+ SENSITIVE = []
218
+ include Aws::Structure
219
+ end
220
+
221
+ # Contains information about a detector's configuration.
222
+ #
223
+ # @!attribute [rw] anomaly_detector_frequency
224
+ # The interval at which the detector analyzes its source data.
225
+ # @return [String]
226
+ #
227
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/AnomalyDetectorConfigSummary AWS API Documentation
228
+ #
229
+ class AnomalyDetectorConfigSummary < Struct.new(
230
+ :anomaly_detector_frequency)
231
+ SENSITIVE = []
232
+ include Aws::Structure
233
+ end
234
+
235
+ # Contains information about an an anomaly detector.
236
+ #
237
+ # @!attribute [rw] anomaly_detector_arn
238
+ # The ARN of the detector.
239
+ # @return [String]
240
+ #
241
+ # @!attribute [rw] anomaly_detector_name
242
+ # The name of the detector.
243
+ # @return [String]
244
+ #
245
+ # @!attribute [rw] anomaly_detector_description
246
+ # A description of the detector.
247
+ # @return [String]
248
+ #
249
+ # @!attribute [rw] creation_time
250
+ # The time at which the detector was created.
251
+ # @return [Time]
252
+ #
253
+ # @!attribute [rw] last_modification_time
254
+ # The time at which the detector was last modified.
255
+ # @return [Time]
256
+ #
257
+ # @!attribute [rw] status
258
+ # The status of detector.
259
+ # @return [String]
260
+ #
261
+ # @!attribute [rw] tags
262
+ # The detector's [tags][1].
263
+ #
264
+ #
265
+ #
266
+ # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
267
+ # @return [Hash<String,String>]
268
+ #
269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/AnomalyDetectorSummary AWS API Documentation
270
+ #
271
+ class AnomalyDetectorSummary < Struct.new(
272
+ :anomaly_detector_arn,
273
+ :anomaly_detector_name,
274
+ :anomaly_detector_description,
275
+ :creation_time,
276
+ :last_modification_time,
277
+ :status,
278
+ :tags)
279
+ SENSITIVE = []
280
+ include Aws::Structure
281
+ end
282
+
283
+ # A group of anomalous metrics
284
+ #
285
+ # @!attribute [rw] start_time
286
+ # The start time for the group.
287
+ # @return [String]
288
+ #
289
+ # @!attribute [rw] end_time
290
+ # The end time for the group.
291
+ # @return [String]
292
+ #
293
+ # @!attribute [rw] anomaly_group_id
294
+ # The ID of the anomaly group.
295
+ # @return [String]
296
+ #
297
+ # @!attribute [rw] anomaly_group_score
298
+ # The severity score of the group.
299
+ # @return [Float]
300
+ #
301
+ # @!attribute [rw] primary_metric_name
302
+ # The name of the primary affected measure for the group.
303
+ # @return [String]
304
+ #
305
+ # @!attribute [rw] metric_level_impact_list
306
+ # A list of measures affected by the anomaly.
307
+ # @return [Array<Types::MetricLevelImpact>]
308
+ #
309
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/AnomalyGroup AWS API Documentation
310
+ #
311
+ class AnomalyGroup < Struct.new(
312
+ :start_time,
313
+ :end_time,
314
+ :anomaly_group_id,
315
+ :anomaly_group_score,
316
+ :primary_metric_name,
317
+ :metric_level_impact_list)
318
+ SENSITIVE = []
319
+ include Aws::Structure
320
+ end
321
+
322
+ # Aggregated statistics for a group of anomalous metrics.
323
+ #
324
+ # @!attribute [rw] evaluation_start_date
325
+ # The start of the time range that was searched.
326
+ # @return [String]
327
+ #
328
+ # @!attribute [rw] total_count
329
+ # The number of groups found.
330
+ # @return [Integer]
331
+ #
332
+ # @!attribute [rw] itemized_metric_stats_list
333
+ # Statistics for individual metrics within the group.
334
+ # @return [Array<Types::ItemizedMetricStats>]
335
+ #
336
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/AnomalyGroupStatistics AWS API Documentation
337
+ #
338
+ class AnomalyGroupStatistics < Struct.new(
339
+ :evaluation_start_date,
340
+ :total_count,
341
+ :itemized_metric_stats_list)
342
+ SENSITIVE = []
343
+ include Aws::Structure
344
+ end
345
+
346
+ # Details about a group of anomalous metrics.
347
+ #
348
+ # @!attribute [rw] start_time
349
+ # The start time for the group.
350
+ # @return [String]
351
+ #
352
+ # @!attribute [rw] end_time
353
+ # The end time for the group.
354
+ # @return [String]
355
+ #
356
+ # @!attribute [rw] anomaly_group_id
357
+ # The ID of the anomaly group.
358
+ # @return [String]
359
+ #
360
+ # @!attribute [rw] anomaly_group_score
361
+ # The severity score of the group.
362
+ # @return [Float]
363
+ #
364
+ # @!attribute [rw] primary_metric_name
365
+ # The name of the primary affected measure for the group.
366
+ # @return [String]
367
+ #
368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/AnomalyGroupSummary AWS API Documentation
369
+ #
370
+ class AnomalyGroupSummary < Struct.new(
371
+ :start_time,
372
+ :end_time,
373
+ :anomaly_group_id,
374
+ :anomaly_group_score,
375
+ :primary_metric_name)
376
+ SENSITIVE = []
377
+ include Aws::Structure
378
+ end
379
+
380
+ # An anomalous metric in an anomaly group.
381
+ #
382
+ # @note When making an API call, you may pass AnomalyGroupTimeSeries
383
+ # data as a hash:
384
+ #
385
+ # {
386
+ # anomaly_group_id: "UUID", # required
387
+ # time_series_id: "TimeSeriesId",
388
+ # }
389
+ #
390
+ # @!attribute [rw] anomaly_group_id
391
+ # The ID of the anomaly group.
392
+ # @return [String]
393
+ #
394
+ # @!attribute [rw] time_series_id
395
+ # The ID of the metric.
396
+ # @return [String]
397
+ #
398
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/AnomalyGroupTimeSeries AWS API Documentation
399
+ #
400
+ class AnomalyGroupTimeSeries < Struct.new(
401
+ :anomaly_group_id,
402
+ :time_series_id)
403
+ SENSITIVE = []
404
+ include Aws::Structure
405
+ end
406
+
407
+ # Feedback for an anomalous metric.
408
+ #
409
+ # @note When making an API call, you may pass AnomalyGroupTimeSeriesFeedback
410
+ # data as a hash:
411
+ #
412
+ # {
413
+ # anomaly_group_id: "UUID", # required
414
+ # time_series_id: "TimeSeriesId", # required
415
+ # is_anomaly: false, # required
416
+ # }
417
+ #
418
+ # @!attribute [rw] anomaly_group_id
419
+ # The ID of the anomaly group.
420
+ # @return [String]
421
+ #
422
+ # @!attribute [rw] time_series_id
423
+ # The ID of the metric.
424
+ # @return [String]
425
+ #
426
+ # @!attribute [rw] is_anomaly
427
+ # Feedback on whether the metric is a legitimate anomaly.
428
+ # @return [Boolean]
429
+ #
430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/AnomalyGroupTimeSeriesFeedback AWS API Documentation
431
+ #
432
+ class AnomalyGroupTimeSeriesFeedback < Struct.new(
433
+ :anomaly_group_id,
434
+ :time_series_id,
435
+ :is_anomaly)
436
+ SENSITIVE = []
437
+ include Aws::Structure
438
+ end
439
+
440
+ # Details about an Amazon AppFlow flow datasource.
441
+ #
442
+ # @note When making an API call, you may pass AppFlowConfig
443
+ # data as a hash:
444
+ #
445
+ # {
446
+ # role_arn: "Arn", # required
447
+ # flow_name: "FlowName", # required
448
+ # }
449
+ #
450
+ # @!attribute [rw] role_arn
451
+ # An IAM role that gives Amazon Lookout for Metrics permission to
452
+ # access the flow.
453
+ # @return [String]
454
+ #
455
+ # @!attribute [rw] flow_name
456
+ # The name of the flow.
457
+ # @return [String]
458
+ #
459
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/AppFlowConfig AWS API Documentation
460
+ #
461
+ class AppFlowConfig < Struct.new(
462
+ :role_arn,
463
+ :flow_name)
464
+ SENSITIVE = []
465
+ include Aws::Structure
466
+ end
467
+
468
+ # @note When making an API call, you may pass BackTestAnomalyDetectorRequest
469
+ # data as a hash:
470
+ #
471
+ # {
472
+ # anomaly_detector_arn: "Arn", # required
473
+ # }
474
+ #
475
+ # @!attribute [rw] anomaly_detector_arn
476
+ # The Amazon Resource Name (ARN) of the anomaly detector.
477
+ # @return [String]
478
+ #
479
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/BackTestAnomalyDetectorRequest AWS API Documentation
480
+ #
481
+ class BackTestAnomalyDetectorRequest < Struct.new(
482
+ :anomaly_detector_arn)
483
+ SENSITIVE = []
484
+ include Aws::Structure
485
+ end
486
+
487
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/BackTestAnomalyDetectorResponse AWS API Documentation
488
+ #
489
+ class BackTestAnomalyDetectorResponse < Aws::EmptyStructure; end
490
+
491
+ # Details about an Amazon CloudWatch datasource.
492
+ #
493
+ # @note When making an API call, you may pass CloudWatchConfig
494
+ # data as a hash:
495
+ #
496
+ # {
497
+ # role_arn: "Arn", # required
498
+ # }
499
+ #
500
+ # @!attribute [rw] role_arn
501
+ # An IAM role that gives Amazon Lookout for Metrics permission to
502
+ # access data in Amazon CloudWatch.
503
+ # @return [String]
504
+ #
505
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CloudWatchConfig AWS API Documentation
506
+ #
507
+ class CloudWatchConfig < Struct.new(
508
+ :role_arn)
509
+ SENSITIVE = []
510
+ include Aws::Structure
511
+ end
512
+
513
+ # There was a conflict processing the request. Try your request again.
514
+ #
515
+ # @!attribute [rw] message
516
+ # @return [String]
517
+ #
518
+ # @!attribute [rw] resource_id
519
+ # The ID of the resource.
520
+ # @return [String]
521
+ #
522
+ # @!attribute [rw] resource_type
523
+ # The type of the resource.
524
+ # @return [String]
525
+ #
526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ConflictException AWS API Documentation
527
+ #
528
+ class ConflictException < Struct.new(
529
+ :message,
530
+ :resource_id,
531
+ :resource_type)
532
+ SENSITIVE = []
533
+ include Aws::Structure
534
+ end
535
+
536
+ # Details about dimensions that contributed to an anomaly.
537
+ #
538
+ # @!attribute [rw] dimension_contribution_list
539
+ # A list of contributing dimensions.
540
+ # @return [Array<Types::DimensionContribution>]
541
+ #
542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ContributionMatrix AWS API Documentation
543
+ #
544
+ class ContributionMatrix < Struct.new(
545
+ :dimension_contribution_list)
546
+ SENSITIVE = []
547
+ include Aws::Structure
548
+ end
549
+
550
+ # @note When making an API call, you may pass CreateAlertRequest
551
+ # data as a hash:
552
+ #
553
+ # {
554
+ # alert_name: "AlertName", # required
555
+ # alert_sensitivity_threshold: 1, # required
556
+ # alert_description: "AlertDescription",
557
+ # anomaly_detector_arn: "Arn", # required
558
+ # action: { # required
559
+ # sns_configuration: {
560
+ # role_arn: "Arn", # required
561
+ # sns_topic_arn: "Arn", # required
562
+ # },
563
+ # lambda_configuration: {
564
+ # role_arn: "Arn", # required
565
+ # lambda_arn: "Arn", # required
566
+ # },
567
+ # },
568
+ # tags: {
569
+ # "TagKey" => "TagValue",
570
+ # },
571
+ # }
572
+ #
573
+ # @!attribute [rw] alert_name
574
+ # The name of the alert.
575
+ # @return [String]
576
+ #
577
+ # @!attribute [rw] alert_sensitivity_threshold
578
+ # An integer from 0 to 100 specifying the alert sensitivity threshold.
579
+ # @return [Integer]
580
+ #
581
+ # @!attribute [rw] alert_description
582
+ # A description of the alert.
583
+ # @return [String]
584
+ #
585
+ # @!attribute [rw] anomaly_detector_arn
586
+ # The ARN of the detector to which the alert is attached.
587
+ # @return [String]
588
+ #
589
+ # @!attribute [rw] action
590
+ # Action that will be triggered when there is an alert.
591
+ # @return [Types::Action]
592
+ #
593
+ # @!attribute [rw] tags
594
+ # A list of [tags][1] to apply to the alert.
595
+ #
596
+ #
597
+ #
598
+ # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
599
+ # @return [Hash<String,String>]
600
+ #
601
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CreateAlertRequest AWS API Documentation
602
+ #
603
+ class CreateAlertRequest < Struct.new(
604
+ :alert_name,
605
+ :alert_sensitivity_threshold,
606
+ :alert_description,
607
+ :anomaly_detector_arn,
608
+ :action,
609
+ :tags)
610
+ SENSITIVE = []
611
+ include Aws::Structure
612
+ end
613
+
614
+ # @!attribute [rw] alert_arn
615
+ # The ARN of the alert.
616
+ # @return [String]
617
+ #
618
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CreateAlertResponse AWS API Documentation
619
+ #
620
+ class CreateAlertResponse < Struct.new(
621
+ :alert_arn)
622
+ SENSITIVE = []
623
+ include Aws::Structure
624
+ end
625
+
626
+ # @note When making an API call, you may pass CreateAnomalyDetectorRequest
627
+ # data as a hash:
628
+ #
629
+ # {
630
+ # anomaly_detector_name: "AnomalyDetectorName", # required
631
+ # anomaly_detector_description: "AnomalyDetectorDescription",
632
+ # anomaly_detector_config: { # required
633
+ # anomaly_detector_frequency: "P1D", # accepts P1D, PT1H, PT10M, PT5M
634
+ # },
635
+ # kms_key_arn: "KmsKeyArn",
636
+ # tags: {
637
+ # "TagKey" => "TagValue",
638
+ # },
639
+ # }
640
+ #
641
+ # @!attribute [rw] anomaly_detector_name
642
+ # The name of the detector.
643
+ # @return [String]
644
+ #
645
+ # @!attribute [rw] anomaly_detector_description
646
+ # A description of the detector.
647
+ # @return [String]
648
+ #
649
+ # @!attribute [rw] anomaly_detector_config
650
+ # Contains information about the configuration of the anomaly
651
+ # detector.
652
+ # @return [Types::AnomalyDetectorConfig]
653
+ #
654
+ # @!attribute [rw] kms_key_arn
655
+ # The ARN of the KMS key to use to encrypt your data.
656
+ # @return [String]
657
+ #
658
+ # @!attribute [rw] tags
659
+ # A list of [tags][1] to apply to the anomaly detector.
660
+ #
661
+ #
662
+ #
663
+ # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
664
+ # @return [Hash<String,String>]
665
+ #
666
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CreateAnomalyDetectorRequest AWS API Documentation
667
+ #
668
+ class CreateAnomalyDetectorRequest < Struct.new(
669
+ :anomaly_detector_name,
670
+ :anomaly_detector_description,
671
+ :anomaly_detector_config,
672
+ :kms_key_arn,
673
+ :tags)
674
+ SENSITIVE = []
675
+ include Aws::Structure
676
+ end
677
+
678
+ # @!attribute [rw] anomaly_detector_arn
679
+ # The ARN of the detector.
680
+ # @return [String]
681
+ #
682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CreateAnomalyDetectorResponse AWS API Documentation
683
+ #
684
+ class CreateAnomalyDetectorResponse < Struct.new(
685
+ :anomaly_detector_arn)
686
+ SENSITIVE = []
687
+ include Aws::Structure
688
+ end
689
+
690
+ # @note When making an API call, you may pass CreateMetricSetRequest
691
+ # data as a hash:
692
+ #
693
+ # {
694
+ # anomaly_detector_arn: "Arn", # required
695
+ # metric_set_name: "MetricSetName", # required
696
+ # metric_set_description: "MetricSetDescription",
697
+ # metric_list: [ # required
698
+ # {
699
+ # metric_name: "ColumnName", # required
700
+ # aggregation_function: "AVG", # required, accepts AVG, SUM
701
+ # namespace: "Namespace",
702
+ # },
703
+ # ],
704
+ # offset: 1,
705
+ # timestamp_column: {
706
+ # column_name: "ColumnName",
707
+ # column_format: "DateTimeFormat",
708
+ # },
709
+ # dimension_list: ["ColumnName"],
710
+ # metric_set_frequency: "P1D", # accepts P1D, PT1H, PT10M, PT5M
711
+ # metric_source: { # required
712
+ # s3_source_config: {
713
+ # role_arn: "Arn", # required
714
+ # templated_path_list: ["TemplatedPath"],
715
+ # historical_data_path_list: ["HistoricalDataPath"],
716
+ # file_format_descriptor: {
717
+ # csv_format_descriptor: {
718
+ # file_compression: "NONE", # accepts NONE, GZIP
719
+ # charset: "Charset",
720
+ # contains_header: false,
721
+ # delimiter: "Delimiter",
722
+ # header_list: ["ColumnName"],
723
+ # quote_symbol: "QuoteSymbol",
724
+ # },
725
+ # json_format_descriptor: {
726
+ # file_compression: "NONE", # accepts NONE, GZIP
727
+ # charset: "Charset",
728
+ # },
729
+ # },
730
+ # },
731
+ # app_flow_config: {
732
+ # role_arn: "Arn", # required
733
+ # flow_name: "FlowName", # required
734
+ # },
735
+ # cloud_watch_config: {
736
+ # role_arn: "Arn", # required
737
+ # },
738
+ # rds_source_config: {
739
+ # db_instance_identifier: "RDSDatabaseIdentifier", # required
740
+ # database_host: "DatabaseHost", # required
741
+ # database_port: 1, # required
742
+ # secret_manager_arn: "PoirotSecretManagerArn", # required
743
+ # database_name: "RDSDatabaseName", # required
744
+ # table_name: "TableName", # required
745
+ # role_arn: "Arn", # required
746
+ # vpc_configuration: { # required
747
+ # subnet_id_list: ["SubnetId"], # required
748
+ # security_group_id_list: ["SecurityGroupId"], # required
749
+ # },
750
+ # },
751
+ # redshift_source_config: {
752
+ # cluster_identifier: "RedshiftClusterIdentifier", # required
753
+ # database_host: "DatabaseHost", # required
754
+ # database_port: 1, # required
755
+ # secret_manager_arn: "PoirotSecretManagerArn", # required
756
+ # database_name: "RedshiftDatabaseName", # required
757
+ # table_name: "TableName", # required
758
+ # role_arn: "Arn", # required
759
+ # vpc_configuration: { # required
760
+ # subnet_id_list: ["SubnetId"], # required
761
+ # security_group_id_list: ["SecurityGroupId"], # required
762
+ # },
763
+ # },
764
+ # },
765
+ # timezone: "Timezone",
766
+ # tags: {
767
+ # "TagKey" => "TagValue",
768
+ # },
769
+ # }
770
+ #
771
+ # @!attribute [rw] anomaly_detector_arn
772
+ # The ARN of the anomaly detector that will use the dataset.
773
+ # @return [String]
774
+ #
775
+ # @!attribute [rw] metric_set_name
776
+ # The name of the dataset.
777
+ # @return [String]
778
+ #
779
+ # @!attribute [rw] metric_set_description
780
+ # A description of the dataset you are creating.
781
+ # @return [String]
782
+ #
783
+ # @!attribute [rw] metric_list
784
+ # A list of metrics that the dataset will contain.
785
+ # @return [Array<Types::Metric>]
786
+ #
787
+ # @!attribute [rw] offset
788
+ # After an interval ends, the amount of time that the detector waits
789
+ # before importing data.
790
+ # @return [Integer]
791
+ #
792
+ # @!attribute [rw] timestamp_column
793
+ # Contains information about the column used for tracking time in your
794
+ # source data.
795
+ # @return [Types::TimestampColumn]
796
+ #
797
+ # @!attribute [rw] dimension_list
798
+ # A list of the fields you want to treat as dimensions.
799
+ # @return [Array<String>]
800
+ #
801
+ # @!attribute [rw] metric_set_frequency
802
+ # The frequency with which the source data will be analyzed for
803
+ # anomalies.
804
+ # @return [String]
805
+ #
806
+ # @!attribute [rw] metric_source
807
+ # Contains information about how the source data should be
808
+ # interpreted.
809
+ # @return [Types::MetricSource]
810
+ #
811
+ # @!attribute [rw] timezone
812
+ # The time zone in which your source data was recorded.
813
+ # @return [String]
814
+ #
815
+ # @!attribute [rw] tags
816
+ # A list of [tags][1] to apply to the dataset.
817
+ #
818
+ #
819
+ #
820
+ # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
821
+ # @return [Hash<String,String>]
822
+ #
823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CreateMetricSetRequest AWS API Documentation
824
+ #
825
+ class CreateMetricSetRequest < Struct.new(
826
+ :anomaly_detector_arn,
827
+ :metric_set_name,
828
+ :metric_set_description,
829
+ :metric_list,
830
+ :offset,
831
+ :timestamp_column,
832
+ :dimension_list,
833
+ :metric_set_frequency,
834
+ :metric_source,
835
+ :timezone,
836
+ :tags)
837
+ SENSITIVE = []
838
+ include Aws::Structure
839
+ end
840
+
841
+ # @!attribute [rw] metric_set_arn
842
+ # The ARN of the dataset.
843
+ # @return [String]
844
+ #
845
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CreateMetricSetResponse AWS API Documentation
846
+ #
847
+ class CreateMetricSetResponse < Struct.new(
848
+ :metric_set_arn)
849
+ SENSITIVE = []
850
+ include Aws::Structure
851
+ end
852
+
853
+ # Contains information about how a source CSV data file should be
854
+ # analyzed.
855
+ #
856
+ # @note When making an API call, you may pass CsvFormatDescriptor
857
+ # data as a hash:
858
+ #
859
+ # {
860
+ # file_compression: "NONE", # accepts NONE, GZIP
861
+ # charset: "Charset",
862
+ # contains_header: false,
863
+ # delimiter: "Delimiter",
864
+ # header_list: ["ColumnName"],
865
+ # quote_symbol: "QuoteSymbol",
866
+ # }
867
+ #
868
+ # @!attribute [rw] file_compression
869
+ # The level of compression of the source CSV file.
870
+ # @return [String]
871
+ #
872
+ # @!attribute [rw] charset
873
+ # The character set in which the source CSV file is written.
874
+ # @return [String]
875
+ #
876
+ # @!attribute [rw] contains_header
877
+ # Whether or not the source CSV file contains a header.
878
+ # @return [Boolean]
879
+ #
880
+ # @!attribute [rw] delimiter
881
+ # The character used to delimit the source CSV file.
882
+ # @return [String]
883
+ #
884
+ # @!attribute [rw] header_list
885
+ # A list of the source CSV file's headers, if any.
886
+ # @return [Array<String>]
887
+ #
888
+ # @!attribute [rw] quote_symbol
889
+ # The character used as a quote character.
890
+ # @return [String]
891
+ #
892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/CsvFormatDescriptor AWS API Documentation
893
+ #
894
+ class CsvFormatDescriptor < Struct.new(
895
+ :file_compression,
896
+ :charset,
897
+ :contains_header,
898
+ :delimiter,
899
+ :header_list,
900
+ :quote_symbol)
901
+ SENSITIVE = []
902
+ include Aws::Structure
903
+ end
904
+
905
+ # @note When making an API call, you may pass DeleteAlertRequest
906
+ # data as a hash:
907
+ #
908
+ # {
909
+ # alert_arn: "Arn", # required
910
+ # }
911
+ #
912
+ # @!attribute [rw] alert_arn
913
+ # The ARN of the alert to delete.
914
+ # @return [String]
915
+ #
916
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DeleteAlertRequest AWS API Documentation
917
+ #
918
+ class DeleteAlertRequest < Struct.new(
919
+ :alert_arn)
920
+ SENSITIVE = []
921
+ include Aws::Structure
922
+ end
923
+
924
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DeleteAlertResponse AWS API Documentation
925
+ #
926
+ class DeleteAlertResponse < Aws::EmptyStructure; end
927
+
928
+ # @note When making an API call, you may pass DeleteAnomalyDetectorRequest
929
+ # data as a hash:
930
+ #
931
+ # {
932
+ # anomaly_detector_arn: "Arn", # required
933
+ # }
934
+ #
935
+ # @!attribute [rw] anomaly_detector_arn
936
+ # The ARN of the detector to delete.
937
+ # @return [String]
938
+ #
939
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DeleteAnomalyDetectorRequest AWS API Documentation
940
+ #
941
+ class DeleteAnomalyDetectorRequest < Struct.new(
942
+ :anomaly_detector_arn)
943
+ SENSITIVE = []
944
+ include Aws::Structure
945
+ end
946
+
947
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DeleteAnomalyDetectorResponse AWS API Documentation
948
+ #
949
+ class DeleteAnomalyDetectorResponse < Aws::EmptyStructure; end
950
+
951
+ # @note When making an API call, you may pass DescribeAlertRequest
952
+ # data as a hash:
953
+ #
954
+ # {
955
+ # alert_arn: "Arn", # required
956
+ # }
957
+ #
958
+ # @!attribute [rw] alert_arn
959
+ # The ARN of the alert to describe.
960
+ # @return [String]
961
+ #
962
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeAlertRequest AWS API Documentation
963
+ #
964
+ class DescribeAlertRequest < Struct.new(
965
+ :alert_arn)
966
+ SENSITIVE = []
967
+ include Aws::Structure
968
+ end
969
+
970
+ # @!attribute [rw] alert
971
+ # Contains information about an alert.
972
+ # @return [Types::Alert]
973
+ #
974
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeAlertResponse AWS API Documentation
975
+ #
976
+ class DescribeAlertResponse < Struct.new(
977
+ :alert)
978
+ SENSITIVE = []
979
+ include Aws::Structure
980
+ end
981
+
982
+ # @note When making an API call, you may pass DescribeAnomalyDetectionExecutionsRequest
983
+ # data as a hash:
984
+ #
985
+ # {
986
+ # anomaly_detector_arn: "Arn", # required
987
+ # timestamp: "TimestampString",
988
+ # max_results: 1,
989
+ # next_token: "NextToken",
990
+ # }
991
+ #
992
+ # @!attribute [rw] anomaly_detector_arn
993
+ # The Amazon Resource Name (ARN) of the anomaly detector.
994
+ # @return [String]
995
+ #
996
+ # @!attribute [rw] timestamp
997
+ # The timestamp of the anomaly detection job.
998
+ # @return [String]
999
+ #
1000
+ # @!attribute [rw] max_results
1001
+ # The number of items to return in the response.
1002
+ # @return [Integer]
1003
+ #
1004
+ # @!attribute [rw] next_token
1005
+ # Specify the pagination token that's returned by a previous request
1006
+ # to retrieve the next page of results.
1007
+ # @return [String]
1008
+ #
1009
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeAnomalyDetectionExecutionsRequest AWS API Documentation
1010
+ #
1011
+ class DescribeAnomalyDetectionExecutionsRequest < Struct.new(
1012
+ :anomaly_detector_arn,
1013
+ :timestamp,
1014
+ :max_results,
1015
+ :next_token)
1016
+ SENSITIVE = []
1017
+ include Aws::Structure
1018
+ end
1019
+
1020
+ # @!attribute [rw] execution_list
1021
+ # A list of detection jobs.
1022
+ # @return [Array<Types::ExecutionStatus>]
1023
+ #
1024
+ # @!attribute [rw] next_token
1025
+ # The pagination token that's included if more results are available.
1026
+ # @return [String]
1027
+ #
1028
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeAnomalyDetectionExecutionsResponse AWS API Documentation
1029
+ #
1030
+ class DescribeAnomalyDetectionExecutionsResponse < Struct.new(
1031
+ :execution_list,
1032
+ :next_token)
1033
+ SENSITIVE = []
1034
+ include Aws::Structure
1035
+ end
1036
+
1037
+ # @note When making an API call, you may pass DescribeAnomalyDetectorRequest
1038
+ # data as a hash:
1039
+ #
1040
+ # {
1041
+ # anomaly_detector_arn: "Arn", # required
1042
+ # }
1043
+ #
1044
+ # @!attribute [rw] anomaly_detector_arn
1045
+ # The ARN of the detector to describe.
1046
+ # @return [String]
1047
+ #
1048
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeAnomalyDetectorRequest AWS API Documentation
1049
+ #
1050
+ class DescribeAnomalyDetectorRequest < Struct.new(
1051
+ :anomaly_detector_arn)
1052
+ SENSITIVE = []
1053
+ include Aws::Structure
1054
+ end
1055
+
1056
+ # @!attribute [rw] anomaly_detector_arn
1057
+ # The ARN of the detector.
1058
+ # @return [String]
1059
+ #
1060
+ # @!attribute [rw] anomaly_detector_name
1061
+ # The name of the detector.
1062
+ # @return [String]
1063
+ #
1064
+ # @!attribute [rw] anomaly_detector_description
1065
+ # A description of the detector.
1066
+ # @return [String]
1067
+ #
1068
+ # @!attribute [rw] anomaly_detector_config
1069
+ # Contains information about the detector's configuration.
1070
+ # @return [Types::AnomalyDetectorConfigSummary]
1071
+ #
1072
+ # @!attribute [rw] creation_time
1073
+ # The time at which the detector was created.
1074
+ # @return [Time]
1075
+ #
1076
+ # @!attribute [rw] last_modification_time
1077
+ # The time at which the detector was last modified.
1078
+ # @return [Time]
1079
+ #
1080
+ # @!attribute [rw] status
1081
+ # The status of the detector.
1082
+ # @return [String]
1083
+ #
1084
+ # @!attribute [rw] failure_reason
1085
+ # The reason that the detector failed, if any.
1086
+ # @return [String]
1087
+ #
1088
+ # @!attribute [rw] kms_key_arn
1089
+ # The ARN of the KMS key to use to encrypt your data.
1090
+ # @return [String]
1091
+ #
1092
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeAnomalyDetectorResponse AWS API Documentation
1093
+ #
1094
+ class DescribeAnomalyDetectorResponse < Struct.new(
1095
+ :anomaly_detector_arn,
1096
+ :anomaly_detector_name,
1097
+ :anomaly_detector_description,
1098
+ :anomaly_detector_config,
1099
+ :creation_time,
1100
+ :last_modification_time,
1101
+ :status,
1102
+ :failure_reason,
1103
+ :kms_key_arn)
1104
+ SENSITIVE = []
1105
+ include Aws::Structure
1106
+ end
1107
+
1108
+ # @note When making an API call, you may pass DescribeMetricSetRequest
1109
+ # data as a hash:
1110
+ #
1111
+ # {
1112
+ # metric_set_arn: "Arn", # required
1113
+ # }
1114
+ #
1115
+ # @!attribute [rw] metric_set_arn
1116
+ # The ARN of the dataset.
1117
+ # @return [String]
1118
+ #
1119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeMetricSetRequest AWS API Documentation
1120
+ #
1121
+ class DescribeMetricSetRequest < Struct.new(
1122
+ :metric_set_arn)
1123
+ SENSITIVE = []
1124
+ include Aws::Structure
1125
+ end
1126
+
1127
+ # @!attribute [rw] metric_set_arn
1128
+ # The ARN of the dataset.
1129
+ # @return [String]
1130
+ #
1131
+ # @!attribute [rw] anomaly_detector_arn
1132
+ # The ARN of the detector that contains the dataset.
1133
+ # @return [String]
1134
+ #
1135
+ # @!attribute [rw] metric_set_name
1136
+ # The name of the dataset.
1137
+ # @return [String]
1138
+ #
1139
+ # @!attribute [rw] metric_set_description
1140
+ # The dataset's description.
1141
+ # @return [String]
1142
+ #
1143
+ # @!attribute [rw] creation_time
1144
+ # The time at which the dataset was created.
1145
+ # @return [Time]
1146
+ #
1147
+ # @!attribute [rw] last_modification_time
1148
+ # The time at which the dataset was last modified.
1149
+ # @return [Time]
1150
+ #
1151
+ # @!attribute [rw] offset
1152
+ # The offset for the dataset.
1153
+ # @return [Integer]
1154
+ #
1155
+ # @!attribute [rw] metric_list
1156
+ # A list of the metrics defined by the dataset.
1157
+ # @return [Array<Types::Metric>]
1158
+ #
1159
+ # @!attribute [rw] timestamp_column
1160
+ # Contains information about the column used for tracking time in your
1161
+ # source data.
1162
+ # @return [Types::TimestampColumn]
1163
+ #
1164
+ # @!attribute [rw] dimension_list
1165
+ # A list of the dimensions chosen for analysis.
1166
+ # @return [Array<String>]
1167
+ #
1168
+ # @!attribute [rw] metric_set_frequency
1169
+ # The interval at which the data will be analyzed for anomalies.
1170
+ # @return [String]
1171
+ #
1172
+ # @!attribute [rw] timezone
1173
+ # The time zone in which the dataset's data was recorded.
1174
+ # @return [String]
1175
+ #
1176
+ # @!attribute [rw] metric_source
1177
+ # Contains information about the dataset's source data.
1178
+ # @return [Types::MetricSource]
1179
+ #
1180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DescribeMetricSetResponse AWS API Documentation
1181
+ #
1182
+ class DescribeMetricSetResponse < Struct.new(
1183
+ :metric_set_arn,
1184
+ :anomaly_detector_arn,
1185
+ :metric_set_name,
1186
+ :metric_set_description,
1187
+ :creation_time,
1188
+ :last_modification_time,
1189
+ :offset,
1190
+ :metric_list,
1191
+ :timestamp_column,
1192
+ :dimension_list,
1193
+ :metric_set_frequency,
1194
+ :timezone,
1195
+ :metric_source)
1196
+ SENSITIVE = []
1197
+ include Aws::Structure
1198
+ end
1199
+
1200
+ # Details about a dimension that contributed to an anomaly.
1201
+ #
1202
+ # @!attribute [rw] dimension_name
1203
+ # The name of the dimension.
1204
+ # @return [String]
1205
+ #
1206
+ # @!attribute [rw] dimension_value_contribution_list
1207
+ # A list of dimension values that contributed to the anomaly.
1208
+ # @return [Array<Types::DimensionValueContribution>]
1209
+ #
1210
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DimensionContribution AWS API Documentation
1211
+ #
1212
+ class DimensionContribution < Struct.new(
1213
+ :dimension_name,
1214
+ :dimension_value_contribution_list)
1215
+ SENSITIVE = []
1216
+ include Aws::Structure
1217
+ end
1218
+
1219
+ # A dimension name and value.
1220
+ #
1221
+ # @!attribute [rw] dimension_name
1222
+ # The name of the dimension.
1223
+ # @return [String]
1224
+ #
1225
+ # @!attribute [rw] dimension_value
1226
+ # The value of the dimension.
1227
+ # @return [String]
1228
+ #
1229
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DimensionNameValue AWS API Documentation
1230
+ #
1231
+ class DimensionNameValue < Struct.new(
1232
+ :dimension_name,
1233
+ :dimension_value)
1234
+ SENSITIVE = []
1235
+ include Aws::Structure
1236
+ end
1237
+
1238
+ # The severity of a value of a dimension that contributed to an anomaly.
1239
+ #
1240
+ # @!attribute [rw] dimension_value
1241
+ # The value of the dimension.
1242
+ # @return [String]
1243
+ #
1244
+ # @!attribute [rw] contribution_score
1245
+ # The severity score of the value.
1246
+ # @return [Float]
1247
+ #
1248
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/DimensionValueContribution AWS API Documentation
1249
+ #
1250
+ class DimensionValueContribution < Struct.new(
1251
+ :dimension_value,
1252
+ :contribution_score)
1253
+ SENSITIVE = []
1254
+ include Aws::Structure
1255
+ end
1256
+
1257
+ # The status of an anomaly detector run.
1258
+ #
1259
+ # @!attribute [rw] timestamp
1260
+ # The run's timestamp.
1261
+ # @return [String]
1262
+ #
1263
+ # @!attribute [rw] status
1264
+ # The run's status.
1265
+ # @return [String]
1266
+ #
1267
+ # @!attribute [rw] failure_reason
1268
+ # The reason that the run failed, if applicable.
1269
+ # @return [String]
1270
+ #
1271
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ExecutionStatus AWS API Documentation
1272
+ #
1273
+ class ExecutionStatus < Struct.new(
1274
+ :timestamp,
1275
+ :status,
1276
+ :failure_reason)
1277
+ SENSITIVE = []
1278
+ include Aws::Structure
1279
+ end
1280
+
1281
+ # Contains information about a source file's formatting.
1282
+ #
1283
+ # @note When making an API call, you may pass FileFormatDescriptor
1284
+ # data as a hash:
1285
+ #
1286
+ # {
1287
+ # csv_format_descriptor: {
1288
+ # file_compression: "NONE", # accepts NONE, GZIP
1289
+ # charset: "Charset",
1290
+ # contains_header: false,
1291
+ # delimiter: "Delimiter",
1292
+ # header_list: ["ColumnName"],
1293
+ # quote_symbol: "QuoteSymbol",
1294
+ # },
1295
+ # json_format_descriptor: {
1296
+ # file_compression: "NONE", # accepts NONE, GZIP
1297
+ # charset: "Charset",
1298
+ # },
1299
+ # }
1300
+ #
1301
+ # @!attribute [rw] csv_format_descriptor
1302
+ # Contains information about how a source CSV data file should be
1303
+ # analyzed.
1304
+ # @return [Types::CsvFormatDescriptor]
1305
+ #
1306
+ # @!attribute [rw] json_format_descriptor
1307
+ # Contains information about how a source JSON data file should be
1308
+ # analyzed.
1309
+ # @return [Types::JsonFormatDescriptor]
1310
+ #
1311
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/FileFormatDescriptor AWS API Documentation
1312
+ #
1313
+ class FileFormatDescriptor < Struct.new(
1314
+ :csv_format_descriptor,
1315
+ :json_format_descriptor)
1316
+ SENSITIVE = []
1317
+ include Aws::Structure
1318
+ end
1319
+
1320
+ # @note When making an API call, you may pass GetAnomalyGroupRequest
1321
+ # data as a hash:
1322
+ #
1323
+ # {
1324
+ # anomaly_group_id: "UUID", # required
1325
+ # anomaly_detector_arn: "Arn", # required
1326
+ # }
1327
+ #
1328
+ # @!attribute [rw] anomaly_group_id
1329
+ # The ID of the anomaly group.
1330
+ # @return [String]
1331
+ #
1332
+ # @!attribute [rw] anomaly_detector_arn
1333
+ # The Amazon Resource Name (ARN) of the anomaly detector.
1334
+ # @return [String]
1335
+ #
1336
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetAnomalyGroupRequest AWS API Documentation
1337
+ #
1338
+ class GetAnomalyGroupRequest < Struct.new(
1339
+ :anomaly_group_id,
1340
+ :anomaly_detector_arn)
1341
+ SENSITIVE = []
1342
+ include Aws::Structure
1343
+ end
1344
+
1345
+ # @!attribute [rw] anomaly_group
1346
+ # Details about the anomaly group.
1347
+ # @return [Types::AnomalyGroup]
1348
+ #
1349
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetAnomalyGroupResponse AWS API Documentation
1350
+ #
1351
+ class GetAnomalyGroupResponse < Struct.new(
1352
+ :anomaly_group)
1353
+ SENSITIVE = []
1354
+ include Aws::Structure
1355
+ end
1356
+
1357
+ # @note When making an API call, you may pass GetFeedbackRequest
1358
+ # data as a hash:
1359
+ #
1360
+ # {
1361
+ # anomaly_detector_arn: "Arn", # required
1362
+ # anomaly_group_time_series_feedback: { # required
1363
+ # anomaly_group_id: "UUID", # required
1364
+ # time_series_id: "TimeSeriesId",
1365
+ # },
1366
+ # max_results: 1,
1367
+ # next_token: "NextToken",
1368
+ # }
1369
+ #
1370
+ # @!attribute [rw] anomaly_detector_arn
1371
+ # The Amazon Resource Name (ARN) of the anomaly detector.
1372
+ # @return [String]
1373
+ #
1374
+ # @!attribute [rw] anomaly_group_time_series_feedback
1375
+ # The anomalous metric and group ID.
1376
+ # @return [Types::AnomalyGroupTimeSeries]
1377
+ #
1378
+ # @!attribute [rw] max_results
1379
+ # The maximum number of results to return.
1380
+ # @return [Integer]
1381
+ #
1382
+ # @!attribute [rw] next_token
1383
+ # Specify the pagination token that's returned by a previous request
1384
+ # to retrieve the next page of results.
1385
+ # @return [String]
1386
+ #
1387
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetFeedbackRequest AWS API Documentation
1388
+ #
1389
+ class GetFeedbackRequest < Struct.new(
1390
+ :anomaly_detector_arn,
1391
+ :anomaly_group_time_series_feedback,
1392
+ :max_results,
1393
+ :next_token)
1394
+ SENSITIVE = []
1395
+ include Aws::Structure
1396
+ end
1397
+
1398
+ # @!attribute [rw] anomaly_group_time_series_feedback
1399
+ # Feedback for an anomalous metric.
1400
+ # @return [Array<Types::TimeSeriesFeedback>]
1401
+ #
1402
+ # @!attribute [rw] next_token
1403
+ # The pagination token that's included if more results are available.
1404
+ # @return [String]
1405
+ #
1406
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetFeedbackResponse AWS API Documentation
1407
+ #
1408
+ class GetFeedbackResponse < Struct.new(
1409
+ :anomaly_group_time_series_feedback,
1410
+ :next_token)
1411
+ SENSITIVE = []
1412
+ include Aws::Structure
1413
+ end
1414
+
1415
+ # @note When making an API call, you may pass GetSampleDataRequest
1416
+ # data as a hash:
1417
+ #
1418
+ # {
1419
+ # s3_source_config: {
1420
+ # role_arn: "Arn", # required
1421
+ # templated_path_list: ["TemplatedPath"],
1422
+ # historical_data_path_list: ["HistoricalDataPath"],
1423
+ # file_format_descriptor: { # required
1424
+ # csv_format_descriptor: {
1425
+ # file_compression: "NONE", # accepts NONE, GZIP
1426
+ # charset: "Charset",
1427
+ # contains_header: false,
1428
+ # delimiter: "Delimiter",
1429
+ # header_list: ["ColumnName"],
1430
+ # quote_symbol: "QuoteSymbol",
1431
+ # },
1432
+ # json_format_descriptor: {
1433
+ # file_compression: "NONE", # accepts NONE, GZIP
1434
+ # charset: "Charset",
1435
+ # },
1436
+ # },
1437
+ # },
1438
+ # }
1439
+ #
1440
+ # @!attribute [rw] s3_source_config
1441
+ # A datasource bucket in Amazon S3.
1442
+ # @return [Types::SampleDataS3SourceConfig]
1443
+ #
1444
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetSampleDataRequest AWS API Documentation
1445
+ #
1446
+ class GetSampleDataRequest < Struct.new(
1447
+ :s3_source_config)
1448
+ SENSITIVE = []
1449
+ include Aws::Structure
1450
+ end
1451
+
1452
+ # @!attribute [rw] header_values
1453
+ # A list of header labels for the records.
1454
+ # @return [Array<String>]
1455
+ #
1456
+ # @!attribute [rw] sample_rows
1457
+ # A list of records.
1458
+ # @return [Array<Array<String>>]
1459
+ #
1460
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/GetSampleDataResponse AWS API Documentation
1461
+ #
1462
+ class GetSampleDataResponse < Struct.new(
1463
+ :header_values,
1464
+ :sample_rows)
1465
+ SENSITIVE = []
1466
+ include Aws::Structure
1467
+ end
1468
+
1469
+ # The request processing has failed because of an unknown error,
1470
+ # exception, or failure.
1471
+ #
1472
+ # @!attribute [rw] message
1473
+ # @return [String]
1474
+ #
1475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/InternalServerException AWS API Documentation
1476
+ #
1477
+ class InternalServerException < Struct.new(
1478
+ :message)
1479
+ SENSITIVE = []
1480
+ include Aws::Structure
1481
+ end
1482
+
1483
+ # Aggregated statistics about a measure affected by an anomaly.
1484
+ #
1485
+ # @!attribute [rw] metric_name
1486
+ # The name of the measure.
1487
+ # @return [String]
1488
+ #
1489
+ # @!attribute [rw] occurrence_count
1490
+ # The number of times that the measure appears.
1491
+ # @return [Integer]
1492
+ #
1493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ItemizedMetricStats AWS API Documentation
1494
+ #
1495
+ class ItemizedMetricStats < Struct.new(
1496
+ :metric_name,
1497
+ :occurrence_count)
1498
+ SENSITIVE = []
1499
+ include Aws::Structure
1500
+ end
1501
+
1502
+ # Contains information about how a source JSON data file should be
1503
+ # analyzed.
1504
+ #
1505
+ # @note When making an API call, you may pass JsonFormatDescriptor
1506
+ # data as a hash:
1507
+ #
1508
+ # {
1509
+ # file_compression: "NONE", # accepts NONE, GZIP
1510
+ # charset: "Charset",
1511
+ # }
1512
+ #
1513
+ # @!attribute [rw] file_compression
1514
+ # The level of compression of the source CSV file.
1515
+ # @return [String]
1516
+ #
1517
+ # @!attribute [rw] charset
1518
+ # The character set in which the source JSON file is written.
1519
+ # @return [String]
1520
+ #
1521
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/JsonFormatDescriptor AWS API Documentation
1522
+ #
1523
+ class JsonFormatDescriptor < Struct.new(
1524
+ :file_compression,
1525
+ :charset)
1526
+ SENSITIVE = []
1527
+ include Aws::Structure
1528
+ end
1529
+
1530
+ # Contains information about a Lambda configuration.
1531
+ #
1532
+ # @note When making an API call, you may pass LambdaConfiguration
1533
+ # data as a hash:
1534
+ #
1535
+ # {
1536
+ # role_arn: "Arn", # required
1537
+ # lambda_arn: "Arn", # required
1538
+ # }
1539
+ #
1540
+ # @!attribute [rw] role_arn
1541
+ # The ARN of an IAM role that has permission to invoke the Lambda
1542
+ # function.
1543
+ # @return [String]
1544
+ #
1545
+ # @!attribute [rw] lambda_arn
1546
+ # The ARN of the Lambda function.
1547
+ # @return [String]
1548
+ #
1549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/LambdaConfiguration AWS API Documentation
1550
+ #
1551
+ class LambdaConfiguration < Struct.new(
1552
+ :role_arn,
1553
+ :lambda_arn)
1554
+ SENSITIVE = []
1555
+ include Aws::Structure
1556
+ end
1557
+
1558
+ # @note When making an API call, you may pass ListAlertsRequest
1559
+ # data as a hash:
1560
+ #
1561
+ # {
1562
+ # anomaly_detector_arn: "Arn",
1563
+ # next_token: "NextToken",
1564
+ # max_results: 1,
1565
+ # }
1566
+ #
1567
+ # @!attribute [rw] anomaly_detector_arn
1568
+ # The ARN of the alert's detector.
1569
+ # @return [String]
1570
+ #
1571
+ # @!attribute [rw] next_token
1572
+ # If the result of the previous request is truncated, the response
1573
+ # includes a `NextToken`. To retrieve the next set of results, use the
1574
+ # token in the next request. Tokens expire after 24 hours.
1575
+ # @return [String]
1576
+ #
1577
+ # @!attribute [rw] max_results
1578
+ # The maximum number of results that will be displayed by the request.
1579
+ # @return [Integer]
1580
+ #
1581
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAlertsRequest AWS API Documentation
1582
+ #
1583
+ class ListAlertsRequest < Struct.new(
1584
+ :anomaly_detector_arn,
1585
+ :next_token,
1586
+ :max_results)
1587
+ SENSITIVE = []
1588
+ include Aws::Structure
1589
+ end
1590
+
1591
+ # @!attribute [rw] alert_summary_list
1592
+ # Contains information about an alert.
1593
+ # @return [Array<Types::AlertSummary>]
1594
+ #
1595
+ # @!attribute [rw] next_token
1596
+ # If the response is truncated, the service returns this token. To
1597
+ # retrieve the next set of results, use this token in the next
1598
+ # request.
1599
+ # @return [String]
1600
+ #
1601
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAlertsResponse AWS API Documentation
1602
+ #
1603
+ class ListAlertsResponse < Struct.new(
1604
+ :alert_summary_list,
1605
+ :next_token)
1606
+ SENSITIVE = []
1607
+ include Aws::Structure
1608
+ end
1609
+
1610
+ # @note When making an API call, you may pass ListAnomalyDetectorsRequest
1611
+ # data as a hash:
1612
+ #
1613
+ # {
1614
+ # max_results: 1,
1615
+ # next_token: "NextToken",
1616
+ # }
1617
+ #
1618
+ # @!attribute [rw] max_results
1619
+ # The maximum number of results to return.
1620
+ # @return [Integer]
1621
+ #
1622
+ # @!attribute [rw] next_token
1623
+ # If the result of the previous request was truncated, the response
1624
+ # includes a `NextToken`. To retrieve the next set of results, use the
1625
+ # token in the next request. Tokens expire after 24 hours.
1626
+ # @return [String]
1627
+ #
1628
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAnomalyDetectorsRequest AWS API Documentation
1629
+ #
1630
+ class ListAnomalyDetectorsRequest < Struct.new(
1631
+ :max_results,
1632
+ :next_token)
1633
+ SENSITIVE = []
1634
+ include Aws::Structure
1635
+ end
1636
+
1637
+ # @!attribute [rw] anomaly_detector_summary_list
1638
+ # A list of anomaly detectors in the account in the current region.
1639
+ # @return [Array<Types::AnomalyDetectorSummary>]
1640
+ #
1641
+ # @!attribute [rw] next_token
1642
+ # If the response is truncated, the service returns this token. To
1643
+ # retrieve the next set of results, use the token in the next request.
1644
+ # @return [String]
1645
+ #
1646
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAnomalyDetectorsResponse AWS API Documentation
1647
+ #
1648
+ class ListAnomalyDetectorsResponse < Struct.new(
1649
+ :anomaly_detector_summary_list,
1650
+ :next_token)
1651
+ SENSITIVE = []
1652
+ include Aws::Structure
1653
+ end
1654
+
1655
+ # @note When making an API call, you may pass ListAnomalyGroupSummariesRequest
1656
+ # data as a hash:
1657
+ #
1658
+ # {
1659
+ # anomaly_detector_arn: "Arn", # required
1660
+ # sensitivity_threshold: 1, # required
1661
+ # max_results: 1,
1662
+ # next_token: "NextToken",
1663
+ # }
1664
+ #
1665
+ # @!attribute [rw] anomaly_detector_arn
1666
+ # The Amazon Resource Name (ARN) of the anomaly detector.
1667
+ # @return [String]
1668
+ #
1669
+ # @!attribute [rw] sensitivity_threshold
1670
+ # The minimum severity score for inclusion in the output.
1671
+ # @return [Integer]
1672
+ #
1673
+ # @!attribute [rw] max_results
1674
+ # The maximum number of results to return.
1675
+ # @return [Integer]
1676
+ #
1677
+ # @!attribute [rw] next_token
1678
+ # Specify the pagination token that's returned by a previous request
1679
+ # to retrieve the next page of results.
1680
+ # @return [String]
1681
+ #
1682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAnomalyGroupSummariesRequest AWS API Documentation
1683
+ #
1684
+ class ListAnomalyGroupSummariesRequest < Struct.new(
1685
+ :anomaly_detector_arn,
1686
+ :sensitivity_threshold,
1687
+ :max_results,
1688
+ :next_token)
1689
+ SENSITIVE = []
1690
+ include Aws::Structure
1691
+ end
1692
+
1693
+ # @!attribute [rw] anomaly_group_summary_list
1694
+ # A list of anomaly group summaries.
1695
+ # @return [Array<Types::AnomalyGroupSummary>]
1696
+ #
1697
+ # @!attribute [rw] anomaly_group_statistics
1698
+ # Aggregated details about the anomaly groups.
1699
+ # @return [Types::AnomalyGroupStatistics]
1700
+ #
1701
+ # @!attribute [rw] next_token
1702
+ # The pagination token that's included if more results are available.
1703
+ # @return [String]
1704
+ #
1705
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAnomalyGroupSummariesResponse AWS API Documentation
1706
+ #
1707
+ class ListAnomalyGroupSummariesResponse < Struct.new(
1708
+ :anomaly_group_summary_list,
1709
+ :anomaly_group_statistics,
1710
+ :next_token)
1711
+ SENSITIVE = []
1712
+ include Aws::Structure
1713
+ end
1714
+
1715
+ # @note When making an API call, you may pass ListAnomalyGroupTimeSeriesRequest
1716
+ # data as a hash:
1717
+ #
1718
+ # {
1719
+ # anomaly_detector_arn: "Arn", # required
1720
+ # anomaly_group_id: "UUID", # required
1721
+ # metric_name: "MetricName", # required
1722
+ # max_results: 1,
1723
+ # next_token: "NextToken",
1724
+ # }
1725
+ #
1726
+ # @!attribute [rw] anomaly_detector_arn
1727
+ # The Amazon Resource Name (ARN) of the anomaly detector.
1728
+ # @return [String]
1729
+ #
1730
+ # @!attribute [rw] anomaly_group_id
1731
+ # The ID of the anomaly group.
1732
+ # @return [String]
1733
+ #
1734
+ # @!attribute [rw] metric_name
1735
+ # The name of the measure field.
1736
+ # @return [String]
1737
+ #
1738
+ # @!attribute [rw] max_results
1739
+ # The maximum number of results to return.
1740
+ # @return [Integer]
1741
+ #
1742
+ # @!attribute [rw] next_token
1743
+ # Specify the pagination token that's returned by a previous request
1744
+ # to retrieve the next page of results.
1745
+ # @return [String]
1746
+ #
1747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAnomalyGroupTimeSeriesRequest AWS API Documentation
1748
+ #
1749
+ class ListAnomalyGroupTimeSeriesRequest < Struct.new(
1750
+ :anomaly_detector_arn,
1751
+ :anomaly_group_id,
1752
+ :metric_name,
1753
+ :max_results,
1754
+ :next_token)
1755
+ SENSITIVE = []
1756
+ include Aws::Structure
1757
+ end
1758
+
1759
+ # @!attribute [rw] anomaly_group_id
1760
+ # The ID of the anomaly group.
1761
+ # @return [String]
1762
+ #
1763
+ # @!attribute [rw] metric_name
1764
+ # The name of the measure field.
1765
+ # @return [String]
1766
+ #
1767
+ # @!attribute [rw] timestamp_list
1768
+ # Timestamps for the anomalous metrics.
1769
+ # @return [Array<String>]
1770
+ #
1771
+ # @!attribute [rw] next_token
1772
+ # The pagination token that's included if more results are available.
1773
+ # @return [String]
1774
+ #
1775
+ # @!attribute [rw] time_series_list
1776
+ # A list of anomalous metrics.
1777
+ # @return [Array<Types::TimeSeries>]
1778
+ #
1779
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListAnomalyGroupTimeSeriesResponse AWS API Documentation
1780
+ #
1781
+ class ListAnomalyGroupTimeSeriesResponse < Struct.new(
1782
+ :anomaly_group_id,
1783
+ :metric_name,
1784
+ :timestamp_list,
1785
+ :next_token,
1786
+ :time_series_list)
1787
+ SENSITIVE = []
1788
+ include Aws::Structure
1789
+ end
1790
+
1791
+ # @note When making an API call, you may pass ListMetricSetsRequest
1792
+ # data as a hash:
1793
+ #
1794
+ # {
1795
+ # anomaly_detector_arn: "Arn",
1796
+ # max_results: 1,
1797
+ # next_token: "NextToken",
1798
+ # }
1799
+ #
1800
+ # @!attribute [rw] anomaly_detector_arn
1801
+ # The ARN of the anomaly detector containing the metrics sets to list.
1802
+ # @return [String]
1803
+ #
1804
+ # @!attribute [rw] max_results
1805
+ # The maximum number of results to return.
1806
+ # @return [Integer]
1807
+ #
1808
+ # @!attribute [rw] next_token
1809
+ # If the result of the previous request was truncated, the response
1810
+ # includes a `NextToken`. To retrieve the next set of results, use the
1811
+ # token in the next request. Tokens expire after 24 hours.
1812
+ # @return [String]
1813
+ #
1814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListMetricSetsRequest AWS API Documentation
1815
+ #
1816
+ class ListMetricSetsRequest < Struct.new(
1817
+ :anomaly_detector_arn,
1818
+ :max_results,
1819
+ :next_token)
1820
+ SENSITIVE = []
1821
+ include Aws::Structure
1822
+ end
1823
+
1824
+ # @!attribute [rw] metric_set_summary_list
1825
+ # A list of the datasets in the AWS Region, with configuration details
1826
+ # for each.
1827
+ # @return [Array<Types::MetricSetSummary>]
1828
+ #
1829
+ # @!attribute [rw] next_token
1830
+ # If the response is truncated, the list call returns this token. To
1831
+ # retrieve the next set of results, use the token in the next list
1832
+ # request.
1833
+ # @return [String]
1834
+ #
1835
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListMetricSetsResponse AWS API Documentation
1836
+ #
1837
+ class ListMetricSetsResponse < Struct.new(
1838
+ :metric_set_summary_list,
1839
+ :next_token)
1840
+ SENSITIVE = []
1841
+ include Aws::Structure
1842
+ end
1843
+
1844
+ # @note When making an API call, you may pass ListTagsForResourceRequest
1845
+ # data as a hash:
1846
+ #
1847
+ # {
1848
+ # resource_arn: "Arn", # required
1849
+ # }
1850
+ #
1851
+ # @!attribute [rw] resource_arn
1852
+ # The resource's Amazon Resource Name (ARN).
1853
+ # @return [String]
1854
+ #
1855
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListTagsForResourceRequest AWS API Documentation
1856
+ #
1857
+ class ListTagsForResourceRequest < Struct.new(
1858
+ :resource_arn)
1859
+ SENSITIVE = []
1860
+ include Aws::Structure
1861
+ end
1862
+
1863
+ # @!attribute [rw] tags
1864
+ # The resource's tags.
1865
+ # @return [Hash<String,String>]
1866
+ #
1867
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ListTagsForResourceResponse AWS API Documentation
1868
+ #
1869
+ class ListTagsForResourceResponse < Struct.new(
1870
+ :tags)
1871
+ SENSITIVE = []
1872
+ include Aws::Structure
1873
+ end
1874
+
1875
+ # A calculation made by contrasting a measure and a dimension from your
1876
+ # source data.
1877
+ #
1878
+ # @note When making an API call, you may pass Metric
1879
+ # data as a hash:
1880
+ #
1881
+ # {
1882
+ # metric_name: "ColumnName", # required
1883
+ # aggregation_function: "AVG", # required, accepts AVG, SUM
1884
+ # namespace: "Namespace",
1885
+ # }
1886
+ #
1887
+ # @!attribute [rw] metric_name
1888
+ # The name of the metric.
1889
+ # @return [String]
1890
+ #
1891
+ # @!attribute [rw] aggregation_function
1892
+ # The function with which the metric is calculated.
1893
+ # @return [String]
1894
+ #
1895
+ # @!attribute [rw] namespace
1896
+ # The namespace for the metric.
1897
+ # @return [String]
1898
+ #
1899
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/Metric AWS API Documentation
1900
+ #
1901
+ class Metric < Struct.new(
1902
+ :metric_name,
1903
+ :aggregation_function,
1904
+ :namespace)
1905
+ SENSITIVE = []
1906
+ include Aws::Structure
1907
+ end
1908
+
1909
+ # Details about a measure affected by an anomaly.
1910
+ #
1911
+ # @!attribute [rw] metric_name
1912
+ # The name of the measure.
1913
+ # @return [String]
1914
+ #
1915
+ # @!attribute [rw] num_time_series
1916
+ # The number of anomalous metrics for the measure.
1917
+ # @return [Integer]
1918
+ #
1919
+ # @!attribute [rw] contribution_matrix
1920
+ # Details about the dimensions that contributed to the anomaly.
1921
+ # @return [Types::ContributionMatrix]
1922
+ #
1923
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/MetricLevelImpact AWS API Documentation
1924
+ #
1925
+ class MetricLevelImpact < Struct.new(
1926
+ :metric_name,
1927
+ :num_time_series,
1928
+ :contribution_matrix)
1929
+ SENSITIVE = []
1930
+ include Aws::Structure
1931
+ end
1932
+
1933
+ # Contains information about a dataset.
1934
+ #
1935
+ # @!attribute [rw] metric_set_arn
1936
+ # The ARN of the dataset.
1937
+ # @return [String]
1938
+ #
1939
+ # @!attribute [rw] anomaly_detector_arn
1940
+ # The ARN of the detector to which the dataset belongs.
1941
+ # @return [String]
1942
+ #
1943
+ # @!attribute [rw] metric_set_description
1944
+ # The description of the dataset.
1945
+ # @return [String]
1946
+ #
1947
+ # @!attribute [rw] metric_set_name
1948
+ # The name of the dataset.
1949
+ # @return [String]
1950
+ #
1951
+ # @!attribute [rw] creation_time
1952
+ # The time at which the dataset was created.
1953
+ # @return [Time]
1954
+ #
1955
+ # @!attribute [rw] last_modification_time
1956
+ # The time at which the dataset was last modified.
1957
+ # @return [Time]
1958
+ #
1959
+ # @!attribute [rw] tags
1960
+ # The dataset's [tags][1].
1961
+ #
1962
+ #
1963
+ #
1964
+ # [1]: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html
1965
+ # @return [Hash<String,String>]
1966
+ #
1967
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/MetricSetSummary AWS API Documentation
1968
+ #
1969
+ class MetricSetSummary < Struct.new(
1970
+ :metric_set_arn,
1971
+ :anomaly_detector_arn,
1972
+ :metric_set_description,
1973
+ :metric_set_name,
1974
+ :creation_time,
1975
+ :last_modification_time,
1976
+ :tags)
1977
+ SENSITIVE = []
1978
+ include Aws::Structure
1979
+ end
1980
+
1981
+ # Contains information about source data used to generate a metric.
1982
+ #
1983
+ # @note When making an API call, you may pass MetricSource
1984
+ # data as a hash:
1985
+ #
1986
+ # {
1987
+ # s3_source_config: {
1988
+ # role_arn: "Arn", # required
1989
+ # templated_path_list: ["TemplatedPath"],
1990
+ # historical_data_path_list: ["HistoricalDataPath"],
1991
+ # file_format_descriptor: {
1992
+ # csv_format_descriptor: {
1993
+ # file_compression: "NONE", # accepts NONE, GZIP
1994
+ # charset: "Charset",
1995
+ # contains_header: false,
1996
+ # delimiter: "Delimiter",
1997
+ # header_list: ["ColumnName"],
1998
+ # quote_symbol: "QuoteSymbol",
1999
+ # },
2000
+ # json_format_descriptor: {
2001
+ # file_compression: "NONE", # accepts NONE, GZIP
2002
+ # charset: "Charset",
2003
+ # },
2004
+ # },
2005
+ # },
2006
+ # app_flow_config: {
2007
+ # role_arn: "Arn", # required
2008
+ # flow_name: "FlowName", # required
2009
+ # },
2010
+ # cloud_watch_config: {
2011
+ # role_arn: "Arn", # required
2012
+ # },
2013
+ # rds_source_config: {
2014
+ # db_instance_identifier: "RDSDatabaseIdentifier", # required
2015
+ # database_host: "DatabaseHost", # required
2016
+ # database_port: 1, # required
2017
+ # secret_manager_arn: "PoirotSecretManagerArn", # required
2018
+ # database_name: "RDSDatabaseName", # required
2019
+ # table_name: "TableName", # required
2020
+ # role_arn: "Arn", # required
2021
+ # vpc_configuration: { # required
2022
+ # subnet_id_list: ["SubnetId"], # required
2023
+ # security_group_id_list: ["SecurityGroupId"], # required
2024
+ # },
2025
+ # },
2026
+ # redshift_source_config: {
2027
+ # cluster_identifier: "RedshiftClusterIdentifier", # required
2028
+ # database_host: "DatabaseHost", # required
2029
+ # database_port: 1, # required
2030
+ # secret_manager_arn: "PoirotSecretManagerArn", # required
2031
+ # database_name: "RedshiftDatabaseName", # required
2032
+ # table_name: "TableName", # required
2033
+ # role_arn: "Arn", # required
2034
+ # vpc_configuration: { # required
2035
+ # subnet_id_list: ["SubnetId"], # required
2036
+ # security_group_id_list: ["SecurityGroupId"], # required
2037
+ # },
2038
+ # },
2039
+ # }
2040
+ #
2041
+ # @!attribute [rw] s3_source_config
2042
+ # Contains information about the configuration of the S3 bucket that
2043
+ # contains source files.
2044
+ # @return [Types::S3SourceConfig]
2045
+ #
2046
+ # @!attribute [rw] app_flow_config
2047
+ # An object containing information about the AppFlow configuration.
2048
+ # @return [Types::AppFlowConfig]
2049
+ #
2050
+ # @!attribute [rw] cloud_watch_config
2051
+ # An object containing information about the Amazon CloudWatch
2052
+ # monitoring configuration.
2053
+ # @return [Types::CloudWatchConfig]
2054
+ #
2055
+ # @!attribute [rw] rds_source_config
2056
+ # An object containing information about the Amazon Relational
2057
+ # Database Service (RDS) configuration.
2058
+ # @return [Types::RDSSourceConfig]
2059
+ #
2060
+ # @!attribute [rw] redshift_source_config
2061
+ # An object containing information about the Amazon Redshift database
2062
+ # configuration.
2063
+ # @return [Types::RedshiftSourceConfig]
2064
+ #
2065
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/MetricSource AWS API Documentation
2066
+ #
2067
+ class MetricSource < Struct.new(
2068
+ :s3_source_config,
2069
+ :app_flow_config,
2070
+ :cloud_watch_config,
2071
+ :rds_source_config,
2072
+ :redshift_source_config)
2073
+ SENSITIVE = []
2074
+ include Aws::Structure
2075
+ end
2076
+
2077
+ # @note When making an API call, you may pass PutFeedbackRequest
2078
+ # data as a hash:
2079
+ #
2080
+ # {
2081
+ # anomaly_detector_arn: "Arn", # required
2082
+ # anomaly_group_time_series_feedback: { # required
2083
+ # anomaly_group_id: "UUID", # required
2084
+ # time_series_id: "TimeSeriesId", # required
2085
+ # is_anomaly: false, # required
2086
+ # },
2087
+ # }
2088
+ #
2089
+ # @!attribute [rw] anomaly_detector_arn
2090
+ # The Amazon Resource Name (ARN) of the anomaly detector.
2091
+ # @return [String]
2092
+ #
2093
+ # @!attribute [rw] anomaly_group_time_series_feedback
2094
+ # Feedback for an anomalous metric.
2095
+ # @return [Types::AnomalyGroupTimeSeriesFeedback]
2096
+ #
2097
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/PutFeedbackRequest AWS API Documentation
2098
+ #
2099
+ class PutFeedbackRequest < Struct.new(
2100
+ :anomaly_detector_arn,
2101
+ :anomaly_group_time_series_feedback)
2102
+ SENSITIVE = []
2103
+ include Aws::Structure
2104
+ end
2105
+
2106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/PutFeedbackResponse AWS API Documentation
2107
+ #
2108
+ class PutFeedbackResponse < Aws::EmptyStructure; end
2109
+
2110
+ # Contains information about the Amazon Relational Database Service
2111
+ # (RDS) configuration.
2112
+ #
2113
+ # @note When making an API call, you may pass RDSSourceConfig
2114
+ # data as a hash:
2115
+ #
2116
+ # {
2117
+ # db_instance_identifier: "RDSDatabaseIdentifier", # required
2118
+ # database_host: "DatabaseHost", # required
2119
+ # database_port: 1, # required
2120
+ # secret_manager_arn: "PoirotSecretManagerArn", # required
2121
+ # database_name: "RDSDatabaseName", # required
2122
+ # table_name: "TableName", # required
2123
+ # role_arn: "Arn", # required
2124
+ # vpc_configuration: { # required
2125
+ # subnet_id_list: ["SubnetId"], # required
2126
+ # security_group_id_list: ["SecurityGroupId"], # required
2127
+ # },
2128
+ # }
2129
+ #
2130
+ # @!attribute [rw] db_instance_identifier
2131
+ # A string identifying the database instance.
2132
+ # @return [String]
2133
+ #
2134
+ # @!attribute [rw] database_host
2135
+ # The host name of the database.
2136
+ # @return [String]
2137
+ #
2138
+ # @!attribute [rw] database_port
2139
+ # The port number where the database can be accessed.
2140
+ # @return [Integer]
2141
+ #
2142
+ # @!attribute [rw] secret_manager_arn
2143
+ # The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
2144
+ # @return [String]
2145
+ #
2146
+ # @!attribute [rw] database_name
2147
+ # The name of the RDS database.
2148
+ # @return [String]
2149
+ #
2150
+ # @!attribute [rw] table_name
2151
+ # The name of the table in the database.
2152
+ # @return [String]
2153
+ #
2154
+ # @!attribute [rw] role_arn
2155
+ # The Amazon Resource Name (ARN) of the role.
2156
+ # @return [String]
2157
+ #
2158
+ # @!attribute [rw] vpc_configuration
2159
+ # An object containing information about the Amazon Virtual Private
2160
+ # Cloud (VPC) configuration.
2161
+ # @return [Types::VpcConfiguration]
2162
+ #
2163
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/RDSSourceConfig AWS API Documentation
2164
+ #
2165
+ class RDSSourceConfig < Struct.new(
2166
+ :db_instance_identifier,
2167
+ :database_host,
2168
+ :database_port,
2169
+ :secret_manager_arn,
2170
+ :database_name,
2171
+ :table_name,
2172
+ :role_arn,
2173
+ :vpc_configuration)
2174
+ SENSITIVE = []
2175
+ include Aws::Structure
2176
+ end
2177
+
2178
+ # Provides information about the Amazon Redshift database configuration.
2179
+ #
2180
+ # @note When making an API call, you may pass RedshiftSourceConfig
2181
+ # data as a hash:
2182
+ #
2183
+ # {
2184
+ # cluster_identifier: "RedshiftClusterIdentifier", # required
2185
+ # database_host: "DatabaseHost", # required
2186
+ # database_port: 1, # required
2187
+ # secret_manager_arn: "PoirotSecretManagerArn", # required
2188
+ # database_name: "RedshiftDatabaseName", # required
2189
+ # table_name: "TableName", # required
2190
+ # role_arn: "Arn", # required
2191
+ # vpc_configuration: { # required
2192
+ # subnet_id_list: ["SubnetId"], # required
2193
+ # security_group_id_list: ["SecurityGroupId"], # required
2194
+ # },
2195
+ # }
2196
+ #
2197
+ # @!attribute [rw] cluster_identifier
2198
+ # A string identifying the Redshift cluster.
2199
+ # @return [String]
2200
+ #
2201
+ # @!attribute [rw] database_host
2202
+ # The name of the database host.
2203
+ # @return [String]
2204
+ #
2205
+ # @!attribute [rw] database_port
2206
+ # The port number where the database can be accessed.
2207
+ # @return [Integer]
2208
+ #
2209
+ # @!attribute [rw] secret_manager_arn
2210
+ # The Amazon Resource Name (ARN) of the AWS Secrets Manager role.
2211
+ # @return [String]
2212
+ #
2213
+ # @!attribute [rw] database_name
2214
+ # The Redshift database name.
2215
+ # @return [String]
2216
+ #
2217
+ # @!attribute [rw] table_name
2218
+ # The table name of the Redshift database.
2219
+ # @return [String]
2220
+ #
2221
+ # @!attribute [rw] role_arn
2222
+ # The Amazon Resource Name (ARN) of the role providing access to the
2223
+ # database.
2224
+ # @return [String]
2225
+ #
2226
+ # @!attribute [rw] vpc_configuration
2227
+ # Contains information about the Amazon Virtual Private Cloud (VPC)
2228
+ # configuration.
2229
+ # @return [Types::VpcConfiguration]
2230
+ #
2231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/RedshiftSourceConfig AWS API Documentation
2232
+ #
2233
+ class RedshiftSourceConfig < Struct.new(
2234
+ :cluster_identifier,
2235
+ :database_host,
2236
+ :database_port,
2237
+ :secret_manager_arn,
2238
+ :database_name,
2239
+ :table_name,
2240
+ :role_arn,
2241
+ :vpc_configuration)
2242
+ SENSITIVE = []
2243
+ include Aws::Structure
2244
+ end
2245
+
2246
+ # The specified resource cannot be found. Check the ARN of the resource
2247
+ # and try again.
2248
+ #
2249
+ # @!attribute [rw] message
2250
+ # @return [String]
2251
+ #
2252
+ # @!attribute [rw] resource_id
2253
+ # The ID of the resource.
2254
+ # @return [String]
2255
+ #
2256
+ # @!attribute [rw] resource_type
2257
+ # The type of the resource.
2258
+ # @return [String]
2259
+ #
2260
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ResourceNotFoundException AWS API Documentation
2261
+ #
2262
+ class ResourceNotFoundException < Struct.new(
2263
+ :message,
2264
+ :resource_id,
2265
+ :resource_type)
2266
+ SENSITIVE = []
2267
+ include Aws::Structure
2268
+ end
2269
+
2270
+ # Contains information about the configuration of the S3 bucket that
2271
+ # contains source files.
2272
+ #
2273
+ # @note When making an API call, you may pass S3SourceConfig
2274
+ # data as a hash:
2275
+ #
2276
+ # {
2277
+ # role_arn: "Arn", # required
2278
+ # templated_path_list: ["TemplatedPath"],
2279
+ # historical_data_path_list: ["HistoricalDataPath"],
2280
+ # file_format_descriptor: {
2281
+ # csv_format_descriptor: {
2282
+ # file_compression: "NONE", # accepts NONE, GZIP
2283
+ # charset: "Charset",
2284
+ # contains_header: false,
2285
+ # delimiter: "Delimiter",
2286
+ # header_list: ["ColumnName"],
2287
+ # quote_symbol: "QuoteSymbol",
2288
+ # },
2289
+ # json_format_descriptor: {
2290
+ # file_compression: "NONE", # accepts NONE, GZIP
2291
+ # charset: "Charset",
2292
+ # },
2293
+ # },
2294
+ # }
2295
+ #
2296
+ # @!attribute [rw] role_arn
2297
+ # The ARN of an IAM role that has read and write access permissions to
2298
+ # the source S3 bucket.
2299
+ # @return [String]
2300
+ #
2301
+ # @!attribute [rw] templated_path_list
2302
+ # A list of templated paths to the source files.
2303
+ # @return [Array<String>]
2304
+ #
2305
+ # @!attribute [rw] historical_data_path_list
2306
+ # A list of paths to the historical data files.
2307
+ # @return [Array<String>]
2308
+ #
2309
+ # @!attribute [rw] file_format_descriptor
2310
+ # Contains information about a source file's formatting.
2311
+ # @return [Types::FileFormatDescriptor]
2312
+ #
2313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/S3SourceConfig AWS API Documentation
2314
+ #
2315
+ class S3SourceConfig < Struct.new(
2316
+ :role_arn,
2317
+ :templated_path_list,
2318
+ :historical_data_path_list,
2319
+ :file_format_descriptor)
2320
+ SENSITIVE = []
2321
+ include Aws::Structure
2322
+ end
2323
+
2324
+ # Contains information about the SNS topic to which you want to send
2325
+ # your alerts and the IAM role that has access to that topic.
2326
+ #
2327
+ # @note When making an API call, you may pass SNSConfiguration
2328
+ # data as a hash:
2329
+ #
2330
+ # {
2331
+ # role_arn: "Arn", # required
2332
+ # sns_topic_arn: "Arn", # required
2333
+ # }
2334
+ #
2335
+ # @!attribute [rw] role_arn
2336
+ # THe ARN of the IAM role that has access to the target SNS topic.
2337
+ # @return [String]
2338
+ #
2339
+ # @!attribute [rw] sns_topic_arn
2340
+ # The ARN of the target SNS topic.
2341
+ # @return [String]
2342
+ #
2343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/SNSConfiguration AWS API Documentation
2344
+ #
2345
+ class SNSConfiguration < Struct.new(
2346
+ :role_arn,
2347
+ :sns_topic_arn)
2348
+ SENSITIVE = []
2349
+ include Aws::Structure
2350
+ end
2351
+
2352
+ # Contains information about the source configuration in Amazon S3.
2353
+ #
2354
+ # @note When making an API call, you may pass SampleDataS3SourceConfig
2355
+ # data as a hash:
2356
+ #
2357
+ # {
2358
+ # role_arn: "Arn", # required
2359
+ # templated_path_list: ["TemplatedPath"],
2360
+ # historical_data_path_list: ["HistoricalDataPath"],
2361
+ # file_format_descriptor: { # required
2362
+ # csv_format_descriptor: {
2363
+ # file_compression: "NONE", # accepts NONE, GZIP
2364
+ # charset: "Charset",
2365
+ # contains_header: false,
2366
+ # delimiter: "Delimiter",
2367
+ # header_list: ["ColumnName"],
2368
+ # quote_symbol: "QuoteSymbol",
2369
+ # },
2370
+ # json_format_descriptor: {
2371
+ # file_compression: "NONE", # accepts NONE, GZIP
2372
+ # charset: "Charset",
2373
+ # },
2374
+ # },
2375
+ # }
2376
+ #
2377
+ # @!attribute [rw] role_arn
2378
+ # The Amazon Resource Name (ARN) of the role.
2379
+ # @return [String]
2380
+ #
2381
+ # @!attribute [rw] templated_path_list
2382
+ # An array of strings containing the list of templated paths.
2383
+ # @return [Array<String>]
2384
+ #
2385
+ # @!attribute [rw] historical_data_path_list
2386
+ # An array of strings containing the historical set of data paths.
2387
+ # @return [Array<String>]
2388
+ #
2389
+ # @!attribute [rw] file_format_descriptor
2390
+ # Contains information about a source file's formatting.
2391
+ # @return [Types::FileFormatDescriptor]
2392
+ #
2393
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/SampleDataS3SourceConfig AWS API Documentation
2394
+ #
2395
+ class SampleDataS3SourceConfig < Struct.new(
2396
+ :role_arn,
2397
+ :templated_path_list,
2398
+ :historical_data_path_list,
2399
+ :file_format_descriptor)
2400
+ SENSITIVE = []
2401
+ include Aws::Structure
2402
+ end
2403
+
2404
+ # The request exceeded the service's quotas. Check the service quotas
2405
+ # and try again.
2406
+ #
2407
+ # @!attribute [rw] message
2408
+ # @return [String]
2409
+ #
2410
+ # @!attribute [rw] resource_id
2411
+ # The ID of the resource.
2412
+ # @return [String]
2413
+ #
2414
+ # @!attribute [rw] resource_type
2415
+ # The type of the resource.
2416
+ # @return [String]
2417
+ #
2418
+ # @!attribute [rw] quota_code
2419
+ # The quota code.
2420
+ # @return [String]
2421
+ #
2422
+ # @!attribute [rw] service_code
2423
+ # The service code.
2424
+ # @return [String]
2425
+ #
2426
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ServiceQuotaExceededException AWS API Documentation
2427
+ #
2428
+ class ServiceQuotaExceededException < Struct.new(
2429
+ :message,
2430
+ :resource_id,
2431
+ :resource_type,
2432
+ :quota_code,
2433
+ :service_code)
2434
+ SENSITIVE = []
2435
+ include Aws::Structure
2436
+ end
2437
+
2438
+ # @note When making an API call, you may pass TagResourceRequest
2439
+ # data as a hash:
2440
+ #
2441
+ # {
2442
+ # resource_arn: "Arn", # required
2443
+ # tags: { # required
2444
+ # "TagKey" => "TagValue",
2445
+ # },
2446
+ # }
2447
+ #
2448
+ # @!attribute [rw] resource_arn
2449
+ # The resource's Amazon Resource Name (ARN).
2450
+ # @return [String]
2451
+ #
2452
+ # @!attribute [rw] tags
2453
+ # Tags to apply to the resource. Tag keys and values can contain
2454
+ # letters, numbers, spaces, and the following symbols: `_.:/=+@-`
2455
+ # @return [Hash<String,String>]
2456
+ #
2457
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/TagResourceRequest AWS API Documentation
2458
+ #
2459
+ class TagResourceRequest < Struct.new(
2460
+ :resource_arn,
2461
+ :tags)
2462
+ SENSITIVE = []
2463
+ include Aws::Structure
2464
+ end
2465
+
2466
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/TagResourceResponse AWS API Documentation
2467
+ #
2468
+ class TagResourceResponse < Aws::EmptyStructure; end
2469
+
2470
+ # Details about a metric. A metric is an aggregation of the values of a
2471
+ # measure for a dimension value, such as *availability* in the
2472
+ # *us-east-1* Region.
2473
+ #
2474
+ # @!attribute [rw] time_series_id
2475
+ # The ID of the metric.
2476
+ # @return [String]
2477
+ #
2478
+ # @!attribute [rw] dimension_list
2479
+ # The dimensions of the metric.
2480
+ # @return [Array<Types::DimensionNameValue>]
2481
+ #
2482
+ # @!attribute [rw] metric_value_list
2483
+ # The values for the metric.
2484
+ # @return [Array<Float>]
2485
+ #
2486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/TimeSeries AWS API Documentation
2487
+ #
2488
+ class TimeSeries < Struct.new(
2489
+ :time_series_id,
2490
+ :dimension_list,
2491
+ :metric_value_list)
2492
+ SENSITIVE = []
2493
+ include Aws::Structure
2494
+ end
2495
+
2496
+ # Details about feedback submitted for an anomalous metric.
2497
+ #
2498
+ # @!attribute [rw] time_series_id
2499
+ # The ID of the metric.
2500
+ # @return [String]
2501
+ #
2502
+ # @!attribute [rw] is_anomaly
2503
+ # Feedback on whether the metric is a legitimate anomaly.
2504
+ # @return [Boolean]
2505
+ #
2506
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/TimeSeriesFeedback AWS API Documentation
2507
+ #
2508
+ class TimeSeriesFeedback < Struct.new(
2509
+ :time_series_id,
2510
+ :is_anomaly)
2511
+ SENSITIVE = []
2512
+ include Aws::Structure
2513
+ end
2514
+
2515
+ # Contains information about the column used to track time in a source
2516
+ # data file.
2517
+ #
2518
+ # @note When making an API call, you may pass TimestampColumn
2519
+ # data as a hash:
2520
+ #
2521
+ # {
2522
+ # column_name: "ColumnName",
2523
+ # column_format: "DateTimeFormat",
2524
+ # }
2525
+ #
2526
+ # @!attribute [rw] column_name
2527
+ # The name of the timestamp column.
2528
+ # @return [String]
2529
+ #
2530
+ # @!attribute [rw] column_format
2531
+ # The format of the timestamp column.
2532
+ # @return [String]
2533
+ #
2534
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/TimestampColumn AWS API Documentation
2535
+ #
2536
+ class TimestampColumn < Struct.new(
2537
+ :column_name,
2538
+ :column_format)
2539
+ SENSITIVE = []
2540
+ include Aws::Structure
2541
+ end
2542
+
2543
+ # The request was denied due to too many requests being submitted at the
2544
+ # same time.
2545
+ #
2546
+ # @!attribute [rw] message
2547
+ # @return [String]
2548
+ #
2549
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/TooManyRequestsException AWS API Documentation
2550
+ #
2551
+ class TooManyRequestsException < Struct.new(
2552
+ :message)
2553
+ SENSITIVE = []
2554
+ include Aws::Structure
2555
+ end
2556
+
2557
+ # @note When making an API call, you may pass UntagResourceRequest
2558
+ # data as a hash:
2559
+ #
2560
+ # {
2561
+ # resource_arn: "Arn", # required
2562
+ # tag_keys: ["TagKey"], # required
2563
+ # }
2564
+ #
2565
+ # @!attribute [rw] resource_arn
2566
+ # The resource's Amazon Resource Name (ARN).
2567
+ # @return [String]
2568
+ #
2569
+ # @!attribute [rw] tag_keys
2570
+ # Keys to remove from the resource's tags.
2571
+ # @return [Array<String>]
2572
+ #
2573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UntagResourceRequest AWS API Documentation
2574
+ #
2575
+ class UntagResourceRequest < Struct.new(
2576
+ :resource_arn,
2577
+ :tag_keys)
2578
+ SENSITIVE = []
2579
+ include Aws::Structure
2580
+ end
2581
+
2582
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UntagResourceResponse AWS API Documentation
2583
+ #
2584
+ class UntagResourceResponse < Aws::EmptyStructure; end
2585
+
2586
+ # @note When making an API call, you may pass UpdateAnomalyDetectorRequest
2587
+ # data as a hash:
2588
+ #
2589
+ # {
2590
+ # anomaly_detector_arn: "Arn", # required
2591
+ # kms_key_arn: "KmsKeyArn",
2592
+ # anomaly_detector_description: "AnomalyDetectorDescription",
2593
+ # anomaly_detector_config: {
2594
+ # anomaly_detector_frequency: "P1D", # accepts P1D, PT1H, PT10M, PT5M
2595
+ # },
2596
+ # }
2597
+ #
2598
+ # @!attribute [rw] anomaly_detector_arn
2599
+ # The ARN of the detector to update.
2600
+ # @return [String]
2601
+ #
2602
+ # @!attribute [rw] kms_key_arn
2603
+ # The Amazon Resource Name (ARN) of an AWS KMS encryption key.
2604
+ # @return [String]
2605
+ #
2606
+ # @!attribute [rw] anomaly_detector_description
2607
+ # The updated detector description.
2608
+ # @return [String]
2609
+ #
2610
+ # @!attribute [rw] anomaly_detector_config
2611
+ # Contains information about the configuration to which the detector
2612
+ # will be updated.
2613
+ # @return [Types::AnomalyDetectorConfig]
2614
+ #
2615
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateAnomalyDetectorRequest AWS API Documentation
2616
+ #
2617
+ class UpdateAnomalyDetectorRequest < Struct.new(
2618
+ :anomaly_detector_arn,
2619
+ :kms_key_arn,
2620
+ :anomaly_detector_description,
2621
+ :anomaly_detector_config)
2622
+ SENSITIVE = []
2623
+ include Aws::Structure
2624
+ end
2625
+
2626
+ # @!attribute [rw] anomaly_detector_arn
2627
+ # The ARN of the updated detector.
2628
+ # @return [String]
2629
+ #
2630
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateAnomalyDetectorResponse AWS API Documentation
2631
+ #
2632
+ class UpdateAnomalyDetectorResponse < Struct.new(
2633
+ :anomaly_detector_arn)
2634
+ SENSITIVE = []
2635
+ include Aws::Structure
2636
+ end
2637
+
2638
+ # @note When making an API call, you may pass UpdateMetricSetRequest
2639
+ # data as a hash:
2640
+ #
2641
+ # {
2642
+ # metric_set_arn: "Arn", # required
2643
+ # metric_set_description: "MetricSetDescription",
2644
+ # metric_list: [
2645
+ # {
2646
+ # metric_name: "ColumnName", # required
2647
+ # aggregation_function: "AVG", # required, accepts AVG, SUM
2648
+ # namespace: "Namespace",
2649
+ # },
2650
+ # ],
2651
+ # offset: 1,
2652
+ # timestamp_column: {
2653
+ # column_name: "ColumnName",
2654
+ # column_format: "DateTimeFormat",
2655
+ # },
2656
+ # dimension_list: ["ColumnName"],
2657
+ # metric_set_frequency: "P1D", # accepts P1D, PT1H, PT10M, PT5M
2658
+ # metric_source: {
2659
+ # s3_source_config: {
2660
+ # role_arn: "Arn", # required
2661
+ # templated_path_list: ["TemplatedPath"],
2662
+ # historical_data_path_list: ["HistoricalDataPath"],
2663
+ # file_format_descriptor: {
2664
+ # csv_format_descriptor: {
2665
+ # file_compression: "NONE", # accepts NONE, GZIP
2666
+ # charset: "Charset",
2667
+ # contains_header: false,
2668
+ # delimiter: "Delimiter",
2669
+ # header_list: ["ColumnName"],
2670
+ # quote_symbol: "QuoteSymbol",
2671
+ # },
2672
+ # json_format_descriptor: {
2673
+ # file_compression: "NONE", # accepts NONE, GZIP
2674
+ # charset: "Charset",
2675
+ # },
2676
+ # },
2677
+ # },
2678
+ # app_flow_config: {
2679
+ # role_arn: "Arn", # required
2680
+ # flow_name: "FlowName", # required
2681
+ # },
2682
+ # cloud_watch_config: {
2683
+ # role_arn: "Arn", # required
2684
+ # },
2685
+ # rds_source_config: {
2686
+ # db_instance_identifier: "RDSDatabaseIdentifier", # required
2687
+ # database_host: "DatabaseHost", # required
2688
+ # database_port: 1, # required
2689
+ # secret_manager_arn: "PoirotSecretManagerArn", # required
2690
+ # database_name: "RDSDatabaseName", # required
2691
+ # table_name: "TableName", # required
2692
+ # role_arn: "Arn", # required
2693
+ # vpc_configuration: { # required
2694
+ # subnet_id_list: ["SubnetId"], # required
2695
+ # security_group_id_list: ["SecurityGroupId"], # required
2696
+ # },
2697
+ # },
2698
+ # redshift_source_config: {
2699
+ # cluster_identifier: "RedshiftClusterIdentifier", # required
2700
+ # database_host: "DatabaseHost", # required
2701
+ # database_port: 1, # required
2702
+ # secret_manager_arn: "PoirotSecretManagerArn", # required
2703
+ # database_name: "RedshiftDatabaseName", # required
2704
+ # table_name: "TableName", # required
2705
+ # role_arn: "Arn", # required
2706
+ # vpc_configuration: { # required
2707
+ # subnet_id_list: ["SubnetId"], # required
2708
+ # security_group_id_list: ["SecurityGroupId"], # required
2709
+ # },
2710
+ # },
2711
+ # },
2712
+ # }
2713
+ #
2714
+ # @!attribute [rw] metric_set_arn
2715
+ # The ARN of the dataset to update.
2716
+ # @return [String]
2717
+ #
2718
+ # @!attribute [rw] metric_set_description
2719
+ # The dataset's description.
2720
+ # @return [String]
2721
+ #
2722
+ # @!attribute [rw] metric_list
2723
+ # The metric list.
2724
+ # @return [Array<Types::Metric>]
2725
+ #
2726
+ # @!attribute [rw] offset
2727
+ # After an interval ends, the amount of time that the detector waits
2728
+ # before importing data.
2729
+ # @return [Integer]
2730
+ #
2731
+ # @!attribute [rw] timestamp_column
2732
+ # The timestamp column.
2733
+ # @return [Types::TimestampColumn]
2734
+ #
2735
+ # @!attribute [rw] dimension_list
2736
+ # The dimension list.
2737
+ # @return [Array<String>]
2738
+ #
2739
+ # @!attribute [rw] metric_set_frequency
2740
+ # The dataset's interval.
2741
+ # @return [String]
2742
+ #
2743
+ # @!attribute [rw] metric_source
2744
+ # Contains information about source data used to generate a metric.
2745
+ # @return [Types::MetricSource]
2746
+ #
2747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateMetricSetRequest AWS API Documentation
2748
+ #
2749
+ class UpdateMetricSetRequest < Struct.new(
2750
+ :metric_set_arn,
2751
+ :metric_set_description,
2752
+ :metric_list,
2753
+ :offset,
2754
+ :timestamp_column,
2755
+ :dimension_list,
2756
+ :metric_set_frequency,
2757
+ :metric_source)
2758
+ SENSITIVE = []
2759
+ include Aws::Structure
2760
+ end
2761
+
2762
+ # @!attribute [rw] metric_set_arn
2763
+ # The ARN of the dataset.
2764
+ # @return [String]
2765
+ #
2766
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/UpdateMetricSetResponse AWS API Documentation
2767
+ #
2768
+ class UpdateMetricSetResponse < Struct.new(
2769
+ :metric_set_arn)
2770
+ SENSITIVE = []
2771
+ include Aws::Structure
2772
+ end
2773
+
2774
+ # The input fails to satisfy the constraints specified by the AWS
2775
+ # service. Check your input values and try again.
2776
+ #
2777
+ # @!attribute [rw] message
2778
+ # @return [String]
2779
+ #
2780
+ # @!attribute [rw] reason
2781
+ # The reason that validation failed.
2782
+ # @return [String]
2783
+ #
2784
+ # @!attribute [rw] fields
2785
+ # Fields that failed validation.
2786
+ # @return [Array<Types::ValidationExceptionField>]
2787
+ #
2788
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ValidationException AWS API Documentation
2789
+ #
2790
+ class ValidationException < Struct.new(
2791
+ :message,
2792
+ :reason,
2793
+ :fields)
2794
+ SENSITIVE = []
2795
+ include Aws::Structure
2796
+ end
2797
+
2798
+ # Contains information about a a field in a validation exception.
2799
+ #
2800
+ # @!attribute [rw] name
2801
+ # The name of the field.
2802
+ # @return [String]
2803
+ #
2804
+ # @!attribute [rw] message
2805
+ # The message with more information about the validation exception.
2806
+ # @return [String]
2807
+ #
2808
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/ValidationExceptionField AWS API Documentation
2809
+ #
2810
+ class ValidationExceptionField < Struct.new(
2811
+ :name,
2812
+ :message)
2813
+ SENSITIVE = []
2814
+ include Aws::Structure
2815
+ end
2816
+
2817
+ # Contains configuration information about the Amazon Virtual Private
2818
+ # Cloud (VPC).
2819
+ #
2820
+ # @note When making an API call, you may pass VpcConfiguration
2821
+ # data as a hash:
2822
+ #
2823
+ # {
2824
+ # subnet_id_list: ["SubnetId"], # required
2825
+ # security_group_id_list: ["SecurityGroupId"], # required
2826
+ # }
2827
+ #
2828
+ # @!attribute [rw] subnet_id_list
2829
+ # An array of strings containing the Amazon VPC subnet IDs (e.g.,
2830
+ # `subnet-0bb1c79de3EXAMPLE`.
2831
+ # @return [Array<String>]
2832
+ #
2833
+ # @!attribute [rw] security_group_id_list
2834
+ # An array of strings containing the list of security groups.
2835
+ # @return [Array<String>]
2836
+ #
2837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25/VpcConfiguration AWS API Documentation
2838
+ #
2839
+ class VpcConfiguration < Struct.new(
2840
+ :subnet_id_list,
2841
+ :security_group_id_list)
2842
+ SENSITIVE = []
2843
+ include Aws::Structure
2844
+ end
2845
+
2846
+ end
2847
+ end