@aws-sdk/client-cloudwatch-logs 3.296.0 → 3.297.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 (61) hide show
  1. package/dist-types/CloudWatchLogs.d.ts +49 -0
  2. package/dist-types/CloudWatchLogsClient.d.ts +24 -4
  3. package/dist-types/commands/AssociateKmsKeyCommand.d.ts +16 -0
  4. package/dist-types/commands/CancelExportTaskCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateExportTaskCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateLogGroupCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateLogStreamCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteDataProtectionPolicyCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteDestinationCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteLogGroupCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteLogStreamCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteMetricFilterCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteQueryDefinitionCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteRetentionPolicyCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteSubscriptionFilterCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeDestinationsCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeExportTasksCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeLogGroupsCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeLogStreamsCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeMetricFiltersCommand.d.ts +16 -0
  22. package/dist-types/commands/DescribeQueriesCommand.d.ts +16 -0
  23. package/dist-types/commands/DescribeQueryDefinitionsCommand.d.ts +16 -0
  24. package/dist-types/commands/DescribeResourcePoliciesCommand.d.ts +16 -0
  25. package/dist-types/commands/DescribeSubscriptionFiltersCommand.d.ts +16 -0
  26. package/dist-types/commands/DisassociateKmsKeyCommand.d.ts +16 -0
  27. package/dist-types/commands/FilterLogEventsCommand.d.ts +16 -0
  28. package/dist-types/commands/GetDataProtectionPolicyCommand.d.ts +16 -0
  29. package/dist-types/commands/GetLogEventsCommand.d.ts +16 -0
  30. package/dist-types/commands/GetLogGroupFieldsCommand.d.ts +16 -0
  31. package/dist-types/commands/GetLogRecordCommand.d.ts +16 -0
  32. package/dist-types/commands/GetQueryResultsCommand.d.ts +16 -0
  33. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  34. package/dist-types/commands/ListTagsLogGroupCommand.d.ts +16 -0
  35. package/dist-types/commands/PutDataProtectionPolicyCommand.d.ts +16 -0
  36. package/dist-types/commands/PutDestinationCommand.d.ts +16 -0
  37. package/dist-types/commands/PutDestinationPolicyCommand.d.ts +16 -0
  38. package/dist-types/commands/PutLogEventsCommand.d.ts +16 -0
  39. package/dist-types/commands/PutMetricFilterCommand.d.ts +16 -0
  40. package/dist-types/commands/PutQueryDefinitionCommand.d.ts +16 -0
  41. package/dist-types/commands/PutResourcePolicyCommand.d.ts +16 -0
  42. package/dist-types/commands/PutRetentionPolicyCommand.d.ts +16 -0
  43. package/dist-types/commands/PutSubscriptionFilterCommand.d.ts +16 -0
  44. package/dist-types/commands/StartQueryCommand.d.ts +16 -0
  45. package/dist-types/commands/StopQueryCommand.d.ts +16 -0
  46. package/dist-types/commands/TagLogGroupCommand.d.ts +16 -0
  47. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  48. package/dist-types/commands/TestMetricFilterCommand.d.ts +16 -0
  49. package/dist-types/commands/UntagLogGroupCommand.d.ts +16 -0
  50. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  51. package/dist-types/models/CloudWatchLogsServiceException.d.ts +2 -0
  52. package/dist-types/models/models_0.d.ts +292 -14
  53. package/dist-types/pagination/DescribeDestinationsPaginator.d.ts +3 -0
  54. package/dist-types/pagination/DescribeLogGroupsPaginator.d.ts +3 -0
  55. package/dist-types/pagination/DescribeLogStreamsPaginator.d.ts +3 -0
  56. package/dist-types/pagination/DescribeMetricFiltersPaginator.d.ts +3 -0
  57. package/dist-types/pagination/DescribeSubscriptionFiltersPaginator.d.ts +3 -0
  58. package/dist-types/pagination/FilterLogEventsPaginator.d.ts +3 -0
  59. package/dist-types/pagination/GetLogEventsPaginator.d.ts +3 -0
  60. package/dist-types/pagination/Interfaces.d.ts +3 -0
  61. package/package.json +3 -3
