@aws-sdk/client-cloudwatch 3.1075.0 → 3.1077.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.
- package/README.md +58 -13
- package/dist-cjs/index.js +2210 -24
- package/dist-es/CloudWatch.js +4 -0
- package/dist-es/commands/PutLogAlarmCommand.js +16 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/enums.js +1 -0
- package/dist-es/models/errors.js +12 -0
- package/dist-es/runtimeConfig.browser.js +0 -2
- package/dist-es/runtimeConfig.js +1 -2
- package/dist-es/runtimeConfig.native.js +0 -2
- package/dist-es/runtimeConfig.shared.js +2 -0
- package/dist-es/schemas/schemas_0.js +77 -7
- package/dist-es/waiters/index.js +1 -0
- package/dist-es/waiters/waitForLogAlarmExists.js +32 -0
- package/dist-types/CloudWatch.d.ts +64 -13
- package/dist-types/CloudWatchClient.d.ts +54 -15
- package/dist-types/commands/DeleteAlarmMuteRuleCommand.d.ts +7 -3
- package/dist-types/commands/DeleteAlarmsCommand.d.ts +8 -5
- package/dist-types/commands/DeleteAnomalyDetectorCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAlarmContributorsCommand.d.ts +3 -1
- package/dist-types/commands/DescribeAlarmHistoryCommand.d.ts +3 -3
- package/dist-types/commands/DescribeAlarmsCommand.d.ts +54 -3
- package/dist-types/commands/DescribeAlarmsForMetricCommand.d.ts +6 -0
- package/dist-types/commands/DescribeAnomalyDetectorsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInsightRulesCommand.d.ts +1 -1
- package/dist-types/commands/GetAlarmMuteRuleCommand.d.ts +11 -5
- package/dist-types/commands/GetMetricDataCommand.d.ts +3 -3
- package/dist-types/commands/GetMetricStatisticsCommand.d.ts +2 -2
- package/dist-types/commands/GetMetricWidgetImageCommand.d.ts +1 -1
- package/dist-types/commands/GetOTelEnrichmentCommand.d.ts +2 -3
- package/dist-types/commands/ListAlarmMuteRulesCommand.d.ts +7 -3
- package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist-types/commands/PutAlarmMuteRuleCommand.d.ts +24 -6
- package/dist-types/commands/PutAnomalyDetectorCommand.d.ts +1 -1
- package/dist-types/commands/PutCompositeAlarmCommand.d.ts +6 -6
- package/dist-types/commands/PutLogAlarmCommand.d.ts +131 -0
- package/dist-types/commands/PutManagedInsightRulesCommand.d.ts +4 -4
- package/dist-types/commands/PutMetricAlarmCommand.d.ts +16 -10
- package/dist-types/commands/PutMetricDataCommand.d.ts +2 -2
- package/dist-types/commands/PutMetricStreamCommand.d.ts +6 -6
- package/dist-types/commands/StartOTelEnrichmentCommand.d.ts +7 -8
- package/dist-types/commands/StopOTelEnrichmentCommand.d.ts +3 -4
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +51 -13
- package/dist-types/models/enums.d.ts +1 -0
- package/dist-types/models/errors.d.ts +12 -0
- package/dist-types/models/models_0.d.ts +849 -294
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +9 -0
- package/dist-types/ts3.4/CloudWatch.d.ts +26 -0
- package/dist-types/ts3.4/CloudWatchClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/PutLogAlarmCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +1 -0
- package/dist-types/ts3.4/models/errors.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +92 -4
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +8 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +8 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +8 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +9 -0
- package/dist-types/ts3.4/waiters/index.d.ts +1 -0
- package/dist-types/ts3.4/waiters/waitForLogAlarmExists.d.ts +17 -0
- package/dist-types/waiters/index.d.ts +1 -0
- package/dist-types/waiters/waitForLogAlarmExists.d.ts +15 -0
- package/package.json +10 -12
- package/dist-cjs/auth/httpAuthSchemeProvider.js +0 -40
- package/dist-cjs/endpoint/bdd.js +0 -49
- package/dist-cjs/endpoint/endpointResolver.js +0 -14
- package/dist-cjs/models/CloudWatchServiceException.js +0 -8
- package/dist-cjs/models/errors.js +0 -227
- package/dist-cjs/runtimeConfig.browser.js +0 -35
- package/dist-cjs/runtimeConfig.js +0 -48
- package/dist-cjs/runtimeConfig.native.js +0 -12
- package/dist-cjs/runtimeConfig.shared.js +0 -40
- package/dist-cjs/schemas/schemas_0.js +0 -1600
|
@@ -45,6 +45,7 @@ import type { PutAnomalyDetectorCommandInput, PutAnomalyDetectorCommandOutput }
|
|
|
45
45
|
import type { PutCompositeAlarmCommandInput, PutCompositeAlarmCommandOutput } from "./commands/PutCompositeAlarmCommand";
|
|
46
46
|
import type { PutDashboardCommandInput, PutDashboardCommandOutput } from "./commands/PutDashboardCommand";
|
|
47
47
|
import type { PutInsightRuleCommandInput, PutInsightRuleCommandOutput } from "./commands/PutInsightRuleCommand";
|
|
48
|
+
import type { PutLogAlarmCommandInput, PutLogAlarmCommandOutput } from "./commands/PutLogAlarmCommand";
|
|
48
49
|
import type { PutManagedInsightRulesCommandInput, PutManagedInsightRulesCommandOutput } from "./commands/PutManagedInsightRulesCommand";
|
|
49
50
|
import type { PutMetricAlarmCommandInput, PutMetricAlarmCommandOutput } from "./commands/PutMetricAlarmCommand";
|
|
50
51
|
import type { PutMetricDataCommandInput, PutMetricDataCommandOutput } from "./commands/PutMetricDataCommand";
|
|
@@ -62,11 +63,11 @@ export { __Client };
|
|
|
62
63
|
/**
|
|
63
64
|
* @public
|
|
64
65
|
*/
|
|
65
|
-
export type ServiceInputTypes = AssociateDatasetKmsKeyCommandInput | DeleteAlarmMuteRuleCommandInput | DeleteAlarmsCommandInput | DeleteAnomalyDetectorCommandInput | DeleteDashboardsCommandInput | DeleteInsightRulesCommandInput | DeleteMetricStreamCommandInput | DescribeAlarmContributorsCommandInput | DescribeAlarmHistoryCommandInput | DescribeAlarmsCommandInput | DescribeAlarmsForMetricCommandInput | DescribeAnomalyDetectorsCommandInput | DescribeInsightRulesCommandInput | DisableAlarmActionsCommandInput | DisableInsightRulesCommandInput | DisassociateDatasetKmsKeyCommandInput | EnableAlarmActionsCommandInput | EnableInsightRulesCommandInput | GetAlarmMuteRuleCommandInput | GetDashboardCommandInput | GetDatasetCommandInput | GetInsightRuleReportCommandInput | GetMetricDataCommandInput | GetMetricStatisticsCommandInput | GetMetricStreamCommandInput | GetMetricWidgetImageCommandInput | GetOTelEnrichmentCommandInput | ListAlarmMuteRulesCommandInput | ListDashboardsCommandInput | ListManagedInsightRulesCommandInput | ListMetricStreamsCommandInput | ListMetricsCommandInput | ListTagsForResourceCommandInput | PutAlarmMuteRuleCommandInput | PutAnomalyDetectorCommandInput | PutCompositeAlarmCommandInput | PutDashboardCommandInput | PutInsightRuleCommandInput | PutManagedInsightRulesCommandInput | PutMetricAlarmCommandInput | PutMetricDataCommandInput | PutMetricStreamCommandInput | SetAlarmStateCommandInput | StartMetricStreamsCommandInput | StartOTelEnrichmentCommandInput | StopMetricStreamsCommandInput | StopOTelEnrichmentCommandInput | TagResourceCommandInput | UntagResourceCommandInput;
|
|
66
|
+
export type ServiceInputTypes = AssociateDatasetKmsKeyCommandInput | DeleteAlarmMuteRuleCommandInput | DeleteAlarmsCommandInput | DeleteAnomalyDetectorCommandInput | DeleteDashboardsCommandInput | DeleteInsightRulesCommandInput | DeleteMetricStreamCommandInput | DescribeAlarmContributorsCommandInput | DescribeAlarmHistoryCommandInput | DescribeAlarmsCommandInput | DescribeAlarmsForMetricCommandInput | DescribeAnomalyDetectorsCommandInput | DescribeInsightRulesCommandInput | DisableAlarmActionsCommandInput | DisableInsightRulesCommandInput | DisassociateDatasetKmsKeyCommandInput | EnableAlarmActionsCommandInput | EnableInsightRulesCommandInput | GetAlarmMuteRuleCommandInput | GetDashboardCommandInput | GetDatasetCommandInput | GetInsightRuleReportCommandInput | GetMetricDataCommandInput | GetMetricStatisticsCommandInput | GetMetricStreamCommandInput | GetMetricWidgetImageCommandInput | GetOTelEnrichmentCommandInput | ListAlarmMuteRulesCommandInput | ListDashboardsCommandInput | ListManagedInsightRulesCommandInput | ListMetricStreamsCommandInput | ListMetricsCommandInput | ListTagsForResourceCommandInput | PutAlarmMuteRuleCommandInput | PutAnomalyDetectorCommandInput | PutCompositeAlarmCommandInput | PutDashboardCommandInput | PutInsightRuleCommandInput | PutLogAlarmCommandInput | PutManagedInsightRulesCommandInput | PutMetricAlarmCommandInput | PutMetricDataCommandInput | PutMetricStreamCommandInput | SetAlarmStateCommandInput | StartMetricStreamsCommandInput | StartOTelEnrichmentCommandInput | StopMetricStreamsCommandInput | StopOTelEnrichmentCommandInput | TagResourceCommandInput | UntagResourceCommandInput;
|
|
66
67
|
/**
|
|
67
68
|
* @public
|
|
68
69
|
*/
|
|
69
|
-
export type ServiceOutputTypes = AssociateDatasetKmsKeyCommandOutput | DeleteAlarmMuteRuleCommandOutput | DeleteAlarmsCommandOutput | DeleteAnomalyDetectorCommandOutput | DeleteDashboardsCommandOutput | DeleteInsightRulesCommandOutput | DeleteMetricStreamCommandOutput | DescribeAlarmContributorsCommandOutput | DescribeAlarmHistoryCommandOutput | DescribeAlarmsCommandOutput | DescribeAlarmsForMetricCommandOutput | DescribeAnomalyDetectorsCommandOutput | DescribeInsightRulesCommandOutput | DisableAlarmActionsCommandOutput | DisableInsightRulesCommandOutput | DisassociateDatasetKmsKeyCommandOutput | EnableAlarmActionsCommandOutput | EnableInsightRulesCommandOutput | GetAlarmMuteRuleCommandOutput | GetDashboardCommandOutput | GetDatasetCommandOutput | GetInsightRuleReportCommandOutput | GetMetricDataCommandOutput | GetMetricStatisticsCommandOutput | GetMetricStreamCommandOutput | GetMetricWidgetImageCommandOutput | GetOTelEnrichmentCommandOutput | ListAlarmMuteRulesCommandOutput | ListDashboardsCommandOutput | ListManagedInsightRulesCommandOutput | ListMetricStreamsCommandOutput | ListMetricsCommandOutput | ListTagsForResourceCommandOutput | PutAlarmMuteRuleCommandOutput | PutAnomalyDetectorCommandOutput | PutCompositeAlarmCommandOutput | PutDashboardCommandOutput | PutInsightRuleCommandOutput | PutManagedInsightRulesCommandOutput | PutMetricAlarmCommandOutput | PutMetricDataCommandOutput | PutMetricStreamCommandOutput | SetAlarmStateCommandOutput | StartMetricStreamsCommandOutput | StartOTelEnrichmentCommandOutput | StopMetricStreamsCommandOutput | StopOTelEnrichmentCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput;
|
|
70
|
+
export type ServiceOutputTypes = AssociateDatasetKmsKeyCommandOutput | DeleteAlarmMuteRuleCommandOutput | DeleteAlarmsCommandOutput | DeleteAnomalyDetectorCommandOutput | DeleteDashboardsCommandOutput | DeleteInsightRulesCommandOutput | DeleteMetricStreamCommandOutput | DescribeAlarmContributorsCommandOutput | DescribeAlarmHistoryCommandOutput | DescribeAlarmsCommandOutput | DescribeAlarmsForMetricCommandOutput | DescribeAnomalyDetectorsCommandOutput | DescribeInsightRulesCommandOutput | DisableAlarmActionsCommandOutput | DisableInsightRulesCommandOutput | DisassociateDatasetKmsKeyCommandOutput | EnableAlarmActionsCommandOutput | EnableInsightRulesCommandOutput | GetAlarmMuteRuleCommandOutput | GetDashboardCommandOutput | GetDatasetCommandOutput | GetInsightRuleReportCommandOutput | GetMetricDataCommandOutput | GetMetricStatisticsCommandOutput | GetMetricStreamCommandOutput | GetMetricWidgetImageCommandOutput | GetOTelEnrichmentCommandOutput | ListAlarmMuteRulesCommandOutput | ListDashboardsCommandOutput | ListManagedInsightRulesCommandOutput | ListMetricStreamsCommandOutput | ListMetricsCommandOutput | ListTagsForResourceCommandOutput | PutAlarmMuteRuleCommandOutput | PutAnomalyDetectorCommandOutput | PutCompositeAlarmCommandOutput | PutDashboardCommandOutput | PutInsightRuleCommandOutput | PutLogAlarmCommandOutput | PutManagedInsightRulesCommandOutput | PutMetricAlarmCommandOutput | PutMetricDataCommandOutput | PutMetricStreamCommandOutput | SetAlarmStateCommandOutput | StartMetricStreamsCommandOutput | StartOTelEnrichmentCommandOutput | StopMetricStreamsCommandOutput | StopOTelEnrichmentCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput;
|
|
70
71
|
/**
|
|
71
72
|
* @public
|
|
72
73
|
*/
|
|
@@ -218,19 +219,57 @@ export type CloudWatchClientResolvedConfigType = __SmithyResolvedConfiguration<_
|
|
|
218
219
|
export interface CloudWatchClientResolvedConfig extends CloudWatchClientResolvedConfigType {
|
|
219
220
|
}
|
|
220
221
|
/**
|
|
221
|
-
* <p>Amazon CloudWatch
|
|
222
|
-
*
|
|
223
|
-
*
|
|
224
|
-
*
|
|
225
|
-
*
|
|
226
|
-
*
|
|
227
|
-
*
|
|
228
|
-
*
|
|
229
|
-
*
|
|
230
|
-
* <p>
|
|
231
|
-
*
|
|
232
|
-
*
|
|
233
|
-
*
|
|
222
|
+
* <p>Amazon CloudWatch enables you to publish, monitor, and manage various metrics, as well
|
|
223
|
+
* as configure alarm actions based on data from metrics. This guide provides detailed
|
|
224
|
+
* information about CloudWatch actions, data types, parameters, and errors. For
|
|
225
|
+
* more information about CloudWatch features, see <a href="https://aws.amazon.com/cloudwatch">Amazon CloudWatch</a> and the
|
|
226
|
+
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
227
|
+
* <p>For information about the metrics that other Amazon Web Services products send to
|
|
228
|
+
* CloudWatch, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html">Amazon CloudWatch
|
|
229
|
+
* Metrics and Dimensions Reference</a> in the <i>Amazon CloudWatch User
|
|
230
|
+
* Guide</i>.</p>
|
|
231
|
+
* <p>Use the following links to get started using the CloudWatch Query API:</p>
|
|
232
|
+
* <p>: An alphabetical list of all CloudWatch
|
|
233
|
+
* actions.</p>
|
|
234
|
+
* <p>: An alphabetical list of all CloudWatch data
|
|
235
|
+
* types.</p>
|
|
236
|
+
* <p>
|
|
237
|
+
* <a>CommonParameters</a>: Parameters that all Query actions can use.</p>
|
|
238
|
+
* <p>
|
|
239
|
+
* <a>CommonErrors</a>: Client and server errors that all actions can
|
|
240
|
+
* return.</p>
|
|
241
|
+
* <p>
|
|
242
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#cw_region">Regions and Endpoints</a>: Supported regions and endpoints for all Amazon Web
|
|
243
|
+
* Services products.</p>
|
|
244
|
+
* <p>Alternatively, you can use one of the <a href="https://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access CloudWatch using an API tailored
|
|
245
|
+
* to your programming language or platform.</p>
|
|
246
|
+
* <p>Developers in the Amazon Web Services developer community also provide their own
|
|
247
|
+
* libraries, which you can find at the following Amazon Web Services developer
|
|
248
|
+
* centers:</p>
|
|
249
|
+
* <p>
|
|
250
|
+
* <a href="http://aws.amazon.com/java/">Java Developer Center</a>
|
|
251
|
+
* </p>
|
|
252
|
+
* <p>
|
|
253
|
+
* <a href="http://aws.amazon.com/javascript/">JavaScript Developer
|
|
254
|
+
* Center</a>
|
|
255
|
+
* </p>
|
|
256
|
+
* <p>
|
|
257
|
+
* <a href="http://aws.amazon.com/mobile/">Amazon Web Services Mobile
|
|
258
|
+
* Services</a>
|
|
259
|
+
* </p>
|
|
260
|
+
* <p>
|
|
261
|
+
* <a href="http://aws.amazon.com/php/">PHP Developer Center</a>
|
|
262
|
+
* </p>
|
|
263
|
+
* <p>
|
|
264
|
+
* <a href="http://aws.amazon.com/python/">Python Developer Center</a>
|
|
265
|
+
* </p>
|
|
266
|
+
* <p>
|
|
267
|
+
* <a href="http://aws.amazon.com/ruby/">Ruby Developer Center</a>
|
|
268
|
+
* </p>
|
|
269
|
+
* <p>
|
|
270
|
+
* <a href="http://aws.amazon.com/net/">Windows and .NET Developer
|
|
271
|
+
* Center</a>
|
|
272
|
+
* </p>
|
|
234
273
|
* @public
|
|
235
274
|
*/
|
|
236
275
|
export declare class CloudWatchClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CloudWatchClientResolvedConfig> {
|
|
@@ -30,12 +30,16 @@ declare const DeleteAlarmMuteRuleCommand_base: {
|
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
32
|
* <p>Deletes a specific alarm mute rule.</p>
|
|
33
|
-
* <p>When you delete a mute rule, any alarms that are currently being muted by that rule
|
|
34
|
-
*
|
|
33
|
+
* <p>When you delete a mute rule, any alarms that are currently being muted by that rule
|
|
34
|
+
* are immediately unmuted. If those alarms are in an ALARM state, their configured actions
|
|
35
|
+
* will trigger.</p>
|
|
36
|
+
* <p>This operation is idempotent. If you delete a mute rule that does not exist, the
|
|
37
|
+
* operation succeeds without returning an error.</p>
|
|
35
38
|
* <p>
|
|
36
39
|
* <b>Permissions</b>
|
|
37
40
|
* </p>
|
|
38
|
-
* <p>To delete a mute rule, you need the <code>cloudwatch:DeleteAlarmMuteRule</code>
|
|
41
|
+
* <p>To delete a mute rule, you need the <code>cloudwatch:DeleteAlarmMuteRule</code>
|
|
42
|
+
* permission on the alarm mute rule resource.</p>
|
|
39
43
|
* @example
|
|
40
44
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
45
|
* ```javascript
|
|
@@ -32,10 +32,10 @@ declare const DeleteAlarmsCommand_base: {
|
|
|
32
32
|
* <p>Deletes the specified alarms. You can delete up to 100 alarms in one operation.
|
|
33
33
|
* However, this total can include no more than one composite alarm. For example, you could
|
|
34
34
|
* delete 99 metric alarms and one composite alarms with one operation, but you can't
|
|
35
|
-
* delete two composite alarms with one operation.</p>
|
|
36
|
-
* <p> If you specify any incorrect alarm names, the alarms you specify with correct
|
|
37
|
-
*
|
|
38
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html">DescribeAlarms</a> operation after using <code>DeleteAlarms</code>.</p>
|
|
35
|
+
* delete two composite alarms with one operation. Log alarms cannot be batch deleted.</p>
|
|
36
|
+
* <p> If you specify any incorrect alarm names, the alarms you specify with correct
|
|
37
|
+
* names are still deleted. Other syntax errors might result in no alarms being deleted. To
|
|
38
|
+
* confirm that alarms were deleted successfully, you can use the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html">DescribeAlarms</a> operation after using <code>DeleteAlarms</code>.</p>
|
|
39
39
|
* <note>
|
|
40
40
|
* <p>It is possible to create a loop or cycle of composite alarms, where composite
|
|
41
41
|
* alarm A depends on composite alarm B, and composite alarm B also depends on
|
|
@@ -45,7 +45,7 @@ declare const DeleteAlarmsCommand_base: {
|
|
|
45
45
|
* <p>To get out of such a situation, you must break the cycle by changing the rule of
|
|
46
46
|
* one of the composite alarms in the cycle to remove a dependency that creates the
|
|
47
47
|
* cycle. The simplest change to make to break a cycle is to change the
|
|
48
|
-
*
|
|
48
|
+
* <code>AlarmRule</code> of one of the alarms to <code>false</code>. </p>
|
|
49
49
|
* <p>Additionally, the evaluation of composite alarms stops if CloudWatch
|
|
50
50
|
* detects a cycle in the evaluation path. </p>
|
|
51
51
|
* </note>
|
|
@@ -74,6 +74,9 @@ declare const DeleteAlarmsCommand_base: {
|
|
|
74
74
|
* @see {@link DeleteAlarmsCommandOutput} for command's `response` shape.
|
|
75
75
|
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
|
|
76
76
|
*
|
|
77
|
+
* @throws {@link ResourceConflict} (client fault)
|
|
78
|
+
* <p>The operation could not be completed because the request conflicts with the current state of the alarm or its underlying scheduled query resource.</p>
|
|
79
|
+
*
|
|
77
80
|
* @throws {@link ResourceNotFound} (client fault)
|
|
78
81
|
* <p>The named resource does not exist.</p>
|
|
79
82
|
*
|
|
@@ -31,7 +31,7 @@ declare const DeleteAnomalyDetectorCommand_base: {
|
|
|
31
31
|
/**
|
|
32
32
|
* <p> Deletes the specified anomaly detection model from your account. For more information
|
|
33
33
|
* about how to delete an anomaly detection model, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Anomaly_Detection_Alarm.html#Delete_Anomaly_Detection_Model">Deleting an anomaly detection model</a> in the <i>CloudWatch User
|
|
34
|
-
*
|
|
34
|
+
* Guide</i>. </p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -29,7 +29,9 @@ declare const DescribeAlarmContributorsCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Returns the information of the current alarm contributors that are in
|
|
32
|
+
* <p>Returns the information of the current alarm contributors that are in
|
|
33
|
+
* <code>ALARM</code> state. This operation returns details about the individual time
|
|
34
|
+
* series that contribute to the alarm's state.</p>
|
|
33
35
|
* @example
|
|
34
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
37
|
* ```javascript
|
|
@@ -36,7 +36,7 @@ declare const DescribeAlarmHistoryCommand_base: {
|
|
|
36
36
|
* <p>To use this operation and return information about a composite alarm, you must be
|
|
37
37
|
* signed on with the <code>cloudwatch:DescribeAlarmHistory</code> permission that is
|
|
38
38
|
* scoped to <code>*</code>. You can't return information about composite alarms if your
|
|
39
|
-
*
|
|
39
|
+
* <code>cloudwatch:DescribeAlarmHistory</code> permission has a narrower scope.</p>
|
|
40
40
|
* @example
|
|
41
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
42
|
* ```javascript
|
|
@@ -49,7 +49,7 @@ declare const DescribeAlarmHistoryCommand_base: {
|
|
|
49
49
|
* AlarmName: "STRING_VALUE",
|
|
50
50
|
* AlarmContributorId: "STRING_VALUE",
|
|
51
51
|
* AlarmTypes: [ // AlarmTypes
|
|
52
|
-
* "CompositeAlarm" || "MetricAlarm",
|
|
52
|
+
* "CompositeAlarm" || "MetricAlarm" || "LogAlarm",
|
|
53
53
|
* ],
|
|
54
54
|
* HistoryItemType: "ConfigurationUpdate" || "StateUpdate" || "Action" || "AlarmContributorStateUpdate" || "AlarmContributorAction",
|
|
55
55
|
* StartDate: new Date("TIMESTAMP"),
|
|
@@ -65,7 +65,7 @@ declare const DescribeAlarmHistoryCommand_base: {
|
|
|
65
65
|
* // { // AlarmHistoryItem
|
|
66
66
|
* // AlarmName: "STRING_VALUE",
|
|
67
67
|
* // AlarmContributorId: "STRING_VALUE",
|
|
68
|
-
* // AlarmType: "CompositeAlarm" || "MetricAlarm",
|
|
68
|
+
* // AlarmType: "CompositeAlarm" || "MetricAlarm" || "LogAlarm",
|
|
69
69
|
* // Timestamp: new Date("TIMESTAMP"),
|
|
70
70
|
* // HistoryItemType: "ConfigurationUpdate" || "StateUpdate" || "Action" || "AlarmContributorStateUpdate" || "AlarmContributorAction",
|
|
71
71
|
* // HistorySummary: "STRING_VALUE",
|
|
@@ -33,8 +33,8 @@ declare const DescribeAlarmsCommand_base: {
|
|
|
33
33
|
* for the alarm name, the alarm state, or a prefix for any action.</p>
|
|
34
34
|
* <p>To use this operation and return information about composite alarms, you must be
|
|
35
35
|
* signed on with the <code>cloudwatch:DescribeAlarms</code> permission that is scoped to
|
|
36
|
-
*
|
|
37
|
-
*
|
|
36
|
+
* <code>*</code>. You can't return information about composite alarms if your
|
|
37
|
+
* <code>cloudwatch:DescribeAlarms</code> permission has a narrower scope.</p>
|
|
38
38
|
* @example
|
|
39
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
40
|
* ```javascript
|
|
@@ -49,7 +49,7 @@ declare const DescribeAlarmsCommand_base: {
|
|
|
49
49
|
* ],
|
|
50
50
|
* AlarmNamePrefix: "STRING_VALUE",
|
|
51
51
|
* AlarmTypes: [ // AlarmTypes
|
|
52
|
-
* "CompositeAlarm" || "MetricAlarm",
|
|
52
|
+
* "CompositeAlarm" || "MetricAlarm" || "LogAlarm",
|
|
53
53
|
* ],
|
|
54
54
|
* ChildrenOfAlarmName: "STRING_VALUE",
|
|
55
55
|
* ParentsOfAlarmName: "STRING_VALUE",
|
|
@@ -154,6 +154,12 @@ declare const DescribeAlarmsCommand_base: {
|
|
|
154
154
|
* // ThresholdMetricId: "STRING_VALUE",
|
|
155
155
|
* // EvaluationState: "PARTIAL_DATA" || "EVALUATION_FAILURE" || "EVALUATION_ERROR",
|
|
156
156
|
* // StateTransitionedTimestamp: new Date("TIMESTAMP"),
|
|
157
|
+
* // EvaluationWindow: { // EvaluationWindow Union: only one key present
|
|
158
|
+
* // WallClockWindow: { // WallClockWindow
|
|
159
|
+
* // Timezone: "STRING_VALUE",
|
|
160
|
+
* // },
|
|
161
|
+
* // SlidingWindow: {},
|
|
162
|
+
* // },
|
|
157
163
|
* // EvaluationCriteria: { // EvaluationCriteria Union: only one key present
|
|
158
164
|
* // PromQLCriteria: { // AlarmPromQLCriteria
|
|
159
165
|
* // Query: "STRING_VALUE", // required
|
|
@@ -164,6 +170,51 @@ declare const DescribeAlarmsCommand_base: {
|
|
|
164
170
|
* // EvaluationInterval: Number("int"),
|
|
165
171
|
* // },
|
|
166
172
|
* // ],
|
|
173
|
+
* // LogAlarms: [ // LogAlarms
|
|
174
|
+
* // { // LogAlarm
|
|
175
|
+
* // AlarmName: "STRING_VALUE",
|
|
176
|
+
* // AlarmArn: "STRING_VALUE",
|
|
177
|
+
* // AlarmDescription: "STRING_VALUE",
|
|
178
|
+
* // AlarmConfigurationUpdatedTimestamp: new Date("TIMESTAMP"),
|
|
179
|
+
* // ActionsEnabled: true || false,
|
|
180
|
+
* // OKActions: "<ResourceList>",
|
|
181
|
+
* // AlarmActions: "<ResourceList>",
|
|
182
|
+
* // InsufficientDataActions: "<ResourceList>",
|
|
183
|
+
* // StateValue: "OK" || "ALARM" || "INSUFFICIENT_DATA",
|
|
184
|
+
* // StateReason: "STRING_VALUE",
|
|
185
|
+
* // StateReasonData: "STRING_VALUE",
|
|
186
|
+
* // StateUpdatedTimestamp: new Date("TIMESTAMP"),
|
|
187
|
+
* // ScheduledQueryConfiguration: { // ScheduledQueryConfiguration
|
|
188
|
+
* // QueryString: "STRING_VALUE", // required
|
|
189
|
+
* // LogGroupIdentifiers: [ // LogGroupIdentifiers
|
|
190
|
+
* // "STRING_VALUE",
|
|
191
|
+
* // ],
|
|
192
|
+
* // QueryARN: "STRING_VALUE",
|
|
193
|
+
* // ScheduledQueryRoleARN: "STRING_VALUE", // required
|
|
194
|
+
* // ScheduleConfiguration: { // ScheduleConfiguration
|
|
195
|
+
* // ScheduleExpression: "STRING_VALUE", // required
|
|
196
|
+
* // StartTimeOffset: Number("long"),
|
|
197
|
+
* // EndTimeOffset: Number("long"),
|
|
198
|
+
* // },
|
|
199
|
+
* // AggregationExpression: "STRING_VALUE", // required
|
|
200
|
+
* // Tags: [ // TagList
|
|
201
|
+
* // { // Tag
|
|
202
|
+
* // Key: "STRING_VALUE", // required
|
|
203
|
+
* // Value: "STRING_VALUE", // required
|
|
204
|
+
* // },
|
|
205
|
+
* // ],
|
|
206
|
+
* // },
|
|
207
|
+
* // QueryResultsToEvaluate: Number("int"),
|
|
208
|
+
* // QueryResultsToAlarm: Number("int"),
|
|
209
|
+
* // Threshold: Number("double"),
|
|
210
|
+
* // ComparisonOperator: "GreaterThanOrEqualToThreshold" || "GreaterThanThreshold" || "LessThanThreshold" || "LessThanOrEqualToThreshold" || "LessThanLowerOrGreaterThanUpperThreshold" || "LessThanLowerThreshold" || "GreaterThanUpperThreshold",
|
|
211
|
+
* // TreatMissingData: "STRING_VALUE",
|
|
212
|
+
* // StateTransitionedTimestamp: new Date("TIMESTAMP"),
|
|
213
|
+
* // EvaluationState: "PARTIAL_DATA" || "EVALUATION_FAILURE" || "EVALUATION_ERROR",
|
|
214
|
+
* // ActionLogLineCount: Number("int"),
|
|
215
|
+
* // ActionLogLineRoleArn: "STRING_VALUE",
|
|
216
|
+
* // },
|
|
217
|
+
* // ],
|
|
167
218
|
* // NextToken: "STRING_VALUE",
|
|
168
219
|
* // };
|
|
169
220
|
*
|
|
@@ -125,6 +125,12 @@ declare const DescribeAlarmsForMetricCommand_base: {
|
|
|
125
125
|
* // ThresholdMetricId: "STRING_VALUE",
|
|
126
126
|
* // EvaluationState: "PARTIAL_DATA" || "EVALUATION_FAILURE" || "EVALUATION_ERROR",
|
|
127
127
|
* // StateTransitionedTimestamp: new Date("TIMESTAMP"),
|
|
128
|
+
* // EvaluationWindow: { // EvaluationWindow Union: only one key present
|
|
129
|
+
* // WallClockWindow: { // WallClockWindow
|
|
130
|
+
* // Timezone: "STRING_VALUE",
|
|
131
|
+
* // },
|
|
132
|
+
* // SlidingWindow: {},
|
|
133
|
+
* // },
|
|
128
134
|
* // EvaluationCriteria: { // EvaluationCriteria Union: only one key present
|
|
129
135
|
* // PromQLCriteria: { // AlarmPromQLCriteria
|
|
130
136
|
* // Query: "STRING_VALUE", // required
|
|
@@ -33,7 +33,7 @@ declare const DescribeAnomalyDetectorsCommand_base: {
|
|
|
33
33
|
* metric anomaly detectors, you can list all of the models in your account or filter the
|
|
34
34
|
* results to only the models that are related to a certain namespace, metric name, or
|
|
35
35
|
* metric dimension. For metric math anomaly detectors, you can list them by adding
|
|
36
|
-
*
|
|
36
|
+
* <code>METRIC_MATH</code> to the <code>AnomalyDetectorTypes</code> array. This will
|
|
37
37
|
* return all metric math anomaly detectors in your account.</p>
|
|
38
38
|
* @example
|
|
39
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -31,7 +31,7 @@ declare const DescribeInsightRulesCommand_base: {
|
|
|
31
31
|
/**
|
|
32
32
|
* <p>Returns a list of all the Contributor Insights rules in your account.</p>
|
|
33
33
|
* <p>For more information about Contributor Insights, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html">Using Contributor
|
|
34
|
-
*
|
|
34
|
+
* Insights to Analyze High-Cardinality Data</a>.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -30,26 +30,32 @@ declare const GetAlarmMuteRuleCommand_base: {
|
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
32
|
* <p>Retrieves details for a specific alarm mute rule.</p>
|
|
33
|
-
* <p>This operation returns complete information about the mute rule, including its
|
|
33
|
+
* <p>This operation returns complete information about the mute rule, including its
|
|
34
|
+
* configuration, status, targeted alarms, and metadata.</p>
|
|
34
35
|
* <p>The returned status indicates the current state of the mute rule:</p>
|
|
35
36
|
* <ul>
|
|
36
37
|
* <li>
|
|
37
38
|
* <p>
|
|
38
|
-
* <b>SCHEDULED</b>: The mute rule is configured and
|
|
39
|
+
* <b>SCHEDULED</b>: The mute rule is configured and
|
|
40
|
+
* will become active in the future</p>
|
|
39
41
|
* </li>
|
|
40
42
|
* <li>
|
|
41
43
|
* <p>
|
|
42
|
-
* <b>ACTIVE</b>: The mute rule is currently muting
|
|
44
|
+
* <b>ACTIVE</b>: The mute rule is currently muting
|
|
45
|
+
* alarm actions</p>
|
|
43
46
|
* </li>
|
|
44
47
|
* <li>
|
|
45
48
|
* <p>
|
|
46
|
-
* <b>EXPIRED</b>: The mute rule has passed its
|
|
49
|
+
* <b>EXPIRED</b>: The mute rule has passed its
|
|
50
|
+
* expiration date and will no longer become active</p>
|
|
47
51
|
* </li>
|
|
48
52
|
* </ul>
|
|
49
53
|
* <p>
|
|
50
54
|
* <b>Permissions</b>
|
|
51
55
|
* </p>
|
|
52
|
-
* <p>To retrieve details for a mute rule, you need the
|
|
56
|
+
* <p>To retrieve details for a mute rule, you need the
|
|
57
|
+
* <code>cloudwatch:GetAlarmMuteRule</code> permission on the alarm mute rule
|
|
58
|
+
* resource.</p>
|
|
53
59
|
* @example
|
|
54
60
|
* Use a bare-bones client and the command you need to make an API call.
|
|
55
61
|
* ```javascript
|
|
@@ -39,15 +39,15 @@ declare const GetMetricDataCommand_base: {
|
|
|
39
39
|
* data. For example, using Lambda metrics, you could divide the Errors metric by the
|
|
40
40
|
* Invocations metric to get an error rate time series. For more information about metric
|
|
41
41
|
* math expressions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax">Metric Math Syntax and Functions</a> in the <i>Amazon CloudWatch User
|
|
42
|
-
*
|
|
42
|
+
* Guide</i>.</p>
|
|
43
43
|
* <p>If you include a Metrics Insights query, each <code>GetMetricData</code> operation can
|
|
44
44
|
* include only one query. But the same <code>GetMetricData</code> operation can also
|
|
45
45
|
* retrieve other metrics. Metrics Insights queries can query only the most recent three
|
|
46
46
|
* hours of metric data. For more information about Metrics Insights, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/query_with_cloudwatch-metrics-insights.html">Query your metrics with CloudWatch Metrics Insights</a>.</p>
|
|
47
47
|
* <p>Calls to the <code>GetMetricData</code> API have a different pricing structure than
|
|
48
48
|
* calls to <code>GetMetricStatistics</code>. For more information about pricing, see
|
|
49
|
-
*
|
|
50
|
-
*
|
|
49
|
+
* <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch
|
|
50
|
+
* Pricing</a>.</p>
|
|
51
51
|
* <p>Amazon CloudWatch retains metric data as follows:</p>
|
|
52
52
|
* <ul>
|
|
53
53
|
* <li>
|
|
@@ -84,8 +84,8 @@ declare const GetMetricStatisticsCommand_base: {
|
|
|
84
84
|
* 2016.</p>
|
|
85
85
|
* <p>For information about metrics and dimensions supported by Amazon Web Services
|
|
86
86
|
* services, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html">Amazon CloudWatch
|
|
87
|
-
*
|
|
88
|
-
*
|
|
87
|
+
* Metrics and Dimensions Reference</a> in the <i>Amazon CloudWatch User
|
|
88
|
+
* Guide</i>.</p>
|
|
89
89
|
* @example
|
|
90
90
|
* Use a bare-bones client and the command you need to make an API call.
|
|
91
91
|
* ```javascript
|
|
@@ -37,7 +37,7 @@ declare const GetMetricWidgetImageCommand_base: {
|
|
|
37
37
|
* <p>The graph you retrieve can include all CloudWatch metric graph features, including
|
|
38
38
|
* metric math and horizontal and vertical annotations.</p>
|
|
39
39
|
* <p>There is a limit of 20 transactions per second for this API. Each
|
|
40
|
-
*
|
|
40
|
+
* <code>GetMetricWidgetImage</code> action has the following limits:</p>
|
|
41
41
|
* <ul>
|
|
42
42
|
* <li>
|
|
43
43
|
* <p>As many as 100 metrics in the graph.</p>
|
|
@@ -30,9 +30,8 @@ declare const GetOTelEnrichmentCommand_base: {
|
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
32
|
* <p>Returns the current status of vended metric enrichment for the account, including
|
|
33
|
-
* whether CloudWatch vended metrics are enriched with resource ARN and resource tag
|
|
34
|
-
*
|
|
35
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/UsingResourceTagsForTelemetry.html">Supported Amazon Web Services infrastructure metrics</a>.</p>
|
|
33
|
+
* whether CloudWatch vended metrics are enriched with resource ARN and resource tag labels
|
|
34
|
+
* and queryable using PromQL. For the list of supported resources, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/UsingResourceTagsForTelemetry.html">Supported Amazon Web Services infrastructure metrics</a>.</p>
|
|
36
35
|
* @example
|
|
37
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
37
|
* ```javascript
|
|
@@ -30,12 +30,16 @@ declare const ListAlarmMuteRulesCommand_base: {
|
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
32
|
* <p>Lists alarm mute rules in your Amazon Web Services account and region.</p>
|
|
33
|
-
* <p>You can filter the results by alarm name to find all mute rules targeting a specific
|
|
34
|
-
*
|
|
33
|
+
* <p>You can filter the results by alarm name to find all mute rules targeting a specific
|
|
34
|
+
* alarm, or by status to find rules that are scheduled, active, or expired.</p>
|
|
35
|
+
* <p>This operation supports pagination for accounts with many mute rules. Use the
|
|
36
|
+
* <code>MaxRecords</code> and <code>NextToken</code> parameters to retrieve results in
|
|
37
|
+
* multiple calls.</p>
|
|
35
38
|
* <p>
|
|
36
39
|
* <b>Permissions</b>
|
|
37
40
|
* </p>
|
|
38
|
-
* <p>To list mute rules, you need the <code>cloudwatch:ListAlarmMuteRules</code>
|
|
41
|
+
* <p>To list mute rules, you need the <code>cloudwatch:ListAlarmMuteRules</code>
|
|
42
|
+
* permission.</p>
|
|
39
43
|
* @example
|
|
40
44
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
45
|
* ```javascript
|
|
@@ -30,7 +30,7 @@ declare const ListDashboardsCommand_base: {
|
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
32
|
* <p>Returns a list of the dashboards for your account. If you include
|
|
33
|
-
*
|
|
33
|
+
* <code>DashboardNamePrefix</code>, only those dashboards with names starting with the
|
|
34
34
|
* prefix are listed. Otherwise, all dashboards in your account are listed. </p>
|
|
35
35
|
* <p>
|
|
36
36
|
* <code>ListDashboards</code> returns up to 1000 results on one page. If there are
|
|
@@ -30,15 +30,33 @@ declare const PutAlarmMuteRuleCommand_base: {
|
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
32
|
* <p>Creates or updates an alarm mute rule.</p>
|
|
33
|
-
* <p>Alarm mute rules automatically mute alarm actions during predefined time windows. When
|
|
34
|
-
*
|
|
35
|
-
*
|
|
33
|
+
* <p>Alarm mute rules automatically mute alarm actions during predefined time windows. When
|
|
34
|
+
* a mute rule is active, targeted alarms continue to evaluate metrics and transition
|
|
35
|
+
* between states, but their configured actions (such as Amazon SNS notifications
|
|
36
|
+
* or Auto Scaling actions) are muted.</p>
|
|
37
|
+
* <p>You can create mute rules with recurring schedules using <code>cron</code> expressions
|
|
38
|
+
* or one-time mute windows using <code>at</code> expressions. Each mute rule can target up
|
|
39
|
+
* to 100 specific alarms by name.</p>
|
|
40
|
+
* <p>If you specify a rule name that already exists, this operation updates the existing
|
|
41
|
+
* rule with the new configuration.</p>
|
|
36
42
|
* <p>
|
|
37
43
|
* <b>Permissions</b>
|
|
38
44
|
* </p>
|
|
39
|
-
* <p>To create or update a mute rule, you must have the
|
|
40
|
-
*
|
|
41
|
-
*
|
|
45
|
+
* <p>To create or update a mute rule, you must have the
|
|
46
|
+
* <code>cloudwatch:PutAlarmMuteRule</code> permission on two types of resources: the
|
|
47
|
+
* alarm mute rule resource itself, and each alarm that the rule targets.</p>
|
|
48
|
+
* <p>For example, If you want to allow a user to create mute rules that target only
|
|
49
|
+
* specific alarms named "WebServerCPUAlarm" and "DatabaseConnectionAlarm", you would
|
|
50
|
+
* create an IAM policy with one statement granting
|
|
51
|
+
* <code>cloudwatch:PutAlarmMuteRule</code> on the alarm mute rule resource
|
|
52
|
+
* (<code>arn:aws:cloudwatch:[REGION]:123456789012:alarm-mute-rule:*</code>), and
|
|
53
|
+
* another statement granting <code>cloudwatch:PutAlarmMuteRule</code> on the targeted
|
|
54
|
+
* alarm resources
|
|
55
|
+
* (<code>arn:aws:cloudwatch:[REGION]:123456789012:alarm:WebServerCPUAlarm</code> and
|
|
56
|
+
* <code>arn:aws:cloudwatch:[REGION]:123456789012:alarm:DatabaseConnectionAlarm</code>).</p>
|
|
57
|
+
* <p>You can also use IAM policy conditions to allow targeting alarms based on resource
|
|
58
|
+
* tags. For example, you can restrict users to create/update mute rules to only target
|
|
59
|
+
* alarms that have a specific tag key-value pair, such as <code>Team=TeamA</code>.</p>
|
|
42
60
|
* @example
|
|
43
61
|
* Use a bare-bones client and the command you need to make an API call.
|
|
44
62
|
* ```javascript
|
|
@@ -34,7 +34,7 @@ declare const PutAnomalyDetectorCommand_base: {
|
|
|
34
34
|
* <p>If you have enabled unified cross-account observability, and this account is a
|
|
35
35
|
* monitoring account, the metric can be in the same account or a source account. You can
|
|
36
36
|
* specify the account ID in the object you specify in the
|
|
37
|
-
*
|
|
37
|
+
* <code>SingleMetricAnomalyDetector</code> parameter.</p>
|
|
38
38
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html">CloudWatch Anomaly Detection</a>.</p>
|
|
39
39
|
* @example
|
|
40
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -65,23 +65,23 @@ declare const PutCompositeAlarmCommand_base: {
|
|
|
65
65
|
* <p>To get out of such a situation, you must break the cycle by changing the rule of
|
|
66
66
|
* one of the composite alarms in the cycle to remove a dependency that creates the
|
|
67
67
|
* cycle. The simplest change to make to break a cycle is to change the
|
|
68
|
-
*
|
|
68
|
+
* <code>AlarmRule</code> of one of the alarms to <code>false</code>. </p>
|
|
69
69
|
* <p>Additionally, the evaluation of composite alarms stops if CloudWatch detects a
|
|
70
70
|
* cycle in the evaluation path. </p>
|
|
71
71
|
* </note>
|
|
72
72
|
* <p>When this operation creates an alarm, the alarm state is immediately set to
|
|
73
|
-
*
|
|
73
|
+
* <code>INSUFFICIENT_DATA</code>. The alarm is then evaluated and its state is set
|
|
74
74
|
* appropriately. Any actions associated with the new state are then executed. For a
|
|
75
75
|
* composite alarm, this initial time after creation is the only time that the alarm can be
|
|
76
76
|
* in <code>INSUFFICIENT_DATA</code> state.</p>
|
|
77
77
|
* <p>When you update an existing alarm, its state is left unchanged, but the update
|
|
78
78
|
* completely overwrites the previous configuration of the alarm.</p>
|
|
79
79
|
* <p>To use this operation, you must be signed on with the
|
|
80
|
-
*
|
|
81
|
-
*
|
|
82
|
-
*
|
|
80
|
+
* <code>cloudwatch:PutCompositeAlarm</code> permission that is scoped to
|
|
81
|
+
* <code>*</code>. You can't create a composite alarms if your
|
|
82
|
+
* <code>cloudwatch:PutCompositeAlarm</code> permission has a narrower scope.</p>
|
|
83
83
|
* <p>If you are an IAM user, you must have
|
|
84
|
-
*
|
|
84
|
+
* <code>iam:CreateServiceLinkedRole</code> to create a composite alarm that has
|
|
85
85
|
* Systems Manager OpsItem actions.</p>
|
|
86
86
|
* @example
|
|
87
87
|
* Use a bare-bones client and the command you need to make an API call.
|