@aws-sdk/client-cloudwatch-logs 3.451.0 → 3.458.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 (66) hide show
  1. package/README.md +129 -73
  2. package/dist-cjs/CloudWatchLogs.js +14 -0
  3. package/dist-cjs/commands/CreateLogAnomalyDetectorCommand.js +51 -0
  4. package/dist-cjs/commands/DeleteLogAnomalyDetectorCommand.js +51 -0
  5. package/dist-cjs/commands/GetLogAnomalyDetectorCommand.js +51 -0
  6. package/dist-cjs/commands/ListAnomaliesCommand.js +51 -0
  7. package/dist-cjs/commands/ListLogAnomalyDetectorsCommand.js +51 -0
  8. package/dist-cjs/commands/UpdateAnomalyCommand.js +51 -0
  9. package/dist-cjs/commands/UpdateLogAnomalyDetectorCommand.js +51 -0
  10. package/dist-cjs/commands/index.js +7 -0
  11. package/dist-cjs/models/models_0.js +39 -1
  12. package/dist-cjs/pagination/ListAnomaliesPaginator.js +29 -0
  13. package/dist-cjs/pagination/ListLogAnomalyDetectorsPaginator.js +29 -0
  14. package/dist-cjs/pagination/index.js +2 -0
  15. package/dist-cjs/protocols/Aws_json1_1.js +340 -3
  16. package/dist-es/CloudWatchLogs.js +14 -0
  17. package/dist-es/commands/CreateLogAnomalyDetectorCommand.js +47 -0
  18. package/dist-es/commands/DeleteLogAnomalyDetectorCommand.js +47 -0
  19. package/dist-es/commands/GetLogAnomalyDetectorCommand.js +47 -0
  20. package/dist-es/commands/ListAnomaliesCommand.js +47 -0
  21. package/dist-es/commands/ListLogAnomalyDetectorsCommand.js +47 -0
  22. package/dist-es/commands/UpdateAnomalyCommand.js +47 -0
  23. package/dist-es/commands/UpdateLogAnomalyDetectorCommand.js +47 -0
  24. package/dist-es/commands/index.js +7 -0
  25. package/dist-es/models/models_0.js +38 -0
  26. package/dist-es/pagination/ListAnomaliesPaginator.js +25 -0
  27. package/dist-es/pagination/ListLogAnomalyDetectorsPaginator.js +25 -0
  28. package/dist-es/pagination/index.js +2 -0
  29. package/dist-es/protocols/Aws_json1_1.js +323 -0
  30. package/dist-types/CloudWatchLogs.d.ts +49 -0
  31. package/dist-types/CloudWatchLogsClient.d.ts +9 -2
  32. package/dist-types/commands/CreateDeliveryCommand.d.ts +1 -1
  33. package/dist-types/commands/CreateLogAnomalyDetectorCommand.d.ts +129 -0
  34. package/dist-types/commands/CreateLogGroupCommand.d.ts +1 -0
  35. package/dist-types/commands/DeleteLogAnomalyDetectorCommand.d.ts +83 -0
  36. package/dist-types/commands/DescribeLogGroupsCommand.d.ts +2 -0
  37. package/dist-types/commands/GetLogAnomalyDetectorCommand.d.ts +95 -0
  38. package/dist-types/commands/ListAnomaliesCommand.d.ts +127 -0
  39. package/dist-types/commands/ListLogAnomalyDetectorsCommand.d.ts +103 -0
  40. package/dist-types/commands/PutDeliveryDestinationCommand.d.ts +1 -1
  41. package/dist-types/commands/PutDeliveryDestinationPolicyCommand.d.ts +1 -1
  42. package/dist-types/commands/PutDeliverySourceCommand.d.ts +1 -1
  43. package/dist-types/commands/UpdateAnomalyCommand.d.ts +98 -0
  44. package/dist-types/commands/UpdateLogAnomalyDetectorCommand.d.ts +87 -0
  45. package/dist-types/commands/index.d.ts +7 -0
  46. package/dist-types/models/models_0.d.ts +686 -4
  47. package/dist-types/pagination/ListAnomaliesPaginator.d.ts +7 -0
  48. package/dist-types/pagination/ListLogAnomalyDetectorsPaginator.d.ts +7 -0
  49. package/dist-types/pagination/index.d.ts +2 -0
  50. package/dist-types/protocols/Aws_json1_1.d.ts +63 -0
  51. package/dist-types/ts3.4/CloudWatchLogs.d.ts +119 -0
  52. package/dist-types/ts3.4/CloudWatchLogsClient.d.ts +44 -2
  53. package/dist-types/ts3.4/commands/CreateLogAnomalyDetectorCommand.d.ts +42 -0
  54. package/dist-types/ts3.4/commands/DeleteLogAnomalyDetectorCommand.d.ts +38 -0
  55. package/dist-types/ts3.4/commands/GetLogAnomalyDetectorCommand.d.ts +42 -0
  56. package/dist-types/ts3.4/commands/ListAnomaliesCommand.d.ts +38 -0
  57. package/dist-types/ts3.4/commands/ListLogAnomalyDetectorsCommand.d.ts +42 -0
  58. package/dist-types/ts3.4/commands/UpdateAnomalyCommand.d.ts +33 -0
  59. package/dist-types/ts3.4/commands/UpdateLogAnomalyDetectorCommand.d.ts +38 -0
  60. package/dist-types/ts3.4/commands/index.d.ts +7 -0
  61. package/dist-types/ts3.4/models/models_0.d.ts +158 -0
  62. package/dist-types/ts3.4/pagination/ListAnomaliesPaginator.d.ts +11 -0
  63. package/dist-types/ts3.4/pagination/ListLogAnomalyDetectorsPaginator.d.ts +11 -0
  64. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  65. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +84 -0
  66. package/package.json +3 -3
