docs(client-cloudwatch-logs): Doc-only update for bug fixes and support of export to buckets encrypted with SSE-KMS

Author: awstools

clients/client-cloudwatch-logs/package.json

@@ -42,6 +42,8 @@
     "@aws-sdk/types": "*",
     "@aws-sdk/url-parser": "*",
     "@aws-sdk/util-base64": "*",
+    "@aws-sdk/util-base64-browser": "*",
+    "@aws-sdk/util-base64-node": "*",
     "@aws-sdk/util-body-length-browser": "*",
     "@aws-sdk/util-body-length-node": "*",
     "@aws-sdk/util-defaults-mode-browser": "*",

clients/client-cloudwatch-logs/src/CloudWatchLogs.ts

@@ -331,6 +331,10 @@ export class CloudWatchLogs extends CloudWatchLogsClient {
    *       log group to an Amazon S3 bucket. When you perform a <code>CreateExportTask</code>
    *       operation, you must use credentials that have permission to write to the S3 bucket
    *       that you specify as the destination.</p>
+   *          <p>Exporting log data to Amazon S3 buckets that are encrypted by KMS is
+   *       supported. Exporting
+   *       log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.</p>
+   *          <p>Exporting to S3 buckets that are encrypted with AES-256 is supported. </p>
    *          <p>This is an asynchronous call. If all the required information is provided, this
    *       operation initiates an export task and responds with the ID of the task. After the task has started,
    *       you can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html">DescribeExportTasks</a> to get the status of the export task. Each account can
@@ -339,8 +343,11 @@ export class CloudWatchLogs extends CloudWatchLogsClient {
    *          <p>You can export logs from multiple log groups or multiple time ranges to the same S3
    *       bucket. To separate out log data for each export task, you can specify a prefix to be used as
    *       the Amazon S3 key prefix for all exported objects.</p>
-   *          <p>Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets
-   *       encrypted with SSE-KMS is not supported. </p>
+   *
+   *          <note>
+   *             <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the
+   *       exported log fild data by using Linux utilities.</p>
+   *          </note>
    */
   public createExportTask(
     args: CreateExportTaskCommandInput,
@@ -1088,6 +1095,7 @@ export class CloudWatchLogs extends CloudWatchLogsClient {
   /**
    * <p>Lists log events from the specified log group. You can list all the log events or filter the results
    *       using a filter pattern, a time range, and the name of the log stream.</p>
+   *          <p>You must have the <code>logs;FilterLogEvents</code> permission to perform this operation.</p>
    *          <p>By default, this operation returns as many log events as can fit in 1 MB (up to 10,000
    *       log events) or all the events found within the time range that you specify. If the results
    *       include a token, then there are more log events available, and you can get additional results
@@ -1622,6 +1630,17 @@ export class CloudWatchLogs extends CloudWatchLogsClient {
    * <p>Sets the retention of the specified log group. A retention policy allows you to
    *       configure the number of days for which to retain log events in the specified log
    *       group.</p>
+   *          <note>
+   *             <p>CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting.
+   *       It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.</p>
+   *             <p>This means that if you change a log group to have a longer retention setting when it contains log events
+   *         that are past the expiration date, but haven’t been actually deleted, those log events will take
+   *         up to 72 hours to be deleted after the new retention date is reached. To make sure
+   *         that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours has passed
+   *         after the end of the previous
+   *         retention period, or you have confirmed that the older log events are deleted.
+   *       </p>
+   *          </note>
    */
   public putRetentionPolicy(
     args: PutRetentionPolicyCommandInput,
@@ -1719,6 +1738,10 @@ export class CloudWatchLogs extends CloudWatchLogsClient {
    *
    *          <p>Queries time out after 15 minutes of execution. If your queries are timing out, reduce the
    *       time range being searched or partition your query into a number of queries.</p>
+   *
+   *          <p>
+   *         You are limited to 20 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
+   *     </p>
    */
   public startQuery(args: StartQueryCommandInput, options?: __HttpHandlerOptions): Promise<StartQueryCommandOutput>;
   public startQuery(args: StartQueryCommandInput, cb: (err: any, data?: StartQueryCommandOutput) => void): void;

clients/client-cloudwatch-logs/src/commands/CreateExportTaskCommand.ts

@@ -33,6 +33,10 @@ export interface CreateExportTaskCommandOutput extends CreateExportTaskResponse,
  *       log group to an Amazon S3 bucket. When you perform a <code>CreateExportTask</code>
  *       operation, you must use credentials that have permission to write to the S3 bucket
  *       that you specify as the destination.</p>
+ *          <p>Exporting log data to Amazon S3 buckets that are encrypted by KMS is
+ *       supported. Exporting
+ *       log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported.</p>
+ *          <p>Exporting to S3 buckets that are encrypted with AES-256 is supported. </p>
  *          <p>This is an asynchronous call. If all the required information is provided, this
  *       operation initiates an export task and responds with the ID of the task. After the task has started,
  *       you can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html">DescribeExportTasks</a> to get the status of the export task. Each account can
@@ -41,8 +45,11 @@ export interface CreateExportTaskCommandOutput extends CreateExportTaskResponse,
  *          <p>You can export logs from multiple log groups or multiple time ranges to the same S3
  *       bucket. To separate out log data for each export task, you can specify a prefix to be used as
  *       the Amazon S3 key prefix for all exported objects.</p>
- *          <p>Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets
- *       encrypted with SSE-KMS is not supported. </p>
+ *
+ *          <note>
+ *             <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can sort the
+ *       exported log fild data by using Linux utilities.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-cloudwatch-logs/src/commands/FilterLogEventsCommand.ts

@@ -31,6 +31,7 @@ export interface FilterLogEventsCommandOutput extends FilterLogEventsResponse, _
 /**
  * <p>Lists log events from the specified log group. You can list all the log events or filter the results
  *       using a filter pattern, a time range, and the name of the log stream.</p>
+ *          <p>You must have the <code>logs;FilterLogEvents</code> permission to perform this operation.</p>
  *          <p>By default, this operation returns as many log events as can fit in 1 MB (up to 10,000
  *       log events) or all the events found within the time range that you specify. If the results
  *       include a token, then there are more log events available, and you can get additional results

clients/client-cloudwatch-logs/src/commands/PutRetentionPolicyCommand.ts

@@ -27,6 +27,17 @@ export interface PutRetentionPolicyCommandOutput extends __MetadataBearer {}
  * <p>Sets the retention of the specified log group. A retention policy allows you to
  *       configure the number of days for which to retain log events in the specified log
  *       group.</p>
+ *          <note>
+ *             <p>CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting.
+ *       It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.</p>
+ *             <p>This means that if you change a log group to have a longer retention setting when it contains log events
+ *         that are past the expiration date, but haven’t been actually deleted, those log events will take
+ *         up to 72 hours to be deleted after the new retention date is reached. To make sure
+ *         that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours has passed
+ *         after the end of the previous
+ *         retention period, or you have confirmed that the older log events are deleted.
+ *       </p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-cloudwatch-logs/src/commands/StartQueryCommand.ts

@@ -35,6 +35,10 @@ export interface StartQueryCommandOutput extends StartQueryResponse, __MetadataB
  *
  *          <p>Queries time out after 15 minutes of execution. If your queries are timing out, reduce the
  *       time range being searched or partition your query into a number of queries.</p>
+ *
+ *          <p>
+ *         You are limited to 20 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
+ *     </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-cloudwatch-logs/src/models/models_0.ts

@@ -146,6 +146,7 @@ export interface CreateExportTaskRequest {
    * <p>The end time of the range for the request, expressed as the number of milliseconds
    *       after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not
    *       exported.</p>
+   *          <p>You must specify a time that is not earlier than when this log group was created.</p>
    */
   to: number | undefined;
 
@@ -354,7 +355,8 @@ export interface DescribeDestinationsRequest {
   nextToken?: string;
 
   /**
-   * <p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>
+   * <p>The maximum number of items returned. If you don't specify a value, the default maximum value of
+   *       50 items is used.</p>
    */
   limit?: number;
 }
@@ -570,7 +572,7 @@ export interface LogGroup {
 
   /**
    * <p>The number of days to retain the log events in the specified log group.
-   *       Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.</p>
+   *       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>
    *          <p>To set a log group to never have log events expire, use
    *     <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html">DeleteRetentionPolicy</a>.
    *   </p>
@@ -1862,7 +1864,7 @@ export interface PutRetentionPolicyRequest {
 
   /**
    * <p>The number of days to retain the log events in the specified log group.
-   *       Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.</p>
+   *       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>
    *          <p>To set a log group to never have log events expire, use
    *     <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html">DeleteRetentionPolicy</a>.
    *   </p>