@aws-sdk/client-cloudwatch-logs 3.241.0 → 3.244.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.
@@ -129,7 +129,6 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
129
129
  * <p>You can export logs from multiple log groups or multiple time ranges to the same S3
130
130
  * bucket. To separate log data for each export task, specify a prefix to be used as the Amazon
131
131
  * S3 key prefix for all exported objects.</p>
132
- *
133
132
  * <note>
134
133
  * <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can
135
134
  * sort the exported log field data by using Linux utilities.</p>
@@ -353,7 +352,6 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
353
352
  * <p>Lists log events from the specified log group. You can list all the log events or filter the results
354
353
  * using a filter pattern, a time range, and the name of the log stream.</p>
355
354
  * <p>You must have the <code>logs;FilterLogEvents</code> permission to perform this operation.</p>
356
- *
357
355
  * <p>By default, this operation returns as many log events as can fit in 1 MB (up to 10,000
358
356
  * log events) or all the events found within the specified time range. If the results include a
359
357
  * token, that means there are more log events available. You can get additional results by
@@ -377,11 +375,9 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
377
375
  /**
378
376
  * <p>Lists log events from the specified log stream. You can list all of the log events or
379
377
  * filter using a time range.</p>
380
- *
381
378
  * <p>By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events).
382
379
  * You can get additional log events by specifying one of the tokens in a subsequent call.
383
380
  * This operation can return empty results while there are more log events available through the token.</p>
384
- *
385
381
  * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
386
382
  * view data from the linked source accounts. For more information, see
387
383
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
@@ -491,21 +487,19 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
491
487
  * <p>Creates or updates an access policy associated with an existing
492
488
  * destination. An access policy is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html">IAM policy document</a> that is used
493
489
  * to authorize claims to register a subscription filter against a given destination.</p>
494
- * <p>If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be
495
- * listed separately in the policy. The policy does not support specifying <code>*</code>
496
- * as the Principal or the use of the <code>aws:PrincipalOrgId</code> global key.</p>
497
490
  */
498
491
  putDestinationPolicy(args: PutDestinationPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutDestinationPolicyCommandOutput>;
499
492
  putDestinationPolicy(args: PutDestinationPolicyCommandInput, cb: (err: any, data?: PutDestinationPolicyCommandOutput) => void): void;
500
493
  putDestinationPolicy(args: PutDestinationPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDestinationPolicyCommandOutput) => void): void;
501
494
  /**
502
495
  * <p>Uploads a batch of log events to the specified log stream.</p>
503
- * <p>You must include the sequence token obtained from the response of the previous call. An
504
- * upload in a newly created log stream does not require a sequence token. You can also get the
505
- * sequence token in the <code>expectedSequenceToken</code> field from
506
- * <code>InvalidSequenceTokenException</code>. If you call <code>PutLogEvents</code> twice
507
- * within a narrow time period using the same value for <code>sequenceToken</code>, both calls
508
- * might be successful or one might be rejected.</p>
496
+ * <important>
497
+ * <p>The sequence token is now ignored in <code>PutLogEvents</code>
498
+ * actions. <code>PutLogEvents</code>
499
+ * actions are always accepted and never return <code>InvalidSequenceTokenException</code> or
500
+ * <code>DataAlreadyAcceptedException</code> even if the sequence token is not valid. You can use
501
+ * parallel <code>PutLogEvents</code> actions on the same log stream. </p>
502
+ * </important>
509
503
  * <p>The batch of events must satisfy the following constraints:</p>
510
504
  * <ul>
511
505
  * <li>
@@ -534,8 +528,12 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
534
528
  * <p>The maximum number of log events in a batch is 10,000.</p>
535
529
  * </li>
536
530
  * <li>
537
- * <p>There is a quota of five requests per second per log stream. Additional requests
538
- * are throttled. This quota can't be changed.</p>
531
+ * <important>
532
+ * <p>The quota of five requests per second per log stream
533
+ * has been removed. Instead, <code>PutLogEvents</code> actions are throttled based on a
534
+ * per-second per-account quota. You can request an increase to the per-second throttling
535
+ * quota by using the Service Quotas service.</p>
536
+ * </important>
539
537
  * </li>
540
538
  * </ul>
541
539
  * <p>If a call to <code>PutLogEvents</code> returns "UnrecognizedClientException" the most
@@ -575,7 +573,6 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
575
573
  /**
576
574
  * <p>Creates or updates a query definition for CloudWatch Logs Insights. For
577
575
  * more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html">Analyzing Log Data with CloudWatch Logs Insights</a>.</p>
578
- *
579
576
  * <p>To update a query definition, specify its <code>queryDefinitionId</code> in your request.
580
577
  * The values of <code>name</code>, <code>queryString</code>, and <code>logGroupNames</code> are
581
578
  * changed to the values that you specify in your update operation. No current values are
@@ -654,16 +651,13 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
654
651
  * <p>Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group
655
652
  * and time range to query and the query string to use.</p>
656
653
  * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query Syntax</a>.</p>
657
- *
658
654
  * <p>Queries time out after 15 minutes of runtime. If your queries are timing out, reduce the
659
655
  * time range being searched or partition your query into a number of queries.</p>
660
- *
661
656
  * <p>If you are using CloudWatch cross-account observability, you can use this operation in a
662
657
  * monitoring account to start a query in a linked source account. For more information, see
663
658
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch
664
659
  * cross-account observability</a>. For a cross-account <code>StartQuery</code> operation,
665
660
  * the query definition must be defined in the monitoring account.</p>
666
- *
667
661
  * <p>You can have up to 20 concurrent CloudWatch Logs insights queries, including queries
668
662
  * that have been added to dashboards. </p>
669
663
  */