@@ -71,6 +71,264 @@ export interface AccountPolicy {
71
71
  */
72
72
  accountId?: string;
73
73
  }
74
+ /**
75
+ * @public
76
+ * <p>A tructures that contains information about one pattern token related to
77
+ * an anomaly.</p>
78
+ * <p>For more information about patterns and tokens, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogAnomalyDetector.html">CreateLogAnomalyDetector</a>.
79
+ * </p>
80
+ */
81
+ export interface PatternToken {
82
+ /**
83
+ * @public
84
+ * <p>For a dynamic token, this indicates where in the pattern that this token appears, related
85
+ * to other dynamic tokens. The dynamic token that appears first has a value of <code>1</code>, the
86
+ * one that appears second is <code>2</code>, and so on.</p>
87
+ */
88
+ dynamicTokenPosition?: number;
89
+ /**
90
+ * @public
91
+ * <p>Specifies whether this is a dynamic token.</p>
92
+ */
93
+ isDynamic?: boolean;
94
+ /**
95
+ * @public
96
+ * <p>The string represented by this token. If this is a dynamic token, the
97
+ * value will be <code><*></code>
98
+ * </p>
99
+ */
100
+ tokenString?: string;
101
+ /**
102
+ * @public
103
+ * <p>Contains the values found for a dynamic token, and the number of times each value was found.</p>
104
+ */
105
+ enumerations?: Record<string, number>;
106
+ }
107
+ /**
108
+ * @public
109
+ * @enum
110
+ */
111
+ export declare const State: {
112
+ readonly Active: "Active";
113
+ readonly Baseline: "Baseline";
114
+ readonly Suppressed: "Suppressed";
115
+ };
116
+ /**
117
+ * @public
118
+ */
119
+ export type State = (typeof State)[keyof typeof State];
120
+ /**
121
+ * @public
122
+ * <p>This structure represents one anomaly that has been found by a logs anomaly detector.</p>
123
+ * <p>For more information about patterns and anomalies, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateLogAnomalyDetector.html">CreateLogAnomalyDetector</a>.
124
+ * </p>
125
+ */
126
+ export interface Anomaly {
127
+ /**
128
+ * @public
129
+ * <p>The unique ID that CloudWatch Logs assigned to this anomaly.</p>
130
+ */
131
+ anomalyId: string | undefined;
132
+ /**
133
+ * @public
134
+ * <p>The ID of the pattern used to help identify this anomaly.</p>
135
+ */
136
+ patternId: string | undefined;
137
+ /**
138
+ * @public
139
+ * <p>The ARN of the anomaly detector that identified this anomaly.</p>
140
+ */
141
+ anomalyDetectorArn: string | undefined;
142
+ /**
143
+ * @public
144
+ * <p>The pattern used to help identify this anomaly, in string format.</p>
145
+ */
146
+ patternString: string | undefined;
147
+ /**
148
+ * @public
149
+ * <p>The pattern used to help identify this anomaly, in regular expression format.</p>
150
+ */
151
+ patternRegex?: string;
152
+ /**
153
+ * @public
154
+ * <p>The priority level of this anomaly, as determined by CloudWatch Logs. Priority is computed based on log
155
+ * severity labels such as <code>FATAL</code> and <code>ERROR</code> and the amount of deviation from the baseline.
156
+ * Possible values are
157
+ * <code>HIGH</code>, <code>MEDIUM</code>, and <code>LOW</code>.</p>
158
+ */
159
+ priority?: string;
160
+ /**
161
+ * @public
162
+ * <p>The date and time when the anomaly detector first saw this anomaly.
163
+ * It is specified as epoch time, which is the number of seconds
164
+ * since <code>January 1, 1970, 00:00:00 UTC</code>.</p>
165
+ */
166
+ firstSeen: number | undefined;
167
+ /**
168
+ * @public
169
+ * <p>The date and time when the anomaly detector most recently saw this anomaly.
170
+ * It is specified as epoch time, which is the number of seconds
171
+ * since <code>January 1, 1970, 00:00:00 UTC</code>.</p>
172
+ */
173
+ lastSeen: number | undefined;
174
+ /**
175
+ * @public
176
+ * <p>A human-readable description of the anomaly. This description is generated by
177
+ * CloudWatch Logs.</p>
178
+ */
179
+ description: string | undefined;
180
+ /**
181
+ * @public
182
+ * <p>Specifies whether this anomaly is still ongoing.</p>
183
+ */
184
+ active: boolean | undefined;
185
+ /**
186
+ * @public
187
+ * <p>Indicates the current state of this anomaly. If it is still being treated as an anomaly, the value
188
+ * is <code>Active</code>. If you have suppressed this anomaly by using the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateAnomaly.html">UpdateAnomaly</a> operation,
189
+ * the value is <code>Suppressed</code>. If this behavior is now considered to be normal, the value
190
+ * is <code>Baseline</code>.</p>
191
+ */
192
+ state: State | undefined;
193
+ /**
194
+ * @public
195
+ * <p>A map showing times when the anomaly detector ran, and the number of occurrences of this anomaly that
196
+ * were detected at each of those runs. The times are specified in epoch time, which is the number of seconds
197
+ * since <code>January 1, 1970, 00:00:00 UTC</code>.</p>
198
+ */
199
+ histogram: Record<string, number> | undefined;
200
+ /**
201
+ * @public
202
+ * <p>An array of sample log event messages that are considered to be part of this anomaly.</p>
203
+ */
204
+ logSamples: string[] | undefined;
205
+ /**
206
+ * @public
207
+ * <p>An array of structures where each structure contains information about one token that makes up the pattern.</p>
208
+ */
209
+ patternTokens: PatternToken[] | undefined;
210
+ /**
211
+ * @public
212
+ * <p>An array of ARNS of the log groups that contained log events considered to be part of this anomaly.</p>
213
+ */
214
+ logGroupArnList: string[] | undefined;
215
+ /**
216
+ * @public
217
+ * <p>Indicates whether this anomaly is currently suppressed. To suppress an anomaly,
218
+ * use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateAnomaly.html">UpdateAnomaly</a>.</p>
219
+ */
220
+ suppressed?: boolean;
221
+ /**
222
+ * @public
223
+ * <p>If the anomaly is suppressed, this indicates when it was suppressed.</p>
224
+ */
225
+ suppressedDate?: number;
226
+ /**
227
+ * @public
228
+ * <p>If the anomaly is suppressed, this indicates when the suppression will end. If this value is <code>0</code>,
229
+ * the anomaly was suppressed with no expiration, with the <code>INFINITE</code> value.</p>
230
+ */
231
+ suppressedUntil?: number;
232
+ /**
233
+ * @public
234
+ * <p>If this anomaly is suppressed, this field is <code>true</code> if the suppression is because the
235
+ * pattern is suppressed. If <code>false</code>, then only this particular anomaly is suppressed.</p>
236
+ */
237
+ isPatternLevelSuppression?: boolean;
238
+ }
239
+ /**
240
+ * @public
241
+ * @enum
242
+ */
243
+ export declare const AnomalyDetectorStatus: {
244
+ readonly ANALYZING: "ANALYZING";
245
+ readonly DELETED: "DELETED";
246
+ readonly FAILED: "FAILED";
247
+ readonly INITIALIZING: "INITIALIZING";
248
+ readonly PAUSED: "PAUSED";
249
+ readonly TRAINING: "TRAINING";
250
+ };
251
+ /**
252
+ * @public
253
+ */
254
+ export type AnomalyDetectorStatus = (typeof AnomalyDetectorStatus)[keyof typeof AnomalyDetectorStatus];
255
+ /**
256
+ * @public
257
+ * @enum
258
+ */
259
+ export declare const EvaluationFrequency: {
260
+ readonly FIFTEEN_MIN: "FIFTEEN_MIN";
261
+ readonly FIVE_MIN: "FIVE_MIN";
262
+ readonly ONE_HOUR: "ONE_HOUR";
263
+ readonly ONE_MIN: "ONE_MIN";
264
+ readonly TEN_MIN: "TEN_MIN";
265
+ readonly THIRTY_MIN: "THIRTY_MIN";
266
+ };
267
+ /**
268
+ * @public
269
+ */
270
+ export type EvaluationFrequency = (typeof EvaluationFrequency)[keyof typeof EvaluationFrequency];
271
+ /**
272
+ * @public
273
+ * <p>Contains information about one anomaly detector in the account.</p>
274
+ */
275
+ export interface AnomalyDetector {
276
+ /**
277
+ * @public
278
+ * <p>The ARN of the anomaly detector.</p>
279
+ */
280
+ anomalyDetectorArn?: string;
281
+ /**
282
+ * @public
283
+ * <p>The name of the anomaly detector.</p>
284
+ */
285
+ detectorName?: string;
286
+ /**
287
+ * @public
288
+ * <p>A list of the ARNs of the log groups that this anomaly detector watches.</p>
289
+ */
290
+ logGroupArnList?: string[];
291
+ /**
292
+ * @public
293
+ * <p>Specifies how often the anomaly detector runs and look for anomalies.</p>
294
+ */
295
+ evaluationFrequency?: EvaluationFrequency;
296
+ /**
297
+ * @public
298
+ * <p>A symbolic description of how CloudWatch Logs should interpret the data in each log
299
+ * event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You
300
+ * use the filter pattern to specify what to look for in the log event message.</p>
301
+ */
302
+ filterPattern?: string;
303
+ /**
304
+ * @public
305
+ * <p>Specifies the current status of the anomaly detector. To pause an anomaly detector, use
306
+ * the <code>enabled</code> parameter in the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateLogAnomalyDetector.html">UpdateLogAnomalyDetector</a>
307
+ * operation.</p>
308
+ */
309
+ anomalyDetectorStatus?: AnomalyDetectorStatus;
310
+ /**
311
+ * @public
312
+ * <p>The ID of the KMS key assigned to this anomaly detector, if any.</p>
313
+ */
314
+ kmsKeyId?: string;
315
+ /**
316
+ * @public
317
+ * <p>The date and time when this anomaly detector was created.</p>
318
+ */
319
+ creationTimeStamp?: number;
320
+ /**
321
+ * @public
322
+ * <p>The date and time when this anomaly detector was most recently modified.</p>
323
+ */
324
+ lastModifiedTimeStamp?: number;
325
+ /**
326
+ * @public
327
+ * <p>The number of days used as the life cycle of anomalies. After this time, anomalies are automatically baselined
328
+ * and the anomaly detector model will treat new occurrences of similar event as normal. </p>
329
+ */
330
+ anomalyVisibilityTime?: number;
331
+ }
74
332
  /**
75
333
  * @public
76
334
  */
