@aws-sdk/client-cloudwatch 3.1074.0 → 3.1076.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 +2188 -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/schemas/schemas_0.js +55 -3
- 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 +48 -3
- 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 +10 -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 +733 -294
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/schemas/schemas_0.d.ts +6 -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 +60 -4
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +7 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +7 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +7 -1
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +6 -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 -10
- 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
|
@@ -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",
|
|
@@ -164,6 +164,51 @@ declare const DescribeAlarmsCommand_base: {
|
|
|
164
164
|
* // EvaluationInterval: Number("int"),
|
|
165
165
|
* // },
|
|
166
166
|
* // ],
|
|
167
|
+
* // LogAlarms: [ // LogAlarms
|
|
168
|
+
* // { // LogAlarm
|
|
169
|
+
* // AlarmName: "STRING_VALUE",
|
|
170
|
+
* // AlarmArn: "STRING_VALUE",
|
|
171
|
+
* // AlarmDescription: "STRING_VALUE",
|
|
172
|
+
* // AlarmConfigurationUpdatedTimestamp: new Date("TIMESTAMP"),
|
|
173
|
+
* // ActionsEnabled: true || false,
|
|
174
|
+
* // OKActions: "<ResourceList>",
|
|
175
|
+
* // AlarmActions: "<ResourceList>",
|
|
176
|
+
* // InsufficientDataActions: "<ResourceList>",
|
|
177
|
+
* // StateValue: "OK" || "ALARM" || "INSUFFICIENT_DATA",
|
|
178
|
+
* // StateReason: "STRING_VALUE",
|
|
179
|
+
* // StateReasonData: "STRING_VALUE",
|
|
180
|
+
* // StateUpdatedTimestamp: new Date("TIMESTAMP"),
|
|
181
|
+
* // ScheduledQueryConfiguration: { // ScheduledQueryConfiguration
|
|
182
|
+
* // QueryString: "STRING_VALUE", // required
|
|
183
|
+
* // LogGroupIdentifiers: [ // LogGroupIdentifiers
|
|
184
|
+
* // "STRING_VALUE",
|
|
185
|
+
* // ],
|
|
186
|
+
* // QueryARN: "STRING_VALUE",
|
|
187
|
+
* // ScheduledQueryRoleARN: "STRING_VALUE", // required
|
|
188
|
+
* // ScheduleConfiguration: { // ScheduleConfiguration
|
|
189
|
+
* // ScheduleExpression: "STRING_VALUE", // required
|
|
190
|
+
* // StartTimeOffset: Number("long"),
|
|
191
|
+
* // EndTimeOffset: Number("long"),
|
|
192
|
+
* // },
|
|
193
|
+
* // AggregationExpression: "STRING_VALUE", // required
|
|
194
|
+
* // Tags: [ // TagList
|
|
195
|
+
* // { // Tag
|
|
196
|
+
* // Key: "STRING_VALUE", // required
|
|
197
|
+
* // Value: "STRING_VALUE", // required
|
|
198
|
+
* // },
|
|
199
|
+
* // ],
|
|
200
|
+
* // },
|
|
201
|
+
* // QueryResultsToEvaluate: Number("int"),
|
|
202
|
+
* // QueryResultsToAlarm: Number("int"),
|
|
203
|
+
* // Threshold: Number("double"),
|
|
204
|
+
* // ComparisonOperator: "GreaterThanOrEqualToThreshold" || "GreaterThanThreshold" || "LessThanThreshold" || "LessThanOrEqualToThreshold" || "LessThanLowerOrGreaterThanUpperThreshold" || "LessThanLowerThreshold" || "GreaterThanUpperThreshold",
|
|
205
|
+
* // TreatMissingData: "STRING_VALUE",
|
|
206
|
+
* // StateTransitionedTimestamp: new Date("TIMESTAMP"),
|
|
207
|
+
* // EvaluationState: "PARTIAL_DATA" || "EVALUATION_FAILURE" || "EVALUATION_ERROR",
|
|
208
|
+
* // ActionLogLineCount: Number("int"),
|
|
209
|
+
* // ActionLogLineRoleArn: "STRING_VALUE",
|
|
210
|
+
* // },
|
|
211
|
+
* // ],
|
|
167
212
|
* // NextToken: "STRING_VALUE",
|
|
168
213
|
* // };
|
|
169
214
|
*
|
|
@@ -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.
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
|
|
4
|
+
import type { PutLogAlarmInput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link PutLogAlarmCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PutLogAlarmCommandInput extends PutLogAlarmInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PutLogAlarmCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PutLogAlarmCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const PutLogAlarmCommand_base: {
|
|
25
|
+
new (input: PutLogAlarmCommandInput): import("@smithy/core/client").CommandImpl<PutLogAlarmCommandInput, PutLogAlarmCommandOutput, CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: PutLogAlarmCommandInput): import("@smithy/core/client").CommandImpl<PutLogAlarmCommandInput, PutLogAlarmCommandOutput, CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* <p>Creates or updates a log alarm. A log alarm evaluates the results of a CloudWatch Logs scheduled query against the configured threshold and comparison operator to determine its state.</p>
|
|
33
|
+
* <p>When you create a log alarm, the operation creates a service-managed CloudWatch Logs scheduled query that runs the query string you provide on the schedule you configure. Each scheduled query execution returns one or more aggregated values determined by the <code>AggregationExpression</code>, and each aggregated value is compared against the alarm <code>Threshold</code> to determine the alarm state. The alarm uses M-out-of-N evaluation: if <code>QueryResultsToAlarm</code> out of the most recent <code>QueryResultsToEvaluate</code> query results breach the threshold, the alarm transitions to <code>ALARM</code>.</p>
|
|
34
|
+
* <p>Log alarms support the alarm states (<code>OK</code>, <code>ALARM</code>, <code>INSUFFICIENT_DATA</code>). Configure transition actions using <code>OKActions</code>, <code>AlarmActions</code>, and <code>InsufficientDataActions</code>.</p>
|
|
35
|
+
* <p>If you call this operation with the name of an existing log alarm, the operation replaces the previous configuration of that alarm.</p>
|
|
36
|
+
* <p>
|
|
37
|
+
* <b>Permissions</b>
|
|
38
|
+
* </p>
|
|
39
|
+
* <p>To create or update a log alarm, you must have the <code>cloudwatch:PutLogAlarm</code> permission. The IAM role specified in <code>ScheduledQueryRoleARN</code> must grant the CloudWatch Alarms service permission to execute scheduled queries on the specified log groups. If you set <code>ActionLogLineCount</code>, the role specified in <code>ActionLogLineRoleArn</code> must grant permission to retrieve log events for inclusion in alarm notifications.</p>
|
|
40
|
+
* @example
|
|
41
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
42
|
+
* ```javascript
|
|
43
|
+
* import { CloudWatchClient, PutLogAlarmCommand } from "@aws-sdk/client-cloudwatch"; // ES Modules import
|
|
44
|
+
* // const { CloudWatchClient, PutLogAlarmCommand } = require("@aws-sdk/client-cloudwatch"); // CommonJS import
|
|
45
|
+
* // import type { CloudWatchClientConfig } from "@aws-sdk/client-cloudwatch";
|
|
46
|
+
* const config = {}; // type is CloudWatchClientConfig
|
|
47
|
+
* const client = new CloudWatchClient(config);
|
|
48
|
+
* const input = { // PutLogAlarmInput
|
|
49
|
+
* AlarmName: "STRING_VALUE", // required
|
|
50
|
+
* AlarmDescription: "STRING_VALUE",
|
|
51
|
+
* ScheduledQueryConfiguration: { // ScheduledQueryConfiguration
|
|
52
|
+
* QueryString: "STRING_VALUE", // required
|
|
53
|
+
* LogGroupIdentifiers: [ // LogGroupIdentifiers
|
|
54
|
+
* "STRING_VALUE",
|
|
55
|
+
* ],
|
|
56
|
+
* QueryARN: "STRING_VALUE",
|
|
57
|
+
* ScheduledQueryRoleARN: "STRING_VALUE", // required
|
|
58
|
+
* ScheduleConfiguration: { // ScheduleConfiguration
|
|
59
|
+
* ScheduleExpression: "STRING_VALUE", // required
|
|
60
|
+
* StartTimeOffset: Number("long"),
|
|
61
|
+
* EndTimeOffset: Number("long"),
|
|
62
|
+
* },
|
|
63
|
+
* AggregationExpression: "STRING_VALUE", // required
|
|
64
|
+
* Tags: [ // TagList
|
|
65
|
+
* { // Tag
|
|
66
|
+
* Key: "STRING_VALUE", // required
|
|
67
|
+
* Value: "STRING_VALUE", // required
|
|
68
|
+
* },
|
|
69
|
+
* ],
|
|
70
|
+
* },
|
|
71
|
+
* ActionLogLineCount: Number("int"),
|
|
72
|
+
* ActionLogLineRoleArn: "STRING_VALUE",
|
|
73
|
+
* ActionsEnabled: true || false,
|
|
74
|
+
* OKActions: [ // ResourceList
|
|
75
|
+
* "STRING_VALUE",
|
|
76
|
+
* ],
|
|
77
|
+
* AlarmActions: [
|
|
78
|
+
* "STRING_VALUE",
|
|
79
|
+
* ],
|
|
80
|
+
* InsufficientDataActions: [
|
|
81
|
+
* "STRING_VALUE",
|
|
82
|
+
* ],
|
|
83
|
+
* QueryResultsToEvaluate: Number("int"), // required
|
|
84
|
+
* QueryResultsToAlarm: Number("int"), // required
|
|
85
|
+
* Threshold: Number("double"), // required
|
|
86
|
+
* ComparisonOperator: "GreaterThanOrEqualToThreshold" || "GreaterThanThreshold" || "LessThanThreshold" || "LessThanOrEqualToThreshold" || "LessThanLowerOrGreaterThanUpperThreshold" || "LessThanLowerThreshold" || "GreaterThanUpperThreshold", // required
|
|
87
|
+
* TreatMissingData: "STRING_VALUE",
|
|
88
|
+
* Tags: [
|
|
89
|
+
* {
|
|
90
|
+
* Key: "STRING_VALUE", // required
|
|
91
|
+
* Value: "STRING_VALUE", // required
|
|
92
|
+
* },
|
|
93
|
+
* ],
|
|
94
|
+
* };
|
|
95
|
+
* const command = new PutLogAlarmCommand(input);
|
|
96
|
+
* const response = await client.send(command);
|
|
97
|
+
* // {};
|
|
98
|
+
*
|
|
99
|
+
* ```
|
|
100
|
+
*
|
|
101
|
+
* @param PutLogAlarmCommandInput - {@link PutLogAlarmCommandInput}
|
|
102
|
+
* @returns {@link PutLogAlarmCommandOutput}
|
|
103
|
+
* @see {@link PutLogAlarmCommandInput} for command's `input` shape.
|
|
104
|
+
* @see {@link PutLogAlarmCommandOutput} for command's `response` shape.
|
|
105
|
+
* @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link LimitExceededFault} (client fault)
|
|
108
|
+
* <p>The quota for alarms for this customer has already been reached.</p>
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link ResourceConflict} (client fault)
|
|
111
|
+
* <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>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link CloudWatchServiceException}
|
|
114
|
+
* <p>Base exception class for all service exceptions from CloudWatch service.</p>
|
|
115
|
+
*
|
|
116
|
+
*
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
export declare class PutLogAlarmCommand extends PutLogAlarmCommand_base {
|
|
120
|
+
/** @internal type navigation helper, not in runtime. */
|
|
121
|
+
protected static __types: {
|
|
122
|
+
api: {
|
|
123
|
+
input: PutLogAlarmInput;
|
|
124
|
+
output: {};
|
|
125
|
+
};
|
|
126
|
+
sdk: {
|
|
127
|
+
input: PutLogAlarmCommandInput;
|
|
128
|
+
output: PutLogAlarmCommandOutput;
|
|
129
|
+
};
|
|
130
|
+
};
|
|
131
|
+
}
|
|
@@ -32,11 +32,11 @@ declare const PutManagedInsightRulesCommand_base: {
|
|
|
32
32
|
* <p> Creates a managed Contributor Insights rule for a specified Amazon Web Services
|
|
33
33
|
* resource. When you enable a managed rule, you create a Contributor Insights rule that
|
|
34
34
|
* collects data from Amazon Web Services services. You cannot edit these rules with
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
35
|
+
* <code>PutInsightRule</code>. The rules can be enabled, disabled, and deleted using
|
|
36
|
+
* <code>EnableInsightRules</code>, <code>DisableInsightRules</code>, and
|
|
37
|
+
* <code>DeleteInsightRules</code>. If a previously created managed rule is currently
|
|
38
38
|
* disabled, a subsequent call to this API will re-enable it. Use
|
|
39
|
-
*
|
|
39
|
+
* <code>ListManagedInsightRules</code> to describe all available rules.
|
|
40
40
|
*
|
|
41
41
|
* </p>
|
|
42
42
|
* @example
|
|
@@ -30,12 +30,12 @@ declare const PutMetricAlarmCommand_base: {
|
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
32
|
* <p>Creates or updates an alarm and associates it with the specified metric, metric
|
|
33
|
-
* math expression, anomaly detection model, Metrics Insights query, or PromQL query. For
|
|
34
|
-
* information about using a Metrics Insights query for an alarm, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html">Create
|
|
35
|
-
*
|
|
33
|
+
* math expression, anomaly detection model, Metrics Insights query, or PromQL query. For
|
|
34
|
+
* more information about using a Metrics Insights query for an alarm, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html">Create
|
|
35
|
+
* alarms on Metrics Insights queries</a>.</p>
|
|
36
36
|
* <p>Alarms based on anomaly detection models cannot have Auto Scaling actions.</p>
|
|
37
37
|
* <p>When this operation creates an alarm, the alarm state is immediately set to
|
|
38
|
-
*
|
|
38
|
+
* <code>INSUFFICIENT_DATA</code>. For PromQL alarms, the alarm state is instead
|
|
39
39
|
* immediately set to <code>OK</code>. The alarm is then evaluated and its state is set
|
|
40
40
|
* appropriately. Any actions associated with the new state are then executed.</p>
|
|
41
41
|
* <p>When you update an existing alarm, its state is left unchanged, but the update
|
|
@@ -54,9 +54,9 @@ declare const PutMetricAlarmCommand_base: {
|
|
|
54
54
|
* </ul>
|
|
55
55
|
* <p>The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary
|
|
56
56
|
* service-linked role for you. The service-linked roles are called
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
57
|
+
* <code>AWSServiceRoleForCloudWatchEvents</code> and
|
|
58
|
+
* <code>AWSServiceRoleForCloudWatchAlarms_ActionSSM</code>. For more information, see
|
|
59
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role">Amazon Web Services service-linked role</a>.</p>
|
|
60
60
|
* <p>Each <code>PutMetricAlarm</code> action has a maximum uncompressed payload of 120
|
|
61
61
|
* KB.</p>
|
|
62
62
|
* <p>
|
|
@@ -68,15 +68,15 @@ declare const PutMetricAlarmCommand_base: {
|
|
|
68
68
|
* <ul>
|
|
69
69
|
* <li>
|
|
70
70
|
* <p>The account where the metrics are located (the <i>sharing
|
|
71
|
-
*
|
|
71
|
+
* account</i>) must already have a sharing role named <b>CloudWatch-CrossAccountSharingRole</b>. If it does not
|
|
72
72
|
* already have this role, you must create it using the instructions in <b>Set up a sharing account</b> in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html#enable-cross-account-cross-Region"> Cross-account cross-Region CloudWatch console</a>. The policy
|
|
73
73
|
* for that role must grant access to the ID of the account where you are creating
|
|
74
74
|
* the alarm. </p>
|
|
75
75
|
* </li>
|
|
76
76
|
* <li>
|
|
77
77
|
* <p>The account where you are creating the alarm (the <i>monitoring
|
|
78
|
-
*
|
|
79
|
-
*
|
|
78
|
+
* account</i>) must already have a service-linked role named <b>AWSServiceRoleForCloudWatchCrossAccount</b> to allow
|
|
79
|
+
* CloudWatch to assume the sharing role in the sharing account. If it
|
|
80
80
|
* does not, you must create it following the directions in <b>Set up a monitoring account</b> in <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Cross-Account-Cross-Region.html#enable-cross-account-cross-Region"> Cross-account cross-Region CloudWatch console</a>.</p>
|
|
81
81
|
* </li>
|
|
82
82
|
* </ul>
|
|
@@ -37,7 +37,7 @@ declare const PutMetricDataCommand_base: {
|
|
|
37
37
|
* found and viewed together), or publish metric data by itself. To send entity data with
|
|
38
38
|
* your metrics, use the <code>EntityMetricData</code> parameter. To send metrics without
|
|
39
39
|
* entity data, use the <code>MetricData</code> parameter. The
|
|
40
|
-
*
|
|
40
|
+
* <code>EntityMetricData</code> structure includes <code>MetricData</code> structures
|
|
41
41
|
* for the metric data.</p>
|
|
42
42
|
* <p>You can publish either individual values in the <code>Value</code> field, or arrays of
|
|
43
43
|
* values and the number of times each value occurred during the period by using the
|
|
@@ -48,7 +48,7 @@ declare const PutMetricDataCommand_base: {
|
|
|
48
48
|
* <p>Each <code>PutMetricData</code> request is limited to 1 MB in size for HTTP POST
|
|
49
49
|
* requests. You can send a payload compressed by gzip. Each request is also limited to no
|
|
50
50
|
* more than 1000 different metrics (across both the <code>MetricData</code> and
|
|
51
|
-
*
|
|
51
|
+
* <code>EntityMetricData</code> properties).</p>
|
|
52
52
|
* <p>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>,
|
|
53
53
|
* CloudWatch rejects values that are either too small or too large. Values must be in the
|
|
54
54
|
* range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
|
|
@@ -33,11 +33,11 @@ declare const PutMetricStreamCommand_base: {
|
|
|
33
33
|
* metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party
|
|
34
34
|
* solutions.</p>
|
|
35
35
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html"> Using
|
|
36
|
-
*
|
|
36
|
+
* Metric Streams</a>.</p>
|
|
37
37
|
* <p>To create a metric stream, you must be signed in to an account that has the
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
38
|
+
* <code>iam:PassRole</code> permission and either the
|
|
39
|
+
* <code>CloudWatchFullAccess</code> policy or the
|
|
40
|
+
* <code>cloudwatch:PutMetricStream</code> permission.</p>
|
|
41
41
|
* <p>When you create or update a metric stream, you choose one of the following:</p>
|
|
42
42
|
* <ul>
|
|
43
43
|
* <li>
|
|
@@ -49,11 +49,11 @@ declare const PutMetricStreamCommand_base: {
|
|
|
49
49
|
* </li>
|
|
50
50
|
* <li>
|
|
51
51
|
* <p>Stream metrics from only the metric namespaces that you list in
|
|
52
|
-
*
|
|
52
|
+
* <code>IncludeFilters</code>.</p>
|
|
53
53
|
* </li>
|
|
54
54
|
* </ul>
|
|
55
55
|
* <p>By default, a metric stream always sends the <code>MAX</code>, <code>MIN</code>,
|
|
56
|
-
*
|
|
56
|
+
* <code>SUM</code>, and <code>SAMPLECOUNT</code> statistics for each metric that is
|
|
57
57
|
* streamed. You can use the <code>StatisticsConfigurations</code> parameter to have the
|
|
58
58
|
* metric stream send additional statistics in the stream. Streaming additional statistics
|
|
59
59
|
* incurs additional costs. For more information, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>. </p>
|
|
@@ -29,14 +29,13 @@ declare const StartOTelEnrichmentCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Enables enrichment and PromQL access for CloudWatch vended metrics for
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* your account. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/EnableResourceTagsOnTelemetry.html">Enable resource tags on telemetry</a>.</p>
|
|
32
|
+
* <p>Enables enrichment and PromQL access for CloudWatch vended metrics for <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/UsingResourceTagsForTelemetry.html">supported Amazon Web Services resources</a> in the account. Once enabled,
|
|
33
|
+
* metrics that contain a resource identifier dimension (for example, EC2
|
|
34
|
+
* <code>CPUUtilization</code> with an <code>InstanceId</code> dimension) are enriched
|
|
35
|
+
* with resource ARN and resource tag labels and become queryable using PromQL.</p>
|
|
36
|
+
* <p>Before calling this operation, you must enable resource tags on telemetry for your
|
|
37
|
+
* account. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/EnableResourceTagsOnTelemetry.html">Enable
|
|
38
|
+
* resource tags on telemetry</a>.</p>
|
|
40
39
|
* @example
|
|
41
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
41
|
* ```javascript
|
|
@@ -29,10 +29,9 @@ declare const StopOTelEnrichmentCommand_base: {
|
|
|
29
29
|
};
|
|
30
30
|
};
|
|
31
31
|
/**
|
|
32
|
-
* <p>Disables enrichment and PromQL access for CloudWatch vended metrics for
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
* queried using PromQL.</p>
|
|
32
|
+
* <p>Disables enrichment and PromQL access for CloudWatch vended metrics for <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/UsingResourceTagsForTelemetry.html">supported Amazon Web Services resources</a> in the account. After disabling,
|
|
33
|
+
* these metrics are no longer enriched with resource ARN and resource tag labels, and
|
|
34
|
+
* cannot be queried using PromQL.</p>
|
|
36
35
|
* @example
|
|
37
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
37
|
* ```javascript
|
|
@@ -36,6 +36,7 @@ export * from "./PutAnomalyDetectorCommand";
|
|
|
36
36
|
export * from "./PutCompositeAlarmCommand";
|
|
37
37
|
export * from "./PutDashboardCommand";
|
|
38
38
|
export * from "./PutInsightRuleCommand";
|
|
39
|
+
export * from "./PutLogAlarmCommand";
|
|
39
40
|
export * from "./PutManagedInsightRulesCommand";
|
|
40
41
|
export * from "./PutMetricAlarmCommand";
|
|
41
42
|
export * from "./PutMetricDataCommand";
|