@aws-sdk/client-cloudwatch 3.36.0 → 3.39.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.
Files changed (118) hide show
  1. package/CHANGELOG.md +42 -0
  2. package/dist-cjs/CloudWatch.js +0 -17
  3. package/dist-cjs/CloudWatchClient.js +0 -22
  4. package/dist-cjs/commands/DeleteAlarmsCommand.js +0 -39
  5. package/dist-cjs/commands/DeleteAnomalyDetectorCommand.js +0 -24
  6. package/dist-cjs/commands/DeleteDashboardsCommand.js +0 -26
  7. package/dist-cjs/commands/DeleteInsightRulesCommand.js +0 -27
  8. package/dist-cjs/commands/DeleteMetricStreamCommand.js +0 -24
  9. package/dist-cjs/commands/DescribeAlarmHistoryCommand.js +0 -26
  10. package/dist-cjs/commands/DescribeAlarmsCommand.js +0 -25
  11. package/dist-cjs/commands/DescribeAlarmsForMetricCommand.js +0 -28
  12. package/dist-cjs/commands/DescribeAnomalyDetectorsCommand.js +0 -26
  13. package/dist-cjs/commands/DescribeInsightRulesCommand.js +0 -27
  14. package/dist-cjs/commands/DisableAlarmActionsCommand.js +0 -25
  15. package/dist-cjs/commands/DisableInsightRulesCommand.js +0 -25
  16. package/dist-cjs/commands/EnableAlarmActionsCommand.js +0 -24
  17. package/dist-cjs/commands/EnableInsightRulesCommand.js +0 -24
  18. package/dist-cjs/commands/GetDashboardCommand.js +0 -27
  19. package/dist-cjs/commands/GetInsightRuleReportCommand.js +0 -60
  20. package/dist-cjs/commands/GetMetricDataCommand.js +0 -59
  21. package/dist-cjs/commands/GetMetricStatisticsCommand.js +0 -75
  22. package/dist-cjs/commands/GetMetricStreamCommand.js +0 -24
  23. package/dist-cjs/commands/GetMetricWidgetImageCommand.js +0 -41
  24. package/dist-cjs/commands/ListDashboardsCommand.js +0 -32
  25. package/dist-cjs/commands/ListMetricStreamsCommand.js +0 -24
  26. package/dist-cjs/commands/ListMetricsCommand.js +0 -37
  27. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -25
  28. package/dist-cjs/commands/PutAnomalyDetectorCommand.js +0 -26
  29. package/dist-cjs/commands/PutCompositeAlarmCommand.js +0 -59
  30. package/dist-cjs/commands/PutDashboardCommand.js +0 -37
  31. package/dist-cjs/commands/PutInsightRuleCommand.js +0 -28
  32. package/dist-cjs/commands/PutMetricAlarmCommand.js +0 -87
  33. package/dist-cjs/commands/PutMetricDataCommand.js +0 -68
  34. package/dist-cjs/commands/PutMetricStreamCommand.js +0 -51
  35. package/dist-cjs/commands/SetAlarmStateCommand.js +0 -39
  36. package/dist-cjs/commands/StartMetricStreamsCommand.js +0 -24
  37. package/dist-cjs/commands/StopMetricStreamsCommand.js +0 -24
  38. package/dist-cjs/commands/TagResourceCommand.js +0 -34
  39. package/dist-cjs/commands/UntagResourceCommand.js +0 -24
  40. package/dist-cjs/commands/index.js +39 -0
  41. package/dist-cjs/endpoints.js +6 -1
  42. package/dist-cjs/index.js +5 -48
  43. package/dist-cjs/models/models_0.js +0 -315
  44. package/dist-cjs/pagination/DescribeAlarmHistoryPaginator.js +0 -10
  45. package/dist-cjs/pagination/DescribeAlarmsPaginator.js +0 -10
  46. package/dist-cjs/pagination/DescribeInsightRulesPaginator.js +0 -10
  47. package/dist-cjs/pagination/GetMetricDataPaginator.js +0 -10
  48. package/dist-cjs/pagination/ListDashboardsPaginator.js +0 -10
  49. package/dist-cjs/pagination/ListMetricStreamsPaginator.js +0 -10
  50. package/dist-cjs/pagination/ListMetricsPaginator.js +0 -10
  51. package/dist-cjs/pagination/index.js +11 -0
  52. package/dist-cjs/protocols/Aws_query.js +0 -2
  53. package/dist-cjs/runtimeConfig.browser.js +1 -5
  54. package/dist-cjs/runtimeConfig.js +1 -5
  55. package/dist-cjs/runtimeConfig.native.js +0 -3
  56. package/dist-cjs/runtimeConfig.shared.js +0 -3
  57. package/dist-cjs/waiters/index.js +5 -0
  58. package/dist-cjs/waiters/waitForAlarmExists.js +0 -9
  59. package/dist-cjs/waiters/waitForCompositeAlarmExists.js +0 -9
  60. package/dist-es/commands/index.js +36 -0
  61. package/dist-es/endpoints.js +6 -1
  62. package/dist-es/index.js +5 -48
  63. package/dist-es/pagination/index.js +8 -0
  64. package/dist-es/waiters/index.js +2 -0
  65. package/dist-types/commands/index.d.ts +36 -0
  66. package/dist-types/index.d.ts +5 -48
  67. package/dist-types/pagination/index.d.ts +8 -0
  68. package/dist-types/ts3.4/CloudWatch.d.ts +37 -536
  69. package/dist-types/ts3.4/CloudWatchClient.d.ts +24 -103
  70. package/dist-types/ts3.4/commands/DeleteAlarmsCommand.d.ts +2 -35
  71. package/dist-types/ts3.4/commands/DeleteAnomalyDetectorCommand.d.ts +2 -20
  72. package/dist-types/ts3.4/commands/DeleteDashboardsCommand.d.ts +2 -22
  73. package/dist-types/ts3.4/commands/DeleteInsightRulesCommand.d.ts +2 -23
  74. package/dist-types/ts3.4/commands/DeleteMetricStreamCommand.d.ts +2 -20
  75. package/dist-types/ts3.4/commands/DescribeAlarmHistoryCommand.d.ts +2 -22
  76. package/dist-types/ts3.4/commands/DescribeAlarmsCommand.d.ts +2 -21
  77. package/dist-types/ts3.4/commands/DescribeAlarmsForMetricCommand.d.ts +2 -24
  78. package/dist-types/ts3.4/commands/DescribeAnomalyDetectorsCommand.d.ts +2 -22
  79. package/dist-types/ts3.4/commands/DescribeInsightRulesCommand.d.ts +2 -23
  80. package/dist-types/ts3.4/commands/DisableAlarmActionsCommand.d.ts +2 -21
  81. package/dist-types/ts3.4/commands/DisableInsightRulesCommand.d.ts +2 -21
  82. package/dist-types/ts3.4/commands/EnableAlarmActionsCommand.d.ts +2 -20
  83. package/dist-types/ts3.4/commands/EnableInsightRulesCommand.d.ts +2 -20
  84. package/dist-types/ts3.4/commands/GetDashboardCommand.d.ts +2 -23
  85. package/dist-types/ts3.4/commands/GetInsightRuleReportCommand.d.ts +2 -56
  86. package/dist-types/ts3.4/commands/GetMetricDataCommand.d.ts +2 -55
  87. package/dist-types/ts3.4/commands/GetMetricStatisticsCommand.d.ts +2 -71
  88. package/dist-types/ts3.4/commands/GetMetricStreamCommand.d.ts +2 -20
  89. package/dist-types/ts3.4/commands/GetMetricWidgetImageCommand.d.ts +2 -37
  90. package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +2 -28
  91. package/dist-types/ts3.4/commands/ListMetricStreamsCommand.d.ts +2 -20
  92. package/dist-types/ts3.4/commands/ListMetricsCommand.d.ts +2 -33
  93. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -21
  94. package/dist-types/ts3.4/commands/PutAnomalyDetectorCommand.d.ts +2 -22
  95. package/dist-types/ts3.4/commands/PutCompositeAlarmCommand.d.ts +2 -55
  96. package/dist-types/ts3.4/commands/PutDashboardCommand.d.ts +2 -33
  97. package/dist-types/ts3.4/commands/PutInsightRuleCommand.d.ts +2 -24
  98. package/dist-types/ts3.4/commands/PutMetricAlarmCommand.d.ts +2 -83
  99. package/dist-types/ts3.4/commands/PutMetricDataCommand.d.ts +2 -64
  100. package/dist-types/ts3.4/commands/PutMetricStreamCommand.d.ts +2 -47
  101. package/dist-types/ts3.4/commands/SetAlarmStateCommand.d.ts +2 -35
  102. package/dist-types/ts3.4/commands/StartMetricStreamsCommand.d.ts +2 -20
  103. package/dist-types/ts3.4/commands/StopMetricStreamsCommand.d.ts +2 -20
  104. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -30
  105. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
  106. package/dist-types/ts3.4/commands/index.d.ts +36 -0
  107. package/dist-types/ts3.4/index.d.ts +5 -48
  108. package/dist-types/ts3.4/models/models_0.d.ts +481 -2223
  109. package/dist-types/ts3.4/pagination/index.d.ts +8 -0
  110. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  111. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  112. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  113. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  114. package/dist-types/ts3.4/waiters/index.d.ts +2 -0
  115. package/dist-types/ts3.4/waiters/waitForAlarmExists.d.ts +2 -9
  116. package/dist-types/ts3.4/waiters/waitForCompositeAlarmExists.d.ts +2 -9
  117. package/dist-types/waiters/index.d.ts +2 -0
  118. package/package.json +33 -33
@@ -1,313 +1,165 @@
1
1
  import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
2
  export declare type AlarmType = "CompositeAlarm" | "MetricAlarm";
3
3
  export declare type HistoryItemType = "Action" | "ConfigurationUpdate" | "StateUpdate";
4
- /**
5
- * <p>Represents the history of a specific alarm.</p>
6
- */
4
+
7
5
  export interface AlarmHistoryItem {
8
- /**
9
- * <p>The descriptive name for the alarm.</p>
10
- */
6
+
11
7
  AlarmName?: string;
12
- /**
13
- * <p>The type of alarm, either metric alarm or composite alarm.</p>
14
- */
8
+
15
9
  AlarmType?: AlarmType | string;
16
- /**
17
- * <p>The time stamp for the alarm history item.</p>
18
- */
10
+
19
11
  Timestamp?: Date;
20
- /**
21
- * <p>The type of alarm history item.</p>
22
- */
12
+
23
13
  HistoryItemType?: HistoryItemType | string;
24
- /**
25
- * <p>A summary of the alarm history, in text format.</p>
26
- */
14
+
27
15
  HistorySummary?: string;
28
- /**
29
- * <p>Data about the alarm, in JSON format.</p>
30
- */
16
+
31
17
  HistoryData?: string;
32
18
  }
33
19
  export declare namespace AlarmHistoryItem {
34
- /**
35
- * @internal
36
- */
20
+
37
21
  const filterSensitiveLog: (obj: AlarmHistoryItem) => any;
38
22
  }
39
- /**
40
- * <p>Specifies one range of days or times to exclude from use for training an
41
- * anomaly detection model.</p>
42
- */
23
+
43
24
  export interface Range {
44
- /**
45
- * <p>The start time of the range to exclude. The format is <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
46
- * <code>2019-07-01T23:59:59</code>.</p>
47
- */
25
+
48
26
  StartTime: Date | undefined;
49
- /**
50
- * <p>The end time of the range to exclude. The format is <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
51
- * <code>2019-07-01T23:59:59</code>.</p>
52
- */
27
+
53
28
  EndTime: Date | undefined;
54
29
  }
55
30
  export declare namespace Range {
56
- /**
57
- * @internal
58
- */
31
+
59
32
  const filterSensitiveLog: (obj: Range) => any;
60
33
  }
61
- /**
62
- * <p>The configuration specifies details about how the anomaly detection model is to be trained,
63
- * including time ranges to exclude from use for training the model and the time zone to
64
- * use for the metric.</p>
65
- */
34
+
66
35
  export interface AnomalyDetectorConfiguration {
67
- /**
68
- * <p>An array of time ranges to exclude from use when the anomaly detection model is trained. Use
69
- * this to make sure that events that could cause unusual values for the metric, such as
70
- * deployments, aren't used when CloudWatch creates the model.</p>
71
- */
36
+
72
37
  ExcludedTimeRanges?: Range[];
73
- /**
74
- * <p>The time zone to use for the metric. This is useful to enable the model to automatically
75
- * account for daylight savings time changes if the metric is sensitive to such time
76
- * changes.</p>
77
- * <p>To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information,
78
- * see <a href="https://en.wikipedia.org/wiki/Tz_database">tz database</a>.</p>
79
- */
38
+
80
39
  MetricTimezone?: string;
81
40
  }
82
41
  export declare namespace AnomalyDetectorConfiguration {
83
- /**
84
- * @internal
85
- */
42
+
86
43
  const filterSensitiveLog: (obj: AnomalyDetectorConfiguration) => any;
87
44
  }
88
- /**
89
- * <p>A dimension is a name/value pair that is part of the identity of a metric. You
90
- * can assign up to 10 dimensions to a metric. Because dimensions are part of the unique
91
- * identifier for a metric, whenever you add a unique name/value pair to one of
92
- * your metrics, you are creating a new variation of that metric. </p>
93
- */
45
+
94
46
  export interface Dimension {
95
- /**
96
- * <p>The name of the dimension. Dimension names must contain only ASCII characters and must include
97
- * at least one non-whitespace character.</p>
98
- */
47
+
99
48
  Name: string | undefined;
100
- /**
101
- * <p>The value of the dimension. Dimension values must contain only ASCII characters and must include
102
- * at least one non-whitespace character.</p>
103
- */
49
+
104
50
  Value: string | undefined;
105
51
  }
106
52
  export declare namespace Dimension {
107
- /**
108
- * @internal
109
- */
53
+
110
54
  const filterSensitiveLog: (obj: Dimension) => any;
111
55
  }
112
56
  export declare type AnomalyDetectorStateValue = "PENDING_TRAINING" | "TRAINED" | "TRAINED_INSUFFICIENT_DATA";
113
- /**
114
- * <p>An anomaly detection model associated with a particular CloudWatch metric and statistic. You
115
- * can use the model to display a band of expected normal values when the metric is
116
- * graphed.</p>
117
- */
57
+
118
58
  export interface AnomalyDetector {
119
- /**
120
- * <p>The namespace of the metric associated with the anomaly detection model.</p>
121
- */
59
+
122
60
  Namespace?: string;
123
- /**
124
- * <p>The name of the metric associated with the anomaly detection model.</p>
125
- */
61
+
126
62
  MetricName?: string;
127
- /**
128
- * <p>The metric dimensions associated with the anomaly detection model.</p>
129
- */
63
+
130
64
  Dimensions?: Dimension[];
131
- /**
132
- * <p>The statistic associated with the anomaly detection model.</p>
133
- */
65
+
134
66
  Stat?: string;
135
- /**
136
- * <p>The configuration specifies details about how the
137
- * anomaly detection model is to be trained, including time ranges to
138
- * exclude from use for training the model, and the time zone to use for
139
- * the metric.</p>
140
- */
67
+
141
68
  Configuration?: AnomalyDetectorConfiguration;
142
- /**
143
- * <p>The current status of the anomaly detector's training. The possible values are <code>TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA</code>
144
- * </p>
145
- */
69
+
146
70
  StateValue?: AnomalyDetectorStateValue | string;
147
71
  }
148
72
  export declare namespace AnomalyDetector {
149
- /**
150
- * @internal
151
- */
73
+
152
74
  const filterSensitiveLog: (obj: AnomalyDetector) => any;
153
75
  }
154
- /**
155
- * <p>This array is empty if the API operation was successful for all the rules specified in the request. If the operation could
156
- * not process one of the rules, the following data is returned for each of those rules.</p>
157
- */
76
+
158
77
  export interface PartialFailure {
159
- /**
160
- * <p>The specified rule that could not be deleted.</p>
161
- */
78
+
162
79
  FailureResource?: string;
163
- /**
164
- * <p>The type of error.</p>
165
- */
80
+
166
81
  ExceptionType?: string;
167
- /**
168
- * <p>The code of the error.</p>
169
- */
82
+
170
83
  FailureCode?: string;
171
- /**
172
- * <p>A description of the error.</p>
173
- */
84
+
174
85
  FailureDescription?: string;
175
86
  }
176
87
  export declare namespace PartialFailure {
177
- /**
178
- * @internal
179
- */
88
+
180
89
  const filterSensitiveLog: (obj: PartialFailure) => any;
181
90
  }
182
91
  export declare type ComparisonOperator = "GreaterThanOrEqualToThreshold" | "GreaterThanThreshold" | "GreaterThanUpperThreshold" | "LessThanLowerOrGreaterThanUpperThreshold" | "LessThanLowerThreshold" | "LessThanOrEqualToThreshold" | "LessThanThreshold";
183
92
  export declare type StateValue = "ALARM" | "INSUFFICIENT_DATA" | "OK";
184
- /**
185
- * <p>The details about a composite alarm.</p>
186
- */
93
+
187
94
  export interface CompositeAlarm {
188
- /**
189
- * <p>Indicates whether actions should be executed during any changes to the alarm state.</p>
190
- */
95
+
191
96
  ActionsEnabled?: boolean;
192
- /**
193
- * <p>The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
194
- */
97
+
195
98
  AlarmActions?: string[];
196
- /**
197
- * <p>The Amazon Resource Name (ARN) of the alarm.</p>
198
- */
99
+
199
100
  AlarmArn?: string;
200
- /**
201
- * <p>The time stamp of the last update to the alarm configuration.</p>
202
- */
101
+
203
102
  AlarmConfigurationUpdatedTimestamp?: Date;
204
- /**
205
- * <p>The description of the alarm.</p>
206
- */
103
+
207
104
  AlarmDescription?: string;
208
- /**
209
- * <p>The name of the alarm.</p>
210
- */
105
+
211
106
  AlarmName?: string;
212
- /**
213
- * <p>The rule that this alarm uses to evaluate its alarm state.</p>
214
- */
107
+
215
108
  AlarmRule?: string;
216
- /**
217
- * <p>The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
218
- */
109
+
219
110
  InsufficientDataActions?: string[];
220
- /**
221
- * <p>The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
222
- */
111
+
223
112
  OKActions?: string[];
224
- /**
225
- * <p>An explanation for the alarm state, in text format.</p>
226
- */
113
+
227
114
  StateReason?: string;
228
- /**
229
- * <p>An explanation for the alarm state, in JSON format.</p>
230
- */
115
+
231
116
  StateReasonData?: string;
232
- /**
233
- * <p>The time stamp of the last update to the alarm state.</p>
234
- */
117
+
235
118
  StateUpdatedTimestamp?: Date;
236
- /**
237
- * <p>The state value for the alarm.</p>
238
- */
119
+
239
120
  StateValue?: StateValue | string;
240
121
  }