@@ -405,13 +663,93 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
405
663
  */
406
664
  constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
407
665
  }
666
+ /**
667
+ * @public
668
+ */
669
+ export interface CreateLogAnomalyDetectorRequest {
670
+ /**
671
+ * @public
672
+ * <p>An array containing the ARNs of the log groups that this anomaly detector will watch. You must specify
673
+ * at least one ARN.</p>
674
+ */
675
+ logGroupArnList: string[] | undefined;
676
+ /**
677
+ * @public
678
+ * <p>A name for this anomaly detector.</p>
679
+ */
680
+ detectorName?: string;
681
+ /**
682
+ * @public
683
+ * <p>Specifies how often the anomaly detector is to run and look for anomalies. Set this value
684
+ * according to the frequency that the log group receives new logs. For example, if the log group
685
+ * receives new log events every 10 minutes, then 15 minutes might be a good setting for
686
+ * <code>evaluationFrequency</code> .</p>
687
+ */
688
+ evaluationFrequency?: EvaluationFrequency;
689
+ /**
690
+ * @public
691
+ * <p>You can use this parameter to limit the anomaly detection model to examine only log events
692
+ * that match the pattern you specify here. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html">Filter and Pattern Syntax</a>.</p>
693
+ */
694
+ filterPattern?: string;
695
+ /**
696
+ * @public
697
+ * <p>Optionally assigns a KMS key to secure this anomaly detector and its findings. If a key is
698
+ * assigned, the anomalies found and the model used by this detector are encrypted at rest with the key. If
699
+ * a key is assigned to an anomaly detector, a user must have permissions for both this key and for the
700
+ * anomaly detector to retrieve information about the anomalies that it finds.</p>
701
+ * <p>For more information about using a KMS key and to see the required IAM
702
+ * policy, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/LogsAnomalyDetection-KMS.html">Use a KMS key with an anomaly detector</a>.</p>
703
+ */
704
+ kmsKeyId?: string;
705
+ /**
706
+ * @public
707
+ * <p>The number of days to have visibility on an anomaly. After this time period has elapsed for an anomaly,
708
+ * it will be automatically baselined and the anomaly detector will treat new occurrences of a similar anomaly as
709
+ * normal. Therefore,
710
+ * if you do not correct the cause of an
711
+ * anomaly during the time period specified in <code>anomalyVisibilityTime</code>, it will be considered normal
712
+ * going forward and will not be detected as an anomaly.</p>
713
+ */
714
+ anomalyVisibilityTime?: number;
715
+ /**
716
+ * @public
717
+ * <p>An optional list of key-value pairs to associate with the resource.</p>
718
+ * <p>For more information about tagging, see
719
+ * <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>
720
+ * </p>
721
+ */
722
+ tags?: Record<string, string>;
723
+ }
724
+ /**
725
+ * @public
726
+ */
727
+ export interface CreateLogAnomalyDetectorResponse {
728
+ /**
729
+ * @public
730
+ * <p>The ARN of the log anomaly detector that you just created.</p>
731
+ */
732
+ anomalyDetectorArn?: string;
733
+ }
734
+ /**
735
+ * @public
736
+ * @enum
737
+ */
738
+ export declare const LogGroupClass: {
739
+ readonly INFREQUENT_ACCESS: "INFREQUENT_ACCESS";
740
+ readonly STANDARD: "STANDARD";
741
+ };
742
+ /**
743
+ * @public
744
+ */
745
+ export type LogGroupClass = (typeof LogGroupClass)[keyof typeof LogGroupClass];
408
746
  /**
409
747
  * @public
410
748
  */