@@ -1,5 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { CloudWatchLogsServiceException as __BaseException } from "./CloudWatchLogsServiceException";
3
+ /**
4
+ * @public
5
+ */
3
6
  export interface AssociateKmsKeyRequest {
4
7
  /**
5
8
  * <p>The name of the log group.</p>
@@ -13,6 +16,7 @@ export interface AssociateKmsKeyRequest {
13
16
  kmsKeyId: string | undefined;
14
17
  }
15
18
  /**
19
+ * @public
16
20
  * <p>A parameter is specified incorrectly.</p>
17
21
  */
18
22
  export declare class InvalidParameterException extends __BaseException {
@@ -24,6 +28,7 @@ export declare class InvalidParameterException extends __BaseException {
24
28
  constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
25
29
  }
26
30
  /**
31
+ * @public
27
32
  * <p>Multiple concurrent requests to update the same resource were in conflict.</p>
28
33
  */
29
34
  export declare class OperationAbortedException extends __BaseException {
@@ -35,6 +40,7 @@ export declare class OperationAbortedException extends __BaseException {
35
40
  constructor(opts: __ExceptionOptionType<OperationAbortedException, __BaseException>);
36
41
  }
37
42
  /**
43
+ * @public
38
44
  * <p>The specified resource does not exist.</p>
39
45
  */
40
46
  export declare class ResourceNotFoundException extends __BaseException {
@@ -46,6 +52,7 @@ export declare class ResourceNotFoundException extends __BaseException {
46
52
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
47
53
  }
48
54
  /**
55
+ * @public
49
56
  * <p>The service cannot complete the request.</p>
50
57
  */
51
58
  export declare class ServiceUnavailableException extends __BaseException {
@@ -56,6 +63,9 @@ export declare class ServiceUnavailableException extends __BaseException {
56
63
  */
57
64
  constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
58
65
  }
66
+ /**
67
+ * @public
68
+ */
59
69
  export interface CancelExportTaskRequest {
60
70
  /**
61
71
  * <p>The ID of the export task.</p>
@@ -63,6 +73,7 @@ export interface CancelExportTaskRequest {
63
73
  taskId: string | undefined;
64
74
  }
65
75
  /**
76
+ * @public
66
77
  * <p>The operation is not valid on the specified resource.</p>
67
78
  */
68
79
  export declare class InvalidOperationException extends __BaseException {
@@ -73,6 +84,9 @@ export declare class InvalidOperationException extends __BaseException {
73
84
  */
74
85
  constructor(opts: __ExceptionOptionType<InvalidOperationException, __BaseException>);
75
86
  }
87
+ /**
88
+ * @public
89
+ */
76
90
  export interface CreateExportTaskRequest {
77
91
  /**
78
92
  * <p>The name of the export task.</p>
@@ -110,6 +124,9 @@ export interface CreateExportTaskRequest {
110
124
  */
111
125
  destinationPrefix?: string;
112
126
  }
127
+ /**
128
+ * @public
129
+ */
113
130
  export interface CreateExportTaskResponse {
114
131
  /**
115
132
  * <p>The ID of the export task.</p>
@@ -117,6 +134,7 @@ export interface CreateExportTaskResponse {
117
134
  taskId?: string;
118
135
  }
119
136
  /**
137
+ * @public
120
138
  * <p>You have reached the maximum number of resources that can be created.</p>
121
139
  */
122
140
  export declare class LimitExceededException extends __BaseException {
@@ -128,6 +146,7 @@ export declare class LimitExceededException extends __BaseException {
128
146
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
129
147
  }
130
148
  /**
149
+ * @public
131
150
  * <p>The specified resource already exists.</p>
132
151
  */
133
152
  export declare class ResourceAlreadyExistsException extends __BaseException {
@@ -138,6 +157,9 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
138
157
  */
139
158
  constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
140
159
  }
160
+ /**
161
+ * @public
162
+ */
141
163
  export interface CreateLogGroupRequest {
142
164
  /**
143
165
  * <p>The name of the log group.</p>
@@ -161,6 +183,9 @@ export interface CreateLogGroupRequest {
161
183
  */
162
184
  tags?: Record<string, string>;
163
185
  }
186
+ /**
187
+ * @public
188
+ */
164
189
  export interface CreateLogStreamRequest {
165
190
  /**
166
191
  * <p>The name of the log group.</p>
@@ -172,6 +197,7 @@ export interface CreateLogStreamRequest {
172
197
  logStreamName: string | undefined;
173
198
  }
174
199
  /**
200
+ * @public
175
201
  * <p>The event was already logged.</p>
176
202
  * <important>
177
203
  * <p>
@@ -190,30 +216,45 @@ export declare class DataAlreadyAcceptedException extends __BaseException {
190
216
  */
191
217
  constructor(opts: __ExceptionOptionType<DataAlreadyAcceptedException, __BaseException>);
192
218
  }
219
+ /**
220
+ * @public
221
+ */
193
222
  export declare enum DataProtectionStatus {
194
223
  ACTIVATED = "ACTIVATED",
195
224
  ARCHIVED = "ARCHIVED",
196
225
  DELETED = "DELETED",
197
226
  DISABLED = "DISABLED"
198
227
  }
228
+ /**
229
+ * @public
230
+ */
199
231
  export interface DeleteDataProtectionPolicyRequest {
200
232
  /**
201
233
  * <p>The name or ARN of the log group that you want to delete the data protection policy for.</p>
202
234
  */
203
235
  logGroupIdentifier: string | undefined;
204
236
  }
237
+ /**
238
+ * @public
239
+ */
205
240
  export interface DeleteDestinationRequest {
206
241
  /**
207
242
  * <p>The name of the destination.</p>
208
243
  */
209
244
  destinationName: string | undefined;
210
245
  }
246
+ /**
247
+ * @public
248
+ */
211
249
  export interface DeleteLogGroupRequest {
212
250
  /**
213
251
  * <p>The name of the log group.</p>
214
252
  */
215
253
  logGroupName: string | undefined;
216
254
  }
255
+ /**
256
+ * @public
257
+ */
217
258
  export interface DeleteLogStreamRequest {
218
259
  /**
219
260
  * <p>The name of the log group.</p>
@@ -224,6 +265,9 @@ export interface DeleteLogStreamRequest {
224
265
  */
225
266
  logStreamName: string | undefined;
226
267
  }
268
+ /**
269
+ * @public
270
+ */
227
271
  export interface DeleteMetricFilterRequest {
228
272
  /**
229
273
  * <p>The name of the log group.</p>
@@ -234,6 +278,9 @@ export interface DeleteMetricFilterRequest {
234
278
  */
235
279
  filterName: string | undefined;
236
280
  }
281
+ /**
282
+ * @public
283
+ */
237
284
  export interface DeleteQueryDefinitionRequest {
238
285
  /**
239
286
  * <p>The ID of the query definition that you want to delete. You can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html">DescribeQueryDefinitions</a> to retrieve the
@@ -241,6 +288,9 @@ export interface DeleteQueryDefinitionRequest {
241
288
  */
242
289
  queryDefinitionId: string | undefined;
243
290
  }
291
+ /**
292
+ * @public
293
+ */
244
294
  export interface DeleteQueryDefinitionResponse {
245
295
  /**
246
296
  * <p>A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation
@@ -248,18 +298,27 @@ export interface DeleteQueryDefinitionResponse {
248
298
  */
249
299
  success?: boolean;
250
300
  }
301
+ /**
302
+ * @public
303
+ */
251
304
  export interface DeleteResourcePolicyRequest {
252
305
  /**
253
306
  * <p>The name of the policy to be revoked. This parameter is required.</p>
254
307
  */
255
308
  policyName?: string;
256
309
  }
310
+ /**
311
+ * @public
312
+ */
257
313
  export interface DeleteRetentionPolicyRequest {
258
314
  /**
259
315
  * <p>The name of the log group.</p>
260
316
  */
261
317
  logGroupName: string | undefined;
262
318
  }
319
+ /**
320
+ * @public
321
+ */
263
322
  export interface DeleteSubscriptionFilterRequest {
264
323
  /**
265
324
  * <p>The name of the log group.</p>
@@ -270,6 +329,9 @@ export interface DeleteSubscriptionFilterRequest {
270
329
  */
271
330
  filterName: string | undefined;
272
331
  }
332
+ /**
333
+ * @public
334
+ */
273
335
  export interface DescribeDestinationsRequest {
274
336
  /**
275
337
  * <p>The prefix to match. If you don't specify a value, no prefix filter is applied.</p>
@@ -286,6 +348,7 @@ export interface DescribeDestinationsRequest {
286
348
  limit?: number;
287
349
  }
288
350
  /**
351
+ * @public
289
352
  * <p>Represents a cross-account destination that receives subscription log events.</p>
290
353
  */
291
354
  export interface Destination {
@@ -317,6 +380,9 @@ export interface Destination {
317
380
  */
318
381
  creationTime?: number;
319
382
  }
383
+ /**
384
+ * @public
385
+ */
320
386
  export interface DescribeDestinationsResponse {
321
387
  /**
322
388
  * <p>The destinations.</p>
@@ -327,6 +393,9 @@ export interface DescribeDestinationsResponse {
327
393
  */
328
394
  nextToken?: string;
329
395
  }
396
+ /**
397
+ * @public
398
+ */
330
399
  export declare enum ExportTaskStatusCode {
331
400
  CANCELLED = "CANCELLED",
332
401
  COMPLETED = "COMPLETED",
@@ -335,6 +404,9 @@ export declare enum ExportTaskStatusCode {
335
404
  PENDING_CANCEL = "PENDING_CANCEL",
336
405
  RUNNING = "RUNNING"
337
406
  }
407
+ /**
408
+ * @public
409
+ */
338
410
  export interface DescribeExportTasksRequest {
339
411
  /**
340
412
  * <p>The ID of the export task. Specifying a task ID filters the results to one or zero
@@ -355,6 +427,7 @@ export interface DescribeExportTasksRequest {
355
427
  limit?: number;
356
428
  }
357
429
  /**
430
+ * @public
358
431
  * <p>Represents the status of an export task.</p>
359
432
  */
360
433
  export interface ExportTaskExecutionInfo {
@@ -370,6 +443,7 @@ export interface ExportTaskExecutionInfo {
370
443
  completionTime?: number;
371
444
  }
372
445
  /**
446
+ * @public
373
447
  * <p>Represents the status of an export task.</p>
374
448
  */
375
449
  export interface ExportTaskStatus {
@@ -383,6 +457,7 @@ export interface ExportTaskStatus {
383
457
  message?: string;
384
458
  }
385
459
  /**
460
+ * @public
386
461
  * <p>Represents an export task.</p>
387
462
  */
388
463
  export interface ExportTask {
@@ -425,6 +500,9 @@ export interface ExportTask {
425
500
  */
426
501
  executionInfo?: ExportTaskExecutionInfo;
427
502
  }
503
+ /**
504
+ * @public
505
+ */
428
506
  export interface DescribeExportTasksResponse {
429
507
  /**
430
508
  * <p>The export tasks.</p>
@@ -435,6 +513,9 @@ export interface DescribeExportTasksResponse {
435
513
  */
436
514
  nextToken?: string;
437
515
  }
516
+ /**
517
+ * @public
518
+ */
438
519
  export interface DescribeLogGroupsRequest {
439
520
  /**
440
521
  * <p>When <code>includeLinkedAccounts</code> is set to <code>True</code>, use this parameter to
@@ -491,6 +572,7 @@ export interface DescribeLogGroupsRequest {
491
572
  includeLinkedAccounts?: boolean;
492
573
  }
493
574
  /**
575
+ * @public
494
576
  * <p>Represents a log group.</p>
495
577
  */
496
578
  export interface LogGroup {
@@ -532,6 +614,9 @@ export interface LogGroup {
532
614
  */
533
615
  dataProtectionStatus?: DataProtectionStatus | string;
534
616
  }
617
+ /**
618
+ * @public
619
+ */
535
620
  export interface DescribeLogGroupsResponse {
536
621
  /**
537
622
  * <p>The log groups.</p>
@@ -544,10 +629,16 @@ export interface DescribeLogGroupsResponse {
544
629
  */
545
630
  nextToken?: string;
546
631
  }
632
+ /**
633
+ * @public
634
+ */
547
635
  export declare enum OrderBy {
548
636
  LastEventTime = "LastEventTime",
549
637
  LogStreamName = "LogStreamName"
550
638
  }
639
+ /**
640
+ * @public
641
+ */
551
642
  export interface DescribeLogStreamsRequest {
552
643
  /**
553
644
  * <p>The name of the log group.</p>
@@ -605,6 +696,7 @@ export interface DescribeLogStreamsRequest {
605
696
  limit?: number;
606
697
  }
607
698
  /**
699
+ * @public
608
700
  * <p>Represents a log stream, which is a sequence of log events from
609
701
  * a single emitter of logs.</p>
610
702
  */
@@ -662,6 +754,9 @@ export interface LogStream {
662
754
  */
663
755
  storedBytes?: number;
664
756
  }
757
+ /**
758
+ * @public
759
+ */
665
760
  export interface DescribeLogStreamsResponse {
666
761
  /**
667
762
  * <p>The log streams.</p>
@@ -672,6 +767,9 @@ export interface DescribeLogStreamsResponse {
672
767
  */
673
768
  nextToken?: string;
674
769
  }
770
+ /**
771
+ * @public
772
+ */
675
773
  export interface DescribeMetricFiltersRequest {
676
774
  /**
677
775
  * <p>The name of the log group.</p>
@@ -701,6 +799,9 @@ export interface DescribeMetricFiltersRequest {
701
799
  */
702
800
  metricNamespace?: string;
703
801
  }
802
+ /**
803
+ * @public
804
+ */
704
805
  export declare enum StandardUnit {
705
806
  Bits = "Bits",
706
807
  BitsSecond = "Bits/Second",
@@ -731,6 +832,7 @@ export declare enum StandardUnit {
731
832
  TerabytesSecond = "Terabytes/Second"
732
833
  }
733
834
  /**
835
+ * @public
734
836
  * <p>Indicates how to transform ingested log events to metric data in a CloudWatch
735
837
  * metric.</p>
736
838
  */
@@ -780,6 +882,7 @@ export interface MetricTransformation {
780
882
  unit?: StandardUnit | string;
781
883
  }
782
884
  /**
885
+ * @public
783
886
  * <p>Metric filters express how CloudWatch Logs would extract metric observations
784
887
  * from ingested log events and transform them into metric data in a CloudWatch metric.</p>
785
888
  */
@@ -808,6 +911,9 @@ export interface MetricFilter {
808
911
  */
809
912
  logGroupName?: string;
810
913
  }
914
+ /**
915
+ * @public
916
+ */
811
917
  export interface DescribeMetricFiltersResponse {
812
918
  /**
813
919
  * <p>The metric filters.</p>
@@ -818,6 +924,9 @@ export interface DescribeMetricFiltersResponse {
818
924
  */
819
925
  nextToken?: string;
820
926
  }
927
+ /**
928
+ * @public
929
+ */
821
930
  export declare enum QueryStatus {
822
931
  Cancelled = "Cancelled",
823
932
  Complete = "Complete",
@@ -827,6 +936,9 @@ export declare enum QueryStatus {
827
936
  Timeout = "Timeout",
828
937
  Unknown = "Unknown"
829
938
  }
939
+ /**
940
+ * @public
941
+ */
830
942
  export interface DescribeQueriesRequest {
831
943
  /**
832
944
  * <p>Limits the returned queries to only those for the specified log group.</p>
@@ -847,6 +959,7 @@ export interface DescribeQueriesRequest {
847
959
  nextToken?: string;
848
960
  }
849
961
  /**
962
+ * @public
850
963
  * <p>Information about one CloudWatch Logs Insights query that matches the request in a <code>DescribeQueries</code> operation. </p>
851
964
  */
852
965
  export interface QueryInfo {
@@ -872,6 +985,9 @@ export interface QueryInfo {
872
985
  */
873
986
  logGroupName?: string;
874
987
  }
988
+ /**
989
+ * @public
990
+ */
875
991
  export interface DescribeQueriesResponse {
876
992
  /**
877
993
  * <p>The list of queries that match the request.</p>
@@ -882,6 +998,9 @@ export interface DescribeQueriesResponse {
882
998
  */
883
999
  nextToken?: string;
884
1000
  }
1001
+ /**
1002
+ * @public
1003
+ */
885
1004
  export interface DescribeQueryDefinitionsRequest {
886
1005
  /**
887
1006
  * <p>Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.</p>
@@ -897,6 +1016,7 @@ export interface DescribeQueryDefinitionsRequest {
897
1016
  nextToken?: string;
898
1017
  }
899
1018
  /**
1019
+ * @public
900
1020
  * <p>This structure contains details about a saved CloudWatch Logs Insights query definition.</p>
901
1021
  */
902
1022
  export interface QueryDefinition {
@@ -922,6 +1042,9 @@ export interface QueryDefinition {
922
1042
  */
923
1043
  logGroupNames?: string[];
924
1044
  }
1045
+ /**
1046
+ * @public
1047
+ */
925
1048
  export interface DescribeQueryDefinitionsResponse {
926
1049
  /**
927
1050
  * <p>The list of query definitions that match your request.</p>
@@ -932,6 +1055,9 @@ export interface DescribeQueryDefinitionsResponse {
932
1055
  */
933
1056
  nextToken?: string;
934
1057
  }
1058
+ /**
1059
+ * @public
1060
+ */
935
1061
  export interface DescribeResourcePoliciesRequest {
936
1062
  /**
937
1063
  * <p>The token for the next set of items to return. The token expires after 24 hours.</p>
@@ -943,6 +1069,7 @@ export interface DescribeResourcePoliciesRequest {
943
1069
  limit?: number;
944
1070
  }
945
1071
  /**
1072
+ * @public
946
1073
  * <p>A policy enabling one or more entities to put logs to a log group in this account.</p>
947
1074
  */
948
1075
  export interface ResourcePolicy {
@@ -960,6 +1087,9 @@ export interface ResourcePolicy {
960
1087
  */
961
1088
  lastUpdatedTime?: number;
962
1089
  }
1090
+ /**
1091
+ * @public
1092
+ */
963
1093
  export interface DescribeResourcePoliciesResponse {
964
1094
  /**
965
1095
  * <p>The resource policies that exist in this account.</p>
@@ -970,6 +1100,9 @@ export interface DescribeResourcePoliciesResponse {
970
1100
  */
971
1101
  nextToken?: string;
972
1102
  }
1103
+ /**
1104
+ * @public
1105
+ */
973
1106
  export interface DescribeSubscriptionFiltersRequest {
974
1107
  /**
975
1108
  * <p>The name of the log group.</p>
@@ -988,11 +1121,15 @@ export interface DescribeSubscriptionFiltersRequest {
988
1121
  */
989
1122
  limit?: number;
990
1123
  }
1124
+ /**
1125
+ * @public
1126
+ */
991
1127
  export declare enum Distribution {
992
1128
  ByLogStream = "ByLogStream",
993
1129
  Random = "Random"
994
1130
  }
995
1131
  /**
1132
+ * @public
996
1133
  * <p>Represents a subscription filter.</p>
997
1134
  */
998
1135
  export interface SubscriptionFilter {
@@ -1029,6 +1166,9 @@ export interface SubscriptionFilter {
1029
1166
  */
1030
1167
  creationTime?: number;
1031
1168
  }
1169
+ /**
1170
+ * @public
1171
+ */
1032
1172
  export interface DescribeSubscriptionFiltersResponse {
1033
1173
  /**
1034
1174
  * <p>The subscription filters.</p>
@@ -1039,6 +1179,9 @@ export interface DescribeSubscriptionFiltersResponse {
1039
1179
  */
1040
1180
  nextToken?: string;
1041
1181
  }
1182
+ /**
1183
+ * @public
1184
+ */
1042
1185
  export interface DisassociateKmsKeyRequest {
1043
1186
  /**
1044
1187
  * <p>The name of the log group.</p>
@@ -1046,6 +1189,7 @@ export interface DisassociateKmsKeyRequest {
1046
1189
  logGroupName: string | undefined;
1047
1190
  }
1048
1191
  /**
1192
+ * @public
1049
1193
  * <p>Represents a matched event.</p>
1050
1194
  */
1051
1195
  export interface FilteredLogEvent {
@@ -1072,6 +1216,9 @@ export interface FilteredLogEvent {
1072
1216
  */
1073
1217
  eventId?: string;
1074
1218
  }
1219
+ /**
1220
+ * @public
1221
+ */
1075
1222
  export interface FilterLogEventsRequest {
1076
1223
  /**
1077
1224
  * <p>The name of the log group to search.</p>
@@ -1154,6 +1301,7 @@ export interface FilterLogEventsRequest {
1154
1301
  unmask?: boolean;
1155
1302
  }
1156
1303
  /**
1304
+ * @public
1157
1305
  * <p>Represents the search status of a log stream.</p>
1158
1306
  */
1159
1307
  export interface SearchedLogStream {
@@ -1166,6 +1314,9 @@ export interface SearchedLogStream {
1166
1314
  */
1167
1315
  searchedCompletely?: boolean;
1168
1316
  }
1317
+ /**
1318
+ * @public
1319
+ */
1169
1320
  export interface FilterLogEventsResponse {
1170
1321
  /**
1171
1322
  * <p>The matched events.</p>
@@ -1183,12 +1334,18 @@ export interface FilterLogEventsResponse {
1183
1334
  */
1184
1335
  nextToken?: string;
1185
1336
  }
1337
+ /**
1338
+ * @public
1339
+ */
1186
1340
  export interface GetDataProtectionPolicyRequest {
1187
1341
  /**
1188
1342
  * <p>The name or ARN of the log group that contains the data protection policy that you want to see.</p>
1189
1343
  */
1190
1344
  logGroupIdentifier: string | undefined;
1191
1345
  }
1346
+ /**
1347
+ * @public
1348
+ */
1192
1349
  export interface GetDataProtectionPolicyResponse {
1193
1350
  /**
1194
1351
  * <p>The log group name or ARN that you specified in your request.</p>
@@ -1203,6 +1360,9 @@ export interface GetDataProtectionPolicyResponse {
1203
1360
  */
1204
1361
  lastUpdatedTime?: number;
1205
1362
  }
1363
+ /**
1364
+ * @public
1365
+ */
1206
1366
  export interface GetLogEventsRequest {
1207
1367
  /**
1208
1368
  * <p>The name of the log group.</p>
@@ -1267,6 +1427,7 @@ export interface GetLogEventsRequest {
1267
1427
  unmask?: boolean;
1268
1428
  }
1269
1429
  /**
1430
+ * @public
1270
1431
  * <p>Represents a log event.</p>
1271
1432
  */
1272
1433
  export interface OutputLogEvent {
@@ -1285,6 +1446,9 @@ export interface OutputLogEvent {
1285
1446
  */
1286
1447
  ingestionTime?: number;
1287
1448
  }
1449
+ /**
1450
+ * @public
1451
+ */
1288
1452
  export interface GetLogEventsResponse {
1289
1453
  /**
1290
1454
  * <p>The events.</p>
@@ -1303,6 +1467,9 @@ export interface GetLogEventsResponse {
1303
1467
  */
1304
1468
  nextBackwardToken?: string;
1305
1469
  }
1470
+ /**
1471
+ * @public
1472
+ */
1306
1473
  export interface GetLogGroupFieldsRequest {
1307
1474
  /**
1308
1475
  * <p>The name of the log group to search.</p>
@@ -1335,6 +1502,7 @@ export interface GetLogGroupFieldsRequest {
1335
1502
  logGroupIdentifier?: string;
1336
1503
  }
1337
1504
  /**
1505
+ * @public
1338
1506
  * <p>The fields contained in log events found by a <code>GetLogGroupFields</code> operation,
1339
1507
  * along with the percentage of queried log events in which each field appears.</p>
1340
1508
  */
@@ -1348,6 +1516,9 @@ export interface LogGroupField {
1348
1516
  */
1349
1517
  percent?: number;
1350
1518
  }
1519
+ /**
1520
+ * @public
1521
+ */
1351
1522
  export interface GetLogGroupFieldsResponse {
1352
1523
  /**
1353
1524
  * <p>The array of fields found in the query. Each object in the array contains the name of the
@@ -1356,6 +1527,9 @@ export interface GetLogGroupFieldsResponse {
1356
1527
  */
1357
1528
  logGroupFields?: LogGroupField[];
1358
1529
  }
1530
+ /**
1531
+ * @public
1532
+ */
1359
1533
  export interface GetLogRecordRequest {
1360
1534
  /**
1361
1535
  * <p>The pointer corresponding to the log event record you want to retrieve. You get this from
@@ -1372,12 +1546,18 @@ export interface GetLogRecordRequest {
1372
1546
  */
1373
1547
  unmask?: boolean;
1374
1548
  }
1549
+ /**
1550
+ * @public
1551
+ */
1375
1552
  export interface GetLogRecordResponse {
1376
1553
  /**
1377
1554
  * <p>The requested log event, as a JSON string.</p>
1378
1555
  */
1379
1556
  logRecord?: Record<string, string>;
1380
1557
  }
1558
+ /**
1559
+ * @public
1560
+ */
1381
1561
  export interface GetQueryResultsRequest {
1382
1562
  /**
1383
1563
  * <p>The ID number of the query.</p>
@@ -1385,6 +1565,7 @@ export interface GetQueryResultsRequest {
1385
1565
  queryId: string | undefined;
1386
1566
  }
1387
1567
  /**
1568
+ * @public
1388
1569
  * <p>Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.</p>
1389
1570
  * <p>For more information about the fields that are
1390
1571
  * generated by CloudWatch logs, see
@@ -1401,6 +1582,7 @@ export interface ResultField {
1401
1582
  value?: string;
1402
1583
  }
1403
1584
  /**
1585
+ * @public
1404
1586
  * <p>Contains the number of log events scanned by the query, the number of log events that matched the
1405
1587
  * query criteria, and the total number of bytes in the log events that were scanned.</p>
1406
1588
  */
@@ -1418,6 +1600,9 @@ export interface QueryStatistics {
1418
1600
  */
1419
1601
  bytesScanned?: number;
1420
1602
  }
1603
+ /**
1604
+ * @public
1605
+ */
1421
1606
  export interface GetQueryResultsResponse {
1422
1607
  /**
1423
1608
  * <p>The log events that matched the query criteria during the most recent time it ran.</p>
@@ -1442,6 +1627,7 @@ export interface GetQueryResultsResponse {
1442
1627
  status?: QueryStatus | string;
1443
1628
  }
1444
1629
  /**
1630
+ * @public
1445
1631
  * <p>Represents a log event, which is a record of activity that was recorded
1446
1632
  * by the application or resource being monitored.</p>
1447
1633
  */
@@ -1457,6 +1643,7 @@ export interface InputLogEvent {
1457
1643
  message: string | undefined;
1458
1644
  }
1459
1645
  /**
1646
+ * @public
1460
1647
  * <p>The sequence token is not valid. You can get the correct sequence token in
1461
1648
  * the <code>expectedSequenceToken</code> field in the <code>InvalidSequenceTokenException</code>
1462
1649
  * message. </p>
@@ -1476,6 +1663,9 @@ export declare class InvalidSequenceTokenException extends __BaseException {
1476
1663
  */
1477
1664
  constructor(opts: __ExceptionOptionType<InvalidSequenceTokenException, __BaseException>);
1478
1665
  }
1666
+ /**
1667
+ * @public
1668
+ */
1479
1669
  export interface ListTagsForResourceRequest {
1480
1670
  /**
1481
1671
  * <p>The ARN of the resource that you want to view tags for.</p>
@@ -1492,24 +1682,36 @@ export interface ListTagsForResourceRequest {
1492
1682
  */
1493
1683
  resourceArn: string | undefined;
1494
1684
  }
1685
+ /**
1686
+ * @public
1687
+ */
1495
1688
  export interface ListTagsForResourceResponse {
1496
1689
  /**
1497
1690
  * <p>The list of tags associated with the requested resource.></p>
1498
1691
  */
1499
1692
  tags?: Record<string, string>;
1500
1693
  }
1694
+ /**
1695
+ * @public
1696
+ */
1501
1697
  export interface ListTagsLogGroupRequest {
1502
1698
  /**
1503
1699
  * <p>The name of the log group.</p>
1504
1700
  */
1505
1701
  logGroupName: string | undefined;
1506
1702
  }
1703
+ /**
1704
+ * @public
1705
+ */
1507
1706
  export interface ListTagsLogGroupResponse {
1508
1707
  /**
1509
1708
  * <p>The tags for the log group.</p>
1510
1709
  */
1511
1710
  tags?: Record<string, string>;
1512
1711
  }
1712
+ /**
1713
+ * @public
1714
+ */
1513
1715
  export interface PutDataProtectionPolicyRequest {
1514
1716
  /**
1515
1717
  * <p>Specify either the log group name or log group ARN.</p>
@@ -1538,8 +1740,8 @@ export interface PutDataProtectionPolicyRequest {
1538
1740
  * <p>The <code>Operation</code> property with the <code>Deidentify</code> action is what actually masks the
1539
1741
  * data, and it must
1540
1742
  * contain the <code>
1541
- * "MaskConfig": {}</code> object. The <code>
1542
- * "MaskConfig": {}</code> object must be empty.</p>
1743
+ * "MaskConfig": \{\}</code> object. The <code>
1744
+ * "MaskConfig": \{\}</code> object must be empty.</p>
1543
1745
  * </li>
1544
1746
  * </ul>
1545
1747
  * <p>For an example data protection policy, see the <b>Examples</b> section on this page.</p>
@@ -1549,6 +1751,9 @@ export interface PutDataProtectionPolicyRequest {
1549
1751
  */
1550
1752
  policyDocument: string | undefined;
1551
1753
  }
1754
+ /**
1755
+ * @public
1756
+ */
1552
1757
  export interface PutDataProtectionPolicyResponse {
1553
1758
  /**
1554
1759
  * <p>The log group name or ARN that you specified in your request.</p>
@@ -1563,6 +1768,9 @@ export interface PutDataProtectionPolicyResponse {
1563
1768
  */
1564
1769
  lastUpdatedTime?: number;
1565
1770
  }
1771
+ /**
1772
+ * @public
1773
+ */
1566
1774
  export interface PutDestinationRequest {
1567
1775
  /**
1568
1776
  * <p>A name for the destination.</p>
@@ -1585,12 +1793,18 @@ export interface PutDestinationRequest {
1585
1793
  */
1586
1794
  tags?: Record<string, string>;
1587
1795
  }
1796
+ /**
1797
+ * @public
1798
+ */
1588
1799
  export interface PutDestinationResponse {
1589
1800
  /**
1590
1801
  * <p>The destination.</p>
1591
1802
  */
1592
1803
  destination?: Destination;
1593
1804
  }
1805
+ /**
1806
+ * @public
1807
+ */
1594
1808
  export interface PutDestinationPolicyRequest {
1595
1809
  /**
1596
1810
  * <p>A name for an existing destination.</p>
@@ -1616,6 +1830,9 @@ export interface PutDestinationPolicyRequest {
1616
1830
  */
1617
1831
  forceUpdate?: boolean;
1618
1832
  }
1833
+ /**
1834
+ * @public
1835
+ */
1619
1836
  export interface PutLogEventsRequest {
1620
1837
  /**
1621
1838
  * <p>The name of the log group.</p>
@@ -1642,6 +1859,7 @@ export interface PutLogEventsRequest {
1642
1859
  sequenceToken?: string;
1643
1860
  }
1644
1861
  /**
1862
+ * @public
1645
1863
  * <p>Represents the rejected events.</p>
1646
1864
  */
1647
1865
  export interface RejectedLogEventsInfo {
@@ -1658,6 +1876,9 @@ export interface RejectedLogEventsInfo {
1658
1876
  */
1659
1877
  expiredLogEventEndIndex?: number;
1660
1878
  }
1879
+ /**
1880
+ * @public
1881
+ */
1661
1882
  export interface PutLogEventsResponse {
1662
1883
  /**
1663
1884
  * <p>The next sequence token.</p>
@@ -1678,6 +1899,7 @@ export interface PutLogEventsResponse {
1678
1899
  rejectedLogEventsInfo?: RejectedLogEventsInfo;
1679
1900
  }
1680
1901
  /**
1902
+ * @public
1681
1903
  * <p>The most likely cause is an Amazon Web Services access key ID or secret key that's not
1682
1904
  * valid.</p>
1683
1905
  */
@@ -1689,6 +1911,9 @@ export declare class UnrecognizedClientException extends __BaseException {
1689
1911
  */
1690
1912
  constructor(opts: __ExceptionOptionType<UnrecognizedClientException, __BaseException>);
1691
1913
  }
1914
+ /**
1915
+ * @public
1916
+ */
1692
1917
  export interface PutMetricFilterRequest {
1693
1918
  /**
1694
1919
  * <p>The name of the log group.</p>
@@ -1707,6 +1932,9 @@ export interface PutMetricFilterRequest {
1707
1932
  */
1708
1933
  metricTransformations: MetricTransformation[] | undefined;
1709
1934
  }
1935
+ /**
1936
+ * @public
1937
+ */
1710
1938
  export interface PutQueryDefinitionRequest {
1711
1939
  /**
1712
1940
  * <p>A name for the query definition. If you are saving numerous query definitions, we
@@ -1735,12 +1963,18 @@ export interface PutQueryDefinitionRequest {
1735
1963
  */
1736
1964
  queryString: string | undefined;
1737
1965
  }
1966
+ /**
1967
+ * @public
1968
+ */
1738
1969
  export interface PutQueryDefinitionResponse {
1739
1970
  /**
1740
1971
  * <p>The ID of the query definition.</p>
1741
1972
  */
1742
1973
  queryDefinitionId?: string;
1743
1974
  }
1975
+ /**
1976
+ * @public
1977
+ */
1744
1978
  export interface PutResourcePolicyRequest {
1745
1979
  /**
1746
1980
  * <p>Name of the new policy. This parameter is required.</p>
@@ -1761,40 +1995,46 @@ export interface PutResourcePolicyRequest {
1761
1995
  * that call.</p>
1762
1996
  * <p></p>
1763
1997
  * <p>
1764
- * <code>{
1998
+ * <code>\{
1765
1999
  * "Version": "2012-10-17",
1766
2000
  * "Statement": [
1767
- * {
2001
+ * \{
1768
2002
  * "Sid": "Route53LogsToCloudWatchLogs",
1769
2003
  * "Effect": "Allow",
1770
- * "Principal": {
2004
+ * "Principal": \{
1771
2005
  * "Service": [
1772
2006
  * "route53.amazonaws.com"
1773
2007
  * ]
1774
- * },
2008
+ * \},
1775
2009
  * "Action": "logs:PutLogEvents",
1776
2010
  * "Resource": "logArn",
1777
- * "Condition": {
1778
- * "ArnLike": {
2011
+ * "Condition": \{
2012
+ * "ArnLike": \{
1779
2013
  * "aws:SourceArn": "myRoute53ResourceArn"
1780
- * },
1781
- * "StringEquals": {
2014
+ * \},
2015
+ * "StringEquals": \{
1782
2016
  * "aws:SourceAccount": "myAwsAccountId"
1783
- * }
1784
- * }
1785
- * }
2017
+ * \}
2018
+ * \}
2019
+ * \}
1786
2020
  * ]
1787
- * }</code>
2021
+ * \}</code>
1788
2022
  * </p>
1789
2023
  */
1790
2024
  policyDocument?: string;
1791
2025
  }
2026
+ /**
2027
+ * @public
2028
+ */
1792
2029
  export interface PutResourcePolicyResponse {
1793
2030
  /**
1794
2031
  * <p>The new policy.</p>
1795
2032
  */
1796
2033
  resourcePolicy?: ResourcePolicy;
1797
2034
  }
2035
+ /**
2036
+ * @public
2037
+ */
1798
2038
  export interface PutRetentionPolicyRequest {
1799
2039
  /**
1800
2040
  * <p>The name of the log group.</p>
@@ -1807,6 +2047,9 @@ export interface PutRetentionPolicyRequest {
1807
2047
  */
1808
2048
  retentionInDays: number | undefined;
1809
2049
  }
2050
+ /**
2051
+ * @public
2052
+ */
1810
2053
  export interface PutSubscriptionFilterRequest {
1811
2054
  /**
1812
2055
  * <p>The name of the log group.</p>
@@ -1862,6 +2105,7 @@ export interface PutSubscriptionFilterRequest {
1862
2105
  distribution?: Distribution | string;
1863
2106
  }
1864
2107
  /**
2108
+ * @public
1865
2109
  * <p>Reserved.</p>
1866
2110
  */
1867
2111
  export interface QueryCompileErrorLocation {
@@ -1875,6 +2119,7 @@ export interface QueryCompileErrorLocation {
1875
2119
  endCharOffset?: number;
1876
2120
  }
1877
2121
  /**
2122
+ * @public
1878
2123
  * <p>Reserved.</p>
1879
2124
  */
1880
2125
  export interface QueryCompileError {
@@ -1888,6 +2133,7 @@ export interface QueryCompileError {
1888
2133
  message?: string;
1889
2134
  }
1890
2135
  /**
2136
+ * @public
1891
2137
  * <p>The query string is not valid. Details about this error are displayed in a
1892
2138
  * <code>QueryCompileError</code> object. For more information, see
1893
2139
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_QueryCompileError.html">QueryCompileError</a>.</p>
@@ -1906,6 +2152,9 @@ export declare class MalformedQueryException extends __BaseException {
1906
2152
  */
1907
2153
  constructor(opts: __ExceptionOptionType<MalformedQueryException, __BaseException>);
1908
2154
  }
2155
+ /**
2156
+ * @public
2157
+ */
1909
2158
  export interface StartQueryRequest {
1910
2159
  /**
1911
2160
  * <p>The log group on which to perform the query.</p>
@@ -1962,12 +2211,18 @@ export interface StartQueryRequest {
1962
2211
  */
1963
2212
  limit?: number;
1964
2213
  }
2214
+ /**
2215
+ * @public
2216
+ */
1965
2217
  export interface StartQueryResponse {
1966
2218
  /**
1967
2219
  * <p>The unique ID of the query. </p>
1968
2220
  */
1969
2221
  queryId?: string;
1970
2222
  }
2223
+ /**
2224
+ * @public
2225
+ */
1971
2226
  export interface StopQueryRequest {
1972
2227
  /**
1973
2228
  * <p>The ID number of the query to stop. To find this ID number, use
@@ -1975,12 +2230,18 @@ export interface StopQueryRequest {
1975
2230
  */
1976
2231
  queryId: string | undefined;
1977
2232
  }
2233
+ /**
2234
+ * @public
2235
+ */
1978
2236
  export interface StopQueryResponse {
1979
2237
  /**
1980
2238
  * <p>This is true if the query was stopped by the <code>StopQuery</code> operation.</p>
1981
2239
  */
1982
2240
  success?: boolean;
1983
2241
  }
2242
+ /**
2243
+ * @public
2244
+ */
1984
2245
  export interface TagLogGroupRequest {
1985
2246
  /**
1986
2247
  * <p>The name of the log group.</p>
@@ -1991,6 +2252,9 @@ export interface TagLogGroupRequest {
1991
2252
  */
1992
2253
  tags: Record<string, string> | undefined;
1993
2254
  }
2255
+ /**
2256
+ * @public
2257
+ */
1994
2258
  export interface TagResourceRequest {
1995
2259
  /**
1996
2260
  * <p>The ARN of the resource that you're adding tags to.</p>
@@ -2012,6 +2276,7 @@ export interface TagResourceRequest {
2012
2276
  tags: Record<string, string> | undefined;
2013
2277
  }
2014
2278
  /**
2279
+ * @public
2015
2280
  * <p>A resource can have no more than 50 tags.</p>
2016
2281
  */
2017
2282
  export declare class TooManyTagsException extends __BaseException {
@@ -2026,6 +2291,9 @@ export declare class TooManyTagsException extends __BaseException {
2026
2291
  */
2027
2292
  constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
2028
2293
  }
2294
+ /**
2295
+ * @public
2296
+ */
2029
2297
  export interface TestMetricFilterRequest {
2030
2298
  /**
2031
2299
  * <p>A symbolic description of how CloudWatch Logs should interpret the data in each log
@@ -2039,6 +2307,7 @@ export interface TestMetricFilterRequest {
2039
2307
  logEventMessages: string[] | undefined;
2040
2308
  }
2041
2309
  /**
2310
+ * @public
2042
2311
  * <p>Represents a matched event.</p>
2043
2312
  */
2044
2313
  export interface MetricFilterMatchRecord {
@@ -2055,12 +2324,18 @@ export interface MetricFilterMatchRecord {
2055
2324
  */
2056
2325
  extractedValues?: Record<string, string>;
2057
2326
  }
2327
+ /**
2328
+ * @public
2329
+ */
2058
2330
  export interface TestMetricFilterResponse {
2059
2331
  /**
2060
2332
  * <p>The matched events.</p>
2061
2333
  */
2062
2334
  matches?: MetricFilterMatchRecord[];
2063
2335
  }
2336
+ /**
2337
+ * @public
2338
+ */
2064
2339
  export interface UntagLogGroupRequest {
2065
2340
  /**
2066
2341
  * <p>The name of the log group.</p>
@@ -2071,6 +2346,9 @@ export interface UntagLogGroupRequest {
2071
2346
  */
2072
2347
  tags: string[] | undefined;
2073
2348
  }
2349
+ /**
2350
+ * @public
2351
+ */
2074
2352
  export interface UntagResourceRequest {
2075
2353
  /**
2076
2354
  * <p>The ARN of the CloudWatch Logs resource that you're removing tags from.</p>