@aws-sdk/client-cloudwatch-logs 3.379.1 → 3.385.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +310 -0
- package/package.json +5 -5
|
@@ -28,27 +28,33 @@ export type Scope = (typeof Scope)[keyof typeof Scope];
|
|
|
28
28
|
*/
|
|
29
29
|
export interface AccountPolicy {
|
|
30
30
|
/**
|
|
31
|
+
* @public
|
|
31
32
|
* <p>The name of the account policy.</p>
|
|
32
33
|
*/
|
|
33
34
|
policyName?: string;
|
|
34
35
|
/**
|
|
36
|
+
* @public
|
|
35
37
|
* <p>The policy document for this account policy.</p>
|
|
36
38
|
* <p>The JSON specified in <code>policyDocument</code> can be up to 30,720 characters.</p>
|
|
37
39
|
*/
|
|
38
40
|
policyDocument?: string;
|
|
39
41
|
/**
|
|
42
|
+
* @public
|
|
40
43
|
* <p>The date and time that this policy was most recently updated.</p>
|
|
41
44
|
*/
|
|
42
45
|
lastUpdatedTime?: number;
|
|
43
46
|
/**
|
|
47
|
+
* @public
|
|
44
48
|
* <p>The type of policy for this account policy.</p>
|
|
45
49
|
*/
|
|
46
50
|
policyType?: PolicyType | string;
|
|
47
51
|
/**
|
|
52
|
+
* @public
|
|
48
53
|
* <p>The scope of the account policy.</p>
|
|
49
54
|
*/
|
|
50
55
|
scope?: Scope | string;
|
|
51
56
|
/**
|
|
57
|
+
* @public
|
|
52
58
|
* <p>The Amazon Web Services account ID that the policy applies to.</p>
|
|
53
59
|
*/
|
|
54
60
|
accountId?: string;
|
|
@@ -58,6 +64,7 @@ export interface AccountPolicy {
|
|
|
58
64
|
*/
|
|
59
65
|
export interface AssociateKmsKeyRequest {
|
|
60
66
|
/**
|
|
67
|
+
* @public
|
|
61
68
|
* <p>The name of the log group.</p>
|
|
62
69
|
* <p>In your <code>AssociateKmsKey</code> operation,
|
|
63
70
|
* you must specify either the <code>resourceIdentifier</code> parameter or the <code>logGroup</code> parameter,
|
|
@@ -65,12 +72,14 @@ export interface AssociateKmsKeyRequest {
|
|
|
65
72
|
*/
|
|
66
73
|
logGroupName?: string;
|
|
67
74
|
/**
|
|
75
|
+
* @public
|
|
68
76
|
* <p>The Amazon Resource Name (ARN) of the KMS key to use when encrypting log
|
|
69
77
|
* data. This must be a symmetric KMS key. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms">Amazon Resource Names</a> and <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric
|
|
70
78
|
* Keys</a>.</p>
|
|
71
79
|
*/
|
|
72
80
|
kmsKeyId: string | undefined;
|
|
73
81
|
/**
|
|
82
|
+
* @public
|
|
74
83
|
* <p>Specifies the target for this operation. You must specify one of the following:</p>
|
|
75
84
|
* <ul>
|
|
76
85
|
* <li>
|
|
@@ -152,6 +161,7 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
152
161
|
*/
|
|
153
162
|
export interface CancelExportTaskRequest {
|
|
154
163
|
/**
|
|
164
|
+
* @public
|
|
155
165
|
* <p>The ID of the export task.</p>
|
|
156
166
|
*/
|
|
157
167
|
taskId: string | undefined;
|
|
@@ -173,25 +183,30 @@ export declare class InvalidOperationException extends __BaseException {
|
|
|
173
183
|
*/
|
|
174
184
|
export interface CreateExportTaskRequest {
|
|
175
185
|
/**
|
|
186
|
+
* @public
|
|
176
187
|
* <p>The name of the export task.</p>
|
|
177
188
|
*/
|
|
178
189
|
taskName?: string;
|
|
179
190
|
/**
|
|
191
|
+
* @public
|
|
180
192
|
* <p>The name of the log group.</p>
|
|
181
193
|
*/
|
|
182
194
|
logGroupName: string | undefined;
|
|
183
195
|
/**
|
|
196
|
+
* @public
|
|
184
197
|
* <p>Export only log streams that match the provided prefix. If you don't
|
|
185
198
|
* specify a value, no prefix filter is applied.</p>
|
|
186
199
|
*/
|
|
187
200
|
logStreamNamePrefix?: string;
|
|
188
201
|
/**
|
|
202
|
+
* @public
|
|
189
203
|
* <p>The start time of the range for the request, expressed as the number of milliseconds
|
|
190
204
|
* after <code>Jan 1, 1970 00:00:00 UTC</code>. Events with a timestamp earlier than this time
|
|
191
205
|
* are not exported.</p>
|
|
192
206
|
*/
|
|
193
207
|
from: number | undefined;
|
|
194
208
|
/**
|
|
209
|
+
* @public
|
|
195
210
|
* <p>The end time of the range for the request, expressed as the number of milliseconds
|
|
196
211
|
* after <code>Jan 1, 1970 00:00:00 UTC</code>. Events with a timestamp later than this time are
|
|
197
212
|
* not exported.</p>
|
|
@@ -199,10 +214,12 @@ export interface CreateExportTaskRequest {
|
|
|
199
214
|
*/
|
|
200
215
|
to: number | undefined;
|
|
201
216
|
/**
|
|
217
|
+
* @public
|
|
202
218
|
* <p>The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.</p>
|
|
203
219
|
*/
|
|
204
220
|
destination: string | undefined;
|
|
205
221
|
/**
|
|
222
|
+
* @public
|
|
206
223
|
* <p>The prefix used as the start of the key for every object exported. If you don't
|
|
207
224
|
* specify a value, the default is <code>exportedlogs</code>.</p>
|
|
208
225
|
*/
|
|
@@ -213,6 +230,7 @@ export interface CreateExportTaskRequest {
|
|
|
213
230
|
*/
|
|
214
231
|
export interface CreateExportTaskResponse {
|
|
215
232
|
/**
|
|
233
|
+
* @public
|
|
216
234
|
* <p>The ID of the export task.</p>
|
|
217
235
|
*/
|
|
218
236
|
taskId?: string;
|
|
@@ -246,16 +264,19 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
246
264
|
*/
|
|
247
265
|
export interface CreateLogGroupRequest {
|
|
248
266
|
/**
|
|
267
|
+
* @public
|
|
249
268
|
* <p>The name of the log group.</p>
|
|
250
269
|
*/
|
|
251
270
|
logGroupName: string | undefined;
|
|
252
271
|
/**
|
|
272
|
+
* @public
|
|
253
273
|
* <p>The Amazon Resource Name (ARN) of the KMS key to use when encrypting log
|
|
254
274
|
* data. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms">Amazon Resource
|
|
255
275
|
* Names</a>.</p>
|
|
256
276
|
*/
|
|
257
277
|
kmsKeyId?: string;
|
|
258
278
|
/**
|
|
279
|
+
* @public
|
|
259
280
|
* <p>The key-value pairs to use for the tags.</p>
|
|
260
281
|
* <p>You can grant users access to certain log groups while preventing them from accessing other log groups.
|
|
261
282
|
* To do so, tag your groups and use IAM policies that refer to those tags. To assign tags when
|
|
@@ -272,10 +293,12 @@ export interface CreateLogGroupRequest {
|
|
|
272
293
|
*/
|
|
273
294
|
export interface CreateLogStreamRequest {
|
|
274
295
|
/**
|
|
296
|
+
* @public
|
|
275
297
|
* <p>The name of the log group.</p>
|
|
276
298
|
*/
|
|
277
299
|
logGroupName: string | undefined;
|
|
278
300
|
/**
|
|
301
|
+
* @public
|
|
279
302
|
* <p>The name of the log stream.</p>
|
|
280
303
|
*/
|
|
281
304
|
logStreamName: string | undefined;
|
|
@@ -319,10 +342,12 @@ export type DataProtectionStatus = (typeof DataProtectionStatus)[keyof typeof Da
|
|
|
319
342
|
*/
|
|
320
343
|
export interface DeleteAccountPolicyRequest {
|
|
321
344
|
/**
|
|
345
|
+
* @public
|
|
322
346
|
* <p>The name of the policy to delete.</p>
|
|
323
347
|
*/
|
|
324
348
|
policyName: string | undefined;
|
|
325
349
|
/**
|
|
350
|
+
* @public
|
|
326
351
|
* <p>The type of policy to delete. Currently, the only valid value is <code>DATA_PROTECTION_POLICY</code>.</p>
|
|
327
352
|
*/
|
|
328
353
|
policyType: PolicyType | string | undefined;
|
|
@@ -332,6 +357,7 @@ export interface DeleteAccountPolicyRequest {
|
|
|
332
357
|
*/
|
|
333
358
|
export interface DeleteDataProtectionPolicyRequest {
|
|
334
359
|
/**
|
|
360
|
+
* @public
|
|
335
361
|
* <p>The name or ARN of the log group that you want to delete the data protection policy for.</p>
|
|
336
362
|
*/
|
|
337
363
|
logGroupIdentifier: string | undefined;
|
|
@@ -341,6 +367,7 @@ export interface DeleteDataProtectionPolicyRequest {
|
|
|
341
367
|
*/
|
|
342
368
|
export interface DeleteDestinationRequest {
|
|
343
369
|
/**
|
|
370
|
+
* @public
|
|
344
371
|
* <p>The name of the destination.</p>
|
|
345
372
|
*/
|
|
346
373
|
destinationName: string | undefined;
|
|
@@ -350,6 +377,7 @@ export interface DeleteDestinationRequest {
|
|
|
350
377
|
*/
|
|
351
378
|
export interface DeleteLogGroupRequest {
|
|
352
379
|
/**
|
|
380
|
+
* @public
|
|
353
381
|
* <p>The name of the log group.</p>
|
|
354
382
|
*/
|
|
355
383
|
logGroupName: string | undefined;
|
|
@@ -359,10 +387,12 @@ export interface DeleteLogGroupRequest {
|
|
|
359
387
|
*/
|
|
360
388
|
export interface DeleteLogStreamRequest {
|
|
361
389
|
/**
|
|
390
|
+
* @public
|
|
362
391
|
* <p>The name of the log group.</p>
|
|
363
392
|
*/
|
|
364
393
|
logGroupName: string | undefined;
|
|
365
394
|
/**
|
|
395
|
+
* @public
|
|
366
396
|
* <p>The name of the log stream.</p>
|
|
367
397
|
*/
|
|
368
398
|
logStreamName: string | undefined;
|
|
@@ -372,10 +402,12 @@ export interface DeleteLogStreamRequest {
|
|
|
372
402
|
*/
|
|
373
403
|
export interface DeleteMetricFilterRequest {
|
|
374
404
|
/**
|
|
405
|
+
* @public
|
|
375
406
|
* <p>The name of the log group.</p>
|
|
376
407
|
*/
|
|
377
408
|
logGroupName: string | undefined;
|
|
378
409
|
/**
|
|
410
|
+
* @public
|
|
379
411
|
* <p>The name of the metric filter.</p>
|
|
380
412
|
*/
|
|
381
413
|
filterName: string | undefined;
|
|
@@ -385,6 +417,7 @@ export interface DeleteMetricFilterRequest {
|
|
|
385
417
|
*/
|
|
386
418
|
export interface DeleteQueryDefinitionRequest {
|
|
387
419
|
/**
|
|
420
|
+
* @public
|
|
388
421
|
* <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
|
|
389
422
|
* IDs of your saved query definitions.</p>
|
|
390
423
|
*/
|
|
@@ -395,6 +428,7 @@ export interface DeleteQueryDefinitionRequest {
|
|
|
395
428
|
*/
|
|
396
429
|
export interface DeleteQueryDefinitionResponse {
|
|
397
430
|
/**
|
|
431
|
+
* @public
|
|
398
432
|
* <p>A value of TRUE indicates that the operation succeeded. FALSE indicates that the operation
|
|
399
433
|
* failed.</p>
|
|
400
434
|
*/
|
|
@@ -405,6 +439,7 @@ export interface DeleteQueryDefinitionResponse {
|
|
|
405
439
|
*/
|
|
406
440
|
export interface DeleteResourcePolicyRequest {
|
|
407
441
|
/**
|
|
442
|
+
* @public
|
|
408
443
|
* <p>The name of the policy to be revoked. This parameter is required.</p>
|
|
409
444
|
*/
|
|
410
445
|
policyName?: string;
|
|
@@ -414,6 +449,7 @@ export interface DeleteResourcePolicyRequest {
|
|
|
414
449
|
*/
|
|
415
450
|
export interface DeleteRetentionPolicyRequest {
|
|
416
451
|
/**
|
|
452
|
+
* @public
|
|
417
453
|
* <p>The name of the log group.</p>
|
|
418
454
|
*/
|
|
419
455
|
logGroupName: string | undefined;
|
|
@@ -423,10 +459,12 @@ export interface DeleteRetentionPolicyRequest {
|
|
|
423
459
|
*/
|
|
424
460
|
export interface DeleteSubscriptionFilterRequest {
|
|
425
461
|
/**
|
|
462
|
+
* @public
|
|
426
463
|
* <p>The name of the log group.</p>
|
|
427
464
|
*/
|
|
428
465
|
logGroupName: string | undefined;
|
|
429
466
|
/**
|
|
467
|
+
* @public
|
|
430
468
|
* <p>The name of the subscription filter.</p>
|
|
431
469
|
*/
|
|
432
470
|
filterName: string | undefined;
|
|
@@ -436,15 +474,18 @@ export interface DeleteSubscriptionFilterRequest {
|
|
|
436
474
|
*/
|
|
437
475
|
export interface DescribeAccountPoliciesRequest {
|
|
438
476
|
/**
|
|
477
|
+
* @public
|
|
439
478
|
* <p>Use this parameter to limit the returned policies to only the policies that match the policy type that you
|
|
440
479
|
* specify. Currently, the only valid value is <code>DATA_PROTECTION_POLICY</code>.</p>
|
|
441
480
|
*/
|
|
442
481
|
policyType: PolicyType | string | undefined;
|
|
443
482
|
/**
|
|
483
|
+
* @public
|
|
444
484
|
* <p>Use this parameter to limit the returned policies to only the policy with the name that you specify.</p>
|
|
445
485
|
*/
|
|
446
486
|
policyName?: string;
|
|
447
487
|
/**
|
|
488
|
+
* @public
|
|
448
489
|
* <p>If you are using an account that is set up as a monitoring account for CloudWatch unified cross-account
|
|
449
490
|
* observability, you can use this to specify the account ID of a source account. If you do,
|
|
450
491
|
* the operation returns the account policy for the specified account. Currently, you can specify only
|
|
@@ -459,6 +500,7 @@ export interface DescribeAccountPoliciesRequest {
|
|
|
459
500
|
*/
|
|
460
501
|
export interface DescribeAccountPoliciesResponse {
|
|
461
502
|
/**
|
|
503
|
+
* @public
|
|
462
504
|
* <p>An array of structures that contain information about the CloudWatch Logs account policies that match
|
|
463
505
|
* the specified filters.</p>
|
|
464
506
|
*/
|
|
@@ -469,14 +511,17 @@ export interface DescribeAccountPoliciesResponse {
|
|
|
469
511
|
*/
|
|
470
512
|
export interface DescribeDestinationsRequest {
|
|
471
513
|
/**
|
|
514
|
+
* @public
|
|
472
515
|
* <p>The prefix to match. If you don't specify a value, no prefix filter is applied.</p>
|
|
473
516
|
*/
|
|
474
517
|
DestinationNamePrefix?: string;
|
|
475
518
|
/**
|
|
519
|
+
* @public
|
|
476
520
|
* <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
|
|
477
521
|
*/
|
|
478
522
|
nextToken?: string;
|
|
479
523
|
/**
|
|
524
|
+
* @public
|
|
480
525
|
* <p>The maximum number of items returned. If you don't specify a value, the default maximum value of
|
|
481
526
|
* 50 items is used.</p>
|
|
482
527
|
*/
|
|
@@ -488,28 +533,34 @@ export interface DescribeDestinationsRequest {
|
|
|
488
533
|
*/
|
|
489
534
|
export interface Destination {
|
|
490
535
|
/**
|
|
536
|
+
* @public
|
|
491
537
|
* <p>The name of the destination.</p>
|
|
492
538
|
*/
|
|
493
539
|
destinationName?: string;
|
|
494
540
|
/**
|
|
541
|
+
* @public
|
|
495
542
|
* <p>The Amazon Resource Name (ARN) of the physical target where the log events are
|
|
496
543
|
* delivered (for example, a Kinesis stream).</p>
|
|
497
544
|
*/
|
|
498
545
|
targetArn?: string;
|
|
499
546
|
/**
|
|
547
|
+
* @public
|
|
500
548
|
* <p>A role for impersonation, used when delivering log events to the target.</p>
|
|
501
549
|
*/
|
|
502
550
|
roleArn?: string;
|
|
503
551
|
/**
|
|
552
|
+
* @public
|
|
504
553
|
* <p>An IAM policy document that governs which Amazon Web Services accounts can create subscription filters
|
|
505
554
|
* against this destination.</p>
|
|
506
555
|
*/
|
|
507
556
|
accessPolicy?: string;
|
|
508
557
|
/**
|
|
558
|
+
* @public
|
|
509
559
|
* <p>The ARN of this destination.</p>
|
|
510
560
|
*/
|
|
511
561
|
arn?: string;
|
|
512
562
|
/**
|
|
563
|
+
* @public
|
|
513
564
|
* <p>The creation time of the destination, expressed as the number of milliseconds after Jan
|
|
514
565
|
* 1, 1970 00:00:00 UTC.</p>
|
|
515
566
|
*/
|
|
@@ -520,10 +571,12 @@ export interface Destination {
|
|
|
520
571
|
*/
|
|
521
572
|
export interface DescribeDestinationsResponse {
|
|
522
573
|
/**
|
|
574
|
+
* @public
|
|
523
575
|
* <p>The destinations.</p>
|
|
524
576
|
*/
|
|
525
577
|
destinations?: Destination[];
|
|
526
578
|
/**
|
|
579
|
+
* @public
|
|
527
580
|
* <p>The token for the next set of items to return. The token expires after 24 hours.</p>
|
|
528
581
|
*/
|
|
529
582
|
nextToken?: string;
|
|
@@ -549,19 +602,23 @@ export type ExportTaskStatusCode = (typeof ExportTaskStatusCode)[keyof typeof Ex
|
|
|
549
602
|
*/
|
|
550
603
|
export interface DescribeExportTasksRequest {
|
|
551
604
|
/**
|
|
605
|
+
* @public
|
|
552
606
|
* <p>The ID of the export task. Specifying a task ID filters the results to one or zero
|
|
553
607
|
* export tasks.</p>
|
|
554
608
|
*/
|
|
555
609
|
taskId?: string;
|
|
556
610
|
/**
|
|
611
|
+
* @public
|
|
557
612
|
* <p>The status code of the export task. Specifying a status code filters the results to zero or more export tasks.</p>
|
|
558
613
|
*/
|
|
559
614
|
statusCode?: ExportTaskStatusCode | string;
|
|
560
615
|
/**
|
|
616
|
+
* @public
|
|
561
617
|
* <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
|
|
562
618
|
*/
|
|
563
619
|
nextToken?: string;
|
|
564
620
|
/**
|
|
621
|
+
* @public
|
|
565
622
|
* <p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>
|
|
566
623
|
*/
|
|
567
624
|
limit?: number;
|
|
@@ -572,11 +629,13 @@ export interface DescribeExportTasksRequest {
|
|
|
572
629
|
*/
|
|
573
630
|
export interface ExportTaskExecutionInfo {
|
|
574
631
|
/**
|
|
632
|
+
* @public
|
|
575
633
|
* <p>The creation time of the export task, expressed as the number of milliseconds after
|
|
576
634
|
* <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
577
635
|
*/
|
|
578
636
|
creationTime?: number;
|
|
579
637
|
/**
|
|
638
|
+
* @public
|
|
580
639
|
* <p>The completion time of the export task, expressed as the number of milliseconds after
|
|
581
640
|
* <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
582
641
|
*/
|
|
@@ -588,10 +647,12 @@ export interface ExportTaskExecutionInfo {
|
|
|
588
647
|
*/
|
|
589
648
|
export interface ExportTaskStatus {
|
|
590
649
|
/**
|
|
650
|
+
* @public
|
|
591
651
|
* <p>The status code of the export task.</p>
|
|
592
652
|
*/
|
|
593
653
|
code?: ExportTaskStatusCode | string;
|
|
594
654
|
/**
|
|
655
|
+
* @public
|
|
595
656
|
* <p>The status message related to the status code.</p>
|
|
596
657
|
*/
|
|
597
658
|
message?: string;
|
|
@@ -602,40 +663,49 @@ export interface ExportTaskStatus {
|
|
|
602
663
|
*/
|
|
603
664
|
export interface ExportTask {
|
|
604
665
|
/**
|
|
666
|
+
* @public
|
|
605
667
|
* <p>The ID of the export task.</p>
|
|
606
668
|
*/
|
|
607
669
|
taskId?: string;
|
|
608
670
|
/**
|
|
671
|
+
* @public
|
|
609
672
|
* <p>The name of the export task.</p>
|
|
610
673
|
*/
|
|
611
674
|
taskName?: string;
|
|
612
675
|
/**
|
|
676
|
+
* @public
|
|
613
677
|
* <p>The name of the log group from which logs data was exported.</p>
|
|
614
678
|
*/
|
|
615
679
|
logGroupName?: string;
|
|
616
680
|
/**
|
|
681
|
+
* @public
|
|
617
682
|
* <p>The start time, expressed as the number of milliseconds after <code>Jan 1, 1970
|
|
618
683
|
* 00:00:00 UTC</code>. Events with a timestamp before this time are not exported.</p>
|
|
619
684
|
*/
|
|
620
685
|
from?: number;
|
|
621
686
|
/**
|
|
687
|
+
* @public
|
|
622
688
|
* <p>The end time, expressed as the number of milliseconds after <code>Jan 1, 1970 00:00:00
|
|
623
689
|
* UTC</code>. Events with a timestamp later than this time are not exported.</p>
|
|
624
690
|
*/
|
|
625
691
|
to?: number;
|
|
626
692
|
/**
|
|
693
|
+
* @public
|
|
627
694
|
* <p>The name of the S3 bucket to which the log data was exported.</p>
|
|
628
695
|
*/
|
|
629
696
|
destination?: string;
|
|
630
697
|
/**
|
|
698
|
+
* @public
|
|
631
699
|
* <p>The prefix that was used as the start of Amazon S3 key for every object exported.</p>
|
|
632
700
|
*/
|
|
633
701
|
destinationPrefix?: string;
|
|
634
702
|
/**
|
|
703
|
+
* @public
|
|
635
704
|
* <p>The status of the export task.</p>
|
|
636
705
|
*/
|
|
637
706
|
status?: ExportTaskStatus;
|
|
638
707
|
/**
|
|
708
|
+
* @public
|
|
639
709
|
* <p>Execution information about the export task.</p>
|
|
640
710
|
*/
|
|
641
711
|
executionInfo?: ExportTaskExecutionInfo;
|
|
@@ -645,10 +715,12 @@ export interface ExportTask {
|
|
|
645
715
|
*/
|
|
646
716
|
export interface DescribeExportTasksResponse {
|
|
647
717
|
/**
|
|
718
|
+
* @public
|
|
648
719
|
* <p>The export tasks.</p>
|
|
649
720
|
*/
|
|
650
721
|
exportTasks?: ExportTask[];
|
|
651
722
|
/**
|
|
723
|
+
* @public
|
|
652
724
|
* <p>The token for the next set of items to return. The token expires after 24 hours.</p>
|
|
653
725
|
*/
|
|
654
726
|
nextToken?: string;
|
|
@@ -658,11 +730,13 @@ export interface DescribeExportTasksResponse {
|
|
|
658
730
|
*/
|
|
659
731
|
export interface DescribeLogGroupsRequest {
|
|
660
732
|
/**
|
|
733
|
+
* @public
|
|
661
734
|
* <p>When <code>includeLinkedAccounts</code> is set to <code>True</code>, use this parameter to
|
|
662
735
|
* specify the list of accounts to search. You can specify as many as 20 account IDs in the array. </p>
|
|
663
736
|
*/
|
|
664
737
|
accountIdentifiers?: string[];
|
|
665
738
|
/**
|
|
739
|
+
* @public
|
|
666
740
|
* <p>The prefix to match.</p>
|
|
667
741
|
* <note>
|
|
668
742
|
* <p>
|
|
@@ -674,6 +748,7 @@ export interface DescribeLogGroupsRequest {
|
|
|
674
748
|
*/
|
|
675
749
|
logGroupNamePrefix?: string;
|
|
676
750
|
/**
|
|
751
|
+
* @public
|
|
677
752
|
* <p>If you specify a string for this parameter, the operation returns only log groups that have names
|
|
678
753
|
* that match the string based on a case-sensitive substring search. For example, if you specify <code>Foo</code>, log groups
|
|
679
754
|
* named <code>FooBar</code>, <code>aws/Foo</code>, and <code>GroupFoo</code> would match, but <code>foo</code>,
|
|
@@ -691,14 +766,17 @@ export interface DescribeLogGroupsRequest {
|
|
|
691
766
|
*/
|
|
692
767
|
logGroupNamePattern?: string;
|
|
693
768
|
/**
|
|
769
|
+
* @public
|
|
694
770
|
* <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
|
|
695
771
|
*/
|
|
696
772
|
nextToken?: string;
|
|
697
773
|
/**
|
|
774
|
+
* @public
|
|
698
775
|
* <p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>
|
|
699
776
|
*/
|
|
700
777
|
limit?: number;
|
|
701
778
|
/**
|
|
779
|
+
* @public
|
|
702
780
|
* <p>If you are using a monitoring account, set this to <code>True</code> to have the operation
|
|
703
781
|
* return log groups in
|
|
704
782
|
* the accounts listed in <code>accountIdentifiers</code>.</p>
|
|
@@ -726,43 +804,52 @@ export type InheritedProperty = (typeof InheritedProperty)[keyof typeof Inherite
|
|
|
726
804
|
*/
|
|
727
805
|
export interface LogGroup {
|
|
728
806
|
/**
|
|
807
|
+
* @public
|
|
729
808
|
* <p>The name of the log group.</p>
|
|
730
809
|
*/
|
|
731
810
|
logGroupName?: string;
|
|
732
811
|
/**
|
|
812
|
+
* @public
|
|
733
813
|
* <p>The creation time of the log group, expressed as the number of milliseconds after Jan
|
|
734
814
|
* 1, 1970 00:00:00 UTC.</p>
|
|
735
815
|
*/
|
|
736
816
|
creationTime?: number;
|
|
737
817
|
/**
|
|
818
|
+
* @public
|
|
738
819
|
* <p>The number of days to retain the log events in the specified log group.
|
|
739
820
|
* Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.</p>
|
|
740
821
|
* <p>To set a log group so that its log events do not expire, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html">DeleteRetentionPolicy</a>. </p>
|
|
741
822
|
*/
|
|
742
823
|
retentionInDays?: number;
|
|
743
824
|
/**
|
|
825
|
+
* @public
|
|
744
826
|
* <p>The number of metric filters.</p>
|
|
745
827
|
*/
|
|
746
828
|
metricFilterCount?: number;
|
|
747
829
|
/**
|
|
830
|
+
* @public
|
|
748
831
|
* <p>The Amazon Resource Name (ARN) of the log group.</p>
|
|
749
832
|
*/
|
|
750
833
|
arn?: string;
|
|
751
834
|
/**
|
|
835
|
+
* @public
|
|
752
836
|
* <p>The number of bytes stored.</p>
|
|
753
837
|
*/
|
|
754
838
|
storedBytes?: number;
|
|
755
839
|
/**
|
|
840
|
+
* @public
|
|
756
841
|
* <p>The Amazon Resource Name (ARN) of the KMS key to use when
|
|
757
842
|
* encrypting log data.</p>
|
|
758
843
|
*/
|
|
759
844
|
kmsKeyId?: string;
|
|
760
845
|
/**
|
|
846
|
+
* @public
|
|
761
847
|
* <p>Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see
|
|
762
848
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html">PutDataProtectionPolicy</a>.</p>
|
|
763
849
|
*/
|
|
764
850
|
dataProtectionStatus?: DataProtectionStatus | string;
|
|
765
851
|
/**
|
|
852
|
+
* @public
|
|
766
853
|
* <p>Displays all the properties that this log group has inherited from account-level
|
|
767
854
|
* settings.</p>
|
|
768
855
|
*/
|
|
@@ -773,12 +860,14 @@ export interface LogGroup {
|
|
|
773
860
|
*/
|
|
774
861
|
export interface DescribeLogGroupsResponse {
|
|
775
862
|
/**
|
|
863
|
+
* @public
|
|
776
864
|
* <p>The log groups.</p>
|
|
777
865
|
* <p>If the <code>retentionInDays</code> value is not included for a log group, then that log
|
|
778
866
|
* group's events do not expire.</p>
|
|
779
867
|
*/
|
|
780
868
|
logGroups?: LogGroup[];
|
|
781
869
|
/**
|
|
870
|
+
* @public
|
|
782
871
|
* <p>The token for the next set of items to return. The token expires after 24 hours.</p>
|
|
783
872
|
*/
|
|
784
873
|
nextToken?: string;
|
|
@@ -800,6 +889,7 @@ export type OrderBy = (typeof OrderBy)[keyof typeof OrderBy];
|
|
|
800
889
|
*/
|
|
801
890
|
export interface DescribeLogStreamsRequest {
|
|
802
891
|
/**
|
|
892
|
+
* @public
|
|
803
893
|
* <p>The name of the log group.</p>
|
|
804
894
|
* <note>
|
|
805
895
|
* <p>
|
|
@@ -810,6 +900,7 @@ export interface DescribeLogStreamsRequest {
|
|
|
810
900
|
*/
|
|
811
901
|
logGroupName?: string;
|
|
812
902
|
/**
|
|
903
|
+
* @public
|
|
813
904
|
* <p>Specify either the name or ARN of the log group to view. If the log group is in a source account
|
|
814
905
|
* and you are using a monitoring account, you must use the log group ARN.</p>
|
|
815
906
|
* <note>
|
|
@@ -821,12 +912,14 @@ export interface DescribeLogStreamsRequest {
|
|
|
821
912
|
*/
|
|
822
913
|
logGroupIdentifier?: string;
|
|
823
914
|
/**
|
|
915
|
+
* @public
|
|
824
916
|
* <p>The prefix to match.</p>
|
|
825
917
|
* <p>If <code>orderBy</code> is <code>LastEventTime</code>, you cannot specify this
|
|
826
918
|
* parameter.</p>
|
|
827
919
|
*/
|
|
828
920
|
logStreamNamePrefix?: string;
|
|
829
921
|
/**
|
|
922
|
+
* @public
|
|
830
923
|
* <p>If the value is <code>LogStreamName</code>, the results are ordered by log stream name.
|
|
831
924
|
* If the value is <code>LastEventTime</code>, the results are ordered by the event time.
|
|
832
925
|
* The default value is <code>LogStreamName</code>.</p>
|
|
@@ -840,16 +933,19 @@ export interface DescribeLogStreamsRequest {
|
|
|
840
933
|
*/
|
|
841
934
|
orderBy?: OrderBy | string;
|
|
842
935
|
/**
|
|
936
|
+
* @public
|
|
843
937
|
* <p>If the value is true, results are returned in descending order.
|
|
844
938
|
* If the value is to false, results are returned in ascending order.
|
|
845
939
|
* The default value is false.</p>
|
|
846
940
|
*/
|
|
847
941
|
descending?: boolean;
|
|
848
942
|
/**
|
|
943
|
+
* @public
|
|
849
944
|
* <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
|
|
850
945
|
*/
|
|
851
946
|
nextToken?: string;
|
|
852
947
|
/**
|
|
948
|
+
* @public
|
|
853
949
|
* <p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>
|
|
854
950
|
*/
|
|
855
951
|
limit?: number;
|
|
@@ -861,20 +957,24 @@ export interface DescribeLogStreamsRequest {
|
|
|
861
957
|
*/
|
|
862
958
|
export interface LogStream {
|
|
863
959
|
/**
|
|
960
|
+
* @public
|
|
864
961
|
* <p>The name of the log stream.</p>
|
|
865
962
|
*/
|
|
866
963
|
logStreamName?: string;
|
|
867
964
|
/**
|
|
965
|
+
* @public
|
|
868
966
|
* <p>The creation time of the stream, expressed as the number of milliseconds after
|
|
869
967
|
* <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
870
968
|
*/
|
|
871
969
|
creationTime?: number;
|
|
872
970
|
/**
|
|
971
|
+
* @public
|
|
873
972
|
* <p>The time of the first event, expressed as the number of milliseconds after <code>Jan 1,
|
|
874
973
|
* 1970 00:00:00 UTC</code>.</p>
|
|
875
974
|
*/
|
|
876
975
|
firstEventTimestamp?: number;
|
|
877
976
|
/**
|
|
977
|
+
* @public
|
|
878
978
|
* <p>The time of the most recent log event in the log stream in CloudWatch Logs. This number
|
|
879
979
|
* is expressed as the number of milliseconds after <code>Jan 1, 1970 00:00:00 UTC</code>. The
|
|
880
980
|
* <code>lastEventTime</code> value updates on an eventual consistency basis. It typically
|
|
@@ -883,12 +983,14 @@ export interface LogStream {
|
|
|
883
983
|
*/
|
|
884
984
|
lastEventTimestamp?: number;
|
|
885
985
|
/**
|
|
986
|
+
* @public
|
|
886
987
|
* <p>The ingestion time, expressed as the number of milliseconds after <code>Jan 1, 1970
|
|
887
988
|
* 00:00:00 UTC</code> The <code>lastIngestionTime</code> value updates on an eventual consistency basis. It
|
|
888
989
|
* typically updates in less than an hour after ingestion, but in rare situations might take longer.</p>
|
|
889
990
|
*/
|
|
890
991
|
lastIngestionTime?: number;
|
|
891
992
|
/**
|
|
993
|
+
* @public
|
|
892
994
|
* <p>The sequence token.</p>
|
|
893
995
|
* <important>
|
|
894
996
|
* <p>The sequence token is now ignored in
|
|
@@ -899,10 +1001,12 @@ export interface LogStream {
|
|
|
899
1001
|
*/
|
|
900
1002
|
uploadSequenceToken?: string;
|
|
901
1003
|
/**
|
|
1004
|
+
* @public
|
|
902
1005
|
* <p>The Amazon Resource Name (ARN) of the log stream.</p>
|
|
903
1006
|
*/
|
|
904
1007
|
arn?: string;
|
|
905
1008
|
/**
|
|
1009
|
+
* @public
|
|
906
1010
|
* @deprecated
|
|
907
1011
|
*
|
|
908
1012
|
* <p>The number of bytes stored.</p>
|
|
@@ -918,10 +1022,12 @@ export interface LogStream {
|
|
|
918
1022
|
*/
|
|
919
1023
|
export interface DescribeLogStreamsResponse {
|
|
920
1024
|
/**
|
|
1025
|
+
* @public
|
|
921
1026
|
* <p>The log streams.</p>
|
|
922
1027
|
*/
|
|
923
1028
|
logStreams?: LogStream[];
|
|
924
1029
|
/**
|
|
1030
|
+
* @public
|
|
925
1031
|
* <p>The token for the next set of items to return. The token expires after 24 hours.</p>
|
|
926
1032
|
*/
|
|
927
1033
|
nextToken?: string;
|
|
@@ -931,28 +1037,34 @@ export interface DescribeLogStreamsResponse {
|
|
|
931
1037
|
*/
|
|
932
1038
|
export interface DescribeMetricFiltersRequest {
|
|
933
1039
|
/**
|
|
1040
|
+
* @public
|
|
934
1041
|
* <p>The name of the log group.</p>
|
|
935
1042
|
*/
|
|
936
1043
|
logGroupName?: string;
|
|
937
1044
|
/**
|
|
1045
|
+
* @public
|
|
938
1046
|
* <p>The prefix to match. CloudWatch Logs uses the value that you set here only if you also
|
|
939
1047
|
* include the <code>logGroupName</code> parameter in your request.</p>
|
|
940
1048
|
*/
|
|
941
1049
|
filterNamePrefix?: string;
|
|
942
1050
|
/**
|
|
1051
|
+
* @public
|
|
943
1052
|
* <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
|
|
944
1053
|
*/
|
|
945
1054
|
nextToken?: string;
|
|
946
1055
|
/**
|
|
1056
|
+
* @public
|
|
947
1057
|
* <p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>
|
|
948
1058
|
*/
|
|
949
1059
|
limit?: number;
|
|
950
1060
|
/**
|
|
1061
|
+
* @public
|
|
951
1062
|
* <p>Filters results to include only those with the specified metric name. If you include this parameter in your request, you
|
|
952
1063
|
* must also include the <code>metricNamespace</code> parameter.</p>
|
|
953
1064
|
*/
|
|
954
1065
|
metricName?: string;
|
|
955
1066
|
/**
|
|
1067
|
+
* @public
|
|
956
1068
|
* <p>Filters results to include only those in the specified namespace. If you include this parameter in your request, you
|
|
957
1069
|
* must also include the <code>metricName</code> parameter.</p>
|
|
958
1070
|
*/
|
|
@@ -1002,24 +1114,29 @@ export type StandardUnit = (typeof StandardUnit)[keyof typeof StandardUnit];
|
|
|
1002
1114
|
*/
|
|
1003
1115
|
export interface MetricTransformation {
|
|
1004
1116
|
/**
|
|
1117
|
+
* @public
|
|
1005
1118
|
* <p>The name of the CloudWatch metric.</p>
|
|
1006
1119
|
*/
|
|
1007
1120
|
metricName: string | undefined;
|
|
1008
1121
|
/**
|
|
1122
|
+
* @public
|
|
1009
1123
|
* <p>A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics
|
|
1010
1124
|
* that are similar. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace">Namespaces</a>.</p>
|
|
1011
1125
|
*/
|
|
1012
1126
|
metricNamespace: string | undefined;
|
|
1013
1127
|
/**
|
|
1128
|
+
* @public
|
|
1014
1129
|
* <p>The value to publish to the CloudWatch metric when a filter pattern matches a log event.</p>
|
|
1015
1130
|
*/
|
|
1016
1131
|
metricValue: string | undefined;
|
|
1017
1132
|
/**
|
|
1133
|
+
* @public
|
|
1018
1134
|
* <p>(Optional) The value to emit when a filter pattern does not match a log event.
|
|
1019
1135
|
* This value can be null.</p>
|
|
1020
1136
|
*/
|
|
1021
1137
|
defaultValue?: number;
|
|
1022
1138
|
/**
|
|
1139
|
+
* @public
|
|
1023
1140
|
* <p>The fields to use as dimensions for the metric. One metric filter can include
|
|
1024
1141
|
* as many as three dimensions.</p>
|
|
1025
1142
|
* <important>
|
|
@@ -1041,6 +1158,7 @@ export interface MetricTransformation {
|
|
|
1041
1158
|
*/
|
|
1042
1159
|
dimensions?: Record<string, string>;
|
|
1043
1160
|
/**
|
|
1161
|
+
* @public
|
|
1044
1162
|
* <p>The unit to assign to the metric. If you omit this, the unit is set as <code>None</code>.</p>
|
|
1045
1163
|
*/
|
|
1046
1164
|
unit?: StandardUnit | string;
|
|
@@ -1052,25 +1170,30 @@ export interface MetricTransformation {
|
|
|
1052
1170
|
*/
|
|
1053
1171
|
export interface MetricFilter {
|
|
1054
1172
|
/**
|
|
1173
|
+
* @public
|
|
1055
1174
|
* <p>The name of the metric filter.</p>
|
|
1056
1175
|
*/
|
|
1057
1176
|
filterName?: string;
|
|
1058
1177
|
/**
|
|
1178
|
+
* @public
|
|
1059
1179
|
* <p>A symbolic description of how CloudWatch Logs should interpret the data in each log
|
|
1060
1180
|
* event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You
|
|
1061
1181
|
* use the filter pattern to specify what to look for in the log event message.</p>
|
|
1062
1182
|
*/
|
|
1063
1183
|
filterPattern?: string;
|
|
1064
1184
|
/**
|
|
1185
|
+
* @public
|
|
1065
1186
|
* <p>The metric transformations.</p>
|
|
1066
1187
|
*/
|
|
1067
1188
|
metricTransformations?: MetricTransformation[];
|
|
1068
1189
|
/**
|
|
1190
|
+
* @public
|
|
1069
1191
|
* <p>The creation time of the metric filter, expressed as the number of milliseconds after
|
|
1070
1192
|
* <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
1071
1193
|
*/
|
|
1072
1194
|
creationTime?: number;
|
|
1073
1195
|
/**
|
|
1196
|
+
* @public
|
|
1074
1197
|
* <p>The name of the log group.</p>
|
|
1075
1198
|
*/
|
|
1076
1199
|
logGroupName?: string;
|
|
@@ -1080,10 +1203,12 @@ export interface MetricFilter {
|
|
|
1080
1203
|
*/
|
|
1081
1204
|
export interface DescribeMetricFiltersResponse {
|
|
1082
1205
|
/**
|
|
1206
|
+
* @public
|
|
1083
1207
|
* <p>The metric filters.</p>
|
|
1084
1208
|
*/
|
|
1085
1209
|
metricFilters?: MetricFilter[];
|
|
1086
1210
|
/**
|
|
1211
|
+
* @public
|
|
1087
1212
|
* <p>The token for the next set of items to return. The token expires after 24 hours.</p>
|
|
1088
1213
|
*/
|
|
1089
1214
|
nextToken?: string;
|
|
@@ -1110,19 +1235,23 @@ export type QueryStatus = (typeof QueryStatus)[keyof typeof QueryStatus];
|
|
|
1110
1235
|
*/
|
|
1111
1236
|
export interface DescribeQueriesRequest {
|
|
1112
1237
|
/**
|
|
1238
|
+
* @public
|
|
1113
1239
|
* <p>Limits the returned queries to only those for the specified log group.</p>
|
|
1114
1240
|
*/
|
|
1115
1241
|
logGroupName?: string;
|
|
1116
1242
|
/**
|
|
1243
|
+
* @public
|
|
1117
1244
|
* <p>Limits the returned queries to only those that have the specified status. Valid values are <code>Cancelled</code>,
|
|
1118
1245
|
* <code>Complete</code>, <code>Failed</code>, <code>Running</code>, and <code>Scheduled</code>.</p>
|
|
1119
1246
|
*/
|
|
1120
1247
|
status?: QueryStatus | string;
|
|
1121
1248
|
/**
|
|
1249
|
+
* @public
|
|
1122
1250
|
* <p>Limits the number of returned queries to the specified number.</p>
|
|
1123
1251
|
*/
|
|
1124
1252
|
maxResults?: number;
|
|
1125
1253
|
/**
|
|
1254
|
+
* @public
|
|
1126
1255
|
* <p>The token for the next set of items to return. The token expires after 24 hours.</p>
|
|
1127
1256
|
*/
|
|
1128
1257
|
nextToken?: string;
|
|
@@ -1133,23 +1262,28 @@ export interface DescribeQueriesRequest {
|
|
|
1133
1262
|
*/
|
|
1134
1263
|
export interface QueryInfo {
|
|
1135
1264
|
/**
|
|
1265
|
+
* @public
|
|
1136
1266
|
* <p>The unique ID number of this query.</p>
|
|
1137
1267
|
*/
|
|
1138
1268
|
queryId?: string;
|
|
1139
1269
|
/**
|
|
1270
|
+
* @public
|
|
1140
1271
|
* <p>The query string used in this query.</p>
|
|
1141
1272
|
*/
|
|
1142
1273
|
queryString?: string;
|
|
1143
1274
|
/**
|
|
1275
|
+
* @public
|
|
1144
1276
|
* <p>The status of this query. Possible values are <code>Cancelled</code>,
|
|
1145
1277
|
* <code>Complete</code>, <code>Failed</code>, <code>Running</code>, <code>Scheduled</code>, and <code>Unknown</code>.</p>
|
|
1146
1278
|
*/
|
|
1147
1279
|
status?: QueryStatus | string;
|
|
1148
1280
|
/**
|
|
1281
|
+
* @public
|
|
1149
1282
|
* <p>The date and time that this query was created.</p>
|
|
1150
1283
|
*/
|
|
1151
1284
|
createTime?: number;
|
|
1152
1285
|
/**
|
|
1286
|
+
* @public
|
|
1153
1287
|
* <p>The name of the log group scanned by this query.</p>
|
|
1154
1288
|
*/
|
|
1155
1289
|
logGroupName?: string;
|
|
@@ -1159,10 +1293,12 @@ export interface QueryInfo {
|
|
|
1159
1293
|
*/
|
|
1160
1294
|
export interface DescribeQueriesResponse {
|
|
1161
1295
|
/**
|
|
1296
|
+
* @public
|
|
1162
1297
|
* <p>The list of queries that match the request.</p>
|
|
1163
1298
|
*/
|
|
1164
1299
|
queries?: QueryInfo[];
|
|
1165
1300
|
/**
|
|
1301
|
+
* @public
|
|
1166
1302
|
* <p>The token for the next set of items to return. The token expires after 24 hours.</p>
|
|
1167
1303
|
*/
|
|
1168
1304
|
nextToken?: string;
|
|
@@ -1172,14 +1308,17 @@ export interface DescribeQueriesResponse {
|
|
|
1172
1308
|
*/
|
|
1173
1309
|
export interface DescribeQueryDefinitionsRequest {
|
|
1174
1310
|
/**
|
|
1311
|
+
* @public
|
|
1175
1312
|
* <p>Use this parameter to filter your results to only the query definitions that have names that start with the prefix you specify.</p>
|
|
1176
1313
|
*/
|
|
1177
1314
|
queryDefinitionNamePrefix?: string;
|
|
1178
1315
|
/**
|
|
1316
|
+
* @public
|
|
1179
1317
|
* <p>Limits the number of returned query definitions to the specified number.</p>
|
|
1180
1318
|
*/
|
|
1181
1319
|
maxResults?: number;
|
|
1182
1320
|
/**
|
|
1321
|
+
* @public
|
|
1183
1322
|
* <p>The token for the next set of items to return. The token expires after 24 hours.</p>
|
|
1184
1323
|
*/
|
|
1185
1324
|
nextToken?: string;
|
|
@@ -1190,23 +1329,28 @@ export interface DescribeQueryDefinitionsRequest {
|
|
|
1190
1329
|
*/
|
|
1191
1330
|
export interface QueryDefinition {
|
|
1192
1331
|
/**
|
|
1332
|
+
* @public
|
|
1193
1333
|
* <p>The unique ID of the query definition.</p>
|
|
1194
1334
|
*/
|
|
1195
1335
|
queryDefinitionId?: string;
|
|
1196
1336
|
/**
|
|
1337
|
+
* @public
|
|
1197
1338
|
* <p>The name of the query definition.</p>
|
|
1198
1339
|
*/
|
|
1199
1340
|
name?: string;
|
|
1200
1341
|
/**
|
|
1342
|
+
* @public
|
|
1201
1343
|
* <p>The query string to use for this definition.
|
|
1202
1344
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query Syntax</a>.</p>
|
|
1203
1345
|
*/
|
|
1204
1346
|
queryString?: string;
|
|
1205
1347
|
/**
|
|
1348
|
+
* @public
|
|
1206
1349
|
* <p>The date that the query definition was most recently modified.</p>
|
|
1207
1350
|
*/
|
|
1208
1351
|
lastModified?: number;
|
|
1209
1352
|
/**
|
|
1353
|
+
* @public
|
|
1210
1354
|
* <p>If this query definition contains a list of log groups that it is limited to, that list appears here.</p>
|
|
1211
1355
|
*/
|
|
1212
1356
|
logGroupNames?: string[];
|
|
@@ -1216,10 +1360,12 @@ export interface QueryDefinition {
|
|
|
1216
1360
|
*/
|
|
1217
1361
|
export interface DescribeQueryDefinitionsResponse {
|
|
1218
1362
|
/**
|
|
1363
|
+
* @public
|
|
1219
1364
|
* <p>The list of query definitions that match your request.</p>
|
|
1220
1365
|
*/
|
|
1221
1366
|
queryDefinitions?: QueryDefinition[];
|
|
1222
1367
|
/**
|
|
1368
|
+
* @public
|
|
1223
1369
|
* <p>The token for the next set of items to return. The token expires after 24 hours.</p>
|
|
1224
1370
|
*/
|
|
1225
1371
|
nextToken?: string;
|
|
@@ -1229,10 +1375,12 @@ export interface DescribeQueryDefinitionsResponse {
|
|
|
1229
1375
|
*/
|
|
1230
1376
|
export interface DescribeResourcePoliciesRequest {
|
|
1231
1377
|
/**
|
|
1378
|
+
* @public
|
|
1232
1379
|
* <p>The token for the next set of items to return. The token expires after 24 hours.</p>
|
|
1233
1380
|
*/
|
|
1234
1381
|
nextToken?: string;
|
|
1235
1382
|
/**
|
|
1383
|
+
* @public
|
|
1236
1384
|
* <p>The maximum number of resource policies to be displayed with one call of this API.</p>
|
|
1237
1385
|
*/
|
|
1238
1386
|
limit?: number;
|
|
@@ -1243,14 +1391,17 @@ export interface DescribeResourcePoliciesRequest {
|
|
|
1243
1391
|
*/
|
|
1244
1392
|
export interface ResourcePolicy {
|
|
1245
1393
|
/**
|
|
1394
|
+
* @public
|
|
1246
1395
|
* <p>The name of the resource policy.</p>
|
|
1247
1396
|
*/
|
|
1248
1397
|
policyName?: string;
|
|
1249
1398
|
/**
|
|
1399
|
+
* @public
|
|
1250
1400
|
* <p>The details of the policy.</p>
|
|
1251
1401
|
*/
|
|
1252
1402
|
policyDocument?: string;
|
|
1253
1403
|
/**
|
|
1404
|
+
* @public
|
|
1254
1405
|
* <p>Timestamp showing when this policy was last updated, expressed as the number of
|
|
1255
1406
|
* milliseconds after <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
1256
1407
|
*/
|
|
@@ -1261,10 +1412,12 @@ export interface ResourcePolicy {
|
|
|
1261
1412
|
*/
|
|
1262
1413
|
export interface DescribeResourcePoliciesResponse {
|
|
1263
1414
|
/**
|
|
1415
|
+
* @public
|
|
1264
1416
|
* <p>The resource policies that exist in this account.</p>
|
|
1265
1417
|
*/
|
|
1266
1418
|
resourcePolicies?: ResourcePolicy[];
|
|
1267
1419
|
/**
|
|
1420
|
+
* @public
|
|
1268
1421
|
* <p>The token for the next set of items to return. The token expires after 24 hours.</p>
|
|
1269
1422
|
*/
|
|
1270
1423
|
nextToken?: string;
|
|
@@ -1274,18 +1427,22 @@ export interface DescribeResourcePoliciesResponse {
|
|
|
1274
1427
|
*/
|
|
1275
1428
|
export interface DescribeSubscriptionFiltersRequest {
|
|
1276
1429
|
/**
|
|
1430
|
+
* @public
|
|
1277
1431
|
* <p>The name of the log group.</p>
|
|
1278
1432
|
*/
|
|
1279
1433
|
logGroupName: string | undefined;
|
|
1280
1434
|
/**
|
|
1435
|
+
* @public
|
|
1281
1436
|
* <p>The prefix to match. If you don't specify a value, no prefix filter is applied.</p>
|
|
1282
1437
|
*/
|
|
1283
1438
|
filterNamePrefix?: string;
|
|
1284
1439
|
/**
|
|
1440
|
+
* @public
|
|
1285
1441
|
* <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
|
|
1286
1442
|
*/
|
|
1287
1443
|
nextToken?: string;
|
|
1288
1444
|
/**
|
|
1445
|
+
* @public
|
|
1289
1446
|
* <p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>
|
|
1290
1447
|
*/
|
|
1291
1448
|
limit?: number;
|
|
@@ -1308,33 +1465,40 @@ export type Distribution = (typeof Distribution)[keyof typeof Distribution];
|
|
|
1308
1465
|
*/
|
|
1309
1466
|
export interface SubscriptionFilter {
|
|
1310
1467
|
/**
|
|
1468
|
+
* @public
|
|
1311
1469
|
* <p>The name of the subscription filter.</p>
|
|
1312
1470
|
*/
|
|
1313
1471
|
filterName?: string;
|
|
1314
1472
|
/**
|
|
1473
|
+
* @public
|
|
1315
1474
|
* <p>The name of the log group.</p>
|
|
1316
1475
|
*/
|
|
1317
1476
|
logGroupName?: string;
|
|
1318
1477
|
/**
|
|
1478
|
+
* @public
|
|
1319
1479
|
* <p>A symbolic description of how CloudWatch Logs should interpret the data in each log
|
|
1320
1480
|
* event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You
|
|
1321
1481
|
* use the filter pattern to specify what to look for in the log event message.</p>
|
|
1322
1482
|
*/
|
|
1323
1483
|
filterPattern?: string;
|
|
1324
1484
|
/**
|
|
1485
|
+
* @public
|
|
1325
1486
|
* <p>The Amazon Resource Name (ARN) of the destination.</p>
|
|
1326
1487
|
*/
|
|
1327
1488
|
destinationArn?: string;
|
|
1328
1489
|
/**
|
|
1490
|
+
* @public
|
|
1329
1491
|
* <p></p>
|
|
1330
1492
|
*/
|
|
1331
1493
|
roleArn?: string;
|
|
1332
1494
|
/**
|
|
1495
|
+
* @public
|
|
1333
1496
|
* <p>The method used to distribute log data to the destination, which can be either
|
|
1334
1497
|
* random or grouped by log stream.</p>
|
|
1335
1498
|
*/
|
|
1336
1499
|
distribution?: Distribution | string;
|
|
1337
1500
|
/**
|
|
1501
|
+
* @public
|
|
1338
1502
|
* <p>The creation time of the subscription filter, expressed as the number of milliseconds
|
|
1339
1503
|
* after <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
1340
1504
|
*/
|
|
@@ -1345,10 +1509,12 @@ export interface SubscriptionFilter {
|
|
|
1345
1509
|
*/
|
|
1346
1510
|
export interface DescribeSubscriptionFiltersResponse {
|
|
1347
1511
|
/**
|
|
1512
|
+
* @public
|
|
1348
1513
|
* <p>The subscription filters.</p>
|
|
1349
1514
|
*/
|
|
1350
1515
|
subscriptionFilters?: SubscriptionFilter[];
|
|
1351
1516
|
/**
|
|
1517
|
+
* @public
|
|
1352
1518
|
* <p>The token for the next set of items to return. The token expires after 24 hours.</p>
|
|
1353
1519
|
*/
|
|
1354
1520
|
nextToken?: string;
|
|
@@ -1358,6 +1524,7 @@ export interface DescribeSubscriptionFiltersResponse {
|
|
|
1358
1524
|
*/
|
|
1359
1525
|
export interface DisassociateKmsKeyRequest {
|
|
1360
1526
|
/**
|
|
1527
|
+
* @public
|
|
1361
1528
|
* <p>The name of the log group.</p>
|
|
1362
1529
|
* <p>In your <code>DisassociateKmsKey</code> operation,
|
|
1363
1530
|
* you must specify either the <code>resourceIdentifier</code> parameter or the <code>logGroup</code> parameter,
|
|
@@ -1365,6 +1532,7 @@ export interface DisassociateKmsKeyRequest {
|
|
|
1365
1532
|
*/
|
|
1366
1533
|
logGroupName?: string;
|
|
1367
1534
|
/**
|
|
1535
|
+
* @public
|
|
1368
1536
|
* <p>Specifies the target for this operation. You must specify one of the following:</p>
|
|
1369
1537
|
* <ul>
|
|
1370
1538
|
* <li>
|
|
@@ -1399,24 +1567,29 @@ export interface DisassociateKmsKeyRequest {
|
|
|
1399
1567
|
*/
|
|
1400
1568
|
export interface FilteredLogEvent {
|
|
1401
1569
|
/**
|
|
1570
|
+
* @public
|
|
1402
1571
|
* <p>The name of the log stream to which this event belongs.</p>
|
|
1403
1572
|
*/
|
|
1404
1573
|
logStreamName?: string;
|
|
1405
1574
|
/**
|
|
1575
|
+
* @public
|
|
1406
1576
|
* <p>The time the event occurred, expressed as the number of milliseconds after <code>Jan 1,
|
|
1407
1577
|
* 1970 00:00:00 UTC</code>.</p>
|
|
1408
1578
|
*/
|
|
1409
1579
|
timestamp?: number;
|
|
1410
1580
|
/**
|
|
1581
|
+
* @public
|
|
1411
1582
|
* <p>The data contained in the log event.</p>
|
|
1412
1583
|
*/
|
|
1413
1584
|
message?: string;
|
|
1414
1585
|
/**
|
|
1586
|
+
* @public
|
|
1415
1587
|
* <p>The time the event was ingested, expressed as the number of milliseconds after
|
|
1416
1588
|
* <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
1417
1589
|
*/
|
|
1418
1590
|
ingestionTime?: number;
|
|
1419
1591
|
/**
|
|
1592
|
+
* @public
|
|
1420
1593
|
* <p>The ID of the event.</p>
|
|
1421
1594
|
*/
|
|
1422
1595
|
eventId?: string;
|
|
@@ -1426,6 +1599,7 @@ export interface FilteredLogEvent {
|
|
|
1426
1599
|
*/
|
|
1427
1600
|
export interface FilterLogEventsRequest {
|
|
1428
1601
|
/**
|
|
1602
|
+
* @public
|
|
1429
1603
|
* <p>The name of the log group to search.</p>
|
|
1430
1604
|
* <note>
|
|
1431
1605
|
* <p>
|
|
@@ -1436,6 +1610,7 @@ export interface FilterLogEventsRequest {
|
|
|
1436
1610
|
*/
|
|
1437
1611
|
logGroupName?: string;
|
|
1438
1612
|
/**
|
|
1613
|
+
* @public
|
|
1439
1614
|
* <p>Specify either the name or ARN of the log group to view log events from. If the log group is in a source account
|
|
1440
1615
|
* and you are using a monitoring account, you must use the log group ARN.</p>
|
|
1441
1616
|
* <note>
|
|
@@ -1447,12 +1622,14 @@ export interface FilterLogEventsRequest {
|
|
|
1447
1622
|
*/
|
|
1448
1623
|
logGroupIdentifier?: string;
|
|
1449
1624
|
/**
|
|
1625
|
+
* @public
|
|
1450
1626
|
* <p>Filters the results to only logs from the log streams in this list.</p>
|
|
1451
1627
|
* <p>If you specify a value for both <code>logStreamNamePrefix</code> and <code>logStreamNames</code>, the action
|
|
1452
1628
|
* returns an <code>InvalidParameterException</code> error.</p>
|
|
1453
1629
|
*/
|
|
1454
1630
|
logStreamNames?: string[];
|
|
1455
1631
|
/**
|
|
1632
|
+
* @public
|
|
1456
1633
|
* <p>Filters the results to include only events from log streams that have names starting with this prefix.</p>
|
|
1457
1634
|
* <p>If you specify a value for both <code>logStreamNamePrefix</code> and <code>logStreamNames</code>, but the value for
|
|
1458
1635
|
* <code>logStreamNamePrefix</code> does not match any log stream names specified in <code>logStreamNames</code>, the action
|
|
@@ -1460,31 +1637,37 @@ export interface FilterLogEventsRequest {
|
|
|
1460
1637
|
*/
|
|
1461
1638
|
logStreamNamePrefix?: string;
|
|
1462
1639
|
/**
|
|
1640
|
+
* @public
|
|
1463
1641
|
* <p>The start of the time range, expressed as the number of milliseconds after <code>Jan 1,
|
|
1464
1642
|
* 1970 00:00:00 UTC</code>. Events with a timestamp before this time are not
|
|
1465
1643
|
* returned.</p>
|
|
1466
1644
|
*/
|
|
1467
1645
|
startTime?: number;
|
|
1468
1646
|
/**
|
|
1647
|
+
* @public
|
|
1469
1648
|
* <p>The end of the time range, expressed as the number of milliseconds after <code>Jan 1,
|
|
1470
1649
|
* 1970 00:00:00 UTC</code>. Events with a timestamp later than this time are not
|
|
1471
1650
|
* returned.</p>
|
|
1472
1651
|
*/
|
|
1473
1652
|
endTime?: number;
|
|
1474
1653
|
/**
|
|
1654
|
+
* @public
|
|
1475
1655
|
* <p>The filter pattern to use. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html">Filter and Pattern Syntax</a>.</p>
|
|
1476
1656
|
* <p>If not provided, all the events are matched.</p>
|
|
1477
1657
|
*/
|
|
1478
1658
|
filterPattern?: string;
|
|
1479
1659
|
/**
|
|
1660
|
+
* @public
|
|
1480
1661
|
* <p>The token for the next set of events to return. (You received this token from a previous call.)</p>
|
|
1481
1662
|
*/
|
|
1482
1663
|
nextToken?: string;
|
|
1483
1664
|
/**
|
|
1665
|
+
* @public
|
|
1484
1666
|
* <p>The maximum number of events to return. The default is 10,000 events.</p>
|
|
1485
1667
|
*/
|
|
1486
1668
|
limit?: number;
|
|
1487
1669
|
/**
|
|
1670
|
+
* @public
|
|
1488
1671
|
* @deprecated
|
|
1489
1672
|
*
|
|
1490
1673
|
* <p>If the value is true, the operation attempts to provide responses that contain events
|
|
@@ -1498,6 +1681,7 @@ export interface FilterLogEventsRequest {
|
|
|
1498
1681
|
*/
|
|
1499
1682
|
interleaved?: boolean;
|
|
1500
1683
|
/**
|
|
1684
|
+
* @public
|
|
1501
1685
|
* <p>Specify <code>true</code> to display the log event fields with all sensitive data unmasked and visible.
|
|
1502
1686
|
* The default is <code>false</code>.</p>
|
|
1503
1687
|
* <p>To use this operation with this parameter, you must be signed into an account with the <code>logs:Unmask</code>
|
|
@@ -1511,10 +1695,12 @@ export interface FilterLogEventsRequest {
|
|
|
1511
1695
|
*/
|
|
1512
1696
|
export interface SearchedLogStream {
|
|
1513
1697
|
/**
|
|
1698
|
+
* @public
|
|
1514
1699
|
* <p>The name of the log stream.</p>
|
|
1515
1700
|
*/
|
|
1516
1701
|
logStreamName?: string;
|
|
1517
1702
|
/**
|
|
1703
|
+
* @public
|
|
1518
1704
|
* <p>Indicates whether all the events in this log stream were searched.</p>
|
|
1519
1705
|
*/
|
|
1520
1706
|
searchedCompletely?: boolean;
|
|
@@ -1524,10 +1710,12 @@ export interface SearchedLogStream {
|
|
|
1524
1710
|
*/
|
|
1525
1711
|
export interface FilterLogEventsResponse {
|
|
1526
1712
|
/**
|
|
1713
|
+
* @public
|
|
1527
1714
|
* <p>The matched events.</p>
|
|
1528
1715
|
*/
|
|
1529
1716
|
events?: FilteredLogEvent[];
|
|
1530
1717
|
/**
|
|
1718
|
+
* @public
|
|
1531
1719
|
* <p>
|
|
1532
1720
|
* <b>Important</b> As of May 15, 2020, this parameter is no longer
|
|
1533
1721
|
* supported. This parameter returns an empty list.</p>
|
|
@@ -1535,6 +1723,7 @@ export interface FilterLogEventsResponse {
|
|
|
1535
1723
|
*/
|
|
1536
1724
|
searchedLogStreams?: SearchedLogStream[];
|
|
1537
1725
|
/**
|
|
1726
|
+
* @public
|
|
1538
1727
|
* <p>The token to use when requesting the next set of items. The token expires after 24 hours.</p>
|
|
1539
1728
|
*/
|
|
1540
1729
|
nextToken?: string;
|
|
@@ -1544,6 +1733,7 @@ export interface FilterLogEventsResponse {
|
|
|
1544
1733
|
*/
|
|
1545
1734
|
export interface GetDataProtectionPolicyRequest {
|
|
1546
1735
|
/**
|
|
1736
|
+
* @public
|
|
1547
1737
|
* <p>The name or ARN of the log group that contains the data protection policy that you want to see.</p>
|
|
1548
1738
|
*/
|
|
1549
1739
|
logGroupIdentifier: string | undefined;
|
|
@@ -1553,14 +1743,17 @@ export interface GetDataProtectionPolicyRequest {
|
|
|
1553
1743
|
*/
|
|
1554
1744
|
export interface GetDataProtectionPolicyResponse {
|
|
1555
1745
|
/**
|
|
1746
|
+
* @public
|
|
1556
1747
|
* <p>The log group name or ARN that you specified in your request.</p>
|
|
1557
1748
|
*/
|
|
1558
1749
|
logGroupIdentifier?: string;
|
|
1559
1750
|
/**
|
|
1751
|
+
* @public
|
|
1560
1752
|
* <p>The data protection policy document for this log group.</p>
|
|
1561
1753
|
*/
|
|
1562
1754
|
policyDocument?: string;
|
|
1563
1755
|
/**
|
|
1756
|
+
* @public
|
|
1564
1757
|
* <p>The date and time that this policy was most recently updated.</p>
|
|
1565
1758
|
*/
|
|
1566
1759
|
lastUpdatedTime?: number;
|
|
@@ -1570,6 +1763,7 @@ export interface GetDataProtectionPolicyResponse {
|
|
|
1570
1763
|
*/
|
|
1571
1764
|
export interface GetLogEventsRequest {
|
|
1572
1765
|
/**
|
|
1766
|
+
* @public
|
|
1573
1767
|
* <p>The name of the log group.</p>
|
|
1574
1768
|
* <note>
|
|
1575
1769
|
* <p>
|
|
@@ -1580,6 +1774,7 @@ export interface GetLogEventsRequest {
|
|
|
1580
1774
|
*/
|
|
1581
1775
|
logGroupName?: string;
|
|
1582
1776
|
/**
|
|
1777
|
+
* @public
|
|
1583
1778
|
* <p>Specify either the name or ARN of the log group to view events from. If the log group is in a source account
|
|
1584
1779
|
* and you are using a monitoring account, you must use the log group ARN.</p>
|
|
1585
1780
|
* <note>
|
|
@@ -1591,31 +1786,37 @@ export interface GetLogEventsRequest {
|
|
|
1591
1786
|
*/
|
|
1592
1787
|
logGroupIdentifier?: string;
|
|
1593
1788
|
/**
|
|
1789
|
+
* @public
|
|
1594
1790
|
* <p>The name of the log stream.</p>
|
|
1595
1791
|
*/
|
|
1596
1792
|
logStreamName: string | undefined;
|
|
1597
1793
|
/**
|
|
1794
|
+
* @public
|
|
1598
1795
|
* <p>The start of the time range, expressed as the number of milliseconds after <code>Jan 1,
|
|
1599
1796
|
* 1970 00:00:00 UTC</code>. Events with a timestamp equal to this time or later than this time
|
|
1600
1797
|
* are included. Events with a timestamp earlier than this time are not included.</p>
|
|
1601
1798
|
*/
|
|
1602
1799
|
startTime?: number;
|
|
1603
1800
|
/**
|
|
1801
|
+
* @public
|
|
1604
1802
|
* <p>The end of the time range, expressed as the number of milliseconds after <code>Jan 1,
|
|
1605
1803
|
* 1970 00:00:00 UTC</code>. Events with a timestamp equal to or later than this time are not
|
|
1606
1804
|
* included.</p>
|
|
1607
1805
|
*/
|
|
1608
1806
|
endTime?: number;
|
|
1609
1807
|
/**
|
|
1808
|
+
* @public
|
|
1610
1809
|
* <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
|
|
1611
1810
|
*/
|
|
1612
1811
|
nextToken?: string;
|
|
1613
1812
|
/**
|
|
1813
|
+
* @public
|
|
1614
1814
|
* <p>The maximum number of log events returned. If you don't specify a limit, the default is
|
|
1615
1815
|
* as many log events as can fit in a response size of 1 MB (up to 10,000 log events).</p>
|
|
1616
1816
|
*/
|
|
1617
1817
|
limit?: number;
|
|
1618
1818
|
/**
|
|
1819
|
+
* @public
|
|
1619
1820
|
* <p>If the value is true, the earliest log events are returned first.
|
|
1620
1821
|
* If the value is false, the latest log events are returned first.
|
|
1621
1822
|
* The default value is false.</p>
|
|
@@ -1624,6 +1825,7 @@ export interface GetLogEventsRequest {
|
|
|
1624
1825
|
*/
|
|
1625
1826
|
startFromHead?: boolean;
|
|
1626
1827
|
/**
|
|
1828
|
+
* @public
|
|
1627
1829
|
* <p>Specify <code>true</code> to display the log event fields with all sensitive data unmasked and visible.
|
|
1628
1830
|
* The default is <code>false</code>.</p>
|
|
1629
1831
|
* <p>To use this operation with this parameter, you must be signed into an account with the <code>logs:Unmask</code>
|
|
@@ -1637,15 +1839,18 @@ export interface GetLogEventsRequest {
|
|
|
1637
1839
|
*/
|
|
1638
1840
|
export interface OutputLogEvent {
|
|
1639
1841
|
/**
|
|
1842
|
+
* @public
|
|
1640
1843
|
* <p>The time the event occurred, expressed as the number of milliseconds after <code>Jan 1,
|
|
1641
1844
|
* 1970 00:00:00 UTC</code>.</p>
|
|
1642
1845
|
*/
|
|
1643
1846
|
timestamp?: number;
|
|
1644
1847
|
/**
|
|
1848
|
+
* @public
|
|
1645
1849
|
* <p>The data contained in the log event.</p>
|
|
1646
1850
|
*/
|
|
1647
1851
|
message?: string;
|
|
1648
1852
|
/**
|
|
1853
|
+
* @public
|
|
1649
1854
|
* <p>The time the event was ingested, expressed as the number of milliseconds after
|
|
1650
1855
|
* <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
1651
1856
|
*/
|
|
@@ -1656,16 +1861,19 @@ export interface OutputLogEvent {
|
|
|
1656
1861
|
*/
|
|
1657
1862
|
export interface GetLogEventsResponse {
|
|
1658
1863
|
/**
|
|
1864
|
+
* @public
|
|
1659
1865
|
* <p>The events.</p>
|
|
1660
1866
|
*/
|
|
1661
1867
|
events?: OutputLogEvent[];
|
|
1662
1868
|
/**
|
|
1869
|
+
* @public
|
|
1663
1870
|
* <p>The token for the next set of items in the forward direction. The token expires after
|
|
1664
1871
|
* 24 hours. If you have reached the end of the stream, it returns the same token you passed
|
|
1665
1872
|
* in.</p>
|
|
1666
1873
|
*/
|
|
1667
1874
|
nextForwardToken?: string;
|
|
1668
1875
|
/**
|
|
1876
|
+
* @public
|
|
1669
1877
|
* <p>The token for the next set of items in the backward direction. The token expires after
|
|
1670
1878
|
* 24 hours. This token is not null. If you have reached the end of the stream, it returns the
|
|
1671
1879
|
* same token you passed in.</p>
|
|
@@ -1677,6 +1885,7 @@ export interface GetLogEventsResponse {
|
|
|
1677
1885
|
*/
|
|
1678
1886
|
export interface GetLogGroupFieldsRequest {
|
|
1679
1887
|
/**
|
|
1888
|
+
* @public
|
|
1680
1889
|
* <p>The name of the log group to search.</p>
|
|
1681
1890
|
* <note>
|
|
1682
1891
|
* <p>
|
|
@@ -1687,6 +1896,7 @@ export interface GetLogGroupFieldsRequest {
|
|
|
1687
1896
|
*/
|
|
1688
1897
|
logGroupName?: string;
|
|
1689
1898
|
/**
|
|
1899
|
+
* @public
|
|
1690
1900
|
* <p>The time to set as the center of the query. If you specify <code>time</code>, the 8 minutes before and
|
|
1691
1901
|
* 8 minutes after this time are searched. If you omit <code>time</code>, the most recent 15 minutes
|
|
1692
1902
|
* up to the current time are searched.</p>
|
|
@@ -1695,6 +1905,7 @@ export interface GetLogGroupFieldsRequest {
|
|
|
1695
1905
|
*/
|
|
1696
1906
|
time?: number;
|
|
1697
1907
|
/**
|
|
1908
|
+
* @public
|
|
1698
1909
|
* <p>Specify either the name or ARN of the log group to view. If the log group is in a source account and
|
|
1699
1910
|
* you are using a monitoring account, you must specify the ARN.</p>
|
|
1700
1911
|
* <note>
|
|
@@ -1713,10 +1924,12 @@ export interface GetLogGroupFieldsRequest {
|
|
|
1713
1924
|
*/
|
|
1714
1925
|
export interface LogGroupField {
|
|
1715
1926
|
/**
|
|
1927
|
+
* @public
|
|
1716
1928
|
* <p>The name of a log field.</p>
|
|
1717
1929
|
*/
|
|
1718
1930
|
name?: string;
|
|
1719
1931
|
/**
|
|
1932
|
+
* @public
|
|
1720
1933
|
* <p>The percentage of log events queried that contained the field.</p>
|
|
1721
1934
|
*/
|
|
1722
1935
|
percent?: number;
|
|
@@ -1726,6 +1939,7 @@ export interface LogGroupField {
|
|
|
1726
1939
|
*/
|
|
1727
1940
|
export interface GetLogGroupFieldsResponse {
|
|
1728
1941
|
/**
|
|
1942
|
+
* @public
|
|
1729
1943
|
* <p>The array of fields found in the query. Each object in the array contains the name of the
|
|
1730
1944
|
* field, along with the percentage of time it appeared in the log events that were
|
|
1731
1945
|
* queried.</p>
|
|
@@ -1737,6 +1951,7 @@ export interface GetLogGroupFieldsResponse {
|
|
|
1737
1951
|
*/
|
|
1738
1952
|
export interface GetLogRecordRequest {
|
|
1739
1953
|
/**
|
|
1954
|
+
* @public
|
|
1740
1955
|
* <p>The pointer corresponding to the log event record you want to retrieve. You get this from
|
|
1741
1956
|
* the response of a <code>GetQueryResults</code> operation. In that response, the value of the
|
|
1742
1957
|
* <code>@ptr</code> field for a log event is the value to use as <code>logRecordPointer</code>
|
|
@@ -1744,6 +1959,7 @@ export interface GetLogRecordRequest {
|
|
|
1744
1959
|
*/
|
|
1745
1960
|
logRecordPointer: string | undefined;
|
|
1746
1961
|
/**
|
|
1962
|
+
* @public
|
|
1747
1963
|
* <p>Specify <code>true</code> to display the log event fields with all sensitive data unmasked and visible.
|
|
1748
1964
|
* The default is <code>false</code>.</p>
|
|
1749
1965
|
* <p>To use this operation with this parameter, you must be signed into an account with the <code>logs:Unmask</code>
|
|
@@ -1756,6 +1972,7 @@ export interface GetLogRecordRequest {
|
|
|
1756
1972
|
*/
|
|
1757
1973
|
export interface GetLogRecordResponse {
|
|
1758
1974
|
/**
|
|
1975
|
+
* @public
|
|
1759
1976
|
* <p>The requested log event, as a JSON string.</p>
|
|
1760
1977
|
*/
|
|
1761
1978
|
logRecord?: Record<string, string>;
|
|
@@ -1765,6 +1982,7 @@ export interface GetLogRecordResponse {
|
|
|
1765
1982
|
*/
|
|
1766
1983
|
export interface GetQueryResultsRequest {
|
|
1767
1984
|
/**
|
|
1985
|
+
* @public
|
|
1768
1986
|
* <p>The ID number of the query.</p>
|
|
1769
1987
|
*/
|
|
1770
1988
|
queryId: string | undefined;
|
|
@@ -1778,10 +1996,12 @@ export interface GetQueryResultsRequest {
|
|
|
1778
1996
|
*/
|
|
1779
1997
|
export interface ResultField {
|
|
1780
1998
|
/**
|
|
1999
|
+
* @public
|
|
1781
2000
|
* <p>The log event field.</p>
|
|
1782
2001
|
*/
|
|
1783
2002
|
field?: string;
|
|
1784
2003
|
/**
|
|
2004
|
+
* @public
|
|
1785
2005
|
* <p>The value of this field.</p>
|
|
1786
2006
|
*/
|
|
1787
2007
|
value?: string;
|
|
@@ -1793,14 +2013,17 @@ export interface ResultField {
|
|
|
1793
2013
|
*/
|
|
1794
2014
|
export interface QueryStatistics {
|
|
1795
2015
|
/**
|
|
2016
|
+
* @public
|
|
1796
2017
|
* <p>The number of log events that matched the query string.</p>
|
|
1797
2018
|
*/
|
|
1798
2019
|
recordsMatched?: number;
|
|
1799
2020
|
/**
|
|
2021
|
+
* @public
|
|
1800
2022
|
* <p>The total number of log events scanned during the query.</p>
|
|
1801
2023
|
*/
|
|
1802
2024
|
recordsScanned?: number;
|
|
1803
2025
|
/**
|
|
2026
|
+
* @public
|
|
1804
2027
|
* <p>The total number of bytes in the log events scanned during the query.</p>
|
|
1805
2028
|
*/
|
|
1806
2029
|
bytesScanned?: number;
|
|
@@ -1810,6 +2033,7 @@ export interface QueryStatistics {
|
|
|
1810
2033
|
*/
|
|
1811
2034
|
export interface GetQueryResultsResponse {
|
|
1812
2035
|
/**
|
|
2036
|
+
* @public
|
|
1813
2037
|
* <p>The log events that matched the query criteria during the most recent time it ran.</p>
|
|
1814
2038
|
* <p>The <code>results</code> value is an array of arrays. Each log event is one object in the
|
|
1815
2039
|
* top-level array. Each of these log event objects is an array of
|
|
@@ -1817,12 +2041,14 @@ export interface GetQueryResultsResponse {
|
|
|
1817
2041
|
*/
|
|
1818
2042
|
results?: ResultField[][];
|
|
1819
2043
|
/**
|
|
2044
|
+
* @public
|
|
1820
2045
|
* <p>Includes the number of log events scanned by the query, the number of log events that
|
|
1821
2046
|
* matched the query criteria, and the total number of bytes in the scanned log events. These
|
|
1822
2047
|
* values reflect the full raw results of the query.</p>
|
|
1823
2048
|
*/
|
|
1824
2049
|
statistics?: QueryStatistics;
|
|
1825
2050
|
/**
|
|
2051
|
+
* @public
|
|
1826
2052
|
* <p>The status of the most recent running of the query. Possible values are <code>Cancelled</code>,
|
|
1827
2053
|
* <code>Complete</code>, <code>Failed</code>, <code>Running</code>, <code>Scheduled</code>,
|
|
1828
2054
|
* <code>Timeout</code>, and <code>Unknown</code>.</p>
|
|
@@ -1831,6 +2057,7 @@ export interface GetQueryResultsResponse {
|
|
|
1831
2057
|
*/
|
|
1832
2058
|
status?: QueryStatus | string;
|
|
1833
2059
|
/**
|
|
2060
|
+
* @public
|
|
1834
2061
|
* <p>If you associated an KMS key with the CloudWatch Logs Insights
|
|
1835
2062
|
* query results in this account, this field displays the ARN of the key that's used to encrypt
|
|
1836
2063
|
* the query results when <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> stores
|
|
@@ -1845,11 +2072,13 @@ export interface GetQueryResultsResponse {
|
|
|
1845
2072
|
*/
|
|
1846
2073
|
export interface InputLogEvent {
|
|
1847
2074
|
/**
|
|
2075
|
+
* @public
|
|
1848
2076
|
* <p>The time the event occurred, expressed as the number of milliseconds after <code>Jan 1,
|
|
1849
2077
|
* 1970 00:00:00 UTC</code>.</p>
|
|
1850
2078
|
*/
|
|
1851
2079
|
timestamp: number | undefined;
|
|
1852
2080
|
/**
|
|
2081
|
+
* @public
|
|
1853
2082
|
* <p>The raw event message. Each log event can be no larger than 256 KB.</p>
|
|
1854
2083
|
*/
|
|
1855
2084
|
message: string | undefined;
|
|
@@ -1880,6 +2109,7 @@ export declare class InvalidSequenceTokenException extends __BaseException {
|
|
|
1880
2109
|
*/
|
|
1881
2110
|
export interface ListTagsForResourceRequest {
|
|
1882
2111
|
/**
|
|
2112
|
+
* @public
|
|
1883
2113
|
* <p>The ARN of the resource that you want to view tags for.</p>
|
|
1884
2114
|
* <p>The ARN format of a log group is
|
|
1885
2115
|
* <code>arn:aws:logs:<i>Region</i>:<i>account-id</i>:log-group:<i>log-group-name</i>
|
|
@@ -1899,6 +2129,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1899
2129
|
*/
|
|
1900
2130
|
export interface ListTagsForResourceResponse {
|
|
1901
2131
|
/**
|
|
2132
|
+
* @public
|
|
1902
2133
|
* <p>The list of tags associated with the requested resource.></p>
|
|
1903
2134
|
*/
|
|
1904
2135
|
tags?: Record<string, string>;
|
|
@@ -1908,6 +2139,7 @@ export interface ListTagsForResourceResponse {
|
|
|
1908
2139
|
*/
|
|
1909
2140
|
export interface ListTagsLogGroupRequest {
|
|
1910
2141
|
/**
|
|
2142
|
+
* @public
|
|
1911
2143
|
* <p>The name of the log group.</p>
|
|
1912
2144
|
*/
|
|
1913
2145
|
logGroupName: string | undefined;
|
|
@@ -1917,6 +2149,7 @@ export interface ListTagsLogGroupRequest {
|
|
|
1917
2149
|
*/
|
|
1918
2150
|
export interface ListTagsLogGroupResponse {
|
|
1919
2151
|
/**
|
|
2152
|
+
* @public
|
|
1920
2153
|
* <p>The tags for the log group.</p>
|
|
1921
2154
|
*/
|
|
1922
2155
|
tags?: Record<string, string>;
|
|
@@ -1926,10 +2159,12 @@ export interface ListTagsLogGroupResponse {
|
|
|
1926
2159
|
*/
|
|
1927
2160
|
export interface PutAccountPolicyRequest {
|
|
1928
2161
|
/**
|
|
2162
|
+
* @public
|
|
1929
2163
|
* <p>A name for the policy. This must be unique within the account.</p>
|
|
1930
2164
|
*/
|
|
1931
2165
|
policyName: string | undefined;
|
|
1932
2166
|
/**
|
|
2167
|
+
* @public
|
|
1933
2168
|
* <p>Specify the data protection policy, in JSON.</p>
|
|
1934
2169
|
* <p>This policy must include two JSON blocks:</p>
|
|
1935
2170
|
* <ul>
|
|
@@ -1968,10 +2203,12 @@ export interface PutAccountPolicyRequest {
|
|
|
1968
2203
|
*/
|
|
1969
2204
|
policyDocument: string | undefined;
|
|
1970
2205
|
/**
|
|
2206
|
+
* @public
|
|
1971
2207
|
* <p>Currently the only valid value for this parameter is <code>DATA_PROTECTION_POLICY</code>.</p>
|
|
1972
2208
|
*/
|
|
1973
2209
|
policyType: PolicyType | string | undefined;
|
|
1974
2210
|
/**
|
|
2211
|
+
* @public
|
|
1975
2212
|
* <p>Currently the only valid value for this parameter is <code>ALL</code>, which specifies that the data
|
|
1976
2213
|
* protection policy applies to all log groups in the account. If you omit this parameter, the default
|
|
1977
2214
|
* of <code>ALL</code> is used.</p>
|
|
@@ -1983,6 +2220,7 @@ export interface PutAccountPolicyRequest {
|
|
|
1983
2220
|
*/
|
|
1984
2221
|
export interface PutAccountPolicyResponse {
|
|
1985
2222
|
/**
|
|
2223
|
+
* @public
|
|
1986
2224
|
* <p>The account policy that you created.</p>
|
|
1987
2225
|
*/
|
|
1988
2226
|
accountPolicy?: AccountPolicy;
|
|
@@ -1992,10 +2230,12 @@ export interface PutAccountPolicyResponse {
|
|
|
1992
2230
|
*/
|
|
1993
2231
|
export interface PutDataProtectionPolicyRequest {
|
|
1994
2232
|
/**
|
|
2233
|
+
* @public
|
|
1995
2234
|
* <p>Specify either the log group name or log group ARN.</p>
|
|
1996
2235
|
*/
|
|
1997
2236
|
logGroupIdentifier: string | undefined;
|
|
1998
2237
|
/**
|
|
2238
|
+
* @public
|
|
1999
2239
|
* <p>Specify the data protection policy, in JSON.</p>
|
|
2000
2240
|
* <p>This policy must include two JSON blocks:</p>
|
|
2001
2241
|
* <ul>
|
|
@@ -2038,14 +2278,17 @@ export interface PutDataProtectionPolicyRequest {
|
|
|
2038
2278
|
*/
|
|
2039
2279
|
export interface PutDataProtectionPolicyResponse {
|
|
2040
2280
|
/**
|
|
2281
|
+
* @public
|
|
2041
2282
|
* <p>The log group name or ARN that you specified in your request.</p>
|
|
2042
2283
|
*/
|
|
2043
2284
|
logGroupIdentifier?: string;
|
|
2044
2285
|
/**
|
|
2286
|
+
* @public
|
|
2045
2287
|
* <p>The data protection policy used for this log group.</p>
|
|
2046
2288
|
*/
|
|
2047
2289
|
policyDocument?: string;
|
|
2048
2290
|
/**
|
|
2291
|
+
* @public
|
|
2049
2292
|
* <p>The date and time that this policy was most recently updated.</p>
|
|
2050
2293
|
*/
|
|
2051
2294
|
lastUpdatedTime?: number;
|
|
@@ -2055,19 +2298,23 @@ export interface PutDataProtectionPolicyResponse {
|
|
|
2055
2298
|
*/
|
|
2056
2299
|
export interface PutDestinationRequest {
|
|
2057
2300
|
/**
|
|
2301
|
+
* @public
|
|
2058
2302
|
* <p>A name for the destination.</p>
|
|
2059
2303
|
*/
|
|
2060
2304
|
destinationName: string | undefined;
|
|
2061
2305
|
/**
|
|
2306
|
+
* @public
|
|
2062
2307
|
* <p>The ARN of an Amazon Kinesis stream to which to deliver matching log events.</p>
|
|
2063
2308
|
*/
|
|
2064
2309
|
targetArn: string | undefined;
|
|
2065
2310
|
/**
|
|
2311
|
+
* @public
|
|
2066
2312
|
* <p>The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon
|
|
2067
2313
|
* Kinesis <code>PutRecord</code> operation on the destination stream.</p>
|
|
2068
2314
|
*/
|
|
2069
2315
|
roleArn: string | undefined;
|
|
2070
2316
|
/**
|
|
2317
|
+
* @public
|
|
2071
2318
|
* <p>An optional list of key-value pairs to associate with the resource.</p>
|
|
2072
2319
|
* <p>For more information about tagging, see
|
|
2073
2320
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>
|
|
@@ -2080,6 +2327,7 @@ export interface PutDestinationRequest {
|
|
|
2080
2327
|
*/
|
|
2081
2328
|
export interface PutDestinationResponse {
|
|
2082
2329
|
/**
|
|
2330
|
+
* @public
|
|
2083
2331
|
* <p>The destination.</p>
|
|
2084
2332
|
*/
|
|
2085
2333
|
destination?: Destination;
|
|
@@ -2089,15 +2337,18 @@ export interface PutDestinationResponse {
|
|
|
2089
2337
|
*/
|
|
2090
2338
|
export interface PutDestinationPolicyRequest {
|
|
2091
2339
|
/**
|
|
2340
|
+
* @public
|
|
2092
2341
|
* <p>A name for an existing destination.</p>
|
|
2093
2342
|
*/
|
|
2094
2343
|
destinationName: string | undefined;
|
|
2095
2344
|
/**
|
|
2345
|
+
* @public
|
|
2096
2346
|
* <p>An IAM policy document that authorizes cross-account users to deliver their log events
|
|
2097
2347
|
* to the associated destination. This can be up to 5120 bytes.</p>
|
|
2098
2348
|
*/
|
|
2099
2349
|
accessPolicy: string | undefined;
|
|
2100
2350
|
/**
|
|
2351
|
+
* @public
|
|
2101
2352
|
* <p>Specify true if you are updating an existing destination policy to grant permission to
|
|
2102
2353
|
* an organization ID instead of granting permission to individual Amazon Web Services accounts. Before
|
|
2103
2354
|
* you update a destination policy this way, you must first update the subscription
|
|
@@ -2117,18 +2368,22 @@ export interface PutDestinationPolicyRequest {
|
|
|
2117
2368
|
*/
|
|
2118
2369
|
export interface PutLogEventsRequest {
|
|
2119
2370
|
/**
|
|
2371
|
+
* @public
|
|
2120
2372
|
* <p>The name of the log group.</p>
|
|
2121
2373
|
*/
|
|
2122
2374
|
logGroupName: string | undefined;
|
|
2123
2375
|
/**
|
|
2376
|
+
* @public
|
|
2124
2377
|
* <p>The name of the log stream.</p>
|
|
2125
2378
|
*/
|
|
2126
2379
|
logStreamName: string | undefined;
|
|
2127
2380
|
/**
|
|
2381
|
+
* @public
|
|
2128
2382
|
* <p>The log events.</p>
|
|
2129
2383
|
*/
|
|
2130
2384
|
logEvents: InputLogEvent[] | undefined;
|
|
2131
2385
|
/**
|
|
2386
|
+
* @public
|
|
2132
2387
|
* <p>The sequence token obtained from the response of the previous <code>PutLogEvents</code>
|
|
2133
2388
|
* call.</p>
|
|
2134
2389
|
* <important>
|
|
@@ -2146,14 +2401,17 @@ export interface PutLogEventsRequest {
|
|
|
2146
2401
|
*/
|
|
2147
2402
|
export interface RejectedLogEventsInfo {
|
|
2148
2403
|
/**
|
|
2404
|
+
* @public
|
|
2149
2405
|
* <p>The log events that are too new.</p>
|
|
2150
2406
|
*/
|
|
2151
2407
|
tooNewLogEventStartIndex?: number;
|
|
2152
2408
|
/**
|
|
2409
|
+
* @public
|
|
2153
2410
|
* <p>The log events that are dated too far in the past.</p>
|
|
2154
2411
|
*/
|
|
2155
2412
|
tooOldLogEventEndIndex?: number;
|
|
2156
2413
|
/**
|
|
2414
|
+
* @public
|
|
2157
2415
|
* <p>The expired log events.</p>
|
|
2158
2416
|
*/
|
|
2159
2417
|
expiredLogEventEndIndex?: number;
|
|
@@ -2163,6 +2421,7 @@ export interface RejectedLogEventsInfo {
|
|
|
2163
2421
|
*/
|
|
2164
2422
|
export interface PutLogEventsResponse {
|
|
2165
2423
|
/**
|
|
2424
|
+
* @public
|
|
2166
2425
|
* <p>The next sequence token.</p>
|
|
2167
2426
|
* <important>
|
|
2168
2427
|
* <p>This field has been deprecated.</p>
|
|
@@ -2176,6 +2435,7 @@ export interface PutLogEventsResponse {
|
|
|
2176
2435
|
*/
|
|
2177
2436
|
nextSequenceToken?: string;
|
|
2178
2437
|
/**
|
|
2438
|
+
* @public
|
|
2179
2439
|
* <p>The rejected events.</p>
|
|
2180
2440
|
*/
|
|
2181
2441
|
rejectedLogEventsInfo?: RejectedLogEventsInfo;
|
|
@@ -2198,18 +2458,22 @@ export declare class UnrecognizedClientException extends __BaseException {
|
|
|
2198
2458
|
*/
|
|
2199
2459
|
export interface PutMetricFilterRequest {
|
|
2200
2460
|
/**
|
|
2461
|
+
* @public
|
|
2201
2462
|
* <p>The name of the log group.</p>
|
|
2202
2463
|
*/
|
|
2203
2464
|
logGroupName: string | undefined;
|
|
2204
2465
|
/**
|
|
2466
|
+
* @public
|
|
2205
2467
|
* <p>A name for the metric filter.</p>
|
|
2206
2468
|
*/
|
|
2207
2469
|
filterName: string | undefined;
|
|
2208
2470
|
/**
|
|
2471
|
+
* @public
|
|
2209
2472
|
* <p>A filter pattern for extracting metric data out of ingested log events.</p>
|
|
2210
2473
|
*/
|
|
2211
2474
|
filterPattern: string | undefined;
|
|
2212
2475
|
/**
|
|
2476
|
+
* @public
|
|
2213
2477
|
* <p>A collection of information that defines how metric data gets emitted.</p>
|
|
2214
2478
|
*/
|
|
2215
2479
|
metricTransformations: MetricTransformation[] | undefined;
|
|
@@ -2219,12 +2483,14 @@ export interface PutMetricFilterRequest {
|
|
|
2219
2483
|
*/
|
|
2220
2484
|
export interface PutQueryDefinitionRequest {
|
|
2221
2485
|
/**
|
|
2486
|
+
* @public
|
|
2222
2487
|
* <p>A name for the query definition. If you are saving numerous query definitions, we
|
|
2223
2488
|
* recommend that you name them. This way, you can find the ones you want by using the first part
|
|
2224
2489
|
* of the name as a filter in the <code>queryDefinitionNamePrefix</code> parameter of <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html">DescribeQueryDefinitions</a>.</p>
|
|
2225
2490
|
*/
|
|
2226
2491
|
name: string | undefined;
|
|
2227
2492
|
/**
|
|
2493
|
+
* @public
|
|
2228
2494
|
* <p>If you are updating a query definition, use this parameter to specify the ID of the query
|
|
2229
2495
|
* definition that you want to update. You can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeQueryDefinitions.html">DescribeQueryDefinitions</a> to retrieve the IDs of your saved query
|
|
2230
2496
|
* definitions.</p>
|
|
@@ -2234,12 +2500,14 @@ export interface PutQueryDefinitionRequest {
|
|
|
2234
2500
|
*/
|
|
2235
2501
|
queryDefinitionId?: string;
|
|
2236
2502
|
/**
|
|
2503
|
+
* @public
|
|
2237
2504
|
* <p>Use this parameter to include specific log groups as part of your query definition.</p>
|
|
2238
2505
|
* <p>If you are updating a query definition and you omit this parameter, then the updated
|
|
2239
2506
|
* definition will contain no log groups.</p>
|
|
2240
2507
|
*/
|
|
2241
2508
|
logGroupNames?: string[];
|
|
2242
2509
|
/**
|
|
2510
|
+
* @public
|
|
2243
2511
|
* <p>The query string to use for this definition.
|
|
2244
2512
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query Syntax</a>.</p>
|
|
2245
2513
|
*/
|
|
@@ -2250,6 +2518,7 @@ export interface PutQueryDefinitionRequest {
|
|
|
2250
2518
|
*/
|
|
2251
2519
|
export interface PutQueryDefinitionResponse {
|
|
2252
2520
|
/**
|
|
2521
|
+
* @public
|
|
2253
2522
|
* <p>The ID of the query definition.</p>
|
|
2254
2523
|
*/
|
|
2255
2524
|
queryDefinitionId?: string;
|
|
@@ -2259,10 +2528,12 @@ export interface PutQueryDefinitionResponse {
|
|
|
2259
2528
|
*/
|
|
2260
2529
|
export interface PutResourcePolicyRequest {
|
|
2261
2530
|
/**
|
|
2531
|
+
* @public
|
|
2262
2532
|
* <p>Name of the new policy. This parameter is required.</p>
|
|
2263
2533
|
*/
|
|
2264
2534
|
policyName?: string;
|
|
2265
2535
|
/**
|
|
2536
|
+
* @public
|
|
2266
2537
|
* <p>Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string.
|
|
2267
2538
|
* This parameter is required.</p>
|
|
2268
2539
|
* <p>The following example creates a resource policy enabling the Route 53 service to put
|
|
@@ -2310,6 +2581,7 @@ export interface PutResourcePolicyRequest {
|
|
|
2310
2581
|
*/
|
|
2311
2582
|
export interface PutResourcePolicyResponse {
|
|
2312
2583
|
/**
|
|
2584
|
+
* @public
|
|
2313
2585
|
* <p>The new policy.</p>
|
|
2314
2586
|
*/
|
|
2315
2587
|
resourcePolicy?: ResourcePolicy;
|
|
@@ -2319,10 +2591,12 @@ export interface PutResourcePolicyResponse {
|
|
|
2319
2591
|
*/
|
|
2320
2592
|
export interface PutRetentionPolicyRequest {
|
|
2321
2593
|
/**
|
|
2594
|
+
* @public
|
|
2322
2595
|
* <p>The name of the log group.</p>
|
|
2323
2596
|
*/
|
|
2324
2597
|
logGroupName: string | undefined;
|
|
2325
2598
|
/**
|
|
2599
|
+
* @public
|
|
2326
2600
|
* <p>The number of days to retain the log events in the specified log group.
|
|
2327
2601
|
* Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653.</p>
|
|
2328
2602
|
* <p>To set a log group so that its log events do not expire, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html">DeleteRetentionPolicy</a>. </p>
|
|
@@ -2334,20 +2608,24 @@ export interface PutRetentionPolicyRequest {
|
|
|
2334
2608
|
*/
|
|
2335
2609
|
export interface PutSubscriptionFilterRequest {
|
|
2336
2610
|
/**
|
|
2611
|
+
* @public
|
|
2337
2612
|
* <p>The name of the log group.</p>
|
|
2338
2613
|
*/
|
|
2339
2614
|
logGroupName: string | undefined;
|
|
2340
2615
|
/**
|
|
2616
|
+
* @public
|
|
2341
2617
|
* <p>A name for the subscription filter. If you are updating an existing filter, you must
|
|
2342
2618
|
* specify the correct name in <code>filterName</code>. To find the name of the filter currently
|
|
2343
2619
|
* associated with a log group, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeSubscriptionFilters.html">DescribeSubscriptionFilters</a>.</p>
|
|
2344
2620
|
*/
|
|
2345
2621
|
filterName: string | undefined;
|
|
2346
2622
|
/**
|
|
2623
|
+
* @public
|
|
2347
2624
|
* <p>A filter pattern for subscribing to a filtered stream of log events.</p>
|
|
2348
2625
|
*/
|
|
2349
2626
|
filterPattern: string | undefined;
|
|
2350
2627
|
/**
|
|
2628
|
+
* @public
|
|
2351
2629
|
* <p>The ARN of the destination to deliver matching log events to. Currently, the supported
|
|
2352
2630
|
* destinations are:</p>
|
|
2353
2631
|
* <ul>
|
|
@@ -2374,12 +2652,14 @@ export interface PutSubscriptionFilterRequest {
|
|
|
2374
2652
|
*/
|
|
2375
2653
|
destinationArn: string | undefined;
|
|
2376
2654
|
/**
|
|
2655
|
+
* @public
|
|
2377
2656
|
* <p>The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log
|
|
2378
2657
|
* events to the destination stream. You don't need to provide the ARN when you are working with
|
|
2379
2658
|
* a logical destination for cross-account delivery.</p>
|
|
2380
2659
|
*/
|
|
2381
2660
|
roleArn?: string;
|
|
2382
2661
|
/**
|
|
2662
|
+
* @public
|
|
2383
2663
|
* <p>The method used to distribute log data to the destination. By default, log data is
|
|
2384
2664
|
* grouped by log stream, but the grouping can be set to random for a more even distribution.
|
|
2385
2665
|
* This property is only applicable when the destination is an Amazon Kinesis data stream. </p>
|
|
@@ -2392,10 +2672,12 @@ export interface PutSubscriptionFilterRequest {
|
|
|
2392
2672
|
*/
|
|
2393
2673
|
export interface QueryCompileErrorLocation {
|
|
2394
2674
|
/**
|
|
2675
|
+
* @public
|
|
2395
2676
|
* <p>Reserved.</p>
|
|
2396
2677
|
*/
|
|
2397
2678
|
startCharOffset?: number;
|
|
2398
2679
|
/**
|
|
2680
|
+
* @public
|
|
2399
2681
|
* <p>Reserved.</p>
|
|
2400
2682
|
*/
|
|
2401
2683
|
endCharOffset?: number;
|
|
@@ -2406,10 +2688,12 @@ export interface QueryCompileErrorLocation {
|
|
|
2406
2688
|
*/
|
|
2407
2689
|
export interface QueryCompileError {
|
|
2408
2690
|
/**
|
|
2691
|
+
* @public
|
|
2409
2692
|
* <p>Reserved.</p>
|
|
2410
2693
|
*/
|
|
2411
2694
|
location?: QueryCompileErrorLocation;
|
|
2412
2695
|
/**
|
|
2696
|
+
* @public
|
|
2413
2697
|
* <p>Reserved.</p>
|
|
2414
2698
|
*/
|
|
2415
2699
|
message?: string;
|
|
@@ -2426,6 +2710,7 @@ export declare class MalformedQueryException extends __BaseException {
|
|
|
2426
2710
|
readonly name: "MalformedQueryException";
|
|
2427
2711
|
readonly $fault: "client";
|
|
2428
2712
|
/**
|
|
2713
|
+
* @public
|
|
2429
2714
|
* <p>Reserved.</p>
|
|
2430
2715
|
*/
|
|
2431
2716
|
queryCompileError?: QueryCompileError;
|
|
@@ -2439,6 +2724,7 @@ export declare class MalformedQueryException extends __BaseException {
|
|
|
2439
2724
|
*/
|
|
2440
2725
|
export interface StartQueryRequest {
|
|
2441
2726
|
/**
|
|
2727
|
+
* @public
|
|
2442
2728
|
* <p>The log group on which to perform the query.</p>
|
|
2443
2729
|
* <note>
|
|
2444
2730
|
* <p>A <code>StartQuery</code> operation must include exactly one of the following
|
|
@@ -2448,6 +2734,7 @@ export interface StartQueryRequest {
|
|
|
2448
2734
|
*/
|
|
2449
2735
|
logGroupName?: string;
|
|
2450
2736
|
/**
|
|
2737
|
+
* @public
|
|
2451
2738
|
* <p>The list of log groups to be queried. You can include up to 50 log groups.</p>
|
|
2452
2739
|
* <note>
|
|
2453
2740
|
* <p>A <code>StartQuery</code> operation must include exactly one of the following
|
|
@@ -2457,6 +2744,7 @@ export interface StartQueryRequest {
|
|
|
2457
2744
|
*/
|
|
2458
2745
|
logGroupNames?: string[];
|
|
2459
2746
|
/**
|
|
2747
|
+
* @public
|
|
2460
2748
|
* <p>The list of log groups to query. You can include up to 50 log groups.</p>
|
|
2461
2749
|
* <p>You can specify them by the log group name or ARN. If a log group that you're querying is
|
|
2462
2750
|
* in a source account and you're using a monitoring account, you must specify the ARN of the log
|
|
@@ -2467,23 +2755,27 @@ export interface StartQueryRequest {
|
|
|
2467
2755
|
*/
|
|
2468
2756
|
logGroupIdentifiers?: string[];
|
|
2469
2757
|
/**
|
|
2758
|
+
* @public
|
|
2470
2759
|
* <p>The beginning of the time range to query. The range is inclusive, so the specified start
|
|
2471
2760
|
* time is included in the query. Specified as epoch time, the number of seconds since
|
|
2472
2761
|
* <code>January 1, 1970, 00:00:00 UTC</code>.</p>
|
|
2473
2762
|
*/
|
|
2474
2763
|
startTime: number | undefined;
|
|
2475
2764
|
/**
|
|
2765
|
+
* @public
|
|
2476
2766
|
* <p>The end of the time range to query. The range is inclusive, so the specified end time is
|
|
2477
2767
|
* included in the query. Specified as epoch time, the number of seconds since <code>January 1,
|
|
2478
2768
|
* 1970, 00:00:00 UTC</code>.</p>
|
|
2479
2769
|
*/
|
|
2480
2770
|
endTime: number | undefined;
|
|
2481
2771
|
/**
|
|
2772
|
+
* @public
|
|
2482
2773
|
* <p>The query string to use.
|
|
2483
2774
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query Syntax</a>.</p>
|
|
2484
2775
|
*/
|
|
2485
2776
|
queryString: string | undefined;
|
|
2486
2777
|
/**
|
|
2778
|
+
* @public
|
|
2487
2779
|
* <p>The maximum number of log events to return in the query. If the query string uses the <code>fields</code> command,
|
|
2488
2780
|
* only the specified fields and their values are returned. The default is 1000.</p>
|
|
2489
2781
|
*/
|
|
@@ -2494,6 +2786,7 @@ export interface StartQueryRequest {
|
|
|
2494
2786
|
*/
|
|
2495
2787
|
export interface StartQueryResponse {
|
|
2496
2788
|
/**
|
|
2789
|
+
* @public
|
|
2497
2790
|
* <p>The unique ID of the query. </p>
|
|
2498
2791
|
*/
|
|
2499
2792
|
queryId?: string;
|
|
@@ -2503,6 +2796,7 @@ export interface StartQueryResponse {
|
|
|
2503
2796
|
*/
|
|
2504
2797
|
export interface StopQueryRequest {
|
|
2505
2798
|
/**
|
|
2799
|
+
* @public
|
|
2506
2800
|
* <p>The ID number of the query to stop. To find this ID number, use
|
|
2507
2801
|
* <code>DescribeQueries</code>.</p>
|
|
2508
2802
|
*/
|
|
@@ -2513,6 +2807,7 @@ export interface StopQueryRequest {
|
|
|
2513
2807
|
*/
|
|
2514
2808
|
export interface StopQueryResponse {
|
|
2515
2809
|
/**
|
|
2810
|
+
* @public
|
|
2516
2811
|
* <p>This is true if the query was stopped by the <code>StopQuery</code> operation.</p>
|
|
2517
2812
|
*/
|
|
2518
2813
|
success?: boolean;
|
|
@@ -2522,10 +2817,12 @@ export interface StopQueryResponse {
|
|
|
2522
2817
|
*/
|
|
2523
2818
|
export interface TagLogGroupRequest {
|
|
2524
2819
|
/**
|
|
2820
|
+
* @public
|
|
2525
2821
|
* <p>The name of the log group.</p>
|
|
2526
2822
|
*/
|
|
2527
2823
|
logGroupName: string | undefined;
|
|
2528
2824
|
/**
|
|
2825
|
+
* @public
|
|
2529
2826
|
* <p>The key-value pairs to use for the tags.</p>
|
|
2530
2827
|
*/
|
|
2531
2828
|
tags: Record<string, string> | undefined;
|
|
@@ -2535,6 +2832,7 @@ export interface TagLogGroupRequest {
|
|
|
2535
2832
|
*/
|
|
2536
2833
|
export interface TagResourceRequest {
|
|
2537
2834
|
/**
|
|
2835
|
+
* @public
|
|
2538
2836
|
* <p>The ARN of the resource that you're adding tags to.</p>
|
|
2539
2837
|
* <p>The ARN format of a log group is
|
|
2540
2838
|
* <code>arn:aws:logs:<i>Region</i>:<i>account-id</i>:log-group:<i>log-group-name</i>
|
|
@@ -2549,6 +2847,7 @@ export interface TagResourceRequest {
|
|
|
2549
2847
|
*/
|
|
2550
2848
|
resourceArn: string | undefined;
|
|
2551
2849
|
/**
|
|
2850
|
+
* @public
|
|
2552
2851
|
* <p>The list of key-value pairs to associate with the resource.</p>
|
|
2553
2852
|
*/
|
|
2554
2853
|
tags: Record<string, string> | undefined;
|
|
@@ -2561,6 +2860,7 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
2561
2860
|
readonly name: "TooManyTagsException";
|
|
2562
2861
|
readonly $fault: "client";
|
|
2563
2862
|
/**
|
|
2863
|
+
* @public
|
|
2564
2864
|
* <p>The name of the resource.</p>
|
|
2565
2865
|
*/
|
|
2566
2866
|
resourceName?: string;
|
|
@@ -2574,12 +2874,14 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
2574
2874
|
*/
|
|
2575
2875
|
export interface TestMetricFilterRequest {
|
|
2576
2876
|
/**
|
|
2877
|
+
* @public
|
|
2577
2878
|
* <p>A symbolic description of how CloudWatch Logs should interpret the data in each log
|
|
2578
2879
|
* event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You
|
|
2579
2880
|
* use the filter pattern to specify what to look for in the log event message.</p>
|
|
2580
2881
|
*/
|
|
2581
2882
|
filterPattern: string | undefined;
|
|
2582
2883
|
/**
|
|
2884
|
+
* @public
|
|
2583
2885
|
* <p>The log event messages to test.</p>
|
|
2584
2886
|
*/
|
|
2585
2887
|
logEventMessages: string[] | undefined;
|
|
@@ -2590,14 +2892,17 @@ export interface TestMetricFilterRequest {
|
|
|
2590
2892
|
*/
|
|
2591
2893
|
export interface MetricFilterMatchRecord {
|
|
2592
2894
|
/**
|
|
2895
|
+
* @public
|
|
2593
2896
|
* <p>The event number.</p>
|
|
2594
2897
|
*/
|
|
2595
2898
|
eventNumber?: number;
|
|
2596
2899
|
/**
|
|
2900
|
+
* @public
|
|
2597
2901
|
* <p>The raw event data.</p>
|
|
2598
2902
|
*/
|
|
2599
2903
|
eventMessage?: string;
|
|
2600
2904
|
/**
|
|
2905
|
+
* @public
|
|
2601
2906
|
* <p>The values extracted from the event data by the filter.</p>
|
|
2602
2907
|
*/
|
|
2603
2908
|
extractedValues?: Record<string, string>;
|
|
@@ -2607,6 +2912,7 @@ export interface MetricFilterMatchRecord {
|
|
|
2607
2912
|
*/
|
|
2608
2913
|
export interface TestMetricFilterResponse {
|
|
2609
2914
|
/**
|
|
2915
|
+
* @public
|
|
2610
2916
|
* <p>The matched events.</p>
|
|
2611
2917
|
*/
|
|
2612
2918
|
matches?: MetricFilterMatchRecord[];
|
|
@@ -2616,10 +2922,12 @@ export interface TestMetricFilterResponse {
|
|
|
2616
2922
|
*/
|
|
2617
2923
|
export interface UntagLogGroupRequest {
|
|
2618
2924
|
/**
|
|
2925
|
+
* @public
|
|
2619
2926
|
* <p>The name of the log group.</p>
|
|
2620
2927
|
*/
|
|
2621
2928
|
logGroupName: string | undefined;
|
|
2622
2929
|
/**
|
|
2930
|
+
* @public
|
|
2623
2931
|
* <p>The tag keys. The corresponding tags are removed from the log group.</p>
|
|
2624
2932
|
*/
|
|
2625
2933
|
tags: string[] | undefined;
|
|
@@ -2629,6 +2937,7 @@ export interface UntagLogGroupRequest {
|
|
|
2629
2937
|
*/
|
|
2630
2938
|
export interface UntagResourceRequest {
|
|
2631
2939
|
/**
|
|
2940
|
+
* @public
|
|
2632
2941
|
* <p>The ARN of the CloudWatch Logs resource that you're removing tags from.</p>
|
|
2633
2942
|
* <p>The ARN format of a log group is
|
|
2634
2943
|
* <code>arn:aws:logs:<i>Region</i>:<i>account-id</i>:log-group:<i>log-group-name</i>
|
|
@@ -2643,6 +2952,7 @@ export interface UntagResourceRequest {
|
|
|
2643
2952
|
*/
|
|
2644
2953
|
resourceArn: string | undefined;
|
|
2645
2954
|
/**
|
|
2955
|
+
* @public
|
|
2646
2956
|
* <p>The list of tag keys to remove from the resource.</p>
|
|
2647
2957
|
*/
|
|
2648
2958
|
tagKeys: string[] | undefined;
|