411
749
  export interface CreateLogGroupRequest {
412
750
  /**
413
751
  * @public
414
- * <p>The name of the log group.</p>
752
+ * <p>A name for the log group.</p>
415
753
  */
416
754
  logGroupName: string | undefined;
417
755
  /**
@@ -433,6 +771,24 @@ export interface CreateLogGroupRequest {
433
771
  * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Controlling access to Amazon Web Services resources using tags</a>.</p>
434
772
  */
435
773
  tags?: Record<string, string>;
774
+ /**
775
+ * @public
776
+ * <p>Use this parameter to specify the log group class for this log group. There are two classes:</p>
777
+ * <ul>
778
+ * <li>
779
+ * <p>The <code>Standard</code> log class supports all CloudWatch Logs features.</p>
780
+ * </li>
781
+ * <li>
782
+ * <p>The <code>Infrequent Access</code> log class supports a subset of CloudWatch Logs features
783
+ * and incurs lower costs.</p>
784
+ * </li>
785
+ * </ul>
786
+ * <p>If you omit this parameter, the default of <code>STANDARD</code> is used.</p>
787
+ * <p>For details about the features supported by each class, see
788
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html">Log classes</a>
789
+ * </p>
790
+ */
791
+ logGroupClass?: LogGroupClass;
436
792
  }