241
122
  export declare namespace CompositeAlarm {
242
- /**
243
- * @internal
244
- */
123
+
245
124
  const filterSensitiveLog: (obj: CompositeAlarm) => any;
246
125
  }
247
- /**
248
- * <p>More than one process tried to modify a resource at the same time.</p>
249
- */
126
+
250
127
  export interface ConcurrentModificationException extends __SmithyException, $MetadataBearer {
251
128
  name: "ConcurrentModificationException";
252
129
  $fault: "client";
253
130
  Message?: string;
254
131
  }
255
132
  export declare namespace ConcurrentModificationException {
256
- /**
257
- * @internal
258
- */
133
+
259
134
  const filterSensitiveLog: (obj: ConcurrentModificationException) => any;
260
135
  }
261
- /**
262
- * <p>Represents a specific dashboard.</p>
263
- */
136
+
264
137
  export interface DashboardEntry {
265
- /**
266
- * <p>The name of the dashboard.</p>
267
- */
138
+
268
139
  DashboardName?: string;
269
- /**
270
- * <p>The Amazon Resource Name (ARN) of the dashboard.</p>
271
- */
140
+
272
141
  DashboardArn?: string;
273
- /**
274
- * <p>The time stamp of when the dashboard was last modified, either by an API call or
275
- * through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>
276
- */
142
+
277
143
  LastModified?: Date;
278
- /**
279
- * <p>The size of the dashboard, in bytes.</p>
280
- */
144
+
281
145
  Size?: number;
282
146
  }
283
147
  export declare namespace DashboardEntry {
284
- /**
285
- * @internal
286
- */
148
+
287
149
  const filterSensitiveLog: (obj: DashboardEntry) => any;
288
150
  }
289
- /**
290
- * <p>An error or warning for the operation.</p>
291
- */
151
+
292
152
  export interface DashboardValidationMessage {
293
- /**
294
- * <p>The data path related to the message.</p>
295
- */
153
+
296
154
  DataPath?: string;
297
- /**
298
- * <p>A message describing the error or warning.</p>
299
- */
155
+
300
156
  Message?: string;
301
157
  }
302
158
  export declare namespace DashboardValidationMessage {
303
- /**
304
- * @internal
305
- */
159
+
306
160
  const filterSensitiveLog: (obj: DashboardValidationMessage) => any;
307
161
  }
308
- /**
309
- * <p>Some part of the dashboard data is invalid.</p>
310
- */
162
+
311
163
  export interface DashboardInvalidInputError extends __SmithyException, $MetadataBearer {
312
164
  name: "DashboardInvalidInputError";
313
165
  $fault: "client";
@@ -315,187 +167,118 @@ export interface DashboardInvalidInputError extends __SmithyException, $Metadata
315
167
  dashboardValidationMessages?: DashboardValidationMessage[];
316
168
  }
317
169
  export declare namespace DashboardInvalidInputError {
318
- /**
319
- * @internal
320
- */
170
+
321
171
  const filterSensitiveLog: (obj: DashboardInvalidInputError) => any;
322
172
  }
323
- /**
324
- * <p>The specified dashboard does not exist.</p>
325
- */
173
+
326
174
  export interface DashboardNotFoundError extends __SmithyException, $MetadataBearer {
327
175
  name: "DashboardNotFoundError";
328
176
  $fault: "client";
329
177
  message?: string;
330
178
  }
331
179
  export declare namespace DashboardNotFoundError {
332
- /**
333
- * @internal
334
- */
180
+
335
181
  const filterSensitiveLog: (obj: DashboardNotFoundError) => any;
336
182
  }
337
183
  export declare type StandardUnit = "Bits" | "Bits/Second" | "Bytes" | "Bytes/Second" | "Count" | "Count/Second" | "Gigabits" | "Gigabits/Second" | "Gigabytes" | "Gigabytes/Second" | "Kilobits" | "Kilobits/Second" | "Kilobytes" | "Kilobytes/Second" | "Megabits" | "Megabits/Second" | "Megabytes" | "Megabytes/Second" | "Microseconds" | "Milliseconds" | "None" | "Percent" | "Seconds" | "Terabits" | "Terabits/Second" | "Terabytes" | "Terabytes/Second";
338
- /**
339
- * <p>Encapsulates the statistical data that CloudWatch computes from metric data.</p>
340
- */
184
+
341
185
  export interface Datapoint {
342
- /**
343
- * <p>The time stamp used for the data point.</p>
344
- */
186
+
345
187
  Timestamp?: Date;
346
- /**
347
- * <p>The number of metric values that contributed to the aggregate value of this
348
- * data point.</p>
349
- */
188
+
350
189
  SampleCount?: number;
351
- /**
352
- * <p>The average of the metric values that correspond to the data point.</p>
353
- */
190
+
354
191
  Average?: number;
355
- /**
356
- * <p>The sum of the metric values for the data point.</p>
357
- */
192
+
358
193
  Sum?: number;
359
- /**
360
- * <p>The minimum metric value for the data point.</p>
361
- */
194
+
362
195
  Minimum?: number;
363
- /**
364
- * <p>The maximum metric value for the data point.</p>
365
- */
196
+
366
197
  Maximum?: number;
367
- /**
368
- * <p>The standard unit for the data point.</p>
369
- */
198
+
370
199
  Unit?: StandardUnit | string;
371
- /**
372
- * <p>The percentile statistic for the data point.</p>
373
- */
200
+
374
201
  ExtendedStatistics?: {
375
202
  [key: string]: number;
376
203
  };
377
204
  }
378
205
  export declare namespace Datapoint {
379
- /**
380
- * @internal
381
- */
206
+
382
207
  const filterSensitiveLog: (obj: Datapoint) => any;
383
208
  }
384
209
  export interface DeleteAlarmsInput {
385
- /**
386
- * <p>The alarms to be deleted.</p>
387
- */
210
+
388
211
  AlarmNames: string[] | undefined;
389
212
  }
390
213
  export declare namespace DeleteAlarmsInput {
391
- /**
392
- * @internal
393
- */
214
+
394
215
  const filterSensitiveLog: (obj: DeleteAlarmsInput) => any;
395
216
  }
396
- /**
397
- * <p>The named resource does not exist.</p>
398
- */
217
+
399
218
  export interface ResourceNotFound extends __SmithyException, $MetadataBearer {
400
219
  name: "ResourceNotFound";
401
220
  $fault: "client";
402
- /**
403
- * <p></p>
404
- */
221
+
405
222
  message?: string;
406
223
  }
407
224
  export declare namespace ResourceNotFound {
408
- /**
409
- * @internal
410
- */
225
+
411
226
  const filterSensitiveLog: (obj: ResourceNotFound) => any;
412
227
  }
413
228
  export interface DeleteAnomalyDetectorInput {
414
- /**
415
- * <p>The namespace associated with the anomaly detection model to delete.</p>
416
- */
229
+
417
230
  Namespace: string | undefined;
418
- /**
419
- * <p>The metric name associated with the anomaly detection model to delete.</p>
420
- */
231
+
421
232
  MetricName: string | undefined;
422
- /**
423
- * <p>The metric dimensions associated with the anomaly detection model to delete.</p>
424
- */
233
+
425
234
  Dimensions?: Dimension[];
426
- /**
427
- * <p>The statistic associated with the anomaly detection model to delete.</p>
428
- */
235
+
429
236
  Stat: string | undefined;
430
237
  }
431
238
  export declare namespace DeleteAnomalyDetectorInput {
432
- /**
433
- * @internal
434
- */
239
+
435
240
  const filterSensitiveLog: (obj: DeleteAnomalyDetectorInput) => any;
436
241
  }
437
242
  export interface DeleteAnomalyDetectorOutput {
438
243
  }
439
244
  export declare namespace DeleteAnomalyDetectorOutput {
440
- /**
441
- * @internal
442
- */
245
+
443
246
  const filterSensitiveLog: (obj: DeleteAnomalyDetectorOutput) => any;
444
247
  }
445
- /**
446
- * <p>Request processing has failed due to some unknown error, exception, or failure.</p>
447
- */
248
+
448
249
  export interface InternalServiceFault extends __SmithyException, $MetadataBearer {
449
250
  name: "InternalServiceFault";
450
251
  $fault: "server";
451
- /**
452
- * <p></p>
453
- */
252
+
454
253
  Message?: string;
455
254
  }
456
255
  export declare namespace InternalServiceFault {
457
- /**
458
- * @internal
459
- */
256
+
460
257
  const filterSensitiveLog: (obj: InternalServiceFault) => any;
461
258
  }
462
- /**
463
- * <p>The value of an input parameter is bad or out-of-range.</p>
464
- */
259
+
465
260
  export interface InvalidParameterValueException extends __SmithyException, $MetadataBearer {
466
261
  name: "InvalidParameterValueException";
467
262
  $fault: "client";
468
- /**
469
- * <p></p>
470
- */
263
+
471
264
  message?: string;
472
265
  }
473
266
  export declare namespace InvalidParameterValueException {
474
- /**
475
- * @internal
476
- */
267
+
477
268
  const filterSensitiveLog: (obj: InvalidParameterValueException) => any;
478
269
  }
479
- /**
480
- * <p>An input parameter that is required is missing.</p>
481
- */
270
+
482
271
  export interface MissingRequiredParameterException extends __SmithyException, $MetadataBearer {
483
272
  name: "MissingRequiredParameterException";
484
273
  $fault: "client";
485
- /**
486
- * <p></p>
487
- */
274
+
488
275
  message?: string;
489
276
  }
490
277
  export declare namespace MissingRequiredParameterException {
491
- /**
492
- * @internal
493
- */
278
+
494
279
  const filterSensitiveLog: (obj: MissingRequiredParameterException) => any;
495
280
  }
496
- /**
497
- * <p>The named resource does not exist.</p>
498
- */
281
+
499
282
  export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
500
283
  name: "ResourceNotFoundException";
501
284
  $fault: "client";
@@ -504,73 +287,51 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB
504
287
  Message?: string;
505
288
  }
506
289
  export declare namespace ResourceNotFoundException {
507
- /**
508
- * @internal
509
- */
290
+
510
291
  const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
511
292
  }
512
293
  export interface DeleteDashboardsInput {
513
- /**
514
- * <p>The dashboards to be deleted. This parameter is required.</p>
515
- */
294
+
516
295
  DashboardNames: string[] | undefined;
517
296
  }
518
297
  export declare namespace DeleteDashboardsInput {
519
- /**
520
- * @internal
521
- */
298
+
522
299
  const filterSensitiveLog: (obj: DeleteDashboardsInput) => any;
523
300
  }
524
301
  export interface DeleteDashboardsOutput {
525
302
  }
526
303
  export declare namespace DeleteDashboardsOutput {
527
- /**
528
- * @internal
529
- */
304
+
530
305
  const filterSensitiveLog: (obj: DeleteDashboardsOutput) => any;
531
306
  }
532
307
  export interface DeleteInsightRulesInput {
533
- /**
534
- * <p>An array of the rule names to delete. If you need to find out the names of your rules, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html">DescribeInsightRules</a>.</p>
535
- */
308
+
536
309
  RuleNames: string[] | undefined;
537
310
  }
538
311
  export declare namespace DeleteInsightRulesInput {
539
- /**
540
- * @internal
541
- */
312
+
542
313
  const filterSensitiveLog: (obj: DeleteInsightRulesInput) => any;
543
314
  }
544
315
  export interface DeleteInsightRulesOutput {
545
- /**
546
- * <p>An array listing the rules that could not be deleted. You cannot delete built-in rules.</p>
547
- */
316
+
548
317
  Failures?: PartialFailure[];
549
318
  }
550
319
  export declare namespace DeleteInsightRulesOutput {
551
- /**
552
- * @internal
553
- */
320
+
554
321
  const filterSensitiveLog: (obj: DeleteInsightRulesOutput) => any;
555
322
  }
556
323
  export interface DeleteMetricStreamInput {
557
- /**
558
- * <p>The name of the metric stream to delete.</p>
559
- */
324
+
560
325
  Name: string | undefined;
561
326
  }
562
327
  export declare namespace DeleteMetricStreamInput {
563
- /**
564
- * @internal
565
- */
328
+
566
329
  const filterSensitiveLog: (obj: DeleteMetricStreamInput) => any;
567
330
  }
568
331
  export interface DeleteMetricStreamOutput {
569
332
  }
570
333
  export declare namespace DeleteMetricStreamOutput {
571
- /**
572
- * @internal
573
- */
334
+
574
335
  const filterSensitiveLog: (obj: DeleteMetricStreamOutput) => any;
575
336
  }