@@ -24,7 +24,6 @@ export interface CreateExportTaskCommandOutput extends CreateExportTaskResponse,
24
24
  * <p>You can export logs from multiple log groups or multiple time ranges to the same S3
25
25
  * bucket. To separate log data for each export task, specify a prefix to be used as the Amazon
26
26
  * S3 key prefix for all exported objects.</p>
27
- *
28
27
  * <note>
29
28
  * <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can
30
29
  * sort the exported log field data by using Linux utilities.</p>
@@ -11,7 +11,6 @@ export interface FilterLogEventsCommandOutput extends FilterLogEventsResponse, _
11
11
  * <p>Lists log events from the specified log group. You can list all the log events or filter the results
12
12
  * using a filter pattern, a time range, and the name of the log stream.</p>
13
13
  * <p>You must have the <code>logs;FilterLogEvents</code> permission to perform this operation.</p>
14
- *
15
14
  * <p>By default, this operation returns as many log events as can fit in 1 MB (up to 10,000
16
15
  * log events) or all the events found within the specified time range. If the results include a
17
16
  * token, that means there are more log events available. You can get additional results by
@@ -10,11 +10,9 @@ export interface GetLogEventsCommandOutput extends GetLogEventsResponse, __Metad
10
10
  /**
11
11
  * <p>Lists log events from the specified log stream. You can list all of the log events or
12
12
  * filter using a time range.</p>
13
- *
14
13
  * <p>By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events).
15
14
  * You can get additional log events by specifying one of the tokens in a subsequent call.
16
15
  * This operation can return empty results while there are more log events available through the token.</p>
17
- *
18
16
  * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
19
17
  * view data from the linked source accounts. For more information, see
20
18
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
@@ -11,9 +11,6 @@ export interface PutDestinationPolicyCommandOutput extends __MetadataBearer {
11
11
  * <p>Creates or updates an access policy associated with an existing
12
12
  * destination. An access policy is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html">IAM policy document</a> that is used
13
13
  * to authorize claims to register a subscription filter against a given destination.</p>
14
- * <p>If multiple Amazon Web Services accounts are sending logs to this destination, each sender account must be
15
- * listed separately in the policy. The policy does not support specifying <code>*</code>
16
- * as the Principal or the use of the <code>aws:PrincipalOrgId</code> global key.</p>
17
14
  * @example
18
15
  * Use a bare-bones client and the command you need to make an API call.
19
16
  * ```javascript
@@ -9,12 +9,13 @@ export interface PutLogEventsCommandOutput extends PutLogEventsResponse, __Metad
9
9
  }
10
10
  /**
11
11
  * <p>Uploads a batch of log events to the specified log stream.</p>
12
- * <p>You must include the sequence token obtained from the response of the previous call. An
13
- * upload in a newly created log stream does not require a sequence token. You can also get the
14
- * sequence token in the <code>expectedSequenceToken</code> field from
15
- * <code>InvalidSequenceTokenException</code>. If you call <code>PutLogEvents</code> twice
16
- * within a narrow time period using the same value for <code>sequenceToken</code>, both calls
17
- * might be successful or one might be rejected.</p>
12
+ * <important>
13
+ * <p>The sequence token is now ignored in <code>PutLogEvents</code>
14
+ * actions. <code>PutLogEvents</code>
15
+ * actions are always accepted and never return <code>InvalidSequenceTokenException</code> or
16
+ * <code>DataAlreadyAcceptedException</code> even if the sequence token is not valid. You can use
17
+ * parallel <code>PutLogEvents</code> actions on the same log stream. </p>
18
+ * </important>
18
19
  * <p>The batch of events must satisfy the following constraints:</p>
19
20
  * <ul>
20
21
  * <li>
@@ -43,8 +44,12 @@ export interface PutLogEventsCommandOutput extends PutLogEventsResponse, __Metad
43
44
  * <p>The maximum number of log events in a batch is 10,000.</p>
44
45
  * </li>
45
46
  * <li>
46
- * <p>There is a quota of five requests per second per log stream. Additional requests
47
- * are throttled. This quota can't be changed.</p>
47
+ * <important>
48
+ * <p>The quota of five requests per second per log stream
49
+ * has been removed. Instead, <code>PutLogEvents</code> actions are throttled based on a
50
+ * per-second per-account quota. You can request an increase to the per-second throttling
51
+ * quota by using the Service Quotas service.</p>
52
+ * </important>
48
53
  * </li>
49
54
  * </ul>
50
55
  * <p>If a call to <code>PutLogEvents</code> returns "UnrecognizedClientException" the most
@@ -10,7 +10,6 @@ export interface PutQueryDefinitionCommandOutput extends PutQueryDefinitionRespo
10
10
  /**
11
11
  * <p>Creates or updates a query definition for CloudWatch Logs Insights. For
12
12
  * more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html">Analyzing Log Data with CloudWatch Logs Insights</a>.</p>
13
- *
14
13
  * <p>To update a query definition, specify its <code>queryDefinitionId</code> in your request.
15
14
  * The values of <code>name</code>, <code>queryString</code>, and <code>logGroupNames</code> are
16
15
  * changed to the values that you specify in your update operation. No current values are
@@ -11,16 +11,13 @@ export interface StartQueryCommandOutput extends StartQueryResponse, __MetadataB
11
11
  * <p>Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group
12
12
  * and time range to query and the query string to use.</p>
13
13
  * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query Syntax</a>.</p>
14
- *
15
14
  * <p>Queries time out after 15 minutes of runtime. If your queries are timing out, reduce the
16
15
  * time range being searched or partition your query into a number of queries.</p>
17
- *
18
16
  * <p>If you are using CloudWatch cross-account observability, you can use this operation in a
19
17
  * monitoring account to start a query in a linked source account. For more information, see
20
18
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch
21
19
  * cross-account observability</a>. For a cross-account <code>StartQuery</code> operation,
22
20
  * the query definition must be defined in the monitoring account.</p>
23
- *
24
21
  * <p>You can have up to 20 concurrent CloudWatch Logs insights queries, including queries
25
22
  * that have been added to dashboards. </p>
26
23
  * @example
@@ -173,6 +173,13 @@ export interface CreateLogStreamRequest {
173
173
  }
174
174
  /**
175
175
  * <p>The event was already logged.</p>
176
+ * <important>
177
+ * <p>
178
+ * <code>PutLogEvents</code>
179
+ * actions are now always accepted and never return
180
+ * <code>DataAlreadyAcceptedException</code> regardless of whether a given batch of log events
181
+ * has already been accepted. </p>
182
+ * </important>
176
183
  */