437
793
  /**
438
794
  * @public
@@ -561,6 +917,18 @@ export interface DeleteDestinationRequest {
561
917
  */
562
918
  destinationName: string | undefined;
563
919
  }
920
+ /**
921
+ * @public
922
+ */
923
+ export interface DeleteLogAnomalyDetectorRequest {
924
+ /**
925
+ * @public
926
+ * <p>The ARN of the anomaly detector to delete. You can find the ARNs of log anomaly detectors
927
+ * in your account by using the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListLogAnomalyDetectors.html">ListLogAnomalyDetectors</a>
928
+ * operation.</p>
929
+ */
930
+ anomalyDetectorArn: string | undefined;
931
+ }
564
932
  /**
565
933
  * @public
566
934
  */
@@ -689,7 +1057,7 @@ export type OutputFormat = (typeof OutputFormat)[keyof typeof OutputFormat];
689
1057
  * @public
690
1058
  * <p>This structure contains information about one <i>delivery destination</i> in your account.
691
1059
  * A delivery destination is an Amazon Web Services resource that represents an
692
- * shared id="AWS"/> service that logs can be sent to. CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations.</p>
1060
+ * Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, are supported as Kinesis Data Firehose delivery destinations.</p>
693
1061
  * <p>To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:</p>
694
1062
  * <ul>
695
1063
  * <li>
