@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
|
@@ -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>
|
|
@@ -151,6 +151,12 @@ declare const PutMetricAlarmCommand_base: {
|
|
|
151
151
|
* },
|
|
152
152
|
* ],
|
|
153
153
|
* ThresholdMetricId: "STRING_VALUE",
|
|
154
|
+
* EvaluationWindow: { // EvaluationWindow Union: only one key present
|
|
155
|
+
* WallClockWindow: { // WallClockWindow
|
|
156
|
+
* Timezone: "STRING_VALUE",
|
|
157
|
+
* },
|
|
158
|
+
* SlidingWindow: {},
|
|
159
|
+
* },
|
|
154
160
|
* EvaluationCriteria: { // EvaluationCriteria Union: only one key present
|
|
155
161
|
* PromQLCriteria: { // AlarmPromQLCriteria
|
|
156
162
|
* Query: "STRING_VALUE", // required
|
|
@@ -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";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,17 +1,55 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <p>Amazon CloudWatch
|
|
3
|
-
*
|
|
4
|
-
*
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
* <p>
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
2
|
+
* <p>Amazon CloudWatch enables you to publish, monitor, and manage various metrics, as well
|
|
3
|
+
* as configure alarm actions based on data from metrics. This guide provides detailed
|
|
4
|
+
* information about CloudWatch actions, data types, parameters, and errors. For
|
|
5
|
+
* more information about CloudWatch features, see <a href="https://aws.amazon.com/cloudwatch">Amazon CloudWatch</a> and the
|
|
6
|
+
* <i>Amazon CloudWatch User Guide</i>.</p>
|
|
7
|
+
* <p>For information about the metrics that other Amazon Web Services products send to
|
|
8
|
+
* CloudWatch, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html">Amazon CloudWatch
|
|
9
|
+
* Metrics and Dimensions Reference</a> in the <i>Amazon CloudWatch User
|
|
10
|
+
* Guide</i>.</p>
|
|
11
|
+
* <p>Use the following links to get started using the CloudWatch Query API:</p>
|
|
12
|
+
* <p>: An alphabetical list of all CloudWatch
|
|
13
|
+
* actions.</p>
|
|
14
|
+
* <p>: An alphabetical list of all CloudWatch data
|
|
15
|
+
* types.</p>
|
|
16
|
+
* <p>
|
|
17
|
+
* <a>CommonParameters</a>: Parameters that all Query actions can use.</p>
|
|
18
|
+
* <p>
|
|
19
|
+
* <a>CommonErrors</a>: Client and server errors that all actions can
|
|
20
|
+
* return.</p>
|
|
21
|
+
* <p>
|
|
22
|
+
* <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
|
|
23
|
+
* Services products.</p>
|
|
24
|
+
* <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
|
|
25
|
+
* to your programming language or platform.</p>
|
|
26
|
+
* <p>Developers in the Amazon Web Services developer community also provide their own
|
|
27
|
+
* libraries, which you can find at the following Amazon Web Services developer
|
|
28
|
+
* centers:</p>
|
|
29
|
+
* <p>
|
|
30
|
+
* <a href="http://aws.amazon.com/java/">Java Developer Center</a>
|
|
31
|
+
* </p>
|
|
32
|
+
* <p>
|
|
33
|
+
* <a href="http://aws.amazon.com/javascript/">JavaScript Developer
|
|
34
|
+
* Center</a>
|
|
35
|
+
* </p>
|
|
36
|
+
* <p>
|
|
37
|
+
* <a href="http://aws.amazon.com/mobile/">Amazon Web Services Mobile
|
|
38
|
+
* Services</a>
|
|
39
|
+
* </p>
|
|
40
|
+
* <p>
|
|
41
|
+
* <a href="http://aws.amazon.com/php/">PHP Developer Center</a>
|
|
42
|
+
* </p>
|
|
43
|
+
* <p>
|
|
44
|
+
* <a href="http://aws.amazon.com/python/">Python Developer Center</a>
|
|
45
|
+
* </p>
|
|
46
|
+
* <p>
|
|
47
|
+
* <a href="http://aws.amazon.com/ruby/">Ruby Developer Center</a>
|
|
48
|
+
* </p>
|
|
49
|
+
* <p>
|
|
50
|
+
* <a href="http://aws.amazon.com/net/">Windows and .NET Developer
|
|
51
|
+
* Center</a>
|
|
52
|
+
* </p>
|
|
15
53
|
*
|
|
16
54
|
* @packageDocumentation
|
|
17
55
|
*/
|
|
@@ -118,6 +118,18 @@ export declare class DashboardNotFoundError extends __BaseException {
|
|
|
118
118
|
*/
|
|
119
119
|
constructor(opts: __ExceptionOptionType<DashboardNotFoundError, __BaseException>);
|
|
120
120
|
}
|
|
121
|
+
/**
|
|
122
|
+
* <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>
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
export declare class ResourceConflict extends __BaseException {
|
|
126
|
+
readonly name: "ResourceConflict";
|
|
127
|
+
readonly $fault: "client";
|
|
128
|
+
/**
|
|
129
|
+
* @internal
|
|
130
|
+
*/
|
|
131
|
+
constructor(opts: __ExceptionOptionType<ResourceConflict, __BaseException>);
|
|
132
|
+
}
|
|
121
133
|
/**
|
|
122
134
|
* <p>The named resource does not exist.</p>
|
|
123
135
|
* @public
|