@aws-sdk/client-cloudwatch-logs 3.216.0 → 3.218.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -14
- package/dist-cjs/CloudWatchLogs.js +45 -0
- package/dist-cjs/commands/DeleteDataProtectionPolicyCommand.js +46 -0
- package/dist-cjs/commands/GetDataProtectionPolicyCommand.js +46 -0
- package/dist-cjs/commands/PutDataProtectionPolicyCommand.js +46 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/endpoint/ruleset.js +5 -5
- package/dist-cjs/models/models_0.js +30 -3
- package/dist-cjs/protocols/Aws_json1_1.js +221 -2
- package/dist-es/CloudWatchLogs.js +45 -0
- package/dist-es/commands/DeleteDataProtectionPolicyCommand.js +42 -0
- package/dist-es/commands/GetDataProtectionPolicyCommand.js +42 -0
- package/dist-es/commands/PutDataProtectionPolicyCommand.js +42 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/endpoint/ruleset.js +5 -5
- package/dist-es/models/models_0.js +22 -0
- package/dist-es/protocols/Aws_json1_1.js +213 -0
- package/dist-types/CloudWatchLogs.d.ts +184 -114
- package/dist-types/CloudWatchLogsClient.d.ts +20 -16
- package/dist-types/commands/AssociateKmsKeyCommand.d.ts +11 -10
- package/dist-types/commands/CreateExportTaskCommand.d.ts +11 -11
- package/dist-types/commands/CreateLogGroupCommand.d.ts +14 -12
- package/dist-types/commands/CreateLogStreamCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDataProtectionPolicyCommand.d.ts +38 -0
- package/dist-types/commands/DescribeLogGroupsCommand.d.ts +3 -0
- package/dist-types/commands/DescribeLogStreamsCommand.d.ts +3 -0
- package/dist-types/commands/DescribeQueriesCommand.d.ts +3 -3
- package/dist-types/commands/DisassociateKmsKeyCommand.d.ts +5 -3
- package/dist-types/commands/FilterLogEventsCommand.d.ts +8 -4
- package/dist-types/commands/GetDataProtectionPolicyCommand.d.ts +37 -0
- package/dist-types/commands/GetLogEventsCommand.d.ts +4 -0
- package/dist-types/commands/GetLogGroupFieldsCommand.d.ts +10 -6
- package/dist-types/commands/GetQueryResultsCommand.d.ts +4 -2
- package/dist-types/commands/PutDataProtectionPolicyCommand.d.ts +51 -0
- package/dist-types/commands/PutDestinationCommand.d.ts +3 -3
- package/dist-types/commands/PutLogEventsCommand.d.ts +11 -8
- package/dist-types/commands/PutMetricFilterCommand.d.ts +5 -5
- package/dist-types/commands/PutQueryDefinitionCommand.d.ts +7 -7
- package/dist-types/commands/PutRetentionPolicyCommand.d.ts +11 -10
- package/dist-types/commands/PutSubscriptionFilterCommand.d.ts +10 -11
- package/dist-types/commands/StartQueryCommand.d.ts +9 -4
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +369 -115
- package/dist-types/protocols/Aws_json1_1.d.ts +9 -0
- package/dist-types/ts3.4/CloudWatchLogs.d.ts +51 -0
- package/dist-types/ts3.4/CloudWatchLogsClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/DeleteDataProtectionPolicyCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/GetDataProtectionPolicyCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/PutDataProtectionPolicyCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +53 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
- package/package.json +3 -3
|
@@ -6,8 +6,9 @@ export interface AssociateKmsKeyRequest {
|
|
|
6
6
|
*/
|
|
7
7
|
logGroupName: string | undefined;
|
|
8
8
|
/**
|
|
9
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
10
|
-
* 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
|
|
9
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key to use when encrypting log
|
|
10
|
+
* 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
|
|
11
|
+
* Keys</a>.</p>
|
|
11
12
|
*/
|
|
12
13
|
kmsKeyId: string | undefined;
|
|
13
14
|
}
|
|
@@ -88,19 +89,19 @@ export interface CreateExportTaskRequest {
|
|
|
88
89
|
logStreamNamePrefix?: string;
|
|
89
90
|
/**
|
|
90
91
|
* <p>The start time of the range for the request, expressed as the number of milliseconds
|
|
91
|
-
* after Jan 1, 1970 00:00:00 UTC
|
|
92
|
-
* exported.</p>
|
|
92
|
+
* after <code>Jan 1, 1970 00:00:00 UTC</code>. Events with a timestamp earlier than this time
|
|
93
|
+
* are not exported.</p>
|
|
93
94
|
*/
|
|
94
95
|
from: number | undefined;
|
|
95
96
|
/**
|
|
96
97
|
* <p>The end time of the range for the request, expressed as the number of milliseconds
|
|
97
|
-
* after Jan 1, 1970 00:00:00 UTC
|
|
98
|
-
* exported.</p>
|
|
98
|
+
* after <code>Jan 1, 1970 00:00:00 UTC</code>. Events with a timestamp later than this time are
|
|
99
|
+
* not exported.</p>
|
|
99
100
|
* <p>You must specify a time that is not earlier than when this log group was created.</p>
|
|
100
101
|
*/
|
|
101
102
|
to: number | undefined;
|
|
102
103
|
/**
|
|
103
|
-
* <p>The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services
|
|
104
|
+
* <p>The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services Region.</p>
|
|
104
105
|
*/
|
|
105
106
|
destination: string | undefined;
|
|
106
107
|
/**
|
|
@@ -143,17 +144,18 @@ export interface CreateLogGroupRequest {
|
|
|
143
144
|
*/
|
|
144
145
|
logGroupName: string | undefined;
|
|
145
146
|
/**
|
|
146
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
147
|
-
* For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms">Amazon Resource
|
|
147
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key to use when encrypting log
|
|
148
|
+
* 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
|
|
149
|
+
* Names</a>.</p>
|
|
148
150
|
*/
|
|
149
151
|
kmsKeyId?: string;
|
|
150
152
|
/**
|
|
151
153
|
* <p>The key-value pairs to use for the tags.</p>
|
|
152
|
-
* <p>CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified
|
|
153
|
-
* log groups using the <code>aws:Resource/<i>key-name</i>
|
|
154
|
-
* </code> or
|
|
155
|
-
*
|
|
156
|
-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Controlling access to Amazon Web Services resources using tags</a>.</p>
|
|
154
|
+
* <p>CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified
|
|
155
|
+
* tags to log groups using the <code>aws:Resource/<i>key-name</i>
|
|
156
|
+
* </code> or
|
|
157
|
+
* <code>aws:TagKeys</code> condition keys. For more information about using tags to control
|
|
158
|
+
* access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Controlling access to Amazon Web Services resources using tags</a>.</p>
|
|
157
159
|
*/
|
|
158
160
|
tags?: Record<string, string>;
|
|
159
161
|
}
|
|
@@ -179,6 +181,18 @@ export declare class DataAlreadyAcceptedException extends __BaseException {
|
|
|
179
181
|
*/
|
|
180
182
|
constructor(opts: __ExceptionOptionType<DataAlreadyAcceptedException, __BaseException>);
|
|
181
183
|
}
|
|
184
|
+
export declare enum DataProtectionStatus {
|
|
185
|
+
ACTIVATED = "ACTIVATED",
|
|
186
|
+
ARCHIVED = "ARCHIVED",
|
|
187
|
+
DELETED = "DELETED",
|
|
188
|
+
DISABLED = "DISABLED"
|
|
189
|
+
}
|
|
190
|
+
export interface DeleteDataProtectionPolicyRequest {
|
|
191
|
+
/**
|
|
192
|
+
* <p>The name or ARN of the log group that you want to delete the data protection policy for.</p>
|
|
193
|
+
*/
|
|
194
|
+
logGroupIdentifier: string | undefined;
|
|
195
|
+
}
|
|
182
196
|
export interface DeleteDestinationRequest {
|
|
183
197
|
/**
|
|
184
198
|
* <p>The name of the destination.</p>
|
|
@@ -314,7 +328,8 @@ export declare enum ExportTaskStatusCode {
|
|
|
314
328
|
}
|
|
315
329
|
export interface DescribeExportTasksRequest {
|
|
316
330
|
/**
|
|
317
|
-
* <p>The ID of the export task. Specifying a task ID filters the results to
|
|
331
|
+
* <p>The ID of the export task. Specifying a task ID filters the results to one or zero
|
|
332
|
+
* export tasks.</p>
|
|
318
333
|
*/
|
|
319
334
|
taskId?: string;
|
|
320
335
|
/**
|
|
@@ -335,13 +350,13 @@ export interface DescribeExportTasksRequest {
|
|
|
335
350
|
*/
|
|
336
351
|
export interface ExportTaskExecutionInfo {
|
|
337
352
|
/**
|
|
338
|
-
* <p>The creation time of the export task, expressed as the number of milliseconds after
|
|
339
|
-
*
|
|
353
|
+
* <p>The creation time of the export task, expressed as the number of milliseconds after
|
|
354
|
+
* <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
340
355
|
*/
|
|
341
356
|
creationTime?: number;
|
|
342
357
|
/**
|
|
343
358
|
* <p>The completion time of the export task, expressed as the number of milliseconds after
|
|
344
|
-
*
|
|
359
|
+
* <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
345
360
|
*/
|
|
346
361
|
completionTime?: number;
|
|
347
362
|
}
|
|
@@ -375,13 +390,13 @@ export interface ExportTask {
|
|
|
375
390
|
*/
|
|
376
391
|
logGroupName?: string;
|
|
377
392
|
/**
|
|
378
|
-
* <p>The start time, expressed as the number of milliseconds after Jan 1, 1970
|
|
379
|
-
*
|
|
393
|
+
* <p>The start time, expressed as the number of milliseconds after <code>Jan 1, 1970
|
|
394
|
+
* 00:00:00 UTC</code>. Events with a timestamp before this time are not exported.</p>
|
|
380
395
|
*/
|
|
381
396
|
from?: number;
|
|
382
397
|
/**
|
|
383
|
-
* <p>The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00
|
|
384
|
-
*
|
|
398
|
+
* <p>The end time, expressed as the number of milliseconds after <code>Jan 1, 1970 00:00:00
|
|
399
|
+
* UTC</code>. Events with a timestamp later than this time are not exported.</p>
|
|
385
400
|
*/
|
|
386
401
|
to?: number;
|
|
387
402
|
/**
|
|
@@ -412,10 +427,39 @@ export interface DescribeExportTasksResponse {
|
|
|
412
427
|
nextToken?: string;
|
|
413
428
|
}
|
|
414
429
|
export interface DescribeLogGroupsRequest {
|
|
430
|
+
/**
|
|
431
|
+
* <p>When <code>includeLinkedAccounts</code> is set to <code>True</code>, use this parameter to
|
|
432
|
+
* specify the list of accounts to search. You can specify as many as 20 account IDs in the array. </p>
|
|
433
|
+
*/
|
|
434
|
+
accountIdentifiers?: string[];
|
|
415
435
|
/**
|
|
416
436
|
* <p>The prefix to match.</p>
|
|
437
|
+
* <note>
|
|
438
|
+
* <p>
|
|
439
|
+
* <code>logGroupNamePrefix</code> and <code>logGroupNamePattern</code> are mutually exclusive.
|
|
440
|
+
* Only one
|
|
441
|
+
* of these parameters can be passed.
|
|
442
|
+
* </p>
|
|
443
|
+
* </note>
|
|
417
444
|
*/
|
|
418
445
|
logGroupNamePrefix?: string;
|
|
446
|
+
/**
|
|
447
|
+
* <p>If you specify a string for this parameter, the operation returns only log groups that have names
|
|
448
|
+
* that match the string based on a case-sensitive substring search. For example, if you specify <code>Foo</code>, log groups
|
|
449
|
+
* named <code>FooBar</code>, <code>aws/Foo</code>, and <code>GroupFoo</code> would match, but <code>foo</code>,
|
|
450
|
+
* <code>F/o/o</code> and <code>Froo</code> would not match.</p>
|
|
451
|
+
*
|
|
452
|
+
*
|
|
453
|
+
*
|
|
454
|
+
* <note>
|
|
455
|
+
* <p>
|
|
456
|
+
* <code>logGroupNamePattern</code> and <code>logGroupNamePrefix</code> are mutually exclusive.
|
|
457
|
+
* Only one
|
|
458
|
+
* of these parameters can be passed.
|
|
459
|
+
* </p>
|
|
460
|
+
* </note>
|
|
461
|
+
*/
|
|
462
|
+
logGroupNamePattern?: string;
|
|
419
463
|
/**
|
|
420
464
|
* <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
|
|
421
465
|
*/
|
|
@@ -424,6 +468,23 @@ export interface DescribeLogGroupsRequest {
|
|
|
424
468
|
* <p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>
|
|
425
469
|
*/
|
|
426
470
|
limit?: number;
|
|
471
|
+
/**
|
|
472
|
+
* <p>If you are using a monitoring account, set this to <code>True</code> to have the operation
|
|
473
|
+
* return log groups in
|
|
474
|
+
* the accounts listed in <code>accountIdentifiers</code>.</p>
|
|
475
|
+
*
|
|
476
|
+
*
|
|
477
|
+
* <p>If this parameter is set to <code>true</code> and <code>accountIdentifiers</code>
|
|
478
|
+
*
|
|
479
|
+
* contains a null value, the operation returns all log groups in the monitoring account
|
|
480
|
+
* and all log groups in all source accounts that are linked to the monitoring account. </p>
|
|
481
|
+
* <note>
|
|
482
|
+
* <p> If you specify <code>includeLinkedAccounts</code> in your request, then
|
|
483
|
+
* <code>metricFilterCount</code>, <code>retentionInDays</code>, and <code>storedBytes</code>
|
|
484
|
+
* are not included in the response. </p>
|
|
485
|
+
* </note>
|
|
486
|
+
*/
|
|
487
|
+
includeLinkedAccounts?: boolean;
|
|
427
488
|
}
|
|
428
489
|
/**
|
|
429
490
|
* <p>Represents a log group.</p>
|
|
@@ -441,9 +502,7 @@ export interface LogGroup {
|
|
|
441
502
|
/**
|
|
442
503
|
* <p>The number of days to retain the log events in the specified log group.
|
|
443
504
|
* Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653.</p>
|
|
444
|
-
* <p>To set a log group
|
|
445
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html">DeleteRetentionPolicy</a>.
|
|
446
|
-
* </p>
|
|
505
|
+
* <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>
|
|
447
506
|
*/
|
|
448
507
|
retentionInDays?: number;
|
|
449
508
|
/**
|
|
@@ -459,15 +518,21 @@ export interface LogGroup {
|
|
|
459
518
|
*/
|
|
460
519
|
storedBytes?: number;
|
|
461
520
|
/**
|
|
462
|
-
* <p>The Amazon Resource Name (ARN) of the
|
|
521
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key to use when
|
|
522
|
+
* encrypting log data.</p>
|
|
463
523
|
*/
|
|
464
524
|
kmsKeyId?: string;
|
|
525
|
+
/**
|
|
526
|
+
* <p>Displays whether this log group has a protection policy, or whether it had one in the past. For more information, see
|
|
527
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html">PutDataProtectionPolicy</a>.</p>
|
|
528
|
+
*/
|
|
529
|
+
dataProtectionStatus?: DataProtectionStatus | string;
|
|
465
530
|
}
|
|
466
531
|
export interface DescribeLogGroupsResponse {
|
|
467
532
|
/**
|
|
468
533
|
* <p>The log groups.</p>
|
|
469
|
-
* <p>If the <code>retentionInDays</code> value is not included for a log group, then that log
|
|
470
|
-
*
|
|
534
|
+
* <p>If the <code>retentionInDays</code> value is not included for a log group, then that log
|
|
535
|
+
* group's events do not expire.</p>
|
|
471
536
|
*/
|
|
472
537
|
logGroups?: LogGroup[];
|
|
473
538
|
/**
|
|
@@ -482,8 +547,22 @@ export declare enum OrderBy {
|
|
|
482
547
|
export interface DescribeLogStreamsRequest {
|
|
483
548
|
/**
|
|
484
549
|
* <p>The name of the log group.</p>
|
|
550
|
+
* <note>
|
|
551
|
+
* <p>
|
|
552
|
+
* If you specify values for both <code>logGroupName</code> and <code>logGroupIdentifier</code>,
|
|
553
|
+
* the action returns an <code>InvalidParameterException</code> error.
|
|
554
|
+
* </p>
|
|
555
|
+
* </note>
|
|
485
556
|
*/
|
|
486
557
|
logGroupName: string | undefined;
|
|
558
|
+
/**
|
|
559
|
+
* <p>Specify either the name or ARN of the log group to view. If the log group is in a source account
|
|
560
|
+
* and you are using a monitoring account, you must use the log group ARN.</p>
|
|
561
|
+
* <p>If you specify values for both <code>logGroupName</code> and
|
|
562
|
+
* <code>logGroupIdentifier</code>, the action returns an
|
|
563
|
+
* <code>InvalidParameterException</code> error.</p>
|
|
564
|
+
*/
|
|
565
|
+
logGroupIdentifier?: string;
|
|
487
566
|
/**
|
|
488
567
|
* <p>The prefix to match.</p>
|
|
489
568
|
* <p>If <code>orderBy</code> is <code>LastEventTime</code>, you cannot specify this
|
|
@@ -498,9 +577,9 @@ export interface DescribeLogStreamsRequest {
|
|
|
498
577
|
* <p>
|
|
499
578
|
* <code>lastEventTimestamp</code> represents the time of the most recent log event in the
|
|
500
579
|
* log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after
|
|
501
|
-
*
|
|
502
|
-
* basis. It typically updates in less than an hour from ingestion, but in
|
|
503
|
-
* take longer.</p>
|
|
580
|
+
* <code>Jan 1, 1970 00:00:00 UTC</code>. <code>lastEventTimestamp</code> updates on an
|
|
581
|
+
* eventual consistency basis. It typically updates in less than an hour from ingestion, but in
|
|
582
|
+
* rare situations might take longer.</p>
|
|
504
583
|
*/
|
|
505
584
|
orderBy?: OrderBy | string;
|
|
506
585
|
/**
|
|
@@ -528,26 +607,26 @@ export interface LogStream {
|
|
|
528
607
|
*/
|
|
529
608
|
logStreamName?: string;
|
|
530
609
|
/**
|
|
531
|
-
* <p>The creation time of the stream, expressed as the number of milliseconds after
|
|
532
|
-
*
|
|
610
|
+
* <p>The creation time of the stream, expressed as the number of milliseconds after
|
|
611
|
+
* <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
533
612
|
*/
|
|
534
613
|
creationTime?: number;
|
|
535
614
|
/**
|
|
536
|
-
* <p>The time of the first event, expressed as the number of milliseconds after Jan 1,
|
|
537
|
-
*
|
|
615
|
+
* <p>The time of the first event, expressed as the number of milliseconds after <code>Jan 1,
|
|
616
|
+
* 1970 00:00:00 UTC</code>.</p>
|
|
538
617
|
*/
|
|
539
618
|
firstEventTimestamp?: number;
|
|
540
619
|
/**
|
|
541
620
|
* <p>The time of the most recent log event in the log stream in CloudWatch Logs. This number
|
|
542
|
-
* is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC
|
|
621
|
+
* is expressed as the number of milliseconds after <code>Jan 1, 1970 00:00:00 UTC</code>. The
|
|
543
622
|
* <code>lastEventTime</code> value updates on an eventual consistency basis. It typically
|
|
544
623
|
* updates in less than an hour from ingestion, but in rare situations might take
|
|
545
624
|
* longer.</p>
|
|
546
625
|
*/
|
|
547
626
|
lastEventTimestamp?: number;
|
|
548
627
|
/**
|
|
549
|
-
* <p>The ingestion time, expressed as the number of milliseconds after Jan 1, 1970
|
|
550
|
-
*
|
|
628
|
+
* <p>The ingestion time, expressed as the number of milliseconds after <code>Jan 1, 1970
|
|
629
|
+
* 00:00:00 UTC</code>.</p>
|
|
551
630
|
*/
|
|
552
631
|
lastIngestionTime?: number;
|
|
553
632
|
/**
|
|
@@ -563,9 +642,9 @@ export interface LogStream {
|
|
|
563
642
|
*
|
|
564
643
|
* <p>The number of bytes stored.</p>
|
|
565
644
|
* <p>
|
|
566
|
-
* <b>Important:</b>
|
|
567
|
-
*
|
|
568
|
-
* streams. The <code>storedBytes</code> parameter for log groups is not affected.</p>
|
|
645
|
+
* <b>Important:</b> As of June 17, 2019, this parameter is no
|
|
646
|
+
* longer supported for log streams, and is always reported as zero. This change applies only to
|
|
647
|
+
* log streams. The <code>storedBytes</code> parameter for log groups is not affected.</p>
|
|
569
648
|
*/
|
|
570
649
|
storedBytes?: number;
|
|
571
650
|
}
|
|
@@ -585,8 +664,8 @@ export interface DescribeMetricFiltersRequest {
|
|
|
585
664
|
*/
|
|
586
665
|
logGroupName?: string;
|
|
587
666
|
/**
|
|
588
|
-
* <p>The prefix to match. CloudWatch Logs uses the value you set here
|
|
589
|
-
*
|
|
667
|
+
* <p>The prefix to match. CloudWatch Logs uses the value that you set here only if you also
|
|
668
|
+
* include the <code>logGroupName</code> parameter in your request.</p>
|
|
590
669
|
*/
|
|
591
670
|
filterNamePrefix?: string;
|
|
592
671
|
/**
|
|
@@ -670,9 +749,9 @@ export interface MetricTransformation {
|
|
|
670
749
|
* found for
|
|
671
750
|
* a dimension is treated as a separate metric and accrues charges as a separate custom metric.
|
|
672
751
|
* </p>
|
|
673
|
-
* <p>
|
|
674
|
-
*
|
|
675
|
-
*
|
|
752
|
+
* <p>CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your
|
|
753
|
+
* specified dimensions within a certain amount of time. This helps to prevent accidental high
|
|
754
|
+
* charges.</p>
|
|
676
755
|
* <p>You can also set up a billing alarm to alert you if your charges are higher than
|
|
677
756
|
* expected. For more information,
|
|
678
757
|
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html">
|
|
@@ -707,7 +786,7 @@ export interface MetricFilter {
|
|
|
707
786
|
metricTransformations?: MetricTransformation[];
|
|
708
787
|
/**
|
|
709
788
|
* <p>The creation time of the metric filter, expressed as the number of milliseconds after
|
|
710
|
-
*
|
|
789
|
+
* <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
711
790
|
*/
|
|
712
791
|
creationTime?: number;
|
|
713
792
|
/**
|
|
@@ -863,7 +942,7 @@ export interface ResourcePolicy {
|
|
|
863
942
|
policyDocument?: string;
|
|
864
943
|
/**
|
|
865
944
|
* <p>Timestamp showing when this policy was last updated, expressed as the number of
|
|
866
|
-
* milliseconds after Jan 1, 1970 00:00:00 UTC
|
|
945
|
+
* milliseconds after <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
867
946
|
*/
|
|
868
947
|
lastUpdatedTime?: number;
|
|
869
948
|
}
|
|
@@ -932,7 +1011,7 @@ export interface SubscriptionFilter {
|
|
|
932
1011
|
distribution?: Distribution | string;
|
|
933
1012
|
/**
|
|
934
1013
|
* <p>The creation time of the subscription filter, expressed as the number of milliseconds
|
|
935
|
-
* after Jan 1, 1970 00:00:00 UTC
|
|
1014
|
+
* after <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
936
1015
|
*/
|
|
937
1016
|
creationTime?: number;
|
|
938
1017
|
}
|
|
@@ -961,8 +1040,8 @@ export interface FilteredLogEvent {
|
|
|
961
1040
|
*/
|
|
962
1041
|
logStreamName?: string;
|
|
963
1042
|
/**
|
|
964
|
-
* <p>The time the event occurred, expressed as the number of milliseconds after Jan 1,
|
|
965
|
-
*
|
|
1043
|
+
* <p>The time the event occurred, expressed as the number of milliseconds after <code>Jan 1,
|
|
1044
|
+
* 1970 00:00:00 UTC</code>.</p>
|
|
966
1045
|
*/
|
|
967
1046
|
timestamp?: number;
|
|
968
1047
|
/**
|
|
@@ -970,8 +1049,8 @@ export interface FilteredLogEvent {
|
|
|
970
1049
|
*/
|
|
971
1050
|
message?: string;
|
|
972
1051
|
/**
|
|
973
|
-
* <p>The time the event was ingested, expressed as the number of milliseconds after
|
|
974
|
-
*
|
|
1052
|
+
* <p>The time the event was ingested, expressed as the number of milliseconds after
|
|
1053
|
+
* <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
975
1054
|
*/
|
|
976
1055
|
ingestionTime?: number;
|
|
977
1056
|
/**
|
|
@@ -982,8 +1061,23 @@ export interface FilteredLogEvent {
|
|
|
982
1061
|
export interface FilterLogEventsRequest {
|
|
983
1062
|
/**
|
|
984
1063
|
* <p>The name of the log group to search.</p>
|
|
1064
|
+
* <note>
|
|
1065
|
+
* <p>
|
|
1066
|
+
* If you specify values
|
|
1067
|
+
* for both <code>logGroupName</code> and <code>logGroupIdentifier</code>,
|
|
1068
|
+
* the action returns an <code>InvalidParameterException</code> error.
|
|
1069
|
+
* </p>
|
|
1070
|
+
* </note>
|
|
985
1071
|
*/
|
|
986
1072
|
logGroupName: string | undefined;
|
|
1073
|
+
/**
|
|
1074
|
+
* <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
|
|
1075
|
+
* and you are using a monitoring account, you must use the log group ARN.</p>
|
|
1076
|
+
* <p>If you specify values for both <code>logGroupName</code> and
|
|
1077
|
+
* <code>logGroupIdentifier</code>, the action returns an
|
|
1078
|
+
* <code>InvalidParameterException</code> error.</p>
|
|
1079
|
+
*/
|
|
1080
|
+
logGroupIdentifier?: string;
|
|
987
1081
|
/**
|
|
988
1082
|
* <p>Filters the results to only logs from the log streams in this list.</p>
|
|
989
1083
|
* <p>If you specify a value for both <code>logStreamNamePrefix</code> and <code>logStreamNames</code>, the action
|
|
@@ -998,13 +1092,15 @@ export interface FilterLogEventsRequest {
|
|
|
998
1092
|
*/
|
|
999
1093
|
logStreamNamePrefix?: string;
|
|
1000
1094
|
/**
|
|
1001
|
-
* <p>The start of the time range, expressed as the number of milliseconds after Jan 1,
|
|
1002
|
-
*
|
|
1095
|
+
* <p>The start of the time range, expressed as the number of milliseconds after <code>Jan 1,
|
|
1096
|
+
* 1970 00:00:00 UTC</code>. Events with a timestamp before this time are not
|
|
1097
|
+
* returned.</p>
|
|
1003
1098
|
*/
|
|
1004
1099
|
startTime?: number;
|
|
1005
1100
|
/**
|
|
1006
|
-
* <p>The end of the time range, expressed as the number of milliseconds after Jan 1,
|
|
1007
|
-
*
|
|
1101
|
+
* <p>The end of the time range, expressed as the number of milliseconds after <code>Jan 1,
|
|
1102
|
+
* 1970 00:00:00 UTC</code>. Events with a timestamp later than this time are not
|
|
1103
|
+
* returned.</p>
|
|
1008
1104
|
*/
|
|
1009
1105
|
endTime?: number;
|
|
1010
1106
|
/**
|
|
@@ -1023,16 +1119,23 @@ export interface FilterLogEventsRequest {
|
|
|
1023
1119
|
/**
|
|
1024
1120
|
* @deprecated
|
|
1025
1121
|
*
|
|
1026
|
-
* <p>If the value is true, the operation
|
|
1027
|
-
*
|
|
1028
|
-
*
|
|
1029
|
-
*
|
|
1122
|
+
* <p>If the value is true, the operation attempts to provide responses that contain events
|
|
1123
|
+
* from multiple log streams within the log group, interleaved in a single response. If the value
|
|
1124
|
+
* is false, all the matched log events in the first log stream are searched first, then those in
|
|
1125
|
+
* the next log stream, and so on.</p>
|
|
1030
1126
|
* <p>
|
|
1031
|
-
* <b>Important
|
|
1032
|
-
*
|
|
1127
|
+
* <b>Important</b> As of June 17, 2019, this parameter is
|
|
1128
|
+
* ignored and the value is assumed to be true. The response from this operation always
|
|
1033
1129
|
* interleaves events from multiple log streams within a log group.</p>
|
|
1034
1130
|
*/
|
|
1035
1131
|
interleaved?: boolean;
|
|
1132
|
+
/**
|
|
1133
|
+
* <p>Specify <code>true</code> to display the log event fields with all sensitive data unmasked and visible.
|
|
1134
|
+
* The default is <code>false</code>.</p>
|
|
1135
|
+
* <p>To use this operation with this parameter, you must be signed into an account with the <code>logs:Unmask</code>
|
|
1136
|
+
* permission.</p>
|
|
1137
|
+
*/
|
|
1138
|
+
unmask?: boolean;
|
|
1036
1139
|
}
|
|
1037
1140
|
/**
|
|
1038
1141
|
* <p>Represents the search status of a log stream.</p>
|
|
@@ -1054,9 +1157,8 @@ export interface FilterLogEventsResponse {
|
|
|
1054
1157
|
events?: FilteredLogEvent[];
|
|
1055
1158
|
/**
|
|
1056
1159
|
* <p>
|
|
1057
|
-
* <b>
|
|
1058
|
-
*
|
|
1059
|
-
* after the deprecation occurs.</p>
|
|
1160
|
+
* <b>Important</b> As of May 15, 2020, this parameter is no longer
|
|
1161
|
+
* supported. This parameter returns an empty list.</p>
|
|
1060
1162
|
* <p>Indicates which log streams have been searched and whether each has been searched completely.</p>
|
|
1061
1163
|
*/
|
|
1062
1164
|
searchedLogStreams?: SearchedLogStream[];
|
|
@@ -1065,24 +1167,57 @@ export interface FilterLogEventsResponse {
|
|
|
1065
1167
|
*/
|
|
1066
1168
|
nextToken?: string;
|
|
1067
1169
|
}
|
|
1170
|
+
export interface GetDataProtectionPolicyRequest {
|
|
1171
|
+
/**
|
|
1172
|
+
* <p>The name or ARN of the log group that contains the data protection policy that you want to see.</p>
|
|
1173
|
+
*/
|
|
1174
|
+
logGroupIdentifier: string | undefined;
|
|
1175
|
+
}
|
|
1176
|
+
export interface GetDataProtectionPolicyResponse {
|
|
1177
|
+
/**
|
|
1178
|
+
* <p>The log group name or ARN that you specified in your request.</p>
|
|
1179
|
+
*/
|
|
1180
|
+
logGroupIdentifier?: string;
|
|
1181
|
+
/**
|
|
1182
|
+
* <p>The data protection policy document for this log group.</p>
|
|
1183
|
+
*/
|
|
1184
|
+
policyDocument?: string;
|
|
1185
|
+
/**
|
|
1186
|
+
* <p>The date and time that this policy was most recently updated.</p>
|
|
1187
|
+
*/
|
|
1188
|
+
lastUpdatedTime?: number;
|
|
1189
|
+
}
|
|
1068
1190
|
export interface GetLogEventsRequest {
|
|
1069
1191
|
/**
|
|
1070
1192
|
* <p>The name of the log group.</p>
|
|
1193
|
+
* <note>
|
|
1194
|
+
* <p>
|
|
1195
|
+
* If you specify values for both <code>logGroupName</code> and <code>logGroupIdentifier</code>,
|
|
1196
|
+
* the action returns an <code>InvalidParameterException</code> error.
|
|
1197
|
+
* </p>
|
|
1198
|
+
* </note>
|
|
1071
1199
|
*/
|
|
1072
1200
|
logGroupName: string | undefined;
|
|
1201
|
+
/**
|
|
1202
|
+
* <p>Specify either the name or ARN of the log group to view events from. If the log group is in a source account
|
|
1203
|
+
* and you are using a monitoring account, you must use the log group ARN.</p>
|
|
1204
|
+
* <p> If you specify values for both <code>logGroupName</code> and <code>logGroupIdentifier</code>,
|
|
1205
|
+
* the action returns an <code>InvalidParameterException</code> error.</p>
|
|
1206
|
+
*/
|
|
1207
|
+
logGroupIdentifier?: string;
|
|
1073
1208
|
/**
|
|
1074
1209
|
* <p>The name of the log stream.</p>
|
|
1075
1210
|
*/
|
|
1076
1211
|
logStreamName: string | undefined;
|
|
1077
1212
|
/**
|
|
1078
|
-
* <p>The start of the time range, expressed as the number of milliseconds after Jan 1,
|
|
1079
|
-
*
|
|
1080
|
-
* Events with a timestamp earlier than this time are not included.</p>
|
|
1213
|
+
* <p>The start of the time range, expressed as the number of milliseconds after <code>Jan 1,
|
|
1214
|
+
* 1970 00:00:00 UTC</code>. Events with a timestamp equal to this time or later than this time
|
|
1215
|
+
* are included. Events with a timestamp earlier than this time are not included.</p>
|
|
1081
1216
|
*/
|
|
1082
1217
|
startTime?: number;
|
|
1083
1218
|
/**
|
|
1084
|
-
* <p>The end of the time range, expressed as the number of milliseconds after Jan 1,
|
|
1085
|
-
*
|
|
1219
|
+
* <p>The end of the time range, expressed as the number of milliseconds after <code>Jan 1,
|
|
1220
|
+
* 1970 00:00:00 UTC</code>. Events with a timestamp equal to or later than this time are not
|
|
1086
1221
|
* included.</p>
|
|
1087
1222
|
*/
|
|
1088
1223
|
endTime?: number;
|
|
@@ -1091,8 +1226,8 @@ export interface GetLogEventsRequest {
|
|
|
1091
1226
|
*/
|
|
1092
1227
|
nextToken?: string;
|
|
1093
1228
|
/**
|
|
1094
|
-
* <p>The maximum number of log events returned. If you don't specify a
|
|
1095
|
-
* as many log events as can fit in a response size of 1 MB
|
|
1229
|
+
* <p>The maximum number of log events returned. If you don't specify a limit, the default is
|
|
1230
|
+
* as many log events as can fit in a response size of 1 MB (up to 10,000 log events).</p>
|
|
1096
1231
|
*/
|
|
1097
1232
|
limit?: number;
|
|
1098
1233
|
/**
|
|
@@ -1103,14 +1238,21 @@ export interface GetLogEventsRequest {
|
|
|
1103
1238
|
* you must specify <code>true</code> for <code>startFromHead</code>.</p>
|
|
1104
1239
|
*/
|
|
1105
1240
|
startFromHead?: boolean;
|
|
1241
|
+
/**
|
|
1242
|
+
* <p>Specify <code>true</code> to display the log event fields with all sensitive data unmasked and visible.
|
|
1243
|
+
* The default is <code>false</code>.</p>
|
|
1244
|
+
* <p>To use this operation with this parameter, you must be signed into an account with the <code>logs:Unmask</code>
|
|
1245
|
+
* permission.</p>
|
|
1246
|
+
*/
|
|
1247
|
+
unmask?: boolean;
|
|
1106
1248
|
}
|
|
1107
1249
|
/**
|
|
1108
1250
|
* <p>Represents a log event.</p>
|
|
1109
1251
|
*/
|
|
1110
1252
|
export interface OutputLogEvent {
|
|
1111
1253
|
/**
|
|
1112
|
-
* <p>The time the event occurred, expressed as the number of milliseconds after Jan 1,
|
|
1113
|
-
*
|
|
1254
|
+
* <p>The time the event occurred, expressed as the number of milliseconds after <code>Jan 1,
|
|
1255
|
+
* 1970 00:00:00 UTC</code>.</p>
|
|
1114
1256
|
*/
|
|
1115
1257
|
timestamp?: number;
|
|
1116
1258
|
/**
|
|
@@ -1118,8 +1260,8 @@ export interface OutputLogEvent {
|
|
|
1118
1260
|
*/
|
|
1119
1261
|
message?: string;
|
|
1120
1262
|
/**
|
|
1121
|
-
* <p>The time the event was ingested, expressed as the number of milliseconds after
|
|
1122
|
-
*
|
|
1263
|
+
* <p>The time the event was ingested, expressed as the number of milliseconds after
|
|
1264
|
+
* <code>Jan 1, 1970 00:00:00 UTC</code>.</p>
|
|
1123
1265
|
*/
|
|
1124
1266
|
ingestionTime?: number;
|
|
1125
1267
|
}
|
|
@@ -1136,7 +1278,7 @@ export interface GetLogEventsResponse {
|
|
|
1136
1278
|
nextForwardToken?: string;
|
|
1137
1279
|
/**
|
|
1138
1280
|
* <p>The token for the next set of items in the backward direction. The token expires after
|
|
1139
|
-
* 24 hours. This token is
|
|
1281
|
+
* 24 hours. This token is not null. If you have reached the end of the stream, it returns the
|
|
1140
1282
|
* same token you passed in.</p>
|
|
1141
1283
|
*/
|
|
1142
1284
|
nextBackwardToken?: string;
|
|
@@ -1144,16 +1286,27 @@ export interface GetLogEventsResponse {
|
|
|
1144
1286
|
export interface GetLogGroupFieldsRequest {
|
|
1145
1287
|
/**
|
|
1146
1288
|
* <p>The name of the log group to search.</p>
|
|
1289
|
+
* <p>If you specify values for both <code>logGroupName</code> and
|
|
1290
|
+
* <code>logGroupIdentifier</code>, the action returns an
|
|
1291
|
+
* <code>InvalidParameterException</code> error.</p>
|
|
1147
1292
|
*/
|
|
1148
1293
|
logGroupName: string | undefined;
|
|
1149
1294
|
/**
|
|
1150
|
-
* <p>The time to set as the center of the query. If you specify <code>time</code>, the 15
|
|
1151
|
-
*
|
|
1152
|
-
*
|
|
1153
|
-
* <p>The <code>time</code> value is specified as epoch time, the number of seconds
|
|
1154
|
-
* January 1, 1970, 00:00:00 UTC
|
|
1295
|
+
* <p>The time to set as the center of the query. If you specify <code>time</code>, the 15
|
|
1296
|
+
* minutes before this time are queries. If you omit <code>time</code>, the 8 minutes before and
|
|
1297
|
+
* 8 minutes after this time are searched.</p>
|
|
1298
|
+
* <p>The <code>time</code> value is specified as epoch time, which is the number of seconds
|
|
1299
|
+
* since <code>January 1, 1970, 00:00:00 UTC</code>.</p>
|
|
1155
1300
|
*/
|
|
1156
1301
|
time?: number;
|
|
1302
|
+
/**
|
|
1303
|
+
* <p>Specify either the name or ARN of the log group to view. If the log group is in a source account and
|
|
1304
|
+
* you are using a monitoring account, you must specify the ARN.</p>
|
|
1305
|
+
* <p>If you specify values for both <code>logGroupName</code> and
|
|
1306
|
+
* <code>logGroupIdentifier</code>, the action returns an
|
|
1307
|
+
* <code>InvalidParameterException</code> error.</p>
|
|
1308
|
+
*/
|
|
1309
|
+
logGroupIdentifier?: string;
|
|
1157
1310
|
}
|
|
1158
1311
|
/**
|
|
1159
1312
|
* <p>The fields contained in log events found by a <code>GetLogGroupFields</code> operation,
|
|
@@ -1171,8 +1324,9 @@ export interface LogGroupField {
|
|
|
1171
1324
|
}
|
|
1172
1325
|
export interface GetLogGroupFieldsResponse {
|
|
1173
1326
|
/**
|
|
1174
|
-
* <p>The array of fields found in the query. Each object in the array contains the name of the
|
|
1175
|
-
*
|
|
1327
|
+
* <p>The array of fields found in the query. Each object in the array contains the name of the
|
|
1328
|
+
* field, along with the percentage of time it appeared in the log events that were
|
|
1329
|
+
* queried.</p>
|
|
1176
1330
|
*/
|
|
1177
1331
|
logGroupFields?: LogGroupField[];
|
|
1178
1332
|
}
|
|
@@ -1184,6 +1338,13 @@ export interface GetLogRecordRequest {
|
|
|
1184
1338
|
* to retrieve that complete log event record.</p>
|
|
1185
1339
|
*/
|
|
1186
1340
|
logRecordPointer: string | undefined;
|
|
1341
|
+
/**
|
|
1342
|
+
* <p>Specify <code>true</code> to display the log event fields with all sensitive data unmasked and visible.
|
|
1343
|
+
* The default is <code>false</code>.</p>
|
|
1344
|
+
* <p>To use this operation with this parameter, you must be signed into an account with the <code>logs:Unmask</code>
|
|
1345
|
+
* permission.</p>
|
|
1346
|
+
*/
|
|
1347
|
+
unmask?: boolean;
|
|
1187
1348
|
}
|
|
1188
1349
|
export interface GetLogRecordResponse {
|
|
1189
1350
|
/**
|
|
@@ -1249,7 +1410,7 @@ export interface GetQueryResultsResponse {
|
|
|
1249
1410
|
* <p>The status of the most recent running of the query. Possible values are <code>Cancelled</code>,
|
|
1250
1411
|
* <code>Complete</code>, <code>Failed</code>, <code>Running</code>, <code>Scheduled</code>,
|
|
1251
1412
|
* <code>Timeout</code>, and <code>Unknown</code>.</p>
|
|
1252
|
-
* <p>Queries time out after 15 minutes of
|
|
1413
|
+
* <p>Queries time out after 15 minutes of runtime. To avoid having your queries time out,
|
|
1253
1414
|
* reduce the time range being searched or partition your query into a number of queries.</p>
|
|
1254
1415
|
*/
|
|
1255
1416
|
status?: QueryStatus | string;
|
|
@@ -1260,8 +1421,8 @@ export interface GetQueryResultsResponse {
|
|
|
1260
1421
|
*/
|
|
1261
1422
|
export interface InputLogEvent {
|
|
1262
1423
|
/**
|
|
1263
|
-
* <p>The time the event occurred, expressed as the number of milliseconds after Jan 1,
|
|
1264
|
-
*
|
|
1424
|
+
* <p>The time the event occurred, expressed as the number of milliseconds after <code>Jan 1,
|
|
1425
|
+
* 1970 00:00:00 UTC</code>.</p>
|
|
1265
1426
|
*/
|
|
1266
1427
|
timestamp: number | undefined;
|
|
1267
1428
|
/**
|
|
@@ -1317,6 +1478,59 @@ export interface ListTagsLogGroupResponse {
|
|
|
1317
1478
|
*/
|
|
1318
1479
|
tags?: Record<string, string>;
|
|
1319
1480
|
}
|
|
1481
|
+
export interface PutDataProtectionPolicyRequest {
|
|
1482
|
+
/**
|
|
1483
|
+
* <p>Specify either the log group name or log group ARN.</p>
|
|
1484
|
+
*/
|
|
1485
|
+
logGroupIdentifier: string | undefined;
|
|
1486
|
+
/**
|
|
1487
|
+
* <p>Specify the data protection policy, in JSON.</p>
|
|
1488
|
+
* <p>This policy must include two JSON blocks:</p>
|
|
1489
|
+
* <ul>
|
|
1490
|
+
* <li>
|
|
1491
|
+
* <p>The first block must include both a <code>DataIdentifer</code> array and an
|
|
1492
|
+
* <code>Operation</code> property with an <code>Audit</code> action. The <code>DataIdentifer</code> array lists the types of sensitive data that
|
|
1493
|
+
* you want to mask. For more information about the available options, see
|
|
1494
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-types.html">Types of data that you can mask</a>.</p>
|
|
1495
|
+
* <p>The <code>Operation</code> property with an <code>Audit</code> action is required to find the
|
|
1496
|
+
* sensitive data terms. This <code>Audit</code> action must contain a <code>FindingsDestination</code>
|
|
1497
|
+
* object. You can optionally use that <code>FindingsDestination</code> object to list one or more
|
|
1498
|
+
* destinations to send audit findings to. If you specify destinations such as log groups,
|
|
1499
|
+
* Kinesis Data Firehose streams, and S3 buckets, they must already exist.</p>
|
|
1500
|
+
* </li>
|
|
1501
|
+
* <li>
|
|
1502
|
+
* <p>The second block must include both a <code>DataIdentifer</code> array and an
|
|
1503
|
+
* <code>Operation</code> property with an <code>Deidentify</code> action. The
|
|
1504
|
+
* <code>DataIdentifer</code> array must exactly match the <code>DataIdentifer</code> array
|
|
1505
|
+
* in the first block of the policy.</p>
|
|
1506
|
+
* <p>The <code>Operation</code> property with the <code>Deidentify</code> action is what actually masks the
|
|
1507
|
+
* data, and it must
|
|
1508
|
+
* contain the <code>
|
|
1509
|
+
* "MaskConfig": {}</code> object. The <code>
|
|
1510
|
+
* "MaskConfig": {}</code> object must be empty.</p>
|
|
1511
|
+
* </li>
|
|
1512
|
+
* </ul>
|
|
1513
|
+
* <p>For an example data protection policy, see the <b>Examples</b> section on this page.</p>
|
|
1514
|
+
* <important>
|
|
1515
|
+
* <p>The contents of two <code>DataIdentifer</code> arrays must match exactly.</p>
|
|
1516
|
+
* </important>
|
|
1517
|
+
*/
|
|
1518
|
+
policyDocument: string | undefined;
|
|
1519
|
+
}
|
|
1520
|
+
export interface PutDataProtectionPolicyResponse {
|
|
1521
|
+
/**
|
|
1522
|
+
* <p>The log group name or ARN that you specified in your request.</p>
|
|
1523
|
+
*/
|
|
1524
|
+
logGroupIdentifier?: string;
|
|
1525
|
+
/**
|
|
1526
|
+
* <p>The data protection policy used for this log group.</p>
|
|
1527
|
+
*/
|
|
1528
|
+
policyDocument?: string;
|
|
1529
|
+
/**
|
|
1530
|
+
* <p>The date and time that this policy was most recently updated.</p>
|
|
1531
|
+
*/
|
|
1532
|
+
lastUpdatedTime?: number;
|
|
1533
|
+
}
|
|
1320
1534
|
export interface PutDestinationRequest {
|
|
1321
1535
|
/**
|
|
1322
1536
|
* <p>A name for the destination.</p>
|
|
@@ -1401,7 +1615,7 @@ export interface RejectedLogEventsInfo {
|
|
|
1401
1615
|
*/
|
|
1402
1616
|
tooNewLogEventStartIndex?: number;
|
|
1403
1617
|
/**
|
|
1404
|
-
* <p>The log events that are too
|
|
1618
|
+
* <p>The log events that are dated too far in the past.</p>
|
|
1405
1619
|
*/
|
|
1406
1620
|
tooOldLogEventEndIndex?: number;
|
|
1407
1621
|
/**
|
|
@@ -1420,7 +1634,8 @@ export interface PutLogEventsResponse {
|
|
|
1420
1634
|
rejectedLogEventsInfo?: RejectedLogEventsInfo;
|
|
1421
1635
|
}
|
|
1422
1636
|
/**
|
|
1423
|
-
* <p>The most likely cause is an
|
|
1637
|
+
* <p>The most likely cause is an Amazon Web Services access key ID or secret key that's not
|
|
1638
|
+
* valid.</p>
|
|
1424
1639
|
*/
|
|
1425
1640
|
export declare class UnrecognizedClientException extends __BaseException {
|
|
1426
1641
|
readonly name: "UnrecognizedClientException";
|
|
@@ -1450,9 +1665,9 @@ export interface PutMetricFilterRequest {
|
|
|
1450
1665
|
}
|
|
1451
1666
|
export interface PutQueryDefinitionRequest {
|
|
1452
1667
|
/**
|
|
1453
|
-
* <p>A name for the query definition. If you are saving
|
|
1454
|
-
* recommend that you name them
|
|
1455
|
-
*
|
|
1668
|
+
* <p>A name for the query definition. If you are saving numerous query definitions, we
|
|
1669
|
+
* recommend that you name them. This way, you can find the ones you want by using the first part
|
|
1670
|
+
* 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>
|
|
1456
1671
|
*/
|
|
1457
1672
|
name: string | undefined;
|
|
1458
1673
|
/**
|
|
@@ -1496,9 +1711,10 @@ export interface PutResourcePolicyRequest {
|
|
|
1496
1711
|
* <p>CloudWatch Logs also supports <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourcearn">aws:SourceArn</a>
|
|
1497
1712
|
* and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-sourceaccount">aws:SourceAccount</a>
|
|
1498
1713
|
* condition context keys.</p>
|
|
1499
|
-
* <p>In the example resource policy, you would replace the value of <code>SourceArn</code> with
|
|
1500
|
-
* call from Route 53 to CloudWatch Logs
|
|
1501
|
-
* the Amazon Web Services account ID making
|
|
1714
|
+
* <p>In the example resource policy, you would replace the value of <code>SourceArn</code> with
|
|
1715
|
+
* the resource making the call from Route 53 to CloudWatch Logs. You would also
|
|
1716
|
+
* replace the value of <code>SourceAccount</code> with the Amazon Web Services account ID making
|
|
1717
|
+
* that call.</p>
|
|
1502
1718
|
* <p></p>
|
|
1503
1719
|
* <p>
|
|
1504
1720
|
* <code>{
|
|
@@ -1544,9 +1760,7 @@ export interface PutRetentionPolicyRequest {
|
|
|
1544
1760
|
/**
|
|
1545
1761
|
* <p>The number of days to retain the log events in the specified log group.
|
|
1546
1762
|
* Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, and 3653.</p>
|
|
1547
|
-
* <p>To set a log group
|
|
1548
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html">DeleteRetentionPolicy</a>.
|
|
1549
|
-
* </p>
|
|
1763
|
+
* <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>
|
|
1550
1764
|
*/
|
|
1551
1765
|
retentionInDays: number | undefined;
|
|
1552
1766
|
}
|
|
@@ -1576,12 +1790,12 @@ export interface PutSubscriptionFilterRequest {
|
|
|
1576
1790
|
* <li>
|
|
1577
1791
|
* <p>A logical destination (specified using an ARN) belonging to a different account,
|
|
1578
1792
|
* for cross-account delivery.</p>
|
|
1579
|
-
* <p>If you
|
|
1580
|
-
*
|
|
1581
|
-
*
|
|
1793
|
+
* <p>If you're setting up a cross-account subscription, the destination must have an IAM
|
|
1794
|
+
* policy associated with it. The IAM policy must allow the sender to send logs to the
|
|
1795
|
+
* destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html">PutDestinationPolicy</a>.</p>
|
|
1582
1796
|
* </li>
|
|
1583
1797
|
* <li>
|
|
1584
|
-
* <p>
|
|
1798
|
+
* <p>A Kinesis Data Firehose delivery stream belonging to the same account as the
|
|
1585
1799
|
* subscription filter, for same-account delivery.</p>
|
|
1586
1800
|
* </li>
|
|
1587
1801
|
* <li>
|
|
@@ -1600,7 +1814,7 @@ export interface PutSubscriptionFilterRequest {
|
|
|
1600
1814
|
/**
|
|
1601
1815
|
* <p>The method used to distribute log data to the destination. By default, log data is
|
|
1602
1816
|
* grouped by log stream, but the grouping can be set to random for a more even distribution.
|
|
1603
|
-
* This property is only applicable when the destination is an Amazon Kinesis stream. </p>
|
|
1817
|
+
* This property is only applicable when the destination is an Amazon Kinesis data stream. </p>
|
|
1604
1818
|
*/
|
|
1605
1819
|
distribution?: Distribution | string;
|
|
1606
1820
|
}
|
|
@@ -1652,26 +1866,46 @@ export declare class MalformedQueryException extends __BaseException {
|
|
|
1652
1866
|
export interface StartQueryRequest {
|
|
1653
1867
|
/**
|
|
1654
1868
|
* <p>The log group on which to perform the query.</p>
|
|
1655
|
-
* <
|
|
1656
|
-
*
|
|
1869
|
+
* <note>
|
|
1870
|
+
* <p>A <code>StartQuery</code> operation must include exactly one
|
|
1871
|
+
* of the following parameters:
|
|
1872
|
+
* <code>logGroupName</code>, <code>logGroupNames</code> or <code>logGroupIdentifiers</code>.
|
|
1873
|
+
* </p>
|
|
1874
|
+
* </note>
|
|
1657
1875
|
*/
|
|
1658
1876
|
logGroupName?: string;
|
|
1659
1877
|
/**
|
|
1660
|
-
* <p>The list of log groups to be queried. You can include up to
|
|
1661
|
-
* <
|
|
1662
|
-
*
|
|
1878
|
+
* <p>The list of log groups to be queried. You can include up to 50 log groups.</p>
|
|
1879
|
+
* <note>
|
|
1880
|
+
* <p>A <code>StartQuery</code> operation must include exactly one
|
|
1881
|
+
* of the following parameters:
|
|
1882
|
+
* <code>logGroupName</code>, <code>logGroupNames</code> or <code>logGroupIdentifiers</code>.
|
|
1883
|
+
* </p>
|
|
1884
|
+
* </note>
|
|
1663
1885
|
*/
|
|
1664
1886
|
logGroupNames?: string[];
|
|
1665
1887
|
/**
|
|
1666
|
-
* <p>The
|
|
1667
|
-
*
|
|
1668
|
-
*
|
|
1888
|
+
* <p>The list of log groups to query. You can include up to 50 log groups.</p>
|
|
1889
|
+
* <p>You can specify them by the log group name or ARN. If a log group that you're querying is
|
|
1890
|
+
* in a source account and you're using a monitoring account, you must specify the ARN of the log
|
|
1891
|
+
* group here. The query definition must also be defined in the monitoring account.</p>
|
|
1892
|
+
* <p>If you specify an ARN, the ARN can't end with an asterisk (*).</p>
|
|
1893
|
+
* <p>A <code>StartQuery</code> operation must include exactly one
|
|
1894
|
+
* of the following parameters:
|
|
1895
|
+
* <code>logGroupName</code>, <code>logGroupNames</code> or <code>logGroupIdentifiers</code>.
|
|
1896
|
+
* </p>
|
|
1897
|
+
*/
|
|
1898
|
+
logGroupIdentifiers?: string[];
|
|
1899
|
+
/**
|
|
1900
|
+
* <p>The beginning of the time range to query. The range is inclusive, so the specified start
|
|
1901
|
+
* time is included in the query. Specified as epoch time, the number of seconds since
|
|
1902
|
+
* <code>January 1, 1970, 00:00:00 UTC</code>.</p>
|
|
1669
1903
|
*/
|
|
1670
1904
|
startTime: number | undefined;
|
|
1671
1905
|
/**
|
|
1672
|
-
* <p>The end of the time range to query. The range is inclusive, so the specified
|
|
1673
|
-
*
|
|
1674
|
-
*
|
|
1906
|
+
* <p>The end of the time range to query. The range is inclusive, so the specified end time is
|
|
1907
|
+
* included in the query. Specified as epoch time, the number of seconds since <code>January 1,
|
|
1908
|
+
* 1970, 00:00:00 UTC</code>.</p>
|
|
1675
1909
|
*/
|
|
1676
1910
|
endTime: number | undefined;
|
|
1677
1911
|
/**
|
|
@@ -1838,6 +2072,10 @@ export declare const CreateLogGroupRequestFilterSensitiveLog: (obj: CreateLogGro
|
|
|
1838
2072
|
* @internal
|
|
1839
2073
|
*/
|
|
1840
2074
|
export declare const CreateLogStreamRequestFilterSensitiveLog: (obj: CreateLogStreamRequest) => any;
|
|
2075
|
+
/**
|
|
2076
|
+
* @internal
|
|
2077
|
+
*/
|
|
2078
|
+
export declare const DeleteDataProtectionPolicyRequestFilterSensitiveLog: (obj: DeleteDataProtectionPolicyRequest) => any;
|
|
1841
2079
|
/**
|
|
1842
2080
|
* @internal
|
|
1843
2081
|
*/
|
|
@@ -2014,6 +2252,14 @@ export declare const SearchedLogStreamFilterSensitiveLog: (obj: SearchedLogStrea
|
|
|
2014
2252
|
* @internal
|
|
2015
2253
|
*/
|
|
2016
2254
|
export declare const FilterLogEventsResponseFilterSensitiveLog: (obj: FilterLogEventsResponse) => any;
|
|
2255
|
+
/**
|
|
2256
|
+
* @internal
|
|
2257
|
+
*/
|
|
2258
|
+
export declare const GetDataProtectionPolicyRequestFilterSensitiveLog: (obj: GetDataProtectionPolicyRequest) => any;
|
|
2259
|
+
/**
|
|
2260
|
+
* @internal
|
|
2261
|
+
*/
|
|
2262
|
+
export declare const GetDataProtectionPolicyResponseFilterSensitiveLog: (obj: GetDataProtectionPolicyResponse) => any;
|
|
2017
2263
|
/**
|
|
2018
2264
|
* @internal
|
|
2019
2265
|
*/
|
|
@@ -2082,6 +2328,14 @@ export declare const ListTagsLogGroupRequestFilterSensitiveLog: (obj: ListTagsLo
|
|
|
2082
2328
|
* @internal
|
|
2083
2329
|
*/
|
|
2084
2330
|
export declare const ListTagsLogGroupResponseFilterSensitiveLog: (obj: ListTagsLogGroupResponse) => any;
|
|
2331
|
+
/**
|
|
2332
|
+
* @internal
|
|
2333
|
+
*/
|
|
2334
|
+
export declare const PutDataProtectionPolicyRequestFilterSensitiveLog: (obj: PutDataProtectionPolicyRequest) => any;
|
|
2335
|
+
/**
|
|
2336
|
+
* @internal
|
|
2337
|
+
*/
|
|
2338
|
+
export declare const PutDataProtectionPolicyResponseFilterSensitiveLog: (obj: PutDataProtectionPolicyResponse) => any;
|
|
2085
2339
|
/**
|
|
2086
2340
|
* @internal
|
|
2087
2341
|
*/
|