@@ -755,7 +1123,7 @@ export interface DeliveryDestination {
755
1123
  * Amazon Web Services destination. The destination can be CloudWatch Logs, Amazon S3, or Kinesis Data Firehose.</p>
756
1124
  * <p>Only some Amazon Web Services services support being configured as a delivery source. These services are listed
757
1125
  * as <b>Supported [V2 Permissions]</b> in the table at
758
- * <a href="https://docs.aws.amazon.com/ AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html#AWS-vended-logs-permissions">Enabling
1126
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enabling
759
1127
  * logging from Amazon Web Services services.</a>
760
1128
  * </p>
761
1129
  * <p>To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:</p>
@@ -1226,6 +1594,23 @@ export interface DescribeLogGroupsRequest {
1226
1594
  * and all log groups in all source accounts that are linked to the monitoring account. </p>
1227
1595
  */
1228
1596
  includeLinkedAccounts?: boolean;
1597
+ /**
1598
+ * @public
1599
+ * <p>Specifies the log group class for this log group. There are two classes:</p>
1600
+ * <ul>
1601
+ * <li>
1602
+ * <p>The <code>Standard</code> log class supports all CloudWatch Logs features.</p>
1603
+ * </li>
1604
+ * <li>
1605
+ * <p>The <code>Infrequent Access</code> log class supports a subset of CloudWatch Logs features
1606
+ * and incurs lower costs.</p>
1607
+ * </li>
1608
+ * </ul>
1609
+ * <p>For details about the features supported by each class, see
1610
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html">Log classes</a>
1611
+ * </p>
1612
+ */
1613
+ logGroupClass?: LogGroupClass;
1229
1614
  }
1230
1615
  /**
1231
1616
  * @public
@@ -1294,6 +1679,23 @@ export interface LogGroup {
1294
1679
  * settings.</p>
1295
1680
  */
1296
1681
  inheritedProperties?: InheritedProperty[];
1682
+ /**
1683
+ * @public
1684
+ * <p>This specifies the log group class for this log group. There are two classes:</p>
1685
+ * <ul>
1686
+ * <li>
1687
+ * <p>The <code>Standard</code> log class supports all CloudWatch Logs features.</p>
1688
+ * </li>
1689
+ * <li>
1690
+ * <p>The <code>Infrequent Access</code> log class supports a subset of CloudWatch Logs features
1691
+ * and incurs lower costs.</p>
1692
+ * </li>
1693
+ * </ul>
1694
+ * <p>For details about the features supported by each class, see
1695
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html">Log classes</a>
1696
+ * </p>
1697
+ */
1698
+ logGroupClass?: LogGroupClass;
1297
1699
  }
1298
1700
  /**
1299
1701
  * @public
@@ -2289,6 +2691,77 @@ export interface GetDeliverySourceResponse {
2289
2691
  */
2290
2692
  deliverySource?: DeliverySource;
2291
2693
  }
2694
+ /**
2695
+ * @public
2696
+ */
2697
+ export interface GetLogAnomalyDetectorRequest {
2698
+ /**
2699
+ * @public
2700
+ * <p>The ARN of the anomaly detector to retrieve information about. You can find the ARNs of log anomaly detectors
2701
+ * in your account by using the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListLogAnomalyDetectors.html">ListLogAnomalyDetectors</a>
2702
+ * operation.</p>
2703
+ */
2704
+ anomalyDetectorArn: string | undefined;
2705
+ }
2706
+ /**
2707
+ * @public
2708
+ */
2709
+ export interface GetLogAnomalyDetectorResponse {
2710
+ /**
2711
+ * @public
2712
+ * <p>The name of the log anomaly detector</p>
2713
+ */
2714
+ detectorName?: string;
2715
+ /**
2716
+ * @public
2717
+ * <p>An array of structures, where each structure contains the ARN of a log group
2718
+ * associated with this anomaly detector.</p>
2719
+ */
2720
+ logGroupArnList?: string[];
2721
+ /**
2722
+ * @public
2723
+ * <p>Specifies how often the anomaly detector runs and look for anomalies. Set this value
2724
+ * according to the frequency that the log group receives new logs. For example, if the log group
2725
+ * receives new log events every 10 minutes, then setting <code>evaluationFrequency</code> to
2726
+ * <code>FIFTEEN_MIN</code> might be appropriate.</p>
2727
+ */
2728
+ evaluationFrequency?: EvaluationFrequency;
2729
+ /**
2730
+ * @public
2731
+ * <p>A symbolic description of how CloudWatch Logs should interpret the data in each log
2732
+ * event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You
2733
+ * use the filter pattern to specify what to look for in the log event message.</p>
2734
+ */
2735
+ filterPattern?: string;
2736
+ /**
2737
+ * @public
2738
+ * <p>Specifies whether the anomaly detector is currently active. To change its status, use
2739
+ * the <code>enabled</code> parameter in the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateLogAnomalyDetector.html">UpdateLogAnomalyDetector</a>
2740
+ * operation.</p>
2741
+ */
2742
+ anomalyDetectorStatus?: AnomalyDetectorStatus;
2743
+ /**
2744
+ * @public
2745
+ * <p>The ID of the KMS key assigned to this anomaly detector, if any.</p>
2746
+ */
2747
+ kmsKeyId?: string;
2748
+ /**
2749
+ * @public
2750
+ * <p>The date and time when this anomaly detector was created.</p>
2751
+ */
2752
+ creationTimeStamp?: number;
2753
+ /**
2754
+ * @public
2755
+ * <p>The date and time when this anomaly detector was most recently modified.</p>
2756
+ */
2757
+ lastModifiedTimeStamp?: number;
2758
+ /**
2759
+ * @public
2760
+ * <p>The number of days used as the life cycle of anomalies. After this time, anomalies are automatically baselined
2761
+ * and the anomaly detector model will treat new occurrences of similar event as normal. </p>
2762
+ */
2763
+ anomalyVisibilityTime?: number;
2764
+ }
2292
2765
  /**
2293
2766
  * @public
2294
2767
  */