576
337
  export declare enum ScanBy {
@@ -578,1121 +339,496 @@ export declare enum ScanBy {
578
339
  TIMESTAMP_DESCENDING = "TimestampDescending"
579
340
  }
580
341
  export interface DescribeAlarmHistoryInput {
581
- /**
582
- * <p>The name of the alarm.</p>
583
- */
342
+
584
343
  AlarmName?: string;
585
- /**
586
- * <p>Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter,
587
- * only metric alarms are returned.</p>
588
- */
344
+
589
345
  AlarmTypes?: (AlarmType | string)[];
590
- /**
591
- * <p>The type of alarm histories to retrieve.</p>
592
- */
346
+
593
347
  HistoryItemType?: HistoryItemType | string;
594
- /**
595
- * <p>The starting date to retrieve alarm history.</p>
596
- */
348
+
597
349
  StartDate?: Date;
598
- /**
599
- * <p>The ending date to retrieve alarm history.</p>
600
- */
350
+
601
351
  EndDate?: Date;
602
- /**
603
- * <p>The maximum number of alarm history records to retrieve.</p>
604
- */
352
+
605
353
  MaxRecords?: number;
606
- /**
607
- * <p>The token returned by a previous call to indicate that there is more data
608
- * available.</p>
609
- */
354
+
610
355
  NextToken?: string;
611
- /**
612
- * <p>Specified whether to return the newest or oldest alarm history first. Specify <code>TimestampDescending</code> to have the newest
613
- * event history returned first, and specify <code>TimestampAscending</code> to have the oldest history returned first.</p>
614
- */
356
+
615
357
  ScanBy?: ScanBy | string;
616
358
  }
617
359
  export declare namespace DescribeAlarmHistoryInput {
618
- /**
619
- * @internal
620
- */
360
+
621
361
  const filterSensitiveLog: (obj: DescribeAlarmHistoryInput) => any;
622
362
  }
623
363
  export interface DescribeAlarmHistoryOutput {
624
- /**
625
- * <p>The alarm histories, in JSON format.</p>
626
- */
364
+
627
365
  AlarmHistoryItems?: AlarmHistoryItem[];
628
- /**
629
- * <p>The token that marks the start of the next batch of returned results.</p>
630
- */
366
+
631
367
  NextToken?: string;
632
368
  }
633
369
  export declare namespace DescribeAlarmHistoryOutput {
634
- /**
635
- * @internal
636
- */
370
+
637
371
  const filterSensitiveLog: (obj: DescribeAlarmHistoryOutput) => any;
638
372
  }
639
- /**
640
- * <p>The next token specified is invalid.</p>
641
- */
373
+
642
374
  export interface InvalidNextToken extends __SmithyException, $MetadataBearer {
643
375
  name: "InvalidNextToken";
644
376
  $fault: "client";
645
- /**
646
- * <p></p>
647
- */
377
+
648
378
  message?: string;
649
379
  }
650
380
  export declare namespace InvalidNextToken {
651
- /**
652
- * @internal
653
- */
381
+
654
382
  const filterSensitiveLog: (obj: InvalidNextToken) => any;
655
383
  }
656
384
  export interface DescribeAlarmsInput {
657
- /**
658
- * <p>The names of the alarms to retrieve information about.</p>
659
- */
385
+
660
386
  AlarmNames?: string[];
661
- /**
662
- * <p>An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names
663
- * that start with this prefix.</p>
664
- * <p>If this parameter
665
- * is specified, you cannot specify <code>AlarmNames</code>.</p>
666
- */
387
+
667
388
  AlarmNamePrefix?: string;
668
- /**
669
- * <p>Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter,
670
- * only metric alarms are returned.</p>
671
- */
389
+
672
390
  AlarmTypes?: (AlarmType | string)[];
673
- /**
674
- * <p>If you use this parameter and specify the name of a composite alarm, the operation returns
675
- * information about the "children" alarms
676
- * of the alarm you specify. These are the metric alarms and composite alarms referenced in the
677
- * <code>AlarmRule</code> field of the composite alarm that you specify in
678
- * <code>ChildrenOfAlarmName</code>. Information about the composite alarm that you name in
679
- * <code>ChildrenOfAlarmName</code> is not returned.</p>
680
- * <p>If you specify <code>ChildrenOfAlarmName</code>, you cannot specify any other parameters in the request except
681
- * for <code>MaxRecords</code> and <code>NextToken</code>. If you do so, you
682
- * receive a validation
683
- * error.</p>
684
- * <note>
685
- * <p>Only the <code>Alarm Name</code>, <code>ARN</code>, <code>StateValue</code> (OK/ALARM/INSUFFICIENT_DATA), and <code>StateUpdatedTimestamp</code>
686
- * information are returned by this operation
687
- * when you use this parameter. To get complete information about
688
- * these alarms, perform another <code>DescribeAlarms</code> operation and specify
689
- * the parent alarm names in the <code>AlarmNames</code> parameter.</p>
690
- * </note>
691
- */
391
+
692
392
  ChildrenOfAlarmName?: string;
693
- /**
694
- * <p>If you use this parameter and specify the name of a metric or composite alarm, the operation returns
695
- * information about the "parent" alarms
696
- * of the alarm you specify. These are the composite alarms that have <code>AlarmRule</code>
697
- * parameters that reference
698
- * the alarm named in <code>ParentsOfAlarmName</code>. Information about the alarm that you specify in
699
- * <code>ParentsOfAlarmName</code> is not returned.</p>
700
- * <p>If you specify <code>ParentsOfAlarmName</code>, you cannot specify any other parameters in the request except
701
- * for <code>MaxRecords</code> and <code>NextToken</code>. If you do so, you receive a validation
702
- * error.</p>
703
- * <note>
704
- * <p>Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about
705
- * these alarms, perform another <code>DescribeAlarms</code> operation and specify
706
- * the parent alarm names in the <code>AlarmNames</code> parameter.</p>
707
- * </note>
708
- */
393
+
709
394
  ParentsOfAlarmName?: string;
710
- /**
711
- * <p>Specify this parameter to receive information only about alarms that are currently in the state that you specify.</p>
712
- */
395
+
713
396
  StateValue?: StateValue | string;
714
- /**
715
- * <p>Use this parameter to filter the results of the operation to only those alarms that
716
- * use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all
717
- * alarms that send notifications to that topic.</p>
718
- */
397
+
719
398
  ActionPrefix?: string;
720
- /**
721
- * <p>The maximum number of alarm descriptions to retrieve.</p>
722
- */
399
+
723
400
  MaxRecords?: number;
724
- /**
725
- * <p>The token returned by a previous call to indicate that there is more data
726
- * available.</p>
727
- */
401
+
728
402
  NextToken?: string;
729
403
  }
730
404
  export declare namespace DescribeAlarmsInput {
731
- /**
732
- * @internal
733
- */
405
+
734
406
  const filterSensitiveLog: (obj: DescribeAlarmsInput) => any;
735
407
  }
736
- /**
737
- * <p>Represents a specific metric.</p>
738
- */
408
+
739
409
  export interface Metric {
740
- /**
741
- * <p>The namespace of the metric.</p>
742
- */
410
+
743
411
  Namespace?: string;
744
- /**
745
- * <p>The name of the metric. This is a required field.</p>
746
- */
412
+
747
413
  MetricName?: string;
748
- /**
749
- * <p>The dimensions for the metric.</p>
750
- */
414
+
751
415
  Dimensions?: Dimension[];
752
416
  }
753
417
  export declare namespace Metric {
754
- /**
755
- * @internal
756
- */
418
+
757
419
  const filterSensitiveLog: (obj: Metric) => any;
758
420
  }
759
- /**
760
- * <p>This structure defines the metric to be returned, along with the statistics, period, and units.</p>
761
- */
421
+
762
422
  export interface MetricStat {
763
- /**
764
- * <p>The metric to return, including the metric name, namespace, and dimensions.</p>
765
- */
423
+
766
424
  Metric: Metric | undefined;
767
- /**
768
- * <p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can
769
- * be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected
770
- * at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics
771
- * are those metrics stored by a <code>PutMetricData</code> call that includes a <code>StorageResolution</code> of 1 second.</p>
772
- * <p>If the <code>StartTime</code> parameter specifies a time stamp that is greater than
773
- * 3 hours ago, you must specify the period as follows or no data points in that time range is returned:</p>
774
- * <ul>
775
- * <li>
776
- * <p>Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).</p>
777
- * </li>
778
- * <li>
779
- * <p>Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).</p>
780
- * </li>
781
- * <li>
782
- * <p>Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).</p>
783
- * </li>
784
- * </ul>
785
- */
425
+
786
426
  Period: number | undefined;
787
- /**
788
- * <p>The statistic to return. It can include any CloudWatch statistic or extended statistic.</p>
789
- */
427
+
790
428
  Stat: string | undefined;
791
- /**
792
- * <p>When you are using a <code>Put</code> operation, this defines what unit you want to use when storing the metric.</p>
793
- * <p>In a <code>Get</code> operation, if you omit <code>Unit</code> then all data that was collected with any unit is returned, along with the corresponding units that were specified
794
- * when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
795
- * If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>
796
- */
429
+
797
430
  Unit?: StandardUnit | string;
798
431
  }
799
432
  export declare namespace MetricStat {
800
- /**
801
- * @internal
802
- */
433
+
803
434
  const filterSensitiveLog: (obj: MetricStat) => any;
804
435
  }
805
- /**
806
- * <p>This structure is used in both <code>GetMetricData</code> and <code>PutMetricAlarm</code>. The supported
807
- * use of this structure is different for those two operations.</p>
808
- * <p>When used in <code>GetMetricData</code>, it indicates the metric data to return, and whether this call is just retrieving
809
- * a batch set of data for one metric, or is performing a math expression on metric data. A
810
- * single <code>GetMetricData</code> call can include up to 500 <code>MetricDataQuery</code>
811
- * structures.</p>
812
- * <p>When used in <code>PutMetricAlarm</code>, it enables you to create an alarm based on a
813
- * metric math expression. Each <code>MetricDataQuery</code> in the array specifies either
814
- * a metric to retrieve, or a math expression to be performed on retrieved metrics. A
815
- * single <code>PutMetricAlarm</code> call can include up to 20
816
- * <code>MetricDataQuery</code> structures in the array. The 20 structures can include
817
- * as many as 10 structures that contain a <code>MetricStat</code> parameter to retrieve a
818
- * metric, and as many as 10 structures that contain the <code>Expression</code> parameter
819
- * to perform a math expression. Of those <code>Expression</code> structures, one must have <code>True</code>
820
- * as the value for <code>ReturnData</code>. The result of this expression is the value the alarm watches.</p>
821
- *
822
- * <p>Any expression used in a <code>PutMetricAlarm</code>
823
- * operation must return a single time series. For more information, 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
824
- * Guide</i>.</p>
825
- *
826
- * <p>Some of the parameters of this structure also have different uses whether you are using this structure in a <code>GetMetricData</code>
827
- * operation or a <code>PutMetricAlarm</code> operation. These differences are explained in the following parameter list.</p>
828
- */
436
+
829
437
  export interface MetricDataQuery {
830
- /**
831
- * <p>A short name used to tie this object to the results in the response. This name must be
832
- * unique within a single call to <code>GetMetricData</code>. If you are performing math
833
- * expressions on this set of data, this name represents that data and can serve as a
834
- * variable in the mathematical expression. The valid characters are letters, numbers, and
835
- * underscore. The first character must be a lowercase letter.</p>
836
- */
438
+
837
439
  Id: string | undefined;
838
- /**
839
- * <p>The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric
840
- * and not performing a math expression on returned data.</p>
841
- * <p>Within one MetricDataQuery object, you must specify either
842
- * <code>Expression</code> or <code>MetricStat</code> but not both.</p>
843
- */
440
+
844
441
  MetricStat?: MetricStat;
845
- /**
846
- * <p>The math expression to be performed on the returned data, if this object is performing a math expression. This expression
847
- * can use the <code>Id</code> of the other metrics to refer to those metrics, and can also use the <code>Id</code> of other
848
- * expressions to use the result of those expressions. For more information about metric math expressions, see
849
- * <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
850
- * <i>Amazon CloudWatch User Guide</i>.</p>
851
- * <p>Within each MetricDataQuery object, you must specify either
852
- * <code>Expression</code> or <code>MetricStat</code> but not both.</p>
853
- */
442
+
854
443
  Expression?: string;
855
- /**
856
- * <p>A human-readable label for this metric or expression. This is especially useful
857
- * if this is an expression, so that you know
858
- * what the value represents. If the metric or expression is shown in a
859
- * CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch
860
- * generates a default.</p>
861
- * <p>You can put dynamic expressions into a label, so that it is more descriptive.
862
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html">Using Dynamic Labels</a>.</p>
863
- */
444
+
864
445
  Label?: string;
865
- /**
866
- * <p>When used in <code>GetMetricData</code>, this option indicates whether to return the
867
- * timestamps and raw data values of this metric. If you are performing this call just to
868
- * do math expressions and do not also need the raw data returned, you can specify
869
- * <code>False</code>. If you omit this, the default of <code>True</code> is
870
- * used.</p>
871
- * <p>When used in <code>PutMetricAlarm</code>, specify <code>True</code> for the one expression result to use as the alarm. For all
872
- * other metrics and expressions in the same <code>PutMetricAlarm</code> operation, specify <code>ReturnData</code> as False.</p>
873
- */
446
+
874
447
  ReturnData?: boolean;
875
- /**
876
- * <p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a
877
- * period can be as short as one minute (60 seconds) and must be a multiple of 60.
878
- * For high-resolution metrics that are collected at intervals of less than one minute,
879
- * the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics
880
- * stored by a <code>PutMetricData</code> operation that includes a <code>StorageResolution of 1 second</code>.</p>
881
- */
448
+
882
449
  Period?: number;
883
- /**
884
- * <p>The ID of the account where the metrics are located, if this is a cross-account alarm.</p>
885
- * <p>Use this field only for <code>PutMetricAlarm</code> operations. It is not used in
886
- * <code>GetMetricData</code> operations.</p>
887
- */
450
+
888
451
  AccountId?: string;
889
452
  }
890
453
  export declare namespace MetricDataQuery {
891
- /**
892
- * @internal
893
- */
454
+
894
455
  const filterSensitiveLog: (obj: MetricDataQuery) => any;
895
456
  }
896
457
  export declare type Statistic = "Average" | "Maximum" | "Minimum" | "SampleCount" | "Sum";
897
- /**
898
- * <p>The details about a metric alarm.</p>
899
- */
458
+
900
459
  export interface MetricAlarm {
901
- /**
902
- * <p>The name of the alarm.</p>
903
- */
460
+
904
461
  AlarmName?: string;
905
- /**
906
- * <p>The Amazon Resource Name (ARN) of the alarm.</p>
907
- */
462
+
908
463
  AlarmArn?: string;
909
- /**
910
- * <p>The description of the alarm.</p>
911
- */
464
+
912
465
  AlarmDescription?: string;
913
- /**
914
- * <p>The time stamp of the last update to the alarm configuration.</p>
915
- */
466
+
916
467
  AlarmConfigurationUpdatedTimestamp?: Date;
917
- /**
918
- * <p>Indicates whether actions should be executed during any changes to the alarm state.</p>
919
- */
468
+
920
469
  ActionsEnabled?: boolean;
921
- /**
922
- * <p>The actions to execute when this alarm transitions to the <code>OK</code> state
923
- * from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
924
- */
470
+
925
471
  OKActions?: string[];
926
- /**
927
- * <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state
928
- * from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
929
- */
472
+
930
473
  AlarmActions?: string[];
931
- /**
932
- * <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state
933
- * from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
934
- */
474
+
935
475
  InsufficientDataActions?: string[];
936
- /**
937
- * <p>The state value for the alarm.</p>
938
- */
476
+
939
477
  StateValue?: StateValue | string;
940
- /**
941
- * <p>An explanation for the alarm state, in text format.</p>
942
- */
478
+
943
479
  StateReason?: string;
944
- /**
945
- * <p>An explanation for the alarm state, in JSON format.</p>
946
- */
480
+
947
481
  StateReasonData?: string;
948
- /**
949
- * <p>The time stamp of the last update to the alarm state.</p>
950
- */
482
+
951
483
  StateUpdatedTimestamp?: Date;
952
- /**
953
- * <p>The name of the metric associated with the alarm, if this is an alarm
954
- * based on a single metric.</p>
955
- */
484
+
956
485
  MetricName?: string;
957
- /**
958
- * <p>The namespace of the metric associated with the alarm.</p>
959
- */
486
+
960
487
  Namespace?: string;
961
- /**
962
- * <p>The statistic for the metric associated with the alarm, other than percentile.
963
- * For percentile statistics, use <code>ExtendedStatistic</code>.</p>
964
- */
488
+
965
489
  Statistic?: Statistic | string;
966
- /**
967
- * <p>The percentile statistic for the metric associated with the alarm. Specify a value between
968
- * p0.0 and p100.</p>
969
- */
490
+
970
491
  ExtendedStatistic?: string;
971
- /**
972
- * <p>The dimensions for the metric associated with the alarm.</p>
973
- */
492
+
974
493
  Dimensions?: Dimension[];
975
- /**
976
- * <p>The period, in seconds, over which the statistic is applied.</p>
977
- */
494
+
978
495
  Period?: number;
979
- /**
980
- * <p>The unit of the metric associated with the alarm.</p>
981
- */
496
+
982
497
  Unit?: StandardUnit | string;
983
- /**
984
- * <p>The number of periods over which data is compared to the specified threshold.</p>
985
- */
498
+
986
499
  EvaluationPeriods?: number;
987
- /**
988
- * <p>The number of data points that must be breaching to trigger the alarm.</p>
989
- */
500
+
990
501
  DatapointsToAlarm?: number;
991
- /**
992
- * <p>The value to compare with the specified statistic.</p>
993
- */
502
+
994
503
  Threshold?: number;
995
- /**
996
- * <p>The arithmetic operation to use when comparing the specified
997
- * statistic and threshold. The specified statistic value is used as the first operand.</p>
998
- */
504
+
999
505
  ComparisonOperator?: ComparisonOperator | string;
1000
- /**
1001
- * <p>Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of <code>missing</code> is used.</p>
1002
- */
506
+
1003
507
  TreatMissingData?: string;
1004
- /**
1005
- * <p>Used only for alarms based on percentiles. If <code>ignore</code>, the alarm state does not change
1006
- * during periods with too few data points to be statistically significant. If <code>evaluate</code> or this
1007
- * parameter is not used, the alarm is always evaluated and possibly changes state no matter
1008
- * how many data points are available.</p>
1009
- */
508
+
1010
509
  EvaluateLowSampleCountPercentile?: string;
1011
- /**
1012
- * <p>An array of MetricDataQuery structures, used in an alarm based on a
1013
- * metric math expression. Each structure either retrieves a
1014
- * metric or performs a math expression.
1015
- *
1016
- * One item in the Metrics array is the math expression that the alarm watches.
1017
- * This expression by designated by having <code>ReturnData</code> set to
1018
- * true.</p>
1019
- */
510
+
1020
511
  Metrics?: MetricDataQuery[];
1021
- /**
1022
- * <p>In an alarm based on an anomaly detection model, this is the ID of the
1023
- * <code>ANOMALY_DETECTION_BAND</code> function
1024
- * used as the threshold for the alarm.</p>
1025
- */
512
+
1026
513
  ThresholdMetricId?: string;
1027
514
  }
1028
515
  export declare namespace MetricAlarm {
1029
- /**
1030
- * @internal
1031
- */
516
+
1032
517
  const filterSensitiveLog: (obj: MetricAlarm) => any;
1033
518
  }
1034
519
  export interface DescribeAlarmsOutput {
1035
- /**
1036
- * <p>The information about any composite alarms returned by the operation.</p>
1037
- */
520
+
1038
521
  CompositeAlarms?: CompositeAlarm[];
1039
- /**
1040
- * <p>The information about any metric alarms returned by the operation.</p>
1041
- */
522
+
1042
523
  MetricAlarms?: MetricAlarm[];
1043
- /**
1044
- * <p>The token that marks the start of the next batch of returned results.</p>
1045
- */
524
+
1046
525
  NextToken?: string;
1047
526
  }
1048
527
  export declare namespace DescribeAlarmsOutput {
1049
- /**
1050
- * @internal
1051
- */
528
+
1052
529
  const filterSensitiveLog: (obj: DescribeAlarmsOutput) => any;
1053
530
  }
1054
531
  export interface DescribeAlarmsForMetricInput {
1055
- /**
1056
- * <p>The name of the metric.</p>
1057
- */
532
+
1058
533
  MetricName: string | undefined;
1059
- /**
1060
- * <p>The namespace of the metric.</p>
1061
- */
534
+
1062
535
  Namespace: string | undefined;
1063
- /**
1064
- * <p>The statistic for the metric, other than percentiles.
1065
- * For percentile statistics, use <code>ExtendedStatistics</code>.</p>
1066
- */
536
+
1067
537
  Statistic?: Statistic | string;
1068
- /**
1069
- * <p>The percentile statistic for the metric. Specify a value between
1070
- * p0.0 and p100.</p>
1071
- */
538
+
1072
539
  ExtendedStatistic?: string;
1073
- /**
1074
- * <p>The dimensions associated with the metric. If the metric has any associated
1075
- * dimensions, you must specify them in order for the call to succeed.</p>
1076
- */
540
+
1077
541
  Dimensions?: Dimension[];
1078
- /**
1079
- * <p>The period, in seconds, over which the statistic is applied.</p>
1080
- */
542
+
1081
543
  Period?: number;
1082
- /**
1083
- * <p>The unit for the metric.</p>
1084
- */
544
+
1085
545
  Unit?: StandardUnit | string;
1086
546
  }
1087
547
  export declare namespace DescribeAlarmsForMetricInput {
1088
- /**
1089
- * @internal
1090
- */
548
+
1091
549
  const filterSensitiveLog: (obj: DescribeAlarmsForMetricInput) => any;
1092
550
  }
1093
551
  export interface DescribeAlarmsForMetricOutput {
1094
- /**
1095
- * <p>The information for each alarm with the specified metric.</p>
1096
- */
552
+
1097
553
  MetricAlarms?: MetricAlarm[];
1098
554
  }
1099
555
  export declare namespace DescribeAlarmsForMetricOutput {
1100
- /**
1101
- * @internal
1102
- */
556
+
1103
557
  const filterSensitiveLog: (obj: DescribeAlarmsForMetricOutput) => any;
1104
558
  }
1105
559
  export interface DescribeAnomalyDetectorsInput {
1106
- /**
1107
- * <p>Use the token returned by the previous operation to request the next page of results.</p>
1108
- */
560
+
1109
561
  NextToken?: string;
1110
- /**
1111
- * <p>The maximum number of results to return in one operation. The maximum
1112
- * value that you can specify is 100.</p>
1113
- * <p>To retrieve the remaining results, make another call with the returned
1114
- * <code>NextToken</code> value. </p>
1115
- */
562
+
1116
563
  MaxResults?: number;
1117
- /**
1118
- * <p>Limits the results to only the anomaly detection models that
1119
- * are associated with the specified namespace.</p>
1120
- */
564
+
1121
565
  Namespace?: string;
1122
- /**
1123
- * <p>Limits the results to only the anomaly detection models that are associated with the
1124
- * specified metric name. If there are multiple metrics with this name in different
1125
- * namespaces that have anomaly detection models, they're all returned.</p>
1126
- */
566
+
1127
567
  MetricName?: string;
1128
- /**
1129
- * <p>Limits the results to only the anomaly detection models that are associated with the
1130
- * specified metric dimensions. If there are multiple metrics that have these dimensions
1131
- * and have anomaly detection models associated, they're all returned.</p>
1132
- */
568
+
1133
569
  Dimensions?: Dimension[];
1134
570
  }
1135
571
  export declare namespace DescribeAnomalyDetectorsInput {
1136
- /**
1137
- * @internal
1138
- */
572
+
1139
573
  const filterSensitiveLog: (obj: DescribeAnomalyDetectorsInput) => any;
1140
574
  }
1141
575
  export interface DescribeAnomalyDetectorsOutput {
1142
- /**
1143
- * <p>The list of anomaly detection models returned by the operation.</p>
1144
- */
576
+
1145
577
  AnomalyDetectors?: AnomalyDetector[];
1146
- /**
1147
- * <p>A token that you can use in a subsequent operation to
1148
- * retrieve the next set of results.</p>
1149
- */
578
+
1150
579
  NextToken?: string;
1151
580
  }
1152
581
  export declare namespace DescribeAnomalyDetectorsOutput {
1153
- /**
1154
- * @internal
1155
- */
582
+
1156
583
  const filterSensitiveLog: (obj: DescribeAnomalyDetectorsOutput) => any;
1157
584
  }
1158
585
  export interface DescribeInsightRulesInput {
1159
- /**
1160
- * <p>Include this value, if it was returned by the previous operation, to get the next set of rules.</p>
1161
- */
586
+
1162
587
  NextToken?: string;
1163
- /**
1164
- * <p>The maximum number of results to return in one operation. If you omit this
1165
- * parameter, the default of 500 is used.</p>
1166
- */
588
+
1167
589
  MaxResults?: number;
1168
590
  }
1169
591
  export declare namespace DescribeInsightRulesInput {
1170
- /**
1171
- * @internal
1172
- */
592
+
1173
593
  const filterSensitiveLog: (obj: DescribeInsightRulesInput) => any;
1174
594
  }
1175
- /**
1176
- * <p>This structure contains the definition for a Contributor Insights rule.</p>
1177
- */
595
+
1178
596
  export interface InsightRule {
1179
- /**
1180
- * <p>The name of the rule.</p>
1181
- */
597
+
1182
598
  Name: string | undefined;
1183
- /**
1184
- * <p>Indicates whether the rule is enabled or disabled.</p>
1185
- */
599
+
1186
600
  State: string | undefined;
1187
- /**
1188
- * <p>For rules that you create, this is always <code>{"Name": "CloudWatchLogRule", "Version": 1}</code>. For built-in rules,
1189
- * this is <code>{"Name": "ServiceLogRule", "Version": 1}</code>
1190
- * </p>
1191
- */
601
+
1192
602
  Schema: string | undefined;
1193
- /**
1194
- * <p>The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors,
1195
- * the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see
1196
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html">Contributor Insights
1197
- * Rule Syntax</a>.</p>
1198
- */
603
+
1199
604
  Definition: string | undefined;
1200
605
  }
1201
606
  export declare namespace InsightRule {
1202
- /**
1203
- * @internal
1204
- */
607
+
1205
608
  const filterSensitiveLog: (obj: InsightRule) => any;
1206
609
  }
1207
610
  export interface DescribeInsightRulesOutput {
1208
- /**
1209
- * <p>If this parameter is present, it is a token that marks the start of the next batch of returned results. </p>
1210
- */
611
+
1211
612
  NextToken?: string;
1212
- /**
1213
- * <p>The rules returned by the operation.</p>
1214
- */
613
+
1215
614
  InsightRules?: InsightRule[];
1216
615
  }
1217
616
  export declare namespace DescribeInsightRulesOutput {
1218
- /**
1219
- * @internal
1220
- */
617
+
1221
618
  const filterSensitiveLog: (obj: DescribeInsightRulesOutput) => any;
1222
619
  }
1223
- /**
1224
- * <p>Represents filters for a dimension.</p>
1225
- */
620
+
1226
621
  export interface DimensionFilter {
1227
- /**
1228
- * <p>The dimension name to be matched.</p>
1229
- */
622
+
1230
623
  Name: string | undefined;
1231
- /**
1232
- * <p>The value of the dimension to be matched.</p>
1233
- */
624
+
1234
625
  Value?: string;
1235
626
  }
1236
627
  export declare namespace DimensionFilter {
1237
- /**
1238
- * @internal
1239
- */
628
+
1240
629
  const filterSensitiveLog: (obj: DimensionFilter) => any;
1241
630
  }
1242
631
  export interface DisableAlarmActionsInput {
1243
- /**
1244
- * <p>The names of the alarms.</p>
1245
- */
632
+
1246
633
  AlarmNames: string[] | undefined;
1247
634
  }
1248
635
  export declare namespace DisableAlarmActionsInput {
1249
- /**
1250
- * @internal
1251
- */
636
+
1252
637
  const filterSensitiveLog: (obj: DisableAlarmActionsInput) => any;
1253
638
  }
1254
639
  export interface DisableInsightRulesInput {
1255
- /**
1256
- * <p>An array of the rule names to disable. If you need to find out the names of your rules, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html">DescribeInsightRules</a>.</p>
1257
- */
640
+
1258
641
  RuleNames: string[] | undefined;
1259
642
  }
1260
643
  export declare namespace DisableInsightRulesInput {
1261
- /**
1262
- * @internal
1263
- */
644
+
1264
645
  const filterSensitiveLog: (obj: DisableInsightRulesInput) => any;
1265
646
  }
1266
647
  export interface DisableInsightRulesOutput {
1267
- /**
1268
- * <p>An array listing the rules that could not be disabled. You cannot disable built-in rules.</p>
1269
- */
648
+
1270
649
  Failures?: PartialFailure[];
1271
650
  }
1272
651
  export declare namespace DisableInsightRulesOutput {
1273
- /**
1274
- * @internal
1275
- */
652
+
1276
653
  const filterSensitiveLog: (obj: DisableInsightRulesOutput) => any;
1277
654
  }
1278
655
  export interface EnableAlarmActionsInput {
1279
- /**
1280
- * <p>The names of the alarms.</p>
1281
- */
656
+
1282
657
  AlarmNames: string[] | undefined;
1283
658
  }
1284
659
  export declare namespace EnableAlarmActionsInput {
1285
- /**
1286
- * @internal
1287
- */
660
+
1288
661
  const filterSensitiveLog: (obj: EnableAlarmActionsInput) => any;
1289
662
  }
1290
663
  export interface EnableInsightRulesInput {
1291
- /**
1292
- * <p>An array of the rule names to enable. If you need to find out the names of your rules, use <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeInsightRules.html">DescribeInsightRules</a>.</p>
1293
- */
664
+
1294
665
  RuleNames: string[] | undefined;
1295
666
  }
1296
667
  export declare namespace EnableInsightRulesInput {
1297
- /**
1298
- * @internal
1299
- */
668
+
1300
669
  const filterSensitiveLog: (obj: EnableInsightRulesInput) => any;
1301
670
  }
1302
671
  export interface EnableInsightRulesOutput {
1303
- /**
1304
- * <p>An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.</p>
1305
- */
672
+
1306
673
  Failures?: PartialFailure[];
1307
674
  }
1308
675
  export declare namespace EnableInsightRulesOutput {
1309
- /**
1310
- * @internal
1311
- */
676
+
1312
677
  const filterSensitiveLog: (obj: EnableInsightRulesOutput) => any;
1313
678
  }
1314
- /**
1315
- * <p>The operation exceeded one or more limits.</p>
1316
- */
679
+
1317
680
  export interface LimitExceededException extends __SmithyException, $MetadataBearer {
1318
681
  name: "LimitExceededException";
1319
682
  $fault: "client";
1320
683
  Message?: string;
1321
684
  }
1322
685
  export declare namespace LimitExceededException {
1323
- /**
1324
- * @internal
1325
- */
686
+
1326
687
  const filterSensitiveLog: (obj: LimitExceededException) => any;
1327
688
  }
1328
689
  export interface GetDashboardInput {
1329
- /**
1330
- * <p>The name of the dashboard to be described.</p>
1331
- */
690
+
1332
691
  DashboardName: string | undefined;
1333
692
  }
1334
693
  export declare namespace GetDashboardInput {
1335
- /**
1336
- * @internal
1337
- */
694
+
1338
695
  const filterSensitiveLog: (obj: GetDashboardInput) => any;
1339
696
  }
1340
697
  export interface GetDashboardOutput {
1341
- /**
1342
- * <p>The Amazon Resource Name (ARN) of the dashboard.</p>
1343
- */
698
+
1344
699
  DashboardArn?: string;
1345
- /**
1346
- * <p>The detailed information about the dashboard, including what widgets are included and their location
1347
- * on the dashboard. For more information about the <code>DashboardBody</code> syntax,
1348
- * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html">Dashboard Body Structure and Syntax</a>. </p>
1349
- */
700
+
1350
701
  DashboardBody?: string;
1351
- /**
1352
- * <p>The name of the dashboard.</p>
1353
- */
702
+
1354
703
  DashboardName?: string;
1355
704
  }
1356
705
  export declare namespace GetDashboardOutput {
1357
- /**
1358
- * @internal
1359
- */
706
+
1360
707
  const filterSensitiveLog: (obj: GetDashboardOutput) => any;
1361
708
  }
1362
709
  export interface GetInsightRuleReportInput {
1363
- /**
1364
- * <p>The name of the rule that you want to see data from.</p>
1365
- */
710
+
1366
711
  RuleName: string | undefined;
1367
- /**
1368
- * <p>The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
1369
- * <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
1370
- * <code>2019-07-01T23:59:59</code>.</p>
1371
- */
712
+
1372
713
  StartTime: Date | undefined;
1373
- /**
1374
- * <p>The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
1375
- * <code>yyyy-MM-dd'T'HH:mm:ss</code>. For example,
1376
- * <code>2019-07-01T23:59:59</code>.</p>
1377
- */
714
+
1378
715
  EndTime: Date | undefined;
1379
- /**
1380
- * <p>The period, in seconds, to use for the statistics in the <code>InsightRuleMetricDatapoint</code> results.</p>
1381
- */
716
+
1382
717
  Period: number | undefined;
1383
- /**
1384
- * <p>The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default of 10 is used.</p>
1385
- */
718
+
1386
719
  MaxContributorCount?: number;
1387
- /**
1388
- * <p>Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more
1389
- * of the following metrics:</p>
1390
- * <ul>
1391
- * <li>
1392
- * <p>
1393
- * <code>UniqueContributors</code> -- the number of unique contributors for each data point.</p>
1394
- * </li>
1395
- * <li>
1396
- * <p>
1397
- * <code>MaxContributorValue</code> -- the value of the top contributor for each data point. The identity of the
1398
- * contributor might change for each data point in the graph.</p>
1399
- * <p>If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the
1400
- * most occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the highest sum in the log field specified
1401
- * by the rule's <code>Value</code>, during that period.</p>
1402
- * </li>
1403
- * <li>
1404
- * <p>
1405
- * <code>SampleCount</code> -- the number of data points matched by the rule.</p>
1406
- * </li>
1407
- * <li>
1408
- * <p>
1409
- * <code>Sum</code> -- the sum of the values from all contributors during the time period represented by that data point.</p>
1410
- * </li>
1411
- * <li>
1412
- * <p>
1413
- * <code>Minimum</code> -- the minimum value from a single observation during the time period represented by that data point.</p>
1414
- * </li>
1415
- * <li>
1416
- * <p>
1417
- * <code>Maximum</code> -- the maximum value from a single observation during the time period represented by that data point.</p>
1418
- * </li>
1419
- * <li>
1420
- * <p>
1421
- * <code>Average</code> -- the average value from all contributors during the time period represented by that data point.</p>
1422
- * </li>
1423
- * </ul>
1424
- */
720
+
1425
721
  Metrics?: string[];
1426
- /**
1427
- * <p>Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.</p>
1428
- */
722
+
1429
723
  OrderBy?: string;
1430
724
  }
1431
725
  export declare namespace GetInsightRuleReportInput {
1432
- /**
1433
- * @internal
1434
- */
726
+
1435
727
  const filterSensitiveLog: (obj: GetInsightRuleReportInput) => any;
1436
728
  }
1437
- /**
1438
- * <p>One data point related to one contributor.</p>
1439
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html">GetInsightRuleReport</a> and
1440
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_InsightRuleContributor.html">InsightRuleContributor</a>.</p>
1441
- */
729
+
1442
730
  export interface InsightRuleContributorDatapoint {
1443
- /**
1444
- * <p>The timestamp of the data point.</p>
1445
- */
731
+
1446
732
  Timestamp: Date | undefined;
1447
- /**
1448
- * <p>The approximate value that this contributor added during this timestamp.</p>
1449
- */
733
+
1450
734
  ApproximateValue: number | undefined;
1451
735
  }
1452
736
  export declare namespace InsightRuleContributorDatapoint {
1453
- /**
1454
- * @internal
1455
- */
737
+
1456
738
  const filterSensitiveLog: (obj: InsightRuleContributorDatapoint) => any;
1457
739
  }
1458
- /**
1459
- * <p>One of the unique contributors found by a Contributor Insights rule. If the rule contains multiple keys, then
1460
- * a unique contributor is a unique combination of values from all the keys in the rule.</p>
1461
- * <p>If the rule contains a single key, then each unique contributor is each unique value for this key.</p>
1462
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html">GetInsightRuleReport</a>.</p>
1463
- */
740
+
1464
741
  export interface InsightRuleContributor {
1465
- /**
1466
- * <p>One of the log entry field keywords that is used to define contributors for this rule.</p>
1467
- */
742
+
1468
743
  Keys: string[] | undefined;
1469
- /**
1470
- * <p>An approximation of the aggregate value that comes from this contributor.</p>
1471
- */
744
+
1472
745
  ApproximateAggregateValue: number | undefined;
1473
- /**
1474
- * <p>An array of the data points where this contributor is present. Only the data points when this contributor appeared are included in the array.</p>
1475
- */
746
+
1476
747
  Datapoints: InsightRuleContributorDatapoint[] | undefined;
1477
748
  }
1478
749
  export declare namespace InsightRuleContributor {
1479
- /**
1480
- * @internal
1481
- */
750
+
1482
751
  const filterSensitiveLog: (obj: InsightRuleContributor) => any;
1483
752
  }
1484
- /**
1485
- * <p>One data point from the metric time series returned in a Contributor Insights rule report.</p>
1486
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetInsightRuleReport.html">GetInsightRuleReport</a>.</p>
1487
- */
753
+
1488
754
  export interface InsightRuleMetricDatapoint {
1489
- /**
1490
- * <p>The timestamp of the data point.</p>
1491
- */
755
+
1492
756
  Timestamp: Date | undefined;
1493
- /**
1494
- * <p>The number of unique contributors who published data during this timestamp.</p>
1495
- * <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
1496
- */
757
+
1497
758
  UniqueContributors?: number;
1498
- /**
1499
- * <p>The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately,
1500
- * so the identity of the max contributor
1501
- * could be different for each timestamp.</p>
1502
- * <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
1503
- */
759
+
1504
760
  MaxContributorValue?: number;
1505
- /**
1506
- * <p>The number of occurrences that matched the rule during this data point.</p>
1507
- * <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
1508
- */
761
+
1509
762
  SampleCount?: number;
1510
- /**
1511
- * <p>The average value from all contributors during the time period represented by that data point.</p>
1512
- * <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
1513
- */
763
+
1514
764
  Average?: number;
1515
- /**
1516
- * <p>The sum of the values from all contributors during the time period represented by that data point.</p>
1517
- * <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
1518
- */
765
+
1519
766
  Sum?: number;
1520
- /**
1521
- * <p>The minimum value from a single contributor during the time period represented by that data point.</p>
1522
- * <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
1523
- */
767
+
1524
768
  Minimum?: number;
1525
- /**
1526
- * <p>The maximum value from a single occurence from a single contributor during the time period represented by that data point.</p>
1527
- * <p>This statistic is returned only if you included it in the <code>Metrics</code> array in your request.</p>
1528
- */
769
+
1529
770
  Maximum?: number;
1530
771
  }
1531
772
  export declare namespace InsightRuleMetricDatapoint {
1532
- /**
1533
- * @internal
1534
- */
773
+
1535
774
  const filterSensitiveLog: (obj: InsightRuleMetricDatapoint) => any;
1536
775
  }
1537
776
  export interface GetInsightRuleReportOutput {
1538
- /**
1539
- * <p>An array of the strings used as the keys for this rule. The keys are the dimensions used to classify contributors.
1540
- * If the rule contains more than one key, then each unique combination of values for the keys is counted as a unique contributor.</p>
1541
- */
777
+
1542
778
  KeyLabels?: string[];
1543
- /**
1544
- * <p>Specifies whether this rule aggregates contributor data by COUNT or SUM.</p>
1545
- */
779
+
1546
780
  AggregationStatistic?: string;
1547
- /**
1548
- * <p>The sum of the values from all individual contributors that match the rule.</p>
1549
- */
781
+
1550
782
  AggregateValue?: number;
1551
- /**
1552
- * <p>An approximate count of the unique contributors found by this rule in this time period.</p>
1553
- */
783
+
1554
784
  ApproximateUniqueCount?: number;
1555
- /**
1556
- * <p>An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys, each combination of values
1557
- * for the keys counts as a unique contributor.</p>
1558
- */
785
+
1559
786
  Contributors?: InsightRuleContributor[];
1560
- /**
1561
- * <p>A time series of metric data points that matches the time period in the rule request.</p>
1562
- */
787
+
1563
788
  MetricDatapoints?: InsightRuleMetricDatapoint[];
1564
789
  }
1565
790
  export declare namespace GetInsightRuleReportOutput {
1566
- /**
1567
- * @internal
1568
- */
791
+
1569
792
  const filterSensitiveLog: (obj: GetInsightRuleReportOutput) => any;
1570
793
  }
1571
- /**
1572
- * <p>This structure includes the <code>Timezone</code> parameter, which you can use
1573
- * to specify your time zone so that the labels that are associated with returned metrics display the
1574
- * correct time
1575
- * for your time zone. </p>
1576
- * <p>The <code>Timezone</code> value affects a label only if you have a time-based
1577
- * dynamic expression in the label. For more information about dynamic expressions in labels,
1578
- * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html">Using Dynamic Labels</a>.</p>
1579
- */
794
+
1580
795
  export interface LabelOptions {
1581
- /**
1582
- * <p>The time zone to use for metric data return in this operation.
1583
- * The format is <code>+</code> or <code>-</code> followed by four digits.
1584
- * The first two digits indicate the number of hours ahead or behind of UTC, and
1585
- * the final two digits are the number of minutes. For example, +0130 indicates a time zone that is 1 hour
1586
- * and 30 minutes ahead of UTC. The default is +0000. </p>
1587
- */
796
+
1588
797
  Timezone?: string;
1589
798
  }
1590
799
  export declare namespace LabelOptions {
1591
- /**
1592
- * @internal
1593
- */
800
+
1594
801
  const filterSensitiveLog: (obj: LabelOptions) => any;
1595
802
  }
1596
803
  export interface GetMetricDataInput {
1597
- /**
1598
- * <p>The metric queries to be returned. A single <code>GetMetricData</code> call can include as many as 500 <code>MetricDataQuery</code>
1599
- * structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data. </p>
1600
- */
804
+
1601
805
  MetricDataQueries: MetricDataQuery[] | undefined;
1602
- /**
1603
- * <p>The time stamp indicating the earliest data to be returned.</p>
1604
- * <p>The value specified is inclusive; results include data points with the specified time stamp. </p>
1605
- * <p>CloudWatch rounds the specified time stamp as follows:</p>
1606
- * <ul>
1607
- * <li>
1608
- * <p>Start time less than 15 days ago - Round down to the nearest whole minute.
1609
- * For example, 12:32:34 is rounded down to 12:32:00.</p>
1610
- * </li>
1611
- * <li>
1612
- * <p>Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval.
1613
- * For example, 12:32:34 is rounded down to 12:30:00.</p>
1614
- * </li>
1615
- * <li>
1616
- * <p>Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval.
1617
- * For example, 12:32:34 is rounded down to 12:00:00.</p>
1618
- * </li>
1619
- * </ul>
1620
- * <p>If you set <code>Period</code> to 5, 10, or 30, the start time of your request is
1621
- * rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions
1622
- * of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous
1623
- * 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to
1624
- * 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a
1625
- * period of 5 seconds, you receive data
1626
- * timestamped between 15:02:15 and 15:07:15.
1627
- * </p>
1628
- * <p>For better performance, specify <code>StartTime</code> and <code>EndTime</code>
1629
- * values that align with the value of the metric's <code>Period</code> and sync up with
1630
- * the beginning and end of an hour. For example, if the <code>Period</code> of a metric
1631
- * is 5 minutes, specifying 12:05 or 12:30 as <code>StartTime</code> can get a faster response
1632
- * from CloudWatch than setting 12:07 or 12:29 as the <code>StartTime</code>.</p>
1633
- */
806
+
1634
807
  StartTime: Date | undefined;
1635
- /**
1636
- * <p>The time stamp indicating the latest data to be returned.</p>
1637
- * <p>The value specified is exclusive; results include data points up to the specified time stamp.</p>
1638
- * <p>For better performance, specify <code>StartTime</code> and <code>EndTime</code>
1639
- * values that align with the value of the metric's <code>Period</code> and sync up with
1640
- * the beginning and end of an hour. For example, if the <code>Period</code> of a metric
1641
- * is 5 minutes, specifying 12:05 or 12:30 as <code>EndTime</code> can get a faster response
1642
- * from CloudWatch than setting 12:07 or 12:29 as the <code>EndTime</code>.</p>
1643
- */
808
+
1644
809
  EndTime: Date | undefined;
1645
- /**
1646
- * <p>Include this value, if it was returned by the previous <code>GetMetricData</code> operation,
1647
- * to get the next set of data points.</p>
1648
- */
810
+
1649
811
  NextToken?: string;
1650
- /**
1651
- * <p>The order in which data points should be returned. <code>TimestampDescending</code> returns the newest data first and paginates
1652
- * when the <code>MaxDatapoints</code> limit is reached. <code>TimestampAscending</code> returns the oldest data first and paginates
1653
- * when the <code>MaxDatapoints</code> limit is reached.</p>
1654
- */
812
+
1655
813
  ScanBy?: ScanBy | string;
1656
- /**
1657
- * <p>The maximum number of data points the request should return before paginating. If you omit
1658
- * this, the default of 100,800 is used.</p>
1659
- */
814
+
1660
815
  MaxDatapoints?: number;
1661
- /**
1662
- * <p>This structure includes the <code>Timezone</code> parameter, which you can use
1663
- * to specify your time zone so that the labels of returned data display the
1664
- * correct time
1665
- * for your time zone. </p>
1666
- */
816
+
1667
817
  LabelOptions?: LabelOptions;
1668
818
  }
1669
819
  export declare namespace GetMetricDataInput {
1670
- /**
1671
- * @internal
1672
- */
820
+
1673
821
  const filterSensitiveLog: (obj: GetMetricDataInput) => any;
1674
822
  }
1675
- /**
1676
- * <p>A message returned by the <code>GetMetricData</code>API, including a code and a description.</p>
1677
- * <p>If a cross-Region <code>GetMetricData</code> operation fails with a code of <code>Forbidden</code> and a
1678
- * value of <code>Authentication too complex to
1679
- * retrieve cross region data</code>, you can correct the problem by running the <code>GetMetricData</code>
1680
- * operation in the same Region where the metric data is.</p>
1681
- */
823
+
1682
824
  export interface MessageData {
1683
- /**
1684
- * <p>The error code or status code associated with the message.</p>
1685
- */
825
+
1686
826
  Code?: string;
1687
- /**
1688
- * <p>The message text.</p>
1689
- */
827
+
1690
828
  Value?: string;
1691
829
  }
1692
830
  export declare namespace MessageData {
1693
- /**
1694
- * @internal
1695
- */
831
+
1696
832
  const filterSensitiveLog: (obj: MessageData) => any;
1697
833
  }
1698
834
  export declare enum StatusCode {
@@ -1700,235 +836,97 @@ export declare enum StatusCode {
1700
836
  INTERNAL_ERROR = "InternalError",
1701
837
  PARTIAL_DATA = "PartialData"
1702
838
  }
1703
- /**
1704
- * <p>A <code>GetMetricData</code> call returns an array of <code>MetricDataResult</code>
1705
- * structures. Each of these structures includes the data points for that metric, along
1706
- * with the timestamps of those data points and other identifying information.</p>
1707
- */
839
+
1708
840
  export interface MetricDataResult {
1709
- /**
1710
- * <p>The short name you specified to represent this metric.</p>
1711
- */
841
+
1712
842
  Id?: string;
1713
- /**
1714
- * <p>The human-readable label associated with the data.</p>
1715
- */
843
+
1716
844
  Label?: string;
1717
- /**
1718
- * <p>The timestamps for the data points, formatted in Unix timestamp format. The number of
1719
- * timestamps always matches the number of values and the value for Timestamps[x] is
1720
- * Values[x].</p>
1721
- */
845
+
1722
846
  Timestamps?: Date[];
1723
- /**
1724
- * <p>The data points for the metric corresponding to <code>Timestamps</code>. The number of
1725
- * values always matches the number of timestamps and the timestamp for Values[x] is
1726
- * Timestamps[x].</p>
1727
- */
847
+
1728
848
  Values?: number[];
1729
- /**
1730
- * <p>The status of the returned data. <code>Complete</code> indicates that all data points in the requested time range were returned.
1731
- * <code>PartialData</code> means that an incomplete set of data points were returned.
1732
- * You can use the <code>NextToken</code> value that was returned and repeat your request to get more data points.
1733
- * <code>NextToken</code> is not returned if you are performing a math expression. <code>InternalError</code>
1734
- * indicates that an error occurred. Retry your request using <code>NextToken</code>, if present.</p>
1735
- */
849
+
1736
850
  StatusCode?: StatusCode | string;
1737
- /**
1738
- * <p>A list of messages with additional information about the data returned.</p>
1739
- */
851
+
1740
852
  Messages?: MessageData[];
1741
853
  }
1742
854
  export declare namespace MetricDataResult {
1743
- /**
1744
- * @internal
1745
- */
855
+
1746
856
  const filterSensitiveLog: (obj: MetricDataResult) => any;
1747
857
  }
1748
858
  export interface GetMetricDataOutput {
1749
- /**
1750
- * <p>The metrics that are returned, including the metric name, namespace, and dimensions.</p>
1751
- */
859
+
1752
860
  MetricDataResults?: MetricDataResult[];
1753
- /**
1754
- * <p>A token that marks the next batch of returned results.</p>
1755
- */
861
+
1756
862
  NextToken?: string;
1757
- /**
1758
- * <p>Contains a message about this <code>GetMetricData</code> operation, if the operation results in such a message.
1759
- * An example of a message that
1760
- * might be returned is <code>Maximum number of allowed metrics exceeded</code>. If there is a message, as much of the
1761
- * operation as possible is still executed.</p>
1762
- * <p>A message appears here only if it is related to the global <code>GetMetricData</code> operation. Any message
1763
- * about a specific metric returned by the operation appears in the <code>MetricDataResult</code> object returned for that metric.</p>
1764
- */
863
+
1765
864
  Messages?: MessageData[];
1766
865
  }
1767
866
  export declare namespace GetMetricDataOutput {
1768
- /**
1769
- * @internal
1770
- */
867
+
1771
868
  const filterSensitiveLog: (obj: GetMetricDataOutput) => any;
1772
869
  }
1773
870
  export interface GetMetricStatisticsInput {
1774
- /**
1775
- * <p>The namespace of the metric, with or without spaces.</p>
1776
- */
871
+
1777
872
  Namespace: string | undefined;
1778
- /**
1779
- * <p>The name of the metric, with or without spaces.</p>
1780
- */
873
+
1781
874
  MetricName: string | undefined;
1782
- /**
1783
- * <p>The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension.
1784
- * CloudWatch treats each unique combination of dimensions as a separate metric.
1785
- * If a specific combination of dimensions was not published, you can't retrieve statistics for it.
1786
- * You must specify the same dimensions that were used when the metrics were created. For an example,
1787
- * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations">Dimension Combinations</a> in the <i>Amazon CloudWatch User Guide</i>. For more information about specifying dimensions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html">Publishing Metrics</a> in the
1788
- * <i>Amazon CloudWatch User Guide</i>.</p>
1789
- */
875
+
1790
876
  Dimensions?: Dimension[];
1791
- /**
1792
- * <p>The time stamp that determines the first data point to return. Start times are
1793
- * evaluated relative to the time that CloudWatch receives the request.</p>
1794
- * <p>The value specified is inclusive; results include data points with the specified time stamp.
1795
- * In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).</p>
1796
- * <p>CloudWatch rounds the specified time stamp as follows:</p>
1797
- * <ul>
1798
- * <li>
1799
- * <p>Start time less than 15 days ago - Round down to the nearest whole minute.
1800
- * For example, 12:32:34 is rounded down to 12:32:00.</p>
1801
- * </li>
1802
- * <li>
1803
- * <p>Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval.
1804
- * For example, 12:32:34 is rounded down to 12:30:00.</p>
1805
- * </li>
1806
- * <li>
1807
- * <p>Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval.
1808
- * For example, 12:32:34 is rounded down to 12:00:00.</p>
1809
- * </li>
1810
- * </ul>
1811
- * <p>If you set <code>Period</code> to 5, 10, or 30, the start time of your request is
1812
- * rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions
1813
- * of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous
1814
- * 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to
1815
- * 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a
1816
- * period of 5 seconds, you receive data
1817
- * timestamped between 15:02:15 and 15:07:15.
1818
- * </p>
1819
- */
877
+
1820
878
  StartTime: Date | undefined;
1821
- /**
1822
- * <p>The time stamp that determines the last data point to return.</p>
1823
- * <p>The value specified is exclusive; results include data points up to the specified time stamp.
1824
- * In a raw HTTP query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).</p>
1825
- */
879
+
1826
880
  EndTime: Date | undefined;
1827
- /**
1828
- * <p>The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can
1829
- * be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected
1830
- * at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics
1831
- * are those metrics stored by a <code>PutMetricData</code> call that includes a <code>StorageResolution</code> of 1 second.</p>
1832
- * <p>If the <code>StartTime</code> parameter specifies a time stamp that is greater than
1833
- * 3 hours ago, you must specify the period as follows or no data points in that time range is returned:</p>
1834
- * <ul>
1835
- * <li>
1836
- * <p>Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).</p>
1837
- * </li>
1838
- * <li>
1839
- * <p>Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).</p>
1840
- * </li>
1841
- * <li>
1842
- * <p>Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).</p>
1843
- * </li>
1844
- * </ul>
1845
- */
881
+
1846
882
  Period: number | undefined;
1847
- /**
1848
- * <p>The metric statistics, other than percentile. For percentile statistics,
1849
- * use <code>ExtendedStatistics</code>. When calling <code>GetMetricStatistics</code>, you must
1850
- * specify either <code>Statistics</code> or <code>ExtendedStatistics</code>, but not both.</p>
1851
- */
883
+
1852
884
  Statistics?: (Statistic | string)[];
1853
- /**
1854
- * <p>The percentile statistics. Specify values between p0.0 and p100. When calling <code>GetMetricStatistics</code>, you must
1855
- * specify either <code>Statistics</code> or <code>ExtendedStatistics</code>, but not both. Percentile statistics are not
1856
- * available for metrics when any of the metric values are negative numbers.</p>
1857
- */
885
+
1858
886
  ExtendedStatistics?: string[];
1859
- /**
1860
- * <p>The unit for a given metric.
1861
- * If you omit <code>Unit</code>, all data that was collected with any unit is returned, along with the corresponding units that were specified
1862
- * when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified.
1863
- * If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.</p>
1864
- */
887
+
1865
888
  Unit?: StandardUnit | string;
1866
889
  }
1867
890
  export declare namespace GetMetricStatisticsInput {
1868
- /**
1869
- * @internal
1870
- */
891
+
1871
892
  const filterSensitiveLog: (obj: GetMetricStatisticsInput) => any;
1872
893
  }
1873
894
  export interface GetMetricStatisticsOutput {
1874
- /**
1875
- * <p>A label for the specified metric.</p>
1876
- */
895
+
1877
896
  Label?: string;
1878
- /**
1879
- * <p>The data points for the specified metric.</p>
1880
- */
897
+
1881
898
  Datapoints?: Datapoint[];
1882
899
  }
1883
900
  export declare namespace GetMetricStatisticsOutput {
1884
- /**
1885
- * @internal
1886
- */
901
+
1887
902
  const filterSensitiveLog: (obj: GetMetricStatisticsOutput) => any;
1888
903
  }
1889
- /**
1890
- * <p>Parameters were used together that cannot be used together.</p>
1891
- */
904
+
1892
905
  export interface InvalidParameterCombinationException extends __SmithyException, $MetadataBearer {
1893
906
  name: "InvalidParameterCombinationException";
1894
907
  $fault: "client";
1895
- /**
1896
- * <p></p>
1897
- */
908
+
1898
909
  message?: string;
1899
910
  }
1900
911
  export declare namespace InvalidParameterCombinationException {
1901
- /**
1902
- * @internal
1903
- */
912
+
1904
913
  const filterSensitiveLog: (obj: InvalidParameterCombinationException) => any;
1905
914
  }
1906
915
  export interface GetMetricStreamInput {
1907
- /**
1908
- * <p>The name of the metric stream to retrieve information about.</p>
1909
- */
916
+
1910
917
  Name: string | undefined;
1911
918
  }
1912
919
  export declare namespace GetMetricStreamInput {
1913
- /**
1914
- * @internal
1915
- */
920
+
1916
921
  const filterSensitiveLog: (obj: GetMetricStreamInput) => any;
1917
922
  }
1918
- /**
1919
- * <p>This structure contains the name of one of the metric namespaces that is listed in
1920
- * a filter of a metric stream.</p>
1921
- */
923
+
1922
924
  export interface MetricStreamFilter {
1923
- /**
1924
- * <p>The name of the metric namespace in the filter.</p>
1925
- */
925
+
1926
926
  Namespace?: string;
1927
927
  }
1928
928
  export declare namespace MetricStreamFilter {
1929
- /**
1930
- * @internal
1931
- */
929
+
1932
930
  const filterSensitiveLog: (obj: MetricStreamFilter) => any;
1933
931
  }
1934
932
  export declare enum MetricStreamOutputFormat {
@@ -1936,1209 +934,469 @@ export declare enum MetricStreamOutputFormat {
1936
934
  OPEN_TELEMETRY_0_7 = "opentelemetry0.7"
1937
935
  }
1938
936
  export interface GetMetricStreamOutput {
1939
- /**
1940
- * <p>The ARN of the metric stream.</p>
1941
- */
937
+
1942
938
  Arn?: string;
1943
- /**
1944
- * <p>The name of the metric stream.</p>
1945
- */
939
+
1946
940
  Name?: string;
1947
- /**
1948
- * <p>If this array of metric namespaces is present, then these
1949
- * namespaces are the only
1950
- * metric namespaces that are streamed by this metric stream.</p>
1951
- */
941
+
1952
942
  IncludeFilters?: MetricStreamFilter[];
1953
- /**
1954
- * <p>If this array of metric namespaces is present, then these namespaces are the only
1955
- * metric namespaces that are not streamed by this metric stream. In this case, all other metric namespaces in
1956
- * the account are streamed by this metric stream.</p>
1957
- */
943
+
1958
944
  ExcludeFilters?: MetricStreamFilter[];
1959
- /**
1960
- * <p>The ARN of the Amazon Kinesis Firehose delivery stream that is used by
1961
- * this metric stream.</p>
1962
- */
945
+
1963
946
  FirehoseArn?: string;
1964
- /**
1965
- * <p>The ARN of the IAM role that is used by this metric stream.</p>
1966
- */
947
+
1967
948
  RoleArn?: string;
1968
- /**
1969
- * <p>The state of the metric stream. The possible values are <code>running</code>
1970
- * and <code>stopped</code>.</p>
1971
- */
949
+
1972
950
  State?: string;
1973
- /**
1974
- * <p>The date that the metric stream was created.</p>
1975
- */
951
+
1976
952
  CreationDate?: Date;
1977
- /**
1978
- * <p>The date of the most recent update to the metric stream's configuration.</p>
1979
- */
953
+
1980
954
  LastUpdateDate?: Date;
1981
- /**
1982
- * <p></p>
1983
- */
955
+
1984
956
  OutputFormat?: MetricStreamOutputFormat | string;
1985
957
  }
1986
958
  export declare namespace GetMetricStreamOutput {
1987
- /**
1988
- * @internal
1989
- */
959
+
1990
960
  const filterSensitiveLog: (obj: GetMetricStreamOutput) => any;
1991
961
  }
1992
962
  export interface GetMetricWidgetImageInput {
1993
- /**
1994
- * <p>A JSON string that defines the bitmap graph to be retrieved. The string includes the
1995
- * metrics to include in the graph, statistics, annotations, title, axis limits, and so on.
1996
- * You can include only one <code>MetricWidget</code> parameter in each <code>GetMetricWidgetImage</code> call.</p>
1997
- * <p>For more information about the syntax of <code>MetricWidget</code> see
1998
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Metric-Widget-Structure.html">GetMetricWidgetImage: Metric Widget Structure and Syntax</a>.</p>
1999
- *
2000
- * <p>If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation
2001
- * point appears next to the graph legend.</p>
2002
- */
963
+
2003
964
  MetricWidget: string | undefined;
2004
- /**
2005
- * <p>The format of the resulting image. Only PNG images are supported.</p>
2006
- *
2007
- * <p>The default is <code>png</code>. If you specify <code>png</code>, the API returns an HTTP response with the
2008
- * content-type set to <code>text/xml</code>. The image data is in a <code>MetricWidgetImage</code>
2009
- * field. For example:</p>
2010
- *
2011
- * <p>
2012
- * <code>
2013
- * <GetMetricWidgetImageResponse xmlns=<URLstring>></code>
2014
- * </p>
2015
- * <p>
2016
- * <code> <GetMetricWidgetImageResult></code>
2017
- * </p>
2018
- * <p>
2019
- * <code> <MetricWidgetImage></code>
2020
- * </p>
2021
- * <p>
2022
- * <code> iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...</code>
2023
- * </p>
2024
- * <p>
2025
- * <code> </MetricWidgetImage></code>
2026
- * </p>
2027
- * <p>
2028
- * <code> </GetMetricWidgetImageResult></code>
2029
- * </p>
2030
- * <p>
2031
- * <code> <ResponseMetadata></code>
2032
- * </p>
2033
- * <p>
2034
- * <code> <RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId></code>
2035
- * </p>
2036
- * <p>
2037
- * <code> </ResponseMetadata></code>
2038
- * </p>
2039
- * <p>
2040
- * <code></GetMetricWidgetImageResponse></code>
2041
- * </p>
2042
- *
2043
- * <p>The <code>image/png</code> setting is intended only for custom HTTP requests. For most
2044
- * use cases, and all actions using an Amazon Web Services SDK, you should use <code>png</code>. If you specify
2045
- * <code>image/png</code>, the HTTP response has a content-type set to <code>image/png</code>,
2046
- * and the body of the response is a PNG image. </p>
2047
- */
965
+
2048
966
  OutputFormat?: string;
2049
967
  }
2050
968
  export declare namespace GetMetricWidgetImageInput {
2051
- /**
2052
- * @internal
2053
- */
969
+
2054
970
  const filterSensitiveLog: (obj: GetMetricWidgetImageInput) => any;
2055
971
  }
2056
972
  export interface GetMetricWidgetImageOutput {
2057
- /**
2058
- * <p>The image of the graph, in the output format specified. The output is base64-encoded.</p>
2059
- */
973
+
2060
974
  MetricWidgetImage?: Uint8Array;
2061
975
  }
2062
976
  export declare namespace GetMetricWidgetImageOutput {
2063
- /**
2064
- * @internal
2065
- */
977
+
2066
978
  const filterSensitiveLog: (obj: GetMetricWidgetImageOutput) => any;
2067
979
  }
2068
980
  export interface ListDashboardsInput {
2069
- /**
2070
- * <p>If you specify this parameter, only
2071
- * the dashboards with names starting with the specified string are listed. The maximum length is 255, and
2072
- * valid characters are A-Z, a-z, 0-9, ".", "-", and "_".
2073
- *
2074
- * </p>
2075
- */
981
+
2076
982
  DashboardNamePrefix?: string;
2077
- /**
2078
- * <p>The token returned by a previous call to indicate that there is more data available.</p>
2079
- */
983
+
2080
984
  NextToken?: string;
2081
985
  }
2082
986
  export declare namespace ListDashboardsInput {
2083
- /**
2084
- * @internal
2085
- */
987
+
2086
988
  const filterSensitiveLog: (obj: ListDashboardsInput) => any;
2087
989
  }
2088
990
  export interface ListDashboardsOutput {
2089
- /**
2090
- * <p>The list of matching dashboards.</p>
2091
- */
991
+
2092
992
  DashboardEntries?: DashboardEntry[];
2093
- /**
2094
- * <p>The token that marks the start of the next batch of returned results.</p>
2095
- */
993
+
2096
994
  NextToken?: string;
2097
995
  }
2098
996
  export declare namespace ListDashboardsOutput {
2099
- /**
2100
- * @internal
2101
- */
997
+
2102
998
  const filterSensitiveLog: (obj: ListDashboardsOutput) => any;
2103
999
  }
2104
1000
  export declare enum RecentlyActive {
2105
1001
  PT3H = "PT3H"
2106
1002
  }
2107
1003
  export interface ListMetricsInput {
2108
- /**
2109
- * <p>The metric namespace to filter against. Only the namespace that matches exactly
2110
- * will be returned.</p>
2111
- */
1004
+
2112
1005
  Namespace?: string;
2113
- /**
2114
- * <p>The name of the metric to filter against. Only the metrics with names that match exactly
2115
- * will be returned.</p>
2116
- */
1006
+
2117
1007
  MetricName?: string;
2118
- /**
2119
- * <p>The dimensions to filter against. Only the dimensions that match exactly
2120
- * will be returned.</p>
2121
- */
1008
+
2122
1009
  Dimensions?: DimensionFilter[];
2123
- /**
2124
- * <p>The token returned by a previous call to indicate that there is more data
2125
- * available.</p>
2126
- */
1010
+
2127
1011
  NextToken?: string;
2128
- /**
2129
- * <p>To filter the results to show only metrics that have had data points published
2130
- * in the past three hours, specify this parameter
2131
- * with a value of <code>PT3H</code>. This is the only valid value
2132
- * for this parameter.</p>
2133
- * <p>The results that are returned are an approximation of the value you specify. There
2134
- * is a low probability that the returned results include metrics with last published
2135
- * data as much as 40 minutes more than the specified time interval.</p>
2136
- */
1012
+
2137
1013
  RecentlyActive?: RecentlyActive | string;
2138
1014
  }
2139
1015
  export declare namespace ListMetricsInput {
2140
- /**
2141
- * @internal
2142
- */
1016
+
2143
1017
  const filterSensitiveLog: (obj: ListMetricsInput) => any;
2144
1018
  }
2145
1019
  export interface ListMetricsOutput {
2146
- /**
2147
- * <p>The metrics that match your request. </p>
2148
- */
1020
+
2149
1021
  Metrics?: Metric[];
2150
- /**
2151
- * <p>The token that marks the start of the next batch of returned results. </p>
2152
- */
1022
+
2153
1023
  NextToken?: string;
2154
1024
  }
2155
1025
  export declare namespace ListMetricsOutput {
2156
- /**
2157
- * @internal
2158
- */
1026
+
2159
1027
  const filterSensitiveLog: (obj: ListMetricsOutput) => any;
2160
1028
  }
2161
1029
  export interface ListMetricStreamsInput {
2162
- /**
2163
- * <p>Include this value, if it was returned by the previous call, to get the next set of metric streams.</p>
2164
- */
1030
+
2165
1031
  NextToken?: string;
2166
- /**
2167
- * <p>The maximum number of results to return in one operation.</p>
2168
- */
1032
+
2169
1033
  MaxResults?: number;
2170
1034
  }
2171
1035
  export declare namespace ListMetricStreamsInput {
2172
- /**
2173
- * @internal
2174
- */
1036
+
2175
1037
  const filterSensitiveLog: (obj: ListMetricStreamsInput) => any;
2176
1038
  }
2177
- /**
2178
- * <p>This structure contains the configuration information about one metric stream.</p>
2179
- */
1039
+
2180
1040
  export interface MetricStreamEntry {
2181
- /**
2182
- * <p>The ARN of the metric stream.</p>
2183
- */
1041
+
2184
1042
  Arn?: string;
2185
- /**
2186
- * <p>The date that the metric stream was originally created.</p>
2187
- */
1043
+
2188
1044
  CreationDate?: Date;
2189
- /**
2190
- * <p>The date that the configuration of this metric stream was most recently updated.</p>
2191
- */
1045
+
2192
1046
  LastUpdateDate?: Date;
2193
- /**
2194
- * <p>The name of the metric stream.</p>
2195
- */
1047
+
2196
1048
  Name?: string;
2197
- /**
2198
- * <p>The ARN of the Kinesis Firehose devlivery stream that is used for this metric stream.</p>
2199
- */
1049
+
2200
1050
  FirehoseArn?: string;
2201
- /**
2202
- * <p>The current state of this stream. Valid values are <code>running</code> and <code>stopped</code>.</p>
2203
- */
1051
+
2204
1052
  State?: string;
2205
- /**
2206
- * <p>The output format of this metric stream. Valid values are
2207
- * <code>json</code>
2208
- * and <code>opentelemetry0.7</code>.</p>
2209
- */
1053
+
2210
1054
  OutputFormat?: MetricStreamOutputFormat | string;
2211
1055
  }
2212
1056
  export declare namespace MetricStreamEntry {
2213
- /**
2214
- * @internal
2215
- */
1057
+
2216
1058
  const filterSensitiveLog: (obj: MetricStreamEntry) => any;
2217
1059
  }
2218
1060
  export interface ListMetricStreamsOutput {
2219
- /**
2220
- * <p>The token that marks the start of the next batch of returned results. You can use this
2221
- * token in a subsequent operation to get the next batch of results.</p>
2222
- */
1061
+
2223
1062
  NextToken?: string;
2224
- /**
2225
- * <p>The array of metric stream information.</p>
2226
- */
1063
+
2227
1064
  Entries?: MetricStreamEntry[];
2228
1065
  }
2229
1066
  export declare namespace ListMetricStreamsOutput {
2230
- /**
2231
- * @internal
2232
- */
1067
+
2233
1068
  const filterSensitiveLog: (obj: ListMetricStreamsOutput) => any;
2234
1069
  }
2235
1070
  export interface ListTagsForResourceInput {
2236
- /**
2237
- * <p>The ARN of the CloudWatch resource that you want to view tags for.</p>
2238
- * <p>The ARN format of an alarm is
2239
- * <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
2240
- * </code>
2241
- * </p>
2242
- * <p>The ARN format of a Contributor Insights rule is
2243
- * <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule:<i>insight-rule-name</i>
2244
- * </code>
2245
- * </p>
2246
- * <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource
2247
- * Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General
2248
- * Reference</i>.</p>
2249
- */
1071
+
2250
1072
  ResourceARN: string | undefined;
2251
1073
  }
2252
1074
  export declare namespace ListTagsForResourceInput {
2253
- /**
2254
- * @internal
2255
- */
1075
+
2256
1076
  const filterSensitiveLog: (obj: ListTagsForResourceInput) => any;
2257
1077
  }
2258
- /**
2259
- * <p>A key-value pair associated with a CloudWatch resource.</p>
2260
- */
1078
+
2261
1079
  export interface Tag {
2262
- /**
2263
- * <p>A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your
2264
- * resources.</p>
2265
- */
1080
+
2266
1081
  Key: string | undefined;
2267
- /**
2268
- * <p>The value for the specified tag key.</p>
2269
- */
1082
+
2270
1083
  Value: string | undefined;
2271
1084
  }
2272
1085
  export declare namespace Tag {
2273
- /**
2274
- * @internal
2275
- */
1086
+
2276
1087
  const filterSensitiveLog: (obj: Tag) => any;
2277
1088
  }
2278
1089
  export interface ListTagsForResourceOutput {
2279
- /**
2280
- * <p>The list of tag keys and values associated with the resource you specified.</p>
2281
- */
1090
+
2282
1091
  Tags?: Tag[];
2283
1092
  }
2284
1093
  export declare namespace ListTagsForResourceOutput {
2285
- /**
2286
- * @internal
2287
- */
1094
+
2288
1095
  const filterSensitiveLog: (obj: ListTagsForResourceOutput) => any;
2289
1096
  }
2290
1097
  export interface PutAnomalyDetectorInput {
2291
- /**
2292
- * <p>The namespace of the metric to create the anomaly detection model for.</p>
2293
- */
1098
+
2294
1099
  Namespace: string | undefined;
2295
- /**
2296
- * <p>The name of the metric to create the anomaly detection model for.</p>
2297
- */
1100
+
2298
1101
  MetricName: string | undefined;
2299
- /**
2300
- * <p>The metric dimensions to create the anomaly detection model for.</p>
2301
- */
1102
+
2302
1103
  Dimensions?: Dimension[];
2303
- /**
2304
- * <p>The statistic to use for the metric and the anomaly detection model.</p>
2305
- */
1104
+
2306
1105
  Stat: string | undefined;
2307
- /**
2308
- * <p>The configuration specifies details about how the
2309
- * anomaly detection model is to be trained, including
2310
- * time ranges to exclude when training and updating the model.
2311
- * You can specify as many as 10 time ranges.</p>
2312
- * <p>The configuration can also include the time zone to use for
2313
- * the metric.</p>
2314
- */
1106
+
2315
1107
  Configuration?: AnomalyDetectorConfiguration;
2316
1108
  }
2317
1109
  export declare namespace PutAnomalyDetectorInput {
2318
- /**
2319
- * @internal
2320
- */
1110
+
2321
1111
  const filterSensitiveLog: (obj: PutAnomalyDetectorInput) => any;
2322
1112
  }
2323
1113
  export interface PutAnomalyDetectorOutput {
2324
1114
  }
2325
1115
  export declare namespace PutAnomalyDetectorOutput {
2326
- /**
2327
- * @internal
2328
- */
1116
+
2329
1117
  const filterSensitiveLog: (obj: PutAnomalyDetectorOutput) => any;
2330
1118
  }
2331
- /**
2332
- * <p>The quota for alarms for this customer has already been reached.</p>
2333
- */
1119
+
2334
1120
  export interface LimitExceededFault extends __SmithyException, $MetadataBearer {
2335
1121
  name: "LimitExceededFault";
2336
1122
  $fault: "client";
2337
- /**
2338
- * <p></p>
2339
- */
1123
+
2340
1124
  message?: string;
2341
1125
  }
2342
1126
  export declare namespace LimitExceededFault {
2343
- /**
2344
- * @internal
2345
- */
1127
+
2346
1128
  const filterSensitiveLog: (obj: LimitExceededFault) => any;
2347
1129
  }
2348
1130
  export interface PutCompositeAlarmInput {
2349
- /**
2350
- * <p>Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is
2351
- * <code>TRUE</code>.</p>
2352
- */
1131
+
2353
1132
  ActionsEnabled?: boolean;
2354
- /**
2355
- * <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state.
2356
- * Each action is specified as an Amazon Resource Name (ARN).</p>
2357
- *
2358
- * <p>Valid Values: <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
2359
- * </code>
2360
- * | <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i>
2361
- * </code>
2362
- * </p>
2363
- */
1133
+
2364
1134
  AlarmActions?: string[];
2365
- /**
2366
- * <p>The description for the composite alarm.</p>
2367
- */
1135
+
2368
1136
  AlarmDescription?: string;
2369
- /**
2370
- * <p>The name for the composite alarm. This name must be unique within the Region.</p>
2371
- */
1137
+
2372
1138
  AlarmName: string | undefined;
2373
- /**
2374
- * <p>An expression that specifies which other alarms are to be evaluated to determine this
2375
- * composite alarm's state. For each alarm that you reference, you
2376
- * designate a function that
2377
- * specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You
2378
- * can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the
2379
- * functions in your expression.</p>
2380
- * <p>You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.</p>
2381
- * <p>Functions can include the following:</p>
2382
- * <ul>
2383
- * <li>
2384
- * <p>
2385
- * <code>ALARM("<i>alarm-name</i> or <i>alarm-ARN</i>")</code> is TRUE if the named
2386
- * alarm is in ALARM state.</p>
2387
- * </li>
2388
- * <li>
2389
- * <p>
2390
- * <code>OK("<i>alarm-name</i> or <i>alarm-ARN</i>")</code> is TRUE if the named
2391
- * alarm is in OK state.</p>
2392
- * </li>
2393
- * <li>
2394
- * <p>
2395
- * <code>INSUFFICIENT_DATA("<i>alarm-name</i> or <i>alarm-ARN</i>")</code> is TRUE if the named
2396
- * alarm is in INSUFFICIENT_DATA state.</p>
2397
- * </li>
2398
- * <li>
2399
- * <p>
2400
- * <code>TRUE</code> always evaluates to TRUE.</p>
2401
- * </li>
2402
- * <li>
2403
- * <p>
2404
- * <code>FALSE</code> always evaluates to FALSE.</p>
2405
- * </li>
2406
- * </ul>
2407
- * <p>TRUE and FALSE are useful for testing a complex <code>AlarmRule</code> structure, and
2408
- * for testing your alarm actions.</p>
2409
- * <p>Alarm names specified in <code>AlarmRule</code> can be surrounded with double-quotes ("), but do not have to be.</p>
2410
- * <p>The following
2411
- * are some examples of <code>AlarmRule</code>:</p>
2412
- * <ul>
2413
- * <li>
2414
- * <p>
2415
- * <code>ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)</code> specifies that the composite alarm goes into ALARM state only
2416
- * if both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in ALARM state.</p>
2417
- * </li>
2418
- * <li>
2419
- * <p>
2420
- * <code>ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)</code>
2421
- * specifies that the alarm goes to ALARM state if CPUUtilizationTooHigh is in ALARM state
2422
- * and DeploymentInProgress is not in ALARM state. This example reduces
2423
- * alarm noise during a known deployment window.</p>
2424
- * </li>
2425
- * <li>
2426
- * <p>
2427
- * <code>(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh)</code> goes into ALARM
2428
- * state if CPUUtilizationTooHigh OR DiskReadOpsTooHigh is in ALARM state, and if NetworkOutTooHigh is in OK state.
2429
- * This provides another example of using a composite alarm to prevent noise. This rule ensures that you are not notified with an
2430
- * alarm action on high CPU or disk usage if a known network problem is also occurring.</p>
2431
- * </li>
2432
- * </ul>
2433
- * <p>The <code>AlarmRule</code> can specify as many as 100
2434
- * "children" alarms. The <code>AlarmRule</code> expression can have as many as 500 elements. Elements
2435
- * are child alarms, TRUE or FALSE statements, and
2436
- * parentheses.</p>
2437
- */
1139
+
2438
1140
  AlarmRule: string | undefined;
2439
- /**
2440
- * <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state.
2441
- * Each action is specified as an Amazon Resource Name (ARN).</p>
2442
- *
2443
- * <p>Valid Values: <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
2444
- * </code>
2445
- * </p>
2446
- */
1141
+
2447
1142
  InsufficientDataActions?: string[];
2448
- /**
2449
- * <p>The actions to execute when this alarm transitions to an <code>OK</code> state
2450
- * from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
2451
- *
2452
- *
2453
- * <p>Valid Values: <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
2454
- * </code>
2455
- * </p>
2456
- */
1143
+
2457
1144
  OKActions?: string[];
2458
- /**
2459
- * <p>A list of key-value pairs to associate with the composite alarm. You can associate as many as 50 tags with an alarm.</p>
2460
- * <p>Tags can help you organize and categorize your
2461
- * resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with
2462
- * certain tag values.</p>
2463
- */
1145
+
2464
1146
  Tags?: Tag[];
2465
1147
  }
2466
1148
  export declare namespace PutCompositeAlarmInput {
2467
- /**
2468
- * @internal
2469
- */
1149
+
2470
1150
  const filterSensitiveLog: (obj: PutCompositeAlarmInput) => any;
2471
1151
  }
2472
1152
  export interface PutDashboardInput {
2473
- /**
2474
- * <p>The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing
2475
- * its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are
2476
- * A-Z, a-z, 0-9, "-", and "_". This parameter is required.</p>
2477
- */
1153
+
2478
1154
  DashboardName: string | undefined;
2479
- /**
2480
- * <p>The detailed information about the dashboard in JSON format, including the widgets to include and their location
2481
- * on the dashboard. This parameter is required.</p>
2482
- * <p>For more information about the syntax,
2483
- * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html">Dashboard Body Structure and Syntax</a>.</p>
2484
- */
1155
+
2485
1156
  DashboardBody: string | undefined;
2486
1157
  }
2487
1158
  export declare namespace PutDashboardInput {
2488
- /**
2489
- * @internal
2490
- */
1159
+
2491
1160
  const filterSensitiveLog: (obj: PutDashboardInput) => any;
2492
1161
  }
2493
1162
  export interface PutDashboardOutput {
2494
- /**
2495
- * <p>If the input for <code>PutDashboard</code> was correct and the dashboard was successfully created or modified, this result is empty.</p>
2496
- * <p>If this result includes only warning messages, then the input was valid enough for the dashboard to be
2497
- * created or modified, but some elements of the dashboard
2498
- * might not render.</p>
2499
- * <p>If this result includes error messages, the input was not valid and the operation failed.</p>
2500
- */
1163
+
2501
1164
  DashboardValidationMessages?: DashboardValidationMessage[];
2502
1165
  }
2503
1166
  export declare namespace PutDashboardOutput {
2504
- /**
2505
- * @internal
2506
- */
1167
+
2507
1168
  const filterSensitiveLog: (obj: PutDashboardOutput) => any;
2508
1169
  }
2509
1170
  export interface PutInsightRuleInput {
2510
- /**
2511
- * <p>A unique name for the rule.</p>
2512
- */
1171
+
2513
1172
  RuleName: string | undefined;
2514
- /**
2515
- * <p>The state of the rule. Valid values are ENABLED and DISABLED.</p>
2516
- */
1173
+
2517
1174
  RuleState?: string;
2518
- /**
2519
- * <p>The definition of the rule, as a JSON object. For details on the valid syntax, see
2520
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-RuleSyntax.html">Contributor Insights
2521
- * Rule Syntax</a>.</p>
2522
- */
1175
+
2523
1176
  RuleDefinition: string | undefined;
2524
- /**
2525
- * <p>A list of key-value pairs to associate with the Contributor Insights rule.
2526
- * You can associate as many as 50 tags with a rule.</p>
2527
- * <p>Tags can help you organize and categorize your
2528
- * resources. You can also use them to scope user permissions, by
2529
- * granting a user permission to access or change only the resources that have
2530
- * certain tag values.</p>
2531
- * <p>To be able to associate tags with a rule, you must have the <code>cloudwatch:TagResource</code>
2532
- * permission in addition to the <code>cloudwatch:PutInsightRule</code> permission.</p>
2533
- * <p>If you are using this operation to update an existing Contributor Insights rule, any tags
2534
- * you specify in this parameter are ignored. To change the tags of an existing rule, use
2535
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
2536
- */
1177
+
2537
1178
  Tags?: Tag[];
2538
1179
  }
2539
1180
  export declare namespace PutInsightRuleInput {
2540
- /**
2541
- * @internal
2542
- */
1181
+
2543
1182
  const filterSensitiveLog: (obj: PutInsightRuleInput) => any;
2544
1183
  }
2545
1184
  export interface PutInsightRuleOutput {
2546
1185
  }
2547
1186
  export declare namespace PutInsightRuleOutput {
2548
- /**
2549
- * @internal
2550
- */
1187
+
2551
1188
  const filterSensitiveLog: (obj: PutInsightRuleOutput) => any;
2552
1189
  }
2553
1190
  export interface PutMetricAlarmInput {
2554
- /**
2555
- * <p>The name for the alarm. This name must be unique within the Region.</p>
2556
- */
1191
+
2557
1192
  AlarmName: string | undefined;
2558
- /**
2559
- * <p>The description for the alarm.</p>
2560
- */
1193
+
2561
1194
  AlarmDescription?: string;
2562
- /**
2563
- * <p>Indicates whether actions should be executed during any changes to the alarm state. The default is
2564
- * <code>TRUE</code>.</p>
2565
- */
1195
+
2566
1196
  ActionsEnabled?: boolean;
2567
- /**
2568
- * <p>The actions to execute when this alarm transitions to an <code>OK</code> state
2569
- * from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>
2570
- *
2571
- * <p>Valid Values: <code>arn:aws:automate:<i>region</i>:ec2:stop</code> |
2572
- * <code>arn:aws:automate:<i>region</i>:ec2:terminate</code> |
2573
- * <code>arn:aws:automate:<i>region</i>:ec2:recover</code> |
2574
- * <code>arn:aws:automate:<i>region</i>:ec2:reboot</code> |
2575
- * <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
2576
- * </code> |
2577
- * <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>:autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i>
2578
- * </code>
2579
- * </p>
2580
- *
2581
- * <p>Valid Values (for use with IAM roles):
2582
- * <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code> |
2583
- * <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code> |
2584
- * <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code> |
2585
- * <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Recover/1.0</code>
2586
- * </p>
2587
- */
1197
+
2588
1198
  OKActions?: string[];
2589
- /**
2590
- * <p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state.
2591
- * Each action is specified as an Amazon Resource Name (ARN).</p>
2592
- *
2593
- * <p>Valid Values: <code>arn:aws:automate:<i>region</i>:ec2:stop</code> |
2594
- * <code>arn:aws:automate:<i>region</i>:ec2:terminate</code> |
2595
- * <code>arn:aws:automate:<i>region</i>:ec2:recover</code> |
2596
- * <code>arn:aws:automate:<i>region</i>:ec2:reboot</code> |
2597
- * <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
2598
- * </code> |
2599
- * <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>:autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i>
2600
- * </code>
2601
- * | <code>arn:aws:ssm:<i>region</i>:<i>account-id</i>:opsitem:<i>severity</i>
2602
- * </code>
2603
- * | <code>arn:aws:ssm-incidents::<i>account-id</i>:response-plan:<i>response-plan-name</i>
2604
- * </code>
2605
- * </p>
2606
- *
2607
- * <p>Valid Values (for use with IAM roles):
2608
- * <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code> |
2609
- * <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code> |
2610
- * <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code> |
2611
- * <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Recover/1.0</code>
2612
- * </p>
2613
- */
1199
+
2614
1200
  AlarmActions?: string[];
2615
- /**
2616
- * <p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state.
2617
- * Each action is specified as an Amazon Resource Name (ARN).</p>
2618
- *
2619
- * <p>Valid Values: <code>arn:aws:automate:<i>region</i>:ec2:stop</code> |
2620
- * <code>arn:aws:automate:<i>region</i>:ec2:terminate</code> |
2621
- * <code>arn:aws:automate:<i>region</i>:ec2:recover</code> |
2622
- * <code>arn:aws:automate:<i>region</i>:ec2:reboot</code> |
2623
- * <code>arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i>
2624
- * </code> |
2625
- * <code>arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i>:autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i>
2626
- * </code>
2627
- * </p>
2628
- *
2629
- * <p>Valid Values (for use with IAM roles):
2630
- * <code>>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Stop/1.0</code> |
2631
- * <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Terminate/1.0</code> |
2632
- * <code>arn:aws:swf:<i>region</i>:<i>account-id</i>:action/actions/AWS_EC2.InstanceId.Reboot/1.0</code>
2633
- * </p>
2634
- */
1201
+
2635
1202
  InsufficientDataActions?: string[];
2636
- /**
2637
- * <p>The name for the metric associated with the alarm. For each <code>PutMetricAlarm</code>
2638
- * operation, you must specify either <code>MetricName</code> or a <code>Metrics</code> array.</p>
2639
- * <p>If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the
2640
- * <code>Dimensions</code>, <code>Period</code>,
2641
- * <code>Namespace</code>, <code>Statistic</code>, or <code>ExtendedStatistic</code> parameters. Instead, you specify
2642
- * all this information in the <code>Metrics</code> array.</p>
2643
- */
1203
+
2644
1204
  MetricName?: string;
2645
- /**
2646
- * <p>The namespace for the metric associated specified in <code>MetricName</code>.</p>
2647
- */
1205
+
2648
1206
  Namespace?: string;
2649
- /**
2650
- * <p>The statistic for the metric specified in <code>MetricName</code>, other than percentile.
2651
- * For percentile statistics, use <code>ExtendedStatistic</code>. When you call <code>PutMetricAlarm</code> and specify
2652
- * a <code>MetricName</code>, you must
2653
- * specify either <code>Statistic</code> or <code>ExtendedStatistic,</code> but not both.</p>
2654
- */
1207
+
2655
1208
  Statistic?: Statistic | string;
2656
- /**
2657
- * <p>The percentile statistic for the metric specified in <code>MetricName</code>. Specify a value
2658
- * between p0.0 and p100. When you call <code>PutMetricAlarm</code> and specify
2659
- * a <code>MetricName</code>, you must
2660
- * specify either <code>Statistic</code> or <code>ExtendedStatistic,</code> but not both.</p>
2661
- */
1209
+
2662
1210
  ExtendedStatistic?: string;
2663
- /**
2664
- * <p>The dimensions for the metric specified in <code>MetricName</code>.</p>
2665
- */
1211
+
2666
1212
  Dimensions?: Dimension[];
2667
- /**
2668
- * <p>The length, in seconds, used each time the metric specified in <code>MetricName</code> is
2669
- * evaluated. Valid values are 10, 30, and any multiple of 60.</p>
2670
- * <p>
2671
- * <code>Period</code> is required for alarms based on static thresholds. If
2672
- * you are creating an alarm based on a metric math expression, you specify the
2673
- * period for each metric within the objects in the <code>Metrics</code> array.</p>
2674
- * <p>Be sure to specify 10 or 30 only for metrics that are stored by a <code>PutMetricData</code> call with a
2675
- * <code>StorageResolution</code> of 1. If you specify a period of 10 or 30 for a metric that does not have
2676
- * sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case,
2677
- * it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm
2678
- * might often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm,
2679
- * which has a higher charge than other alarms. For more information about pricing, see <a href="https://aws.amazon.com/cloudwatch/pricing/">Amazon CloudWatch Pricing</a>.</p>
2680
- * <p>An alarm's total current evaluation period can
2681
- * be no longer than one day, so <code>Period</code> multiplied by <code>EvaluationPeriods</code> cannot be more than 86,400 seconds.</p>
2682
- */
1213
+
2683
1214
  Period?: number;
2684
- /**
2685
- * <p>The unit of measure for the statistic. For example, the units for the Amazon EC2
2686
- * NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance
2687
- * receives on all network interfaces. You can also specify a unit when you create a custom
2688
- * metric. Units help provide conceptual meaning to your data. Metric data points that
2689
- * specify a unit of measure, such as Percent, are aggregated separately.</p>
2690
- * <p>If you don't specify <code>Unit</code>, CloudWatch retrieves all unit types that have been published for the
2691
- * metric and attempts to evaluate the alarm.
2692
- * Usually, metrics are
2693
- * published with only one unit, so the alarm
2694
- * works as intended.</p>
2695
- * <p>However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's
2696
- * behavior is not defined and
2697
- * it behaves predictably.</p>
2698
- * <p>We recommend omitting <code>Unit</code> so that you don't inadvertently
2699
- * specify an incorrect unit that is not published for this metric. Doing so
2700
- * causes the alarm to be stuck in the <code>INSUFFICIENT DATA</code> state.</p>
2701
- */
1215
+
2702
1216
  Unit?: StandardUnit | string;
2703
- /**
2704
- * <p>The number of periods over which data is compared to the specified threshold. If you are
2705
- * setting an alarm that requires that a number of consecutive data points be breaching to
2706
- * trigger the alarm, this value specifies that number. If you are setting an "M out of N"
2707
- * alarm, this value is the N.</p>
2708
- * <p>An alarm's total current evaluation period can
2709
- * be no longer than one day, so this number multiplied by <code>Period</code> cannot be more than 86,400 seconds.</p>
2710
- */
1217
+
2711
1218
  EvaluationPeriods: number | undefined;
2712
- /**
2713
- * <p>The number of data points that must be breaching to trigger the alarm. This is used only if you are setting
2714
- * an "M out of N" alarm. In that case, this value is the M. For more information, see
2715
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation">Evaluating an Alarm</a> in the
2716
- * <i>Amazon CloudWatch User Guide</i>.</p>
2717
- */
1219
+
2718
1220
  DatapointsToAlarm?: number;
2719
- /**
2720
- * <p>The value against which the specified statistic is compared.</p>
2721
- * <p>This parameter is required for alarms based on static thresholds, but should
2722
- * not be used for alarms based on anomaly detection models.</p>
2723
- */
1221
+
2724
1222
  Threshold?: number;
2725
- /**
2726
- * <p> The arithmetic operation to use when comparing the specified statistic and
2727
- * threshold. The specified statistic value is used as the first operand.</p>
2728
- * <p>The values <code>LessThanLowerOrGreaterThanUpperThreshold</code>,
2729
- * <code>LessThanLowerThreshold</code>, and <code>GreaterThanUpperThreshold</code>
2730
- * are used only for alarms based on anomaly detection models.</p>
2731
- */
1223
+
2732
1224
  ComparisonOperator: ComparisonOperator | string | undefined;
2733
- /**
2734
- * <p> Sets how this alarm is to handle missing data points. If <code>TreatMissingData</code> is omitted, the default behavior of <code>missing</code> is used.
2735
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data">Configuring How CloudWatch
2736
- * Alarms Treats Missing Data</a>.</p>
2737
- * <p>Valid Values: <code>breaching | notBreaching | ignore | missing</code>
2738
- * </p>
2739
- */
1225
+
2740
1226
  TreatMissingData?: string;
2741
- /**
2742
- * <p> Used only for alarms based on percentiles. If you specify <code>ignore</code>, the alarm state does not change during periods with too few data points to be
2743
- * statistically significant. If you specify <code>evaluate</code> or omit this parameter, the alarm is always evaluated and possibly changes state
2744
- * no matter how many data points are available. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples">Percentile-Based CloudWatch Alarms and Low Data Samples</a>.</p>
2745
- * <p>Valid Values: <code>evaluate | ignore</code>
2746
- * </p>
2747
- */
1227
+
2748
1228
  EvaluateLowSampleCountPercentile?: string;
2749
- /**
2750
- * <p>An array of <code>MetricDataQuery</code> structures that enable you to create an alarm based on the result of a
2751
- * metric math expression. For each <code>PutMetricAlarm</code>
2752
- * operation, you must specify either <code>MetricName</code> or a <code>Metrics</code> array.</p>
2753
- * <p>Each item in the <code>Metrics</code> array either retrieves a metric or performs a math expression.</p>
2754
- * <p>One item in the <code>Metrics</code> array is the expression that the alarm watches. You designate this expression
2755
- * by setting <code>ReturnData</code> to true for this object in the array. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html">MetricDataQuery</a>.</p>
2756
- * <p>If you use the <code>Metrics</code> parameter, you cannot include the <code>MetricName</code>, <code>Dimensions</code>, <code>Period</code>,
2757
- * <code>Namespace</code>, <code>Statistic</code>, or <code>ExtendedStatistic</code> parameters of <code>PutMetricAlarm</code> in the same operation.
2758
- * Instead, you retrieve
2759
- * the metrics you are using in your math expression as part of the <code>Metrics</code> array.</p>
2760
- */
1229
+
2761
1230
  Metrics?: MetricDataQuery[];
2762
- /**
2763
- * <p>A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.</p>
2764
- * <p>Tags can help you organize and categorize your resources. You can also use them to scope user
2765
- * permissions by granting a user
2766
- * permission to access or change only resources with certain tag values.</p>
2767
- * <p>If you are using this operation to update an existing alarm, any tags
2768
- * you specify in this parameter are ignored. To change the tags of an existing alarm, use
2769
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a>
2770
- * or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
2771
- */
1231
+
2772
1232
  Tags?: Tag[];
2773
- /**
2774
- * <p>If this is an alarm based on an anomaly detection model, make this value match
2775
- * the ID of
2776
- * the <code>ANOMALY_DETECTION_BAND</code> function.</p>
2777
- * <p>For an example of how to use this parameter, see the
2778
- * <b>Anomaly Detection
2779
- * Model Alarm</b> example on this page.</p>
2780
- * <p>If your alarm uses this parameter, it cannot have Auto Scaling actions.</p>
2781
- */
1233
+
2782
1234
  ThresholdMetricId?: string;
2783
1235
  }
2784
1236
  export declare namespace PutMetricAlarmInput {
2785
- /**
2786
- * @internal
2787
- */
1237
+
2788
1238
  const filterSensitiveLog: (obj: PutMetricAlarmInput) => any;
2789
1239
  }
2790
- /**
2791
- * <p>Represents a set of statistics that describes a specific metric. </p>
2792
- */
1240
+
2793
1241
  export interface StatisticSet {
2794
- /**
2795
- * <p>The number of samples used for the statistic set.</p>
2796
- */
1242
+
2797
1243
  SampleCount: number | undefined;
2798
- /**
2799
- * <p>The sum of values for the sample set.</p>
2800
- */
1244
+
2801
1245
  Sum: number | undefined;
2802
- /**
2803
- * <p>The minimum value of the sample set.</p>
2804
- */
1246
+
2805
1247
  Minimum: number | undefined;
2806
- /**
2807
- * <p>The maximum value of the sample set.</p>
2808
- */
1248
+
2809
1249
  Maximum: number | undefined;
2810
1250
  }
2811
1251
  export declare namespace StatisticSet {
2812
- /**
2813
- * @internal
2814
- */
1252
+
2815
1253
  const filterSensitiveLog: (obj: StatisticSet) => any;
2816
1254
  }
2817
- /**
2818
- * <p>Encapsulates the information sent to either create a metric or add new values
2819
- * to be aggregated into an existing metric.</p>
2820
- */
1255
+
2821
1256
  export interface MetricDatum {
2822
- /**
2823
- * <p>The name of the metric.</p>
2824
- */
1257
+
2825
1258
  MetricName: string | undefined;
2826
- /**
2827
- * <p>The dimensions associated with the metric.</p>
2828
- */
1259
+
2829
1260
  Dimensions?: Dimension[];
2830
- /**
2831
- * <p>The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>
2832
- */
1261
+
2833
1262
  Timestamp?: Date;
2834
- /**
2835
- * <p>The value for the metric.</p>
2836
- * <p>Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or
2837
- * too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity)
2838
- * are not supported.</p>
2839
- */
1263
+
2840
1264
  Value?: number;
2841
- /**
2842
- * <p>The statistical values for the metric.</p>
2843
- */
1265
+
2844
1266
  StatisticValues?: StatisticSet;
2845
- /**
2846
- * <p>Array of numbers representing the values for the metric during the period. Each unique value is listed just once
2847
- * in this array, and the corresponding number in the <code>Counts</code> array specifies the number of times that value occurred during the period.
2848
- * You can include up to 150 unique values in each <code>PutMetricData</code> action that specifies a <code>Values</code> array.</p>
2849
- * <p>Although the <code>Values</code> array accepts numbers of type
2850
- * <code>Double</code>, CloudWatch rejects values that are either too small
2851
- * or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
2852
- * -Infinity) are not supported.</p>
2853
- */
1267
+
2854
1268
  Values?: number[];
2855
- /**
2856
- * <p>Array of numbers that is used along with the <code>Values</code> array. Each number in the <code>Count</code> array
2857
- * is the number of times the corresponding value in the <code>Values</code> array occurred during the period. </p>
2858
- * <p>If you omit the <code>Counts</code> array, the default of 1 is used as the value for each count. If you
2859
- * include a <code>Counts</code> array, it must include the same amount of values as the <code>Values</code> array.</p>
2860
- */
1269
+
2861
1270
  Counts?: number[];
2862
- /**
2863
- * <p>When you are using a <code>Put</code> operation, this defines what unit you want to use when storing the metric.</p>
2864
- * <p>In
2865
- * a <code>Get</code> operation, this displays the unit that is used for the metric.</p>
2866
- */
1271
+
2867
1272
  Unit?: StandardUnit | string;
2868
- /**
2869
- * <p>Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with
2870
- * sub-minute resolution down to one second.
2871
- * Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available
2872
- * only for custom metrics. For more information about high-resolution metrics,
2873
- * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#high-resolution-metrics">High-Resolution Metrics</a> in the
2874
- * <i>Amazon CloudWatch User Guide</i>.
2875
- * </p>
2876
- * <p>This field is optional, if you do not specify it the default of 60 is used.</p>
2877
- */
1273
+
2878
1274
  StorageResolution?: number;
2879
1275
  }
2880
1276
  export declare namespace MetricDatum {
2881
- /**
2882
- * @internal
2883
- */
1277
+
2884
1278
  const filterSensitiveLog: (obj: MetricDatum) => any;
2885
1279
  }
2886
1280
  export interface PutMetricDataInput {
2887
- /**
2888
- * <p>The namespace for the metric data.</p>
2889
- * <p>To avoid conflicts
2890
- * with Amazon Web Services service namespaces, you should not specify a namespace that begins with <code>AWS/</code>
2891
- * </p>
2892
- */
1281
+
2893
1282
  Namespace: string | undefined;
2894
- /**
2895
- * <p>The data for the metric. The array can include no more than 20 metrics per call.</p>
2896
- */
1283
+
2897
1284
  MetricData: MetricDatum[] | undefined;
2898
1285
  }
2899
1286
  export declare namespace PutMetricDataInput {
2900
- /**
2901
- * @internal
2902
- */
1287
+
2903
1288
  const filterSensitiveLog: (obj: PutMetricDataInput) => any;
2904
1289
  }
2905
1290
  export interface PutMetricStreamInput {
2906
- /**
2907
- * <p>If you are creating a new metric stream, this is the name for the new stream. The name
2908
- * must be different than the names of other metric streams in this account and Region.</p>
2909
- * <p>If you are updating a metric stream, specify the name of that stream here.</p>
2910
- * <p>Valid characters are A-Z, a-z, 0-9, "-" and "_".</p>
2911
- */
1291
+
2912
1292
  Name: string | undefined;
2913
- /**
2914
- * <p>If you specify this parameter, the stream sends only the
2915
- * metrics from the metric namespaces that you specify here.</p>
2916
- * <p>You cannot include <code>IncludeFilters</code> and <code>ExcludeFilters</code>
2917
- * in the same operation.</p>
2918
- */
1293
+
2919
1294
  IncludeFilters?: MetricStreamFilter[];
2920
- /**
2921
- * <p>If you specify this parameter, the stream sends metrics from all
2922
- * metric namespaces except for the namespaces that you specify here.</p>
2923
- * <p>You cannot include <code>ExcludeFilters</code> and <code>IncludeFilters</code> in
2924
- * the same operation.</p>
2925
- */
1295
+
2926
1296
  ExcludeFilters?: MetricStreamFilter[];
2927
- /**
2928
- * <p>The ARN of the Amazon Kinesis Firehose delivery stream to use for this metric stream.
2929
- * This Amazon Kinesis Firehose delivery stream must already exist and must be in the same
2930
- * account as the metric stream.</p>
2931
- */
1297
+
2932
1298
  FirehoseArn: string | undefined;
2933
- /**
2934
- * <p>The ARN of an IAM role that this metric stream will use to access
2935
- * Amazon Kinesis Firehose resources. This IAM role must already
2936
- * exist and must be in the same account as the metric stream. This IAM role must include the following permissions:</p>
2937
- * <ul>
2938
- * <li>
2939
- * <p>firehose:PutRecord</p>
2940
- * </li>
2941
- * <li>
2942
- * <p>firehose:PutRecordBatch</p>
2943
- * </li>
2944
- * </ul>
2945
- */
1299
+
2946
1300
  RoleArn: string | undefined;
2947
- /**
2948
- * <p>The output format for the stream. Valid values are <code>json</code>
2949
- * and <code>opentelemetry0.7</code>. For more information about metric stream
2950
- * output formats, see
2951
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-formats.html">
2952
- * Metric streams output formats</a>.</p>
2953
- */
1301
+
2954
1302
  OutputFormat: MetricStreamOutputFormat | string | undefined;
2955
- /**
2956
- * <p>A list of key-value pairs to associate with the metric stream. You can associate as
2957
- * many as 50 tags with a metric stream.</p>
2958
- * <p>Tags can help you organize and categorize your resources. You can also use them to scope user
2959
- * permissions by granting a user
2960
- * permission to access or change only resources with certain tag values.</p>
2961
- * <p>You can use this parameter only when you are creating a new metric stream. If you are using this operation to update an existing metric stream, any tags
2962
- * you specify in this parameter are ignored. To change the tags of an existing metric stream, use
2963
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html">TagResource</a>
2964
- * or <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
2965
- */
1303
+
2966
1304
  Tags?: Tag[];
2967
1305
  }
2968
1306
  export declare namespace PutMetricStreamInput {
2969
- /**
2970
- * @internal
2971
- */
1307
+
2972
1308
  const filterSensitiveLog: (obj: PutMetricStreamInput) => any;
2973
1309
  }
2974
1310
  export interface PutMetricStreamOutput {
2975
- /**
2976
- * <p>The ARN of the metric stream.</p>
2977
- */
1311
+
2978
1312
  Arn?: string;
2979
1313
  }
2980
1314
  export declare namespace PutMetricStreamOutput {
2981
- /**
2982
- * @internal
2983
- */
1315
+
2984
1316
  const filterSensitiveLog: (obj: PutMetricStreamOutput) => any;
2985
1317
  }
2986
- /**
2987
- * <p>Data was not syntactically valid JSON.</p>
2988
- */
1318
+
2989
1319
  export interface InvalidFormatFault extends __SmithyException, $MetadataBearer {
2990
1320
  name: "InvalidFormatFault";
2991
1321
  $fault: "client";
2992
- /**
2993
- * <p></p>
2994
- */
1322
+
2995
1323
  message?: string;
2996
1324
  }
2997
1325
  export declare namespace InvalidFormatFault {
2998
- /**
2999
- * @internal
3000
- */
1326
+
3001
1327
  const filterSensitiveLog: (obj: InvalidFormatFault) => any;
3002
1328
  }
3003
1329
  export interface SetAlarmStateInput {
3004
- /**
3005
- * <p>The name of the alarm.</p>
3006
- */
1330
+
3007
1331
  AlarmName: string | undefined;
3008
- /**
3009
- * <p>The value of the state.</p>
3010
- */
1332
+
3011
1333
  StateValue: StateValue | string | undefined;
3012
- /**
3013
- * <p>The reason that this alarm is set to this specific state, in text format.</p>
3014
- */
1334
+
3015
1335
  StateReason: string | undefined;
3016
- /**
3017
- * <p>The reason that this alarm is set to this specific state, in JSON format.</p>
3018
- * <p>For SNS or EC2 alarm actions, this is just informational. But for EC2 Auto Scaling or application Auto Scaling
3019
- * alarm actions, the Auto Scaling policy uses the information in this field to take the correct action.</p>
3020
- */
1336
+
3021
1337
  StateReasonData?: string;
3022
1338
  }
3023
1339
  export declare namespace SetAlarmStateInput {
3024
- /**
3025
- * @internal
3026
- */
1340
+
3027
1341
  const filterSensitiveLog: (obj: SetAlarmStateInput) => any;
3028
1342
  }
3029
1343
  export interface StartMetricStreamsInput {
3030
- /**
3031
- * <p>The array of the names of metric streams to start streaming.</p>
3032
- * <p>This is an "all or nothing" operation. If you do not have
3033
- * permission to access all of the metric streams that you list here, then none of the streams that you list
3034
- * in the operation will start streaming.</p>
3035
- */
1344
+
3036
1345
  Names: string[] | undefined;
3037
1346
  }
3038
1347
  export declare namespace StartMetricStreamsInput {
3039
- /**
3040
- * @internal
3041
- */
1348
+
3042
1349
  const filterSensitiveLog: (obj: StartMetricStreamsInput) => any;
3043
1350
  }
3044
1351
  export interface StartMetricStreamsOutput {
3045
1352
  }
3046
1353
  export declare namespace StartMetricStreamsOutput {
3047
- /**
3048
- * @internal
3049
- */
1354
+
3050
1355
  const filterSensitiveLog: (obj: StartMetricStreamsOutput) => any;
3051
1356
  }
3052
1357
  export interface StopMetricStreamsInput {
3053
- /**
3054
- * <p>The array of the names of metric streams to stop streaming.</p>
3055
- * <p>This is an "all or nothing" operation. If you do not have
3056
- * permission to access all of the metric streams that you list here, then none of the streams that you list
3057
- * in the operation will stop streaming.</p>
3058
- */
1358
+
3059
1359
  Names: string[] | undefined;
3060
1360
  }
3061
1361
  export declare namespace StopMetricStreamsInput {
3062
- /**
3063
- * @internal
3064
- */
1362
+
3065
1363
  const filterSensitiveLog: (obj: StopMetricStreamsInput) => any;
3066
1364
  }
3067
1365
  export interface StopMetricStreamsOutput {
3068
1366
  }
3069
1367
  export declare namespace StopMetricStreamsOutput {
3070
- /**
3071
- * @internal
3072
- */
1368
+
3073
1369
  const filterSensitiveLog: (obj: StopMetricStreamsOutput) => any;
3074
1370
  }
3075
1371
  export interface TagResourceInput {
3076
- /**
3077
- * <p>The ARN of the CloudWatch resource that you're adding tags to.</p>
3078
- * <p>The ARN format of an alarm is
3079
- * <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
3080
- * </code>
3081
- * </p>
3082
- * <p>The ARN format of a Contributor Insights rule is
3083
- * <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule:<i>insight-rule-name</i>
3084
- * </code>
3085
- * </p>
3086
- * <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource
3087
- * Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General
3088
- * Reference</i>.</p>
3089
- */
1372
+
3090
1373
  ResourceARN: string | undefined;
3091
- /**
3092
- * <p>The list of key-value pairs to associate with the alarm.</p>
3093
- */
1374
+
3094
1375
  Tags: Tag[] | undefined;
3095
1376
  }
3096
1377
  export declare namespace TagResourceInput {
3097
- /**
3098
- * @internal
3099
- */
1378
+
3100
1379
  const filterSensitiveLog: (obj: TagResourceInput) => any;
3101
1380
  }
3102
1381
  export interface TagResourceOutput {
3103
1382
  }
3104
1383
  export declare namespace TagResourceOutput {
3105
- /**
3106
- * @internal
3107
- */
1384
+
3108
1385
  const filterSensitiveLog: (obj: TagResourceOutput) => any;
3109
1386
  }
3110
1387
  export interface UntagResourceInput {
3111
- /**
3112
- * <p>The ARN of the CloudWatch resource that you're removing tags from.</p>
3113
- * <p>The ARN format of an alarm is
3114
- * <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:alarm:<i>alarm-name</i>
3115
- * </code>
3116
- * </p>
3117
- * <p>The ARN format of a Contributor Insights rule is
3118
- * <code>arn:aws:cloudwatch:<i>Region</i>:<i>account-id</i>:insight-rule:<i>insight-rule-name</i>
3119
- * </code>
3120
- * </p>
3121
- * <p>For more information about ARN format, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazoncloudwatch.html#amazoncloudwatch-resources-for-iam-policies"> Resource
3122
- * Types Defined by Amazon CloudWatch</a> in the <i>Amazon Web Services General
3123
- * Reference</i>.</p>
3124
- */
1388
+
3125
1389
  ResourceARN: string | undefined;
3126
- /**
3127
- * <p>The list of tag keys to remove from the resource.</p>
3128
- */
1390
+
3129
1391
  TagKeys: string[] | undefined;
3130
1392
  }
3131
1393
  export declare namespace UntagResourceInput {
3132
- /**
3133
- * @internal
3134
- */
1394
+
3135
1395
  const filterSensitiveLog: (obj: UntagResourceInput) => any;
3136
1396
  }
3137
1397
  export interface UntagResourceOutput {
3138
1398
  }
3139
1399
  export declare namespace UntagResourceOutput {
3140
- /**
3141
- * @internal
3142
- */
1400
+
3143
1401
  const filterSensitiveLog: (obj: UntagResourceOutput) => any;
3144
1402
  }