aws-sdk-cloudwatch 1.139.0 → 1.141.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-cloudwatch/alarm.rb +3 -3
- data/lib/aws-sdk-cloudwatch/client.rb +491 -15
- data/lib/aws-sdk-cloudwatch/client_api.rb +164 -0
- data/lib/aws-sdk-cloudwatch/composite_alarm.rb +3 -3
- data/lib/aws-sdk-cloudwatch/errors.rb +64 -0
- data/lib/aws-sdk-cloudwatch/resource.rb +18 -12
- data/lib/aws-sdk-cloudwatch/types.rb +600 -10
- data/lib/aws-sdk-cloudwatch/waiters.rb +37 -0
- data/lib/aws-sdk-cloudwatch.rb +2 -2
- data/sig/alarm.rbs +1 -1
- data/sig/client.rbs +90 -4
- data/sig/composite_alarm.rbs +1 -1
- data/sig/errors.rbs +12 -0
- data/sig/resource.rbs +2 -2
- data/sig/types.rbs +116 -3
- data/sig/waiters.rbs +20 -2
- metadata +1 -1
|
@@ -265,6 +265,44 @@ module Aws::CloudWatch
|
|
|
265
265
|
include Aws::Structure
|
|
266
266
|
end
|
|
267
267
|
|
|
268
|
+
# @!attribute [rw] dataset_identifier
|
|
269
|
+
# Specifies the identifier of the dataset that you want to associate
|
|
270
|
+
# the KMS key with. For the `default` dataset, you can specify either
|
|
271
|
+
# `default` or the full dataset Amazon Resource Name (ARN) in the
|
|
272
|
+
# format `arn:aws:cloudwatch:Region:account-id:dataset/default`.
|
|
273
|
+
# @return [String]
|
|
274
|
+
#
|
|
275
|
+
# @!attribute [rw] kms_key_arn
|
|
276
|
+
# Specifies the Amazon Resource Name (ARN) of the customer managed KMS
|
|
277
|
+
# key to associate with the dataset. The key must be a symmetric
|
|
278
|
+
# encryption KMS key (`SYMMETRIC_DEFAULT`) in the same Amazon Web
|
|
279
|
+
# Services Region as the dataset.
|
|
280
|
+
#
|
|
281
|
+
# The ARN must be in the format
|
|
282
|
+
# `arn:aws:kms:Region:account-id:key/key-id `. Key IDs, aliases, and
|
|
283
|
+
# alias ARNs are not accepted.
|
|
284
|
+
#
|
|
285
|
+
# For more information about KMS key ARNs, see [Key ARN][1] in the
|
|
286
|
+
# *Amazon Web Services Key Management Service Developer Guide*.
|
|
287
|
+
#
|
|
288
|
+
#
|
|
289
|
+
#
|
|
290
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN
|
|
291
|
+
# @return [String]
|
|
292
|
+
#
|
|
293
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/AssociateDatasetKmsKeyInput AWS API Documentation
|
|
294
|
+
#
|
|
295
|
+
class AssociateDatasetKmsKeyInput < Struct.new(
|
|
296
|
+
:dataset_identifier,
|
|
297
|
+
:kms_key_arn)
|
|
298
|
+
SENSITIVE = []
|
|
299
|
+
include Aws::Structure
|
|
300
|
+
end
|
|
301
|
+
|
|
302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/AssociateDatasetKmsKeyOutput AWS API Documentation
|
|
303
|
+
#
|
|
304
|
+
class AssociateDatasetKmsKeyOutput < Aws::EmptyStructure; end
|
|
305
|
+
|
|
268
306
|
# The details about a composite alarm.
|
|
269
307
|
#
|
|
270
308
|
# @!attribute [rw] actions_enabled
|
|
@@ -761,8 +799,8 @@ module Aws::CloudWatch
|
|
|
761
799
|
#
|
|
762
800
|
# @!attribute [rw] alarm_types
|
|
763
801
|
# Use this parameter to specify whether you want the operation to
|
|
764
|
-
# return metric alarms or
|
|
765
|
-
# parameter, only metric alarms are returned.
|
|
802
|
+
# return metric alarms, composite alarms, or log alarms. If you omit
|
|
803
|
+
# this parameter, only metric alarms are returned.
|
|
766
804
|
# @return [Array<String>]
|
|
767
805
|
#
|
|
768
806
|
# @!attribute [rw] history_item_type
|
|
@@ -899,17 +937,21 @@ module Aws::CloudWatch
|
|
|
899
937
|
#
|
|
900
938
|
# @!attribute [rw] alarm_types
|
|
901
939
|
# Use this parameter to specify whether you want the operation to
|
|
902
|
-
# return metric alarms or
|
|
903
|
-
# parameter, only metric alarms are returned, even if composite
|
|
904
|
-
# exist in the account.
|
|
940
|
+
# return metric alarms, composite alarms, or log alarms. If you omit
|
|
941
|
+
# this parameter, only metric alarms are returned, even if composite
|
|
942
|
+
# alarms or log alarms exist in the account.
|
|
905
943
|
#
|
|
906
944
|
# For example, if you omit this parameter or specify `MetricAlarms`,
|
|
907
945
|
# the operation returns only a list of metric alarms. It does not
|
|
908
|
-
# return any composite alarms, even if
|
|
946
|
+
# return any composite alarms or log alarms, even if they exist in the
|
|
909
947
|
# account.
|
|
910
948
|
#
|
|
911
949
|
# If you specify `CompositeAlarms`, the operation returns only a list
|
|
912
|
-
# of composite alarms, and does not return any metric alarms
|
|
950
|
+
# of composite alarms, and does not return any metric alarms or log
|
|
951
|
+
# alarms.
|
|
952
|
+
#
|
|
953
|
+
# If you specify `LogAlarms`, the operation returns only a list of log
|
|
954
|
+
# alarms, and does not return any metric alarms or composite alarms.
|
|
913
955
|
# @return [Array<String>]
|
|
914
956
|
#
|
|
915
957
|
# @!attribute [rw] children_of_alarm_name
|
|
@@ -1001,6 +1043,10 @@ module Aws::CloudWatch
|
|
|
1001
1043
|
# The information about any metric alarms returned by the operation.
|
|
1002
1044
|
# @return [Array<Types::MetricAlarm>]
|
|
1003
1045
|
#
|
|
1046
|
+
# @!attribute [rw] log_alarms
|
|
1047
|
+
# The information about any log alarms returned by the operation.
|
|
1048
|
+
# @return [Array<Types::LogAlarm>]
|
|
1049
|
+
#
|
|
1004
1050
|
# @!attribute [rw] next_token
|
|
1005
1051
|
# The token that marks the start of the next batch of returned
|
|
1006
1052
|
# results.
|
|
@@ -1011,6 +1057,7 @@ module Aws::CloudWatch
|
|
|
1011
1057
|
class DescribeAlarmsOutput < Struct.new(
|
|
1012
1058
|
:composite_alarms,
|
|
1013
1059
|
:metric_alarms,
|
|
1060
|
+
:log_alarms,
|
|
1014
1061
|
:next_token)
|
|
1015
1062
|
SENSITIVE = []
|
|
1016
1063
|
include Aws::Structure
|
|
@@ -1215,6 +1262,25 @@ module Aws::CloudWatch
|
|
|
1215
1262
|
include Aws::Structure
|
|
1216
1263
|
end
|
|
1217
1264
|
|
|
1265
|
+
# @!attribute [rw] dataset_identifier
|
|
1266
|
+
# Specifies the identifier of the dataset from which to remove the KMS
|
|
1267
|
+
# key association. For the `default` dataset, you can specify either
|
|
1268
|
+
# `default` or the full dataset Amazon Resource Name (ARN) in the
|
|
1269
|
+
# format `arn:aws:cloudwatch:Region:account-id:dataset/default`.
|
|
1270
|
+
# @return [String]
|
|
1271
|
+
#
|
|
1272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisassociateDatasetKmsKeyInput AWS API Documentation
|
|
1273
|
+
#
|
|
1274
|
+
class DisassociateDatasetKmsKeyInput < Struct.new(
|
|
1275
|
+
:dataset_identifier)
|
|
1276
|
+
SENSITIVE = []
|
|
1277
|
+
include Aws::Structure
|
|
1278
|
+
end
|
|
1279
|
+
|
|
1280
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DisassociateDatasetKmsKeyOutput AWS API Documentation
|
|
1281
|
+
#
|
|
1282
|
+
class DisassociateDatasetKmsKeyOutput < Aws::EmptyStructure; end
|
|
1283
|
+
|
|
1218
1284
|
# @!attribute [rw] alarm_names
|
|
1219
1285
|
# The names of the alarms.
|
|
1220
1286
|
# @return [Array<String>]
|
|
@@ -1445,7 +1511,7 @@ module Aws::CloudWatch
|
|
|
1445
1511
|
#
|
|
1446
1512
|
#
|
|
1447
1513
|
#
|
|
1448
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/
|
|
1514
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Dashboard-Body-Structure.html
|
|
1449
1515
|
# @return [String]
|
|
1450
1516
|
#
|
|
1451
1517
|
# @!attribute [rw] dashboard_name
|
|
@@ -1462,6 +1528,48 @@ module Aws::CloudWatch
|
|
|
1462
1528
|
include Aws::Structure
|
|
1463
1529
|
end
|
|
1464
1530
|
|
|
1531
|
+
# @!attribute [rw] dataset_identifier
|
|
1532
|
+
# Specifies the identifier of the dataset to retrieve. For the
|
|
1533
|
+
# `default` dataset, you can specify either `default` or the full
|
|
1534
|
+
# dataset Amazon Resource Name (ARN) in the format
|
|
1535
|
+
# `arn:aws:cloudwatch:Region:account-id:dataset/default`.
|
|
1536
|
+
# @return [String]
|
|
1537
|
+
#
|
|
1538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetDatasetInput AWS API Documentation
|
|
1539
|
+
#
|
|
1540
|
+
class GetDatasetInput < Struct.new(
|
|
1541
|
+
:dataset_identifier)
|
|
1542
|
+
SENSITIVE = []
|
|
1543
|
+
include Aws::Structure
|
|
1544
|
+
end
|
|
1545
|
+
|
|
1546
|
+
# @!attribute [rw] dataset_id
|
|
1547
|
+
# Returns the identifier of the dataset.
|
|
1548
|
+
# @return [String]
|
|
1549
|
+
#
|
|
1550
|
+
# @!attribute [rw] arn
|
|
1551
|
+
# Returns the Amazon Resource Name (ARN) of the dataset, in the format
|
|
1552
|
+
# `arn:aws:cloudwatch:Region:account-id:dataset/dataset-id `.
|
|
1553
|
+
# @return [String]
|
|
1554
|
+
#
|
|
1555
|
+
# @!attribute [rw] kms_key_arn
|
|
1556
|
+
# Returns the Amazon Resource Name (ARN) of the customer managed
|
|
1557
|
+
# Amazon Web Services KMS key that is currently associated with the
|
|
1558
|
+
# dataset, if any. If the dataset is not associated with a customer
|
|
1559
|
+
# managed KMS key, this field is not included in the response and the
|
|
1560
|
+
# dataset is encrypted at rest using an Amazon Web Services owned key.
|
|
1561
|
+
# @return [String]
|
|
1562
|
+
#
|
|
1563
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetDatasetOutput AWS API Documentation
|
|
1564
|
+
#
|
|
1565
|
+
class GetDatasetOutput < Struct.new(
|
|
1566
|
+
:dataset_id,
|
|
1567
|
+
:arn,
|
|
1568
|
+
:kms_key_arn)
|
|
1569
|
+
SENSITIVE = []
|
|
1570
|
+
include Aws::Structure
|
|
1571
|
+
end
|
|
1572
|
+
|
|
1465
1573
|
# @!attribute [rw] rule_name
|
|
1466
1574
|
# The name of the rule that you want to see data from.
|
|
1467
1575
|
# @return [String]
|
|
@@ -1981,7 +2089,7 @@ module Aws::CloudWatch
|
|
|
1981
2089
|
#
|
|
1982
2090
|
#
|
|
1983
2091
|
#
|
|
1984
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/
|
|
2092
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Widget-Structure.html
|
|
1985
2093
|
# @return [String]
|
|
1986
2094
|
#
|
|
1987
2095
|
# @!attribute [rw] output_format
|
|
@@ -2341,6 +2449,61 @@ module Aws::CloudWatch
|
|
|
2341
2449
|
include Aws::Structure
|
|
2342
2450
|
end
|
|
2343
2451
|
|
|
2452
|
+
# The operation was denied because either the calling principal lacks
|
|
2453
|
+
# the required Amazon Web Services Key Management Service (Amazon Web
|
|
2454
|
+
# Services KMS) permission on the key, or the key policy does not grant
|
|
2455
|
+
# Amazon CloudWatch the permissions it needs to use the key. Verify that
|
|
2456
|
+
# the caller has `kms:Decrypt` permission on the key, and that the key
|
|
2457
|
+
# policy grants the CloudWatch service principal the `kms:DescribeKey`,
|
|
2458
|
+
# `kms:GenerateDataKey`, `kms:Encrypt`, `kms:Decrypt`, and
|
|
2459
|
+
# `kms:ReEncrypt*` permissions described in [AssociateDatasetKmsKey][1].
|
|
2460
|
+
#
|
|
2461
|
+
#
|
|
2462
|
+
#
|
|
2463
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_AssociateDatasetKmsKey.html
|
|
2464
|
+
#
|
|
2465
|
+
# @!attribute [rw] message
|
|
2466
|
+
# @return [String]
|
|
2467
|
+
#
|
|
2468
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/KmsAccessDeniedException AWS API Documentation
|
|
2469
|
+
#
|
|
2470
|
+
class KmsAccessDeniedException < Struct.new(
|
|
2471
|
+
:message)
|
|
2472
|
+
SENSITIVE = []
|
|
2473
|
+
include Aws::Structure
|
|
2474
|
+
end
|
|
2475
|
+
|
|
2476
|
+
# The specified Amazon Web Services Key Management Service (Amazon Web
|
|
2477
|
+
# Services KMS) key is disabled or pending deletion. Re-enable the key
|
|
2478
|
+
# (or restore it, if it is pending deletion) and retry the operation.
|
|
2479
|
+
#
|
|
2480
|
+
# @!attribute [rw] message
|
|
2481
|
+
# @return [String]
|
|
2482
|
+
#
|
|
2483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/KmsKeyDisabledException AWS API Documentation
|
|
2484
|
+
#
|
|
2485
|
+
class KmsKeyDisabledException < Struct.new(
|
|
2486
|
+
:message)
|
|
2487
|
+
SENSITIVE = []
|
|
2488
|
+
include Aws::Structure
|
|
2489
|
+
end
|
|
2490
|
+
|
|
2491
|
+
# The specified Amazon Web Services Key Management Service (Amazon Web
|
|
2492
|
+
# Services KMS) key could not be found. Verify that the key Amazon
|
|
2493
|
+
# Resource Name (ARN) is correct, that the key exists, and that it is in
|
|
2494
|
+
# the same Amazon Web Services Region as the resource.
|
|
2495
|
+
#
|
|
2496
|
+
# @!attribute [rw] message
|
|
2497
|
+
# @return [String]
|
|
2498
|
+
#
|
|
2499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/KmsKeyNotFoundException AWS API Documentation
|
|
2500
|
+
#
|
|
2501
|
+
class KmsKeyNotFoundException < Struct.new(
|
|
2502
|
+
:message)
|
|
2503
|
+
SENSITIVE = []
|
|
2504
|
+
include Aws::Structure
|
|
2505
|
+
end
|
|
2506
|
+
|
|
2344
2507
|
# This structure includes the `Timezone` parameter, which you can use to
|
|
2345
2508
|
# specify your time zone so that the labels that are associated with
|
|
2346
2509
|
# returned metrics display the correct time for your time zone.
|
|
@@ -2695,6 +2858,159 @@ module Aws::CloudWatch
|
|
|
2695
2858
|
include Aws::Structure
|
|
2696
2859
|
end
|
|
2697
2860
|
|
|
2861
|
+
# The details about a log alarm.
|
|
2862
|
+
#
|
|
2863
|
+
# @!attribute [rw] alarm_name
|
|
2864
|
+
# The name of the alarm.
|
|
2865
|
+
# @return [String]
|
|
2866
|
+
#
|
|
2867
|
+
# @!attribute [rw] alarm_arn
|
|
2868
|
+
# The Amazon Resource Name (ARN) of the alarm.
|
|
2869
|
+
# @return [String]
|
|
2870
|
+
#
|
|
2871
|
+
# @!attribute [rw] alarm_description
|
|
2872
|
+
# The description of the alarm.
|
|
2873
|
+
# @return [String]
|
|
2874
|
+
#
|
|
2875
|
+
# @!attribute [rw] alarm_configuration_updated_timestamp
|
|
2876
|
+
# The time stamp of the last update to the alarm configuration.
|
|
2877
|
+
# @return [Time]
|
|
2878
|
+
#
|
|
2879
|
+
# @!attribute [rw] actions_enabled
|
|
2880
|
+
# Indicates whether actions should be executed during any changes to
|
|
2881
|
+
# the alarm state.
|
|
2882
|
+
# @return [Boolean]
|
|
2883
|
+
#
|
|
2884
|
+
# @!attribute [rw] ok_actions
|
|
2885
|
+
# The actions to execute when this alarm transitions to the `OK` state
|
|
2886
|
+
# from any other state. Each action is specified as an Amazon Resource
|
|
2887
|
+
# Name (ARN).
|
|
2888
|
+
# @return [Array<String>]
|
|
2889
|
+
#
|
|
2890
|
+
# @!attribute [rw] alarm_actions
|
|
2891
|
+
# The actions to execute when this alarm transitions to the `ALARM`
|
|
2892
|
+
# state from any other state. Each action is specified as an Amazon
|
|
2893
|
+
# Resource Name (ARN).
|
|
2894
|
+
# @return [Array<String>]
|
|
2895
|
+
#
|
|
2896
|
+
# @!attribute [rw] insufficient_data_actions
|
|
2897
|
+
# The actions to execute when this alarm transitions to the
|
|
2898
|
+
# `INSUFFICIENT_DATA` state from any other state. Each action is
|
|
2899
|
+
# specified as an Amazon Resource Name (ARN).
|
|
2900
|
+
# @return [Array<String>]
|
|
2901
|
+
#
|
|
2902
|
+
# @!attribute [rw] state_value
|
|
2903
|
+
# The state value for the alarm.
|
|
2904
|
+
# @return [String]
|
|
2905
|
+
#
|
|
2906
|
+
# @!attribute [rw] state_reason
|
|
2907
|
+
# An explanation for the alarm state, in text format.
|
|
2908
|
+
# @return [String]
|
|
2909
|
+
#
|
|
2910
|
+
# @!attribute [rw] state_reason_data
|
|
2911
|
+
# An explanation for the alarm state, in JSON format.
|
|
2912
|
+
# @return [String]
|
|
2913
|
+
#
|
|
2914
|
+
# @!attribute [rw] state_updated_timestamp
|
|
2915
|
+
# The time stamp of the last update to the value of either the
|
|
2916
|
+
# `StateValue` or `EvaluationState` parameters.
|
|
2917
|
+
# @return [Time]
|
|
2918
|
+
#
|
|
2919
|
+
# @!attribute [rw] scheduled_query_configuration
|
|
2920
|
+
# The configuration of the underlying CloudWatch Logs scheduled query,
|
|
2921
|
+
# including the query string, log groups, schedule, aggregation
|
|
2922
|
+
# expression, and the ARN of the managed scheduled query.
|
|
2923
|
+
# @return [Types::ScheduledQueryConfiguration]
|
|
2924
|
+
#
|
|
2925
|
+
# @!attribute [rw] query_results_to_evaluate
|
|
2926
|
+
# The number of most recent scheduled query results that the alarm
|
|
2927
|
+
# evaluates against the threshold (the N in M-of-N evaluation).
|
|
2928
|
+
# @return [Integer]
|
|
2929
|
+
#
|
|
2930
|
+
# @!attribute [rw] query_results_to_alarm
|
|
2931
|
+
# The number of query results, out of the most recent
|
|
2932
|
+
# `QueryResultsToEvaluate` results, that must breach the threshold to
|
|
2933
|
+
# trigger the alarm to transition to `ALARM` (the M in M-of-N
|
|
2934
|
+
# evaluation).
|
|
2935
|
+
# @return [Integer]
|
|
2936
|
+
#
|
|
2937
|
+
# @!attribute [rw] threshold
|
|
2938
|
+
# The value to compare with the aggregated query result.
|
|
2939
|
+
# @return [Float]
|
|
2940
|
+
#
|
|
2941
|
+
# @!attribute [rw] comparison_operator
|
|
2942
|
+
# The arithmetic operation to use when comparing the aggregated query
|
|
2943
|
+
# result and the threshold. The aggregated query result is used as the
|
|
2944
|
+
# first operand.
|
|
2945
|
+
# @return [String]
|
|
2946
|
+
#
|
|
2947
|
+
# @!attribute [rw] treat_missing_data
|
|
2948
|
+
# How this alarm handles missing data points. Valid values are
|
|
2949
|
+
# `breaching`, `notBreaching`, `ignore`, and `missing`.
|
|
2950
|
+
# @return [String]
|
|
2951
|
+
#
|
|
2952
|
+
# @!attribute [rw] state_transitioned_timestamp
|
|
2953
|
+
# The date and time that the alarm's `StateValue` most recently
|
|
2954
|
+
# changed.
|
|
2955
|
+
# @return [Time]
|
|
2956
|
+
#
|
|
2957
|
+
# @!attribute [rw] evaluation_state
|
|
2958
|
+
# If the value of this field is `EVALUATION_ERROR`, it indicates
|
|
2959
|
+
# configuration errors in the alarm setup that require review and
|
|
2960
|
+
# correction. Refer to the `StateReason` field of the alarm for more
|
|
2961
|
+
# details.
|
|
2962
|
+
#
|
|
2963
|
+
# If the value of this field is `EVALUATION_FAILURE`, it indicates
|
|
2964
|
+
# temporary CloudWatch issues. We recommend manual monitoring until
|
|
2965
|
+
# the issue is resolved.
|
|
2966
|
+
#
|
|
2967
|
+
# If the value of this field is `PARTIAL_DATA`, it indicates that the
|
|
2968
|
+
# query returned the maximum 500 contributor groups but more matched.
|
|
2969
|
+
# The alarm evaluates the available contributors, but results might be
|
|
2970
|
+
# incomplete.
|
|
2971
|
+
# @return [String]
|
|
2972
|
+
#
|
|
2973
|
+
# @!attribute [rw] action_log_line_count
|
|
2974
|
+
# The number of log lines from the most recent scheduled query
|
|
2975
|
+
# execution that are included in alarm action notifications. Valid
|
|
2976
|
+
# range is 0 through 50. A value of 0 means no log lines are included.
|
|
2977
|
+
# @return [Integer]
|
|
2978
|
+
#
|
|
2979
|
+
# @!attribute [rw] action_log_line_role_arn
|
|
2980
|
+
# The Amazon Resource Name (ARN) of the IAM role that CloudWatch
|
|
2981
|
+
# assumes to retrieve log events for inclusion in alarm action
|
|
2982
|
+
# notifications. Set when `ActionLogLineCount` is greater than 0.
|
|
2983
|
+
# @return [String]
|
|
2984
|
+
#
|
|
2985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/LogAlarm AWS API Documentation
|
|
2986
|
+
#
|
|
2987
|
+
class LogAlarm < Struct.new(
|
|
2988
|
+
:alarm_name,
|
|
2989
|
+
:alarm_arn,
|
|
2990
|
+
:alarm_description,
|
|
2991
|
+
:alarm_configuration_updated_timestamp,
|
|
2992
|
+
:actions_enabled,
|
|
2993
|
+
:ok_actions,
|
|
2994
|
+
:alarm_actions,
|
|
2995
|
+
:insufficient_data_actions,
|
|
2996
|
+
:state_value,
|
|
2997
|
+
:state_reason,
|
|
2998
|
+
:state_reason_data,
|
|
2999
|
+
:state_updated_timestamp,
|
|
3000
|
+
:scheduled_query_configuration,
|
|
3001
|
+
:query_results_to_evaluate,
|
|
3002
|
+
:query_results_to_alarm,
|
|
3003
|
+
:threshold,
|
|
3004
|
+
:comparison_operator,
|
|
3005
|
+
:treat_missing_data,
|
|
3006
|
+
:state_transitioned_timestamp,
|
|
3007
|
+
:evaluation_state,
|
|
3008
|
+
:action_log_line_count,
|
|
3009
|
+
:action_log_line_role_arn)
|
|
3010
|
+
SENSITIVE = []
|
|
3011
|
+
include Aws::Structure
|
|
3012
|
+
end
|
|
3013
|
+
|
|
2698
3014
|
# Contains the information that's required to enable a managed
|
|
2699
3015
|
# Contributor Insights rule for an Amazon Web Services resource.
|
|
2700
3016
|
#
|
|
@@ -4052,7 +4368,7 @@ module Aws::CloudWatch
|
|
|
4052
4368
|
#
|
|
4053
4369
|
#
|
|
4054
4370
|
#
|
|
4055
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/
|
|
4371
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Dashboard-Body-Structure.html
|
|
4056
4372
|
# @return [String]
|
|
4057
4373
|
#
|
|
4058
4374
|
# @!attribute [rw] tags
|
|
@@ -4183,6 +4499,175 @@ module Aws::CloudWatch
|
|
|
4183
4499
|
#
|
|
4184
4500
|
class PutInsightRuleOutput < Aws::EmptyStructure; end
|
|
4185
4501
|
|
|
4502
|
+
# @!attribute [rw] alarm_name
|
|
4503
|
+
# The name for the alarm. This name must be unique within the Amazon
|
|
4504
|
+
# Web Services account and Region.
|
|
4505
|
+
# @return [String]
|
|
4506
|
+
#
|
|
4507
|
+
# @!attribute [rw] alarm_description
|
|
4508
|
+
# The description for the alarm.
|
|
4509
|
+
# @return [String]
|
|
4510
|
+
#
|
|
4511
|
+
# @!attribute [rw] scheduled_query_configuration
|
|
4512
|
+
# The configuration of the underlying CloudWatch Logs scheduled query
|
|
4513
|
+
# that this alarm evaluates, including the query string, log groups,
|
|
4514
|
+
# schedule, and aggregation expression.
|
|
4515
|
+
# @return [Types::ScheduledQueryConfiguration]
|
|
4516
|
+
#
|
|
4517
|
+
# @!attribute [rw] action_log_line_count
|
|
4518
|
+
# The number of log lines from the most recent scheduled query
|
|
4519
|
+
# execution to include in alarm action notifications. Valid range is 0
|
|
4520
|
+
# through 50. The default is 0, which means no log lines are included.
|
|
4521
|
+
# @return [Integer]
|
|
4522
|
+
#
|
|
4523
|
+
# @!attribute [rw] action_log_line_role_arn
|
|
4524
|
+
# The Amazon Resource Name (ARN) of an IAM role that CloudWatch
|
|
4525
|
+
# assumes to retrieve log events for inclusion in alarm action
|
|
4526
|
+
# notifications. Required when `ActionLogLineCount` is greater than 0.
|
|
4527
|
+
# @return [String]
|
|
4528
|
+
#
|
|
4529
|
+
# @!attribute [rw] actions_enabled
|
|
4530
|
+
# Indicates whether actions should be executed during any changes to
|
|
4531
|
+
# the alarm state. The default is `true`.
|
|
4532
|
+
# @return [Boolean]
|
|
4533
|
+
#
|
|
4534
|
+
# @!attribute [rw] ok_actions
|
|
4535
|
+
# The actions to execute when this alarm transitions to the `OK` state
|
|
4536
|
+
# from any other state. Each action is specified as an Amazon Resource
|
|
4537
|
+
# Name (ARN).
|
|
4538
|
+
#
|
|
4539
|
+
# Valid Values:
|
|
4540
|
+
#
|
|
4541
|
+
# **Amazon SNS actions:**
|
|
4542
|
+
#
|
|
4543
|
+
# `arn:aws:sns:region:account-id:sns-topic-name `
|
|
4544
|
+
#
|
|
4545
|
+
# **Lambda actions:**
|
|
4546
|
+
#
|
|
4547
|
+
# * Invoke the latest version of a Lambda function:
|
|
4548
|
+
# `arn:aws:lambda:region:account-id:function:function-name `
|
|
4549
|
+
#
|
|
4550
|
+
# * Invoke a specific version of a Lambda function:
|
|
4551
|
+
# `arn:aws:lambda:region:account-id:function:function-name:version-number
|
|
4552
|
+
# `
|
|
4553
|
+
#
|
|
4554
|
+
# * Invoke a function by using an alias Lambda function:
|
|
4555
|
+
# `arn:aws:lambda:region:account-id:function:function-name:alias-name
|
|
4556
|
+
# `
|
|
4557
|
+
# @return [Array<String>]
|
|
4558
|
+
#
|
|
4559
|
+
# @!attribute [rw] alarm_actions
|
|
4560
|
+
# The actions to execute when this alarm transitions to the `ALARM`
|
|
4561
|
+
# state from any other state. Each action is specified as an Amazon
|
|
4562
|
+
# Resource Name (ARN).
|
|
4563
|
+
#
|
|
4564
|
+
# Valid Values:
|
|
4565
|
+
#
|
|
4566
|
+
# **Amazon SNS actions:**
|
|
4567
|
+
#
|
|
4568
|
+
# `arn:aws:sns:region:account-id:sns-topic-name `
|
|
4569
|
+
#
|
|
4570
|
+
# **Lambda actions:**
|
|
4571
|
+
#
|
|
4572
|
+
# * Invoke the latest version of a Lambda function:
|
|
4573
|
+
# `arn:aws:lambda:region:account-id:function:function-name `
|
|
4574
|
+
#
|
|
4575
|
+
# * Invoke a specific version of a Lambda function:
|
|
4576
|
+
# `arn:aws:lambda:region:account-id:function:function-name:version-number
|
|
4577
|
+
# `
|
|
4578
|
+
#
|
|
4579
|
+
# * Invoke a function by using an alias Lambda function:
|
|
4580
|
+
# `arn:aws:lambda:region:account-id:function:function-name:alias-name
|
|
4581
|
+
# `
|
|
4582
|
+
#
|
|
4583
|
+
# **Systems Manager actions:**
|
|
4584
|
+
#
|
|
4585
|
+
# `arn:aws:ssm:region:account-id:opsitem:severity `
|
|
4586
|
+
# @return [Array<String>]
|
|
4587
|
+
#
|
|
4588
|
+
# @!attribute [rw] insufficient_data_actions
|
|
4589
|
+
# The actions to execute when this alarm transitions to the
|
|
4590
|
+
# `INSUFFICIENT_DATA` state from any other state. Each action is
|
|
4591
|
+
# specified as an Amazon Resource Name (ARN).
|
|
4592
|
+
#
|
|
4593
|
+
# Valid Values:
|
|
4594
|
+
#
|
|
4595
|
+
# **Amazon SNS actions:**
|
|
4596
|
+
#
|
|
4597
|
+
# `arn:aws:sns:region:account-id:sns-topic-name `
|
|
4598
|
+
#
|
|
4599
|
+
# **Lambda actions:**
|
|
4600
|
+
#
|
|
4601
|
+
# * Invoke the latest version of a Lambda function:
|
|
4602
|
+
# `arn:aws:lambda:region:account-id:function:function-name `
|
|
4603
|
+
#
|
|
4604
|
+
# * Invoke a specific version of a Lambda function:
|
|
4605
|
+
# `arn:aws:lambda:region:account-id:function:function-name:version-number
|
|
4606
|
+
# `
|
|
4607
|
+
#
|
|
4608
|
+
# * Invoke a function by using an alias Lambda function:
|
|
4609
|
+
# `arn:aws:lambda:region:account-id:function:function-name:alias-name
|
|
4610
|
+
# `
|
|
4611
|
+
# @return [Array<String>]
|
|
4612
|
+
#
|
|
4613
|
+
# @!attribute [rw] query_results_to_evaluate
|
|
4614
|
+
# The number of most recent scheduled query results to evaluate
|
|
4615
|
+
# against the threshold (the N in M-of-N evaluation). Valid range is 1
|
|
4616
|
+
# through 100.
|
|
4617
|
+
# @return [Integer]
|
|
4618
|
+
#
|
|
4619
|
+
# @!attribute [rw] query_results_to_alarm
|
|
4620
|
+
# The number of query results, out of the most recent
|
|
4621
|
+
# `QueryResultsToEvaluate` results, that must breach the threshold to
|
|
4622
|
+
# trigger the alarm to transition to `ALARM` (the M in M-of-N
|
|
4623
|
+
# evaluation). Must be less than or equal to `QueryResultsToEvaluate`.
|
|
4624
|
+
# @return [Integer]
|
|
4625
|
+
#
|
|
4626
|
+
# @!attribute [rw] threshold
|
|
4627
|
+
# The value to compare with the aggregated query result.
|
|
4628
|
+
# @return [Float]
|
|
4629
|
+
#
|
|
4630
|
+
# @!attribute [rw] comparison_operator
|
|
4631
|
+
# The arithmetic operation to use when comparing the aggregated query
|
|
4632
|
+
# result and the threshold. The aggregated query result is used as the
|
|
4633
|
+
# first operand. Valid values are `GreaterThanThreshold`,
|
|
4634
|
+
# `GreaterThanOrEqualToThreshold`, `LessThanThreshold`, and
|
|
4635
|
+
# `LessThanOrEqualToThreshold`.
|
|
4636
|
+
# @return [String]
|
|
4637
|
+
#
|
|
4638
|
+
# @!attribute [rw] treat_missing_data
|
|
4639
|
+
# Sets how this alarm is to handle missing data points. Valid values
|
|
4640
|
+
# are `breaching`, `notBreaching`, `ignore`, and `missing`. If this
|
|
4641
|
+
# parameter is omitted, the default behavior of `missing` is used.
|
|
4642
|
+
# @return [String]
|
|
4643
|
+
#
|
|
4644
|
+
# @!attribute [rw] tags
|
|
4645
|
+
# A list of key-value pairs to associate with the alarm. You can use
|
|
4646
|
+
# tags to categorize and manage your alarms.
|
|
4647
|
+
# @return [Array<Types::Tag>]
|
|
4648
|
+
#
|
|
4649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutLogAlarmInput AWS API Documentation
|
|
4650
|
+
#
|
|
4651
|
+
class PutLogAlarmInput < Struct.new(
|
|
4652
|
+
:alarm_name,
|
|
4653
|
+
:alarm_description,
|
|
4654
|
+
:scheduled_query_configuration,
|
|
4655
|
+
:action_log_line_count,
|
|
4656
|
+
:action_log_line_role_arn,
|
|
4657
|
+
:actions_enabled,
|
|
4658
|
+
:ok_actions,
|
|
4659
|
+
:alarm_actions,
|
|
4660
|
+
:insufficient_data_actions,
|
|
4661
|
+
:query_results_to_evaluate,
|
|
4662
|
+
:query_results_to_alarm,
|
|
4663
|
+
:threshold,
|
|
4664
|
+
:comparison_operator,
|
|
4665
|
+
:treat_missing_data,
|
|
4666
|
+
:tags)
|
|
4667
|
+
SENSITIVE = []
|
|
4668
|
+
include Aws::Structure
|
|
4669
|
+
end
|
|
4670
|
+
|
|
4186
4671
|
# @!attribute [rw] managed_rules
|
|
4187
4672
|
# A list of `ManagedRules` to enable.
|
|
4188
4673
|
# @return [Array<Types::ManagedRule>]
|
|
@@ -4954,6 +5439,21 @@ module Aws::CloudWatch
|
|
|
4954
5439
|
include Aws::Structure
|
|
4955
5440
|
end
|
|
4956
5441
|
|
|
5442
|
+
# The operation could not be completed because the request conflicts
|
|
5443
|
+
# with the current state of the alarm or its underlying scheduled query
|
|
5444
|
+
# resource.
|
|
5445
|
+
#
|
|
5446
|
+
# @!attribute [rw] message
|
|
5447
|
+
# @return [String]
|
|
5448
|
+
#
|
|
5449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ResourceConflict AWS API Documentation
|
|
5450
|
+
#
|
|
5451
|
+
class ResourceConflict < Struct.new(
|
|
5452
|
+
:message)
|
|
5453
|
+
SENSITIVE = []
|
|
5454
|
+
include Aws::Structure
|
|
5455
|
+
end
|
|
5456
|
+
|
|
4957
5457
|
# The named resource does not exist.
|
|
4958
5458
|
#
|
|
4959
5459
|
# @!attribute [rw] message
|
|
@@ -5108,6 +5608,96 @@ module Aws::CloudWatch
|
|
|
5108
5608
|
include Aws::Structure
|
|
5109
5609
|
end
|
|
5110
5610
|
|
|
5611
|
+
# Contains the schedule expression and time-range offsets that define
|
|
5612
|
+
# when a scheduled query runs and what time range each execution covers.
|
|
5613
|
+
#
|
|
5614
|
+
# @!attribute [rw] schedule_expression
|
|
5615
|
+
# The schedule expression that defines how often the underlying
|
|
5616
|
+
# CloudWatch Logs scheduled query runs. Specify a `rate()` expression,
|
|
5617
|
+
# for example `rate(5 minutes)`.
|
|
5618
|
+
# @return [String]
|
|
5619
|
+
#
|
|
5620
|
+
# @!attribute [rw] start_time_offset
|
|
5621
|
+
# The offset, in seconds, before the scheduled execution time at which
|
|
5622
|
+
# the query time range begins. For example, an offset of 360 (6
|
|
5623
|
+
# minutes) on a query running at 12:05:00 starts the query time range
|
|
5624
|
+
# at 11:59:00.
|
|
5625
|
+
# @return [Integer]
|
|
5626
|
+
#
|
|
5627
|
+
# @!attribute [rw] end_time_offset
|
|
5628
|
+
# The offset, in seconds, before the scheduled execution time at which
|
|
5629
|
+
# the query time range ends. Must be non-negative and less than
|
|
5630
|
+
# `StartTimeOffset`. The default is 0.
|
|
5631
|
+
# @return [Integer]
|
|
5632
|
+
#
|
|
5633
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ScheduleConfiguration AWS API Documentation
|
|
5634
|
+
#
|
|
5635
|
+
class ScheduleConfiguration < Struct.new(
|
|
5636
|
+
:schedule_expression,
|
|
5637
|
+
:start_time_offset,
|
|
5638
|
+
:end_time_offset)
|
|
5639
|
+
SENSITIVE = []
|
|
5640
|
+
include Aws::Structure
|
|
5641
|
+
end
|
|
5642
|
+
|
|
5643
|
+
# The configuration of the CloudWatch Logs scheduled query that backs a
|
|
5644
|
+
# log alarm.
|
|
5645
|
+
#
|
|
5646
|
+
# @!attribute [rw] query_string
|
|
5647
|
+
# The CloudWatch Logs query to execute on each scheduled run. Length
|
|
5648
|
+
# constraints: maximum of 10,000 characters.
|
|
5649
|
+
# @return [String]
|
|
5650
|
+
#
|
|
5651
|
+
# @!attribute [rw] log_group_identifiers
|
|
5652
|
+
# The log groups to query. Each entry can be a log group name or ARN.
|
|
5653
|
+
# Use the ARN form when querying log groups in a different account
|
|
5654
|
+
# (for example, when running cross-account queries from a monitoring
|
|
5655
|
+
# account). The list must contain between 1 and 50 entries.
|
|
5656
|
+
# @return [Array<String>]
|
|
5657
|
+
#
|
|
5658
|
+
# @!attribute [rw] query_arn
|
|
5659
|
+
# The Amazon Resource Name (ARN) of the CloudWatch Logs scheduled
|
|
5660
|
+
# query that the alarm uses. This field is populated in
|
|
5661
|
+
# `DescribeAlarms` responses.
|
|
5662
|
+
# @return [String]
|
|
5663
|
+
#
|
|
5664
|
+
# @!attribute [rw] scheduled_query_role_arn
|
|
5665
|
+
# The Amazon Resource Name (ARN) of the IAM role that CloudWatch
|
|
5666
|
+
# assumes when executing the scheduled query against the configured
|
|
5667
|
+
# log groups.
|
|
5668
|
+
# @return [String]
|
|
5669
|
+
#
|
|
5670
|
+
# @!attribute [rw] schedule_configuration
|
|
5671
|
+
# The schedule and time-range offset configuration for the underlying
|
|
5672
|
+
# scheduled query.
|
|
5673
|
+
# @return [Types::ScheduleConfiguration]
|
|
5674
|
+
#
|
|
5675
|
+
# @!attribute [rw] aggregation_expression
|
|
5676
|
+
# The expression that defines how to aggregate query results into one
|
|
5677
|
+
# or more scalar values for alarm evaluation. For example, `count(*)`
|
|
5678
|
+
# or `avg(latency) by host | sort desc`. Length constraints: minimum 1
|
|
5679
|
+
# character, maximum 2048 characters.
|
|
5680
|
+
# @return [String]
|
|
5681
|
+
#
|
|
5682
|
+
# @!attribute [rw] tags
|
|
5683
|
+
# A list of key-value pairs to associate with the underlying scheduled
|
|
5684
|
+
# query resource.
|
|
5685
|
+
# @return [Array<Types::Tag>]
|
|
5686
|
+
#
|
|
5687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/ScheduledQueryConfiguration AWS API Documentation
|
|
5688
|
+
#
|
|
5689
|
+
class ScheduledQueryConfiguration < Struct.new(
|
|
5690
|
+
:query_string,
|
|
5691
|
+
:log_group_identifiers,
|
|
5692
|
+
:query_arn,
|
|
5693
|
+
:scheduled_query_role_arn,
|
|
5694
|
+
:schedule_configuration,
|
|
5695
|
+
:aggregation_expression,
|
|
5696
|
+
:tags)
|
|
5697
|
+
SENSITIVE = []
|
|
5698
|
+
include Aws::Structure
|
|
5699
|
+
end
|
|
5700
|
+
|
|
5111
5701
|
# @!attribute [rw] alarm_name
|
|
5112
5702
|
# The name of the alarm.
|
|
5113
5703
|
# @return [String]
|