@@ -2635,6 +3108,99 @@ export declare class InvalidSequenceTokenException extends __BaseException {
2635
3108
  */
2636
3109
  constructor(opts: __ExceptionOptionType<InvalidSequenceTokenException, __BaseException>);
2637
3110
  }
3111
+ /**
3112
+ * @public
3113
+ * @enum
3114
+ */
3115
+ export declare const SuppressionState: {
3116
+ readonly SUPPRESSED: "SUPPRESSED";
3117
+ readonly UNSUPPRESSED: "UNSUPPRESSED";
3118
+ };
3119
+ /**
3120
+ * @public
3121
+ */
3122
+ export type SuppressionState = (typeof SuppressionState)[keyof typeof SuppressionState];
3123
+ /**
3124
+ * @public
3125
+ */
3126
+ export interface ListAnomaliesRequest {
3127
+ /**
3128
+ * @public
3129
+ * <p>Use this to optionally limit the results to only the anomalies found by a certain
3130
+ * anomaly detector.</p>
3131
+ */
3132
+ anomalyDetectorArn?: string;
3133
+ /**
3134
+ * @public
3135
+ * <p>You can specify this parameter if you want to the operation to return only anomalies that
3136
+ * are currently either suppressed or unsuppressed.</p>
3137
+ */
3138
+ suppressionState?: SuppressionState;
3139
+ /**
3140
+ * @public
3141
+ * <p>The maximum number of items to return. If you don't specify a value, the default maximum value of
3142
+ * 50 items is used.</p>
3143
+ */
3144
+ limit?: number;
3145
+ /**
3146
+ * @public
3147
+ * <p>The token for the next set of items to return. The token expires after 24 hours.</p>
3148
+ */
3149
+ nextToken?: string;
3150
+ }
3151
+ /**
3152
+ * @public
3153
+ */
3154
+ export interface ListAnomaliesResponse {
3155
+ /**
3156
+ * @public
3157
+ * <p>An array of structures, where each structure contains information about one anomaly that a log
3158
+ * anomaly detector has found.</p>
3159
+ */
3160
+ anomalies?: Anomaly[];
3161
+ /**
3162
+ * @public
3163
+ * <p>The token for the next set of items to return. The token expires after 24 hours.</p>
3164
+ */
3165
+ nextToken?: string;
3166
+ }
3167
+ /**
3168
+ * @public
3169
+ */
3170
+ export interface ListLogAnomalyDetectorsRequest {
3171
+ /**
3172
+ * @public
3173
+ * <p>Use this to optionally filter the results to only include anomaly detectors that are associated with the
3174
+ * specified log group.</p>
3175
+ */
3176
+ filterLogGroupArn?: string;
3177
+ /**
3178
+ * @public
3179
+ * <p>The maximum number of items to return. If you don't specify a value, the default maximum value of
3180
+ * 50 items is used.</p>
3181
+ */
3182
+ limit?: number;
3183
+ /**
3184
+ * @public
3185
+ * <p>The token for the next set of items to return. The token expires after 24 hours.</p>
3186
+ */
3187
+ nextToken?: string;
3188
+ }
3189
+ /**
3190
+ * @public
3191
+ */
3192
+ export interface ListLogAnomalyDetectorsResponse {
3193
+ /**
3194
+ * @public
3195
+ * <p>An array of structures, where each structure in the array contains information about one anomaly detector.</p>
3196
+ */
3197
+ anomalyDetectors?: AnomalyDetector[];
3198
+ /**
3199
+ * @public
3200
+ * <p>The token for the next set of items to return. The token expires after 24 hours.</p>
3201
+ */
3202
+ nextToken?: string;
3203
+ }
2638
3204
  /**
2639
3205
  * @public
2640
3206
  */