177
184
  export declare class DataAlreadyAcceptedException extends __BaseException {
178
185
  readonly name: "DataAlreadyAcceptedException";
@@ -450,9 +457,6 @@ export interface DescribeLogGroupsRequest {
450
457
  * that match the string based on a case-sensitive substring search. For example, if you specify <code>Foo</code>, log groups
451
458
  * named <code>FooBar</code>, <code>aws/Foo</code>, and <code>GroupFoo</code> would match, but <code>foo</code>,
452
459
  * <code>F/o/o</code> and <code>Froo</code> would not match.</p>
453
- *
454
- *
455
- *
456
460
  * <note>
457
461
  * <p>
458
462
  * <code>logGroupNamePattern</code> and <code>logGroupNamePrefix</code> are mutually exclusive.
@@ -474,8 +478,6 @@ export interface DescribeLogGroupsRequest {
474
478
  * <p>If you are using a monitoring account, set this to <code>True</code> to have the operation
475
479
  * return log groups in
476
480
  * the accounts listed in <code>accountIdentifiers</code>.</p>
477
- *
478
- *
479
481
  * <p>If this parameter is set to <code>true</code> and <code>accountIdentifiers</code>
480
482
  *
481
483
  * contains a null value, the operation returns all log groups in the monitoring account
@@ -628,11 +630,18 @@ export interface LogStream {
628
630
  lastEventTimestamp?: number;
629
631
  /**
630
632
  * <p>The ingestion time, expressed as the number of milliseconds after <code>Jan 1, 1970
631
- * 00:00:00 UTC</code>.</p>
633
+ * 00:00:00 UTC</code> The <code>lastIngestionTime</code> value updates on an eventual consistency basis. It
634
+ * typically updates in less than an hour after ingestion, but in rare situations might take longer.</p>
632
635
  */
633
636
  lastIngestionTime?: number;
634
637
  /**
635
638
  * <p>The sequence token.</p>
639
+ * <important>
640
+ * <p>The sequence token is now ignored in
641
+ * <code>PutLogEvents</code>
642
+ * actions. <code>PutLogEvents</code> actions are always accepted regardless of receiving an invalid sequence token.
643
+ * You don't need to obtain <code>uploadSequenceToken</code> to use a <code>PutLogEvents</code> action.</p>
644
+ * </important>
636
645
  */
637
646
  uploadSequenceToken?: string;
638
647
  /**
@@ -1436,6 +1445,12 @@ export interface InputLogEvent {
1436
1445
  * <p>The sequence token is not valid. You can get the correct sequence token in
1437
1446
  * the <code>expectedSequenceToken</code> field in the <code>InvalidSequenceTokenException</code>
1438
1447
  * message. </p>
1448
+ * <important>
1449
+ * <p>
1450
+ * <code>PutLogEvents</code>
1451
+ * actions are now always accepted and never return
1452
+ * <code>InvalidSequenceTokenException</code> regardless of receiving an invalid sequence token. </p>
1453
+ * </important>
1439
1454
  */
1440
1455
  export declare class InvalidSequenceTokenException extends __BaseException {
1441
1456
  readonly name: "InvalidSequenceTokenException";
@@ -1601,10 +1616,13 @@ export interface PutLogEventsRequest {
1601
1616
  logEvents: InputLogEvent[] | undefined;
1602
1617
  /**
1603
1618
  * <p>The sequence token obtained from the response of the previous <code>PutLogEvents</code>
1604
- * call. An upload in a newly created log stream does not require a sequence token. You can also
1605
- * get the sequence token using <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeLogStreams.html">DescribeLogStreams</a>. If you call <code>PutLogEvents</code> twice within a narrow
1606
- * time period using the same value for <code>sequenceToken</code>, both calls might be
1607
- * successful or one might be rejected.</p>
1619
+ * call.</p>
1620
+ * <important>
1621
+ * <p>The <code>sequenceToken</code> parameter is now ignored in <code>PutLogEvents</code>
1622
+ * actions. <code>PutLogEvents</code>
1623
+ * actions are now accepted and never return <code>InvalidSequenceTokenException</code> or
1624
+ * <code>DataAlreadyAcceptedException</code> even if the sequence token is not valid.</p>
1625
+ * </important>
1608
1626
  */
1609
1627
  sequenceToken?: string;
1610
1628
  }
@@ -1628,6 +1646,15 @@ export interface RejectedLogEventsInfo {
1628
1646
  export interface PutLogEventsResponse {
1629
1647
  /**
1630
1648
  * <p>The next sequence token.</p>
1649
+ * <important>
1650
+ * <p>This field has been deprecated.</p>
1651
+ * <p>The sequence token is now ignored in <code>PutLogEvents</code>
1652
+ * actions. <code>PutLogEvents</code>
1653
+ * actions are always accepted even if the sequence token is not valid. You can use
1654
+ * parallel <code>PutLogEvents</code> actions on the same log stream and you do not need
1655
+ * to wait for the response of a previous <code>PutLogEvents</code> action to obtain
1656
+ * the <code>nextSequenceToken</code> value.</p>
1657
+ * </important>
1631
1658
  */
1632
1659
  nextSequenceToken?: string;
1633
1660
  /**
@@ -1743,7 +1770,6 @@ export interface PutResourcePolicyRequest {
1743
1770
  * }
1744
1771
  * ]
1745
1772
  * }</code>
1746
- *
1747
1773
  * </p>
1748
1774
  */
1749
1775
  policyDocument?: string;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cloudwatch-logs",
3
3
  "description": "AWS SDK for JavaScript Cloudwatch Logs Client for Node.js, Browser and React Native",
4
- "version": "3.241.0",
4
+ "version": "3.244.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",