@@ -3149,7 +3715,9 @@ export interface PutQueryDefinitionRequest {
3149
3715
  queryString: string | undefined;
3150
3716
  /**
3151
3717
  * @public
3152
- * <p>Used as an idempotency token, to avoid returning an exception if the service receives the same request twice because of a network
3718
+ * <p>Used as an idempotency token, to avoid returning an exception if the service receives the same
3719
+ * request twice because of a network
3720
+ *
3153
3721
  * error.</p>
3154
3722
  */
3155
3723
  clientToken?: string;
@@ -3598,3 +4166,117 @@ export interface UntagResourceRequest {
3598
4166
  */
3599
4167
  tagKeys: string[] | undefined;
3600
4168
  }
4169
+ /**
4170
+ * @public
4171
+ * @enum
4172
+ */
4173
+ export declare const SuppressionUnit: {
4174
+ readonly HOURS: "HOURS";
4175
+ readonly MINUTES: "MINUTES";
4176
+ readonly SECONDS: "SECONDS";
4177
+ };
4178
+ /**
4179
+ * @public
4180
+ */
4181
+ export type SuppressionUnit = (typeof SuppressionUnit)[keyof typeof SuppressionUnit];
4182
+ /**
4183
+ * @public
4184
+ * <p>If you are suppressing an anomaly temporariliy, this structure defines how long the suppression period
4185
+ * is to be.</p>
4186
+ */
4187
+ export interface SuppressionPeriod {
4188
+ /**
4189
+ * @public
4190
+ * <p>Specifies the number of seconds, minutes or hours to suppress this anomaly. There is no maximum.</p>
4191
+ */
4192
+ value?: number;
4193
+ /**
4194
+ * @public
4195
+ * <p>Specifies whether the value of <code>value</code> is in seconds, minutes, or hours.</p>
4196
+ */
4197
+ suppressionUnit?: SuppressionUnit;
4198
+ }
4199
+ /**
4200
+ * @public
4201
+ * @enum
4202
+ */
4203
+ export declare const SuppressionType: {
4204
+ readonly INFINITE: "INFINITE";
4205
+ readonly LIMITED: "LIMITED";
4206
+ };
4207
+ /**
4208
+ * @public
4209
+ */
4210
+ export type SuppressionType = (typeof SuppressionType)[keyof typeof SuppressionType];
4211
+ /**
4212
+ * @public
4213
+ */
4214
+ export interface UpdateAnomalyRequest {
4215
+ /**
4216
+ * @public
4217
+ * <p>If you are suppressing or unsuppressing an anomaly, specify its unique ID here. You can find anomaly IDs by
4218
+ * using the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListAnomalies.html">ListAnomalies</a> operation.</p>
4219
+ */
4220
+ anomalyId?: string;
4221
+ /**
4222
+ * @public
4223
+ * <p>If you are suppressing or unsuppressing an pattern, specify its unique ID here. You can find pattern IDs by
4224
+ * using the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListAnomalies.html">ListAnomalies</a> operation.</p>
4225
+ */
4226
+ patternId?: string;
4227
+ /**
4228
+ * @public
4229
+ * <p>The ARN of the anomaly detector that this operation is to act on.</p>
4230
+ */
4231
+ anomalyDetectorArn: string | undefined;
4232
+ /**
4233
+ * @public
4234
+ * <p>Use this to specify whether the suppression to be temporary or infinite. If you specify <code>LIMITED</code>,
4235
+ * you must also specify a <code>suppressionPeriod</code>. If you specify <code>INFINITE</code>,
4236
+ * any value for <code>suppressionPeriod</code> is ignored. </p>
4237
+ */
4238
+ suppressionType?: SuppressionType;
4239
+ /**
4240
+ * @public
4241
+ * <p>If you are temporarily suppressing an anomaly or pattern, use this structure to specify
4242
+ * how long the suppression is to last.</p>
4243
+ */
4244
+ suppressionPeriod?: SuppressionPeriod;
4245
+ }
4246
+ /**
4247
+ * @public
4248
+ */
4249
+ export interface UpdateLogAnomalyDetectorRequest {
4250
+ /**
4251
+ * @public
4252
+ * <p>The ARN of the anomaly detector that you want to update.</p>
4253
+ */
4254
+ anomalyDetectorArn: string | undefined;
4255
+ /**
4256
+ * @public
4257
+ * <p>Specifies how often the anomaly detector runs and look for anomalies. Set this value
4258
+ * according to the frequency that the log group receives new logs. For example, if the log group
4259
+ * receives new log events every 10 minutes, then setting <code>evaluationFrequency</code> to
4260
+ * <code>FIFTEEN_MIN</code> might be appropriate.</p>
4261
+ */
4262
+ evaluationFrequency?: EvaluationFrequency;
4263
+ /**
4264
+ * @public
4265
+ * <p>A symbolic description of how CloudWatch Logs should interpret the data in each log
4266
+ * event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You
4267
+ * use the filter pattern to specify what to look for in the log event message.</p>
4268
+ */
4269
+ filterPattern?: string;
4270
+ /**
4271
+ * @public
4272
+ * <p>The number of days to use as the life cycle of anomalies. After this time, anomalies are automatically baselined
4273
+ * and the anomaly detector model will treat new occurrences of similar event as normal. Therefore, if you do not correct the cause of an
4274
+ * anomaly during this time, it will be considered normal going forward and will not be detected.</p>
4275
+ */
4276
+ anomalyVisibilityTime?: number;
4277
+ /**
4278
+ * @public
4279
+ * <p>Use this parameter to pause or restart the anomaly detector. </p>
4280
+ */
4281
+ enabled: boolean | undefined;
4282
+ }