@aws-sdk/client-cloudwatch-logs 3.215.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.
Files changed (55) hide show
  1. package/README.md +15 -14
  2. package/dist-cjs/CloudWatchLogs.js +45 -0
  3. package/dist-cjs/commands/DeleteDataProtectionPolicyCommand.js +46 -0
  4. package/dist-cjs/commands/GetDataProtectionPolicyCommand.js +46 -0
  5. package/dist-cjs/commands/PutDataProtectionPolicyCommand.js +46 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/endpoint/ruleset.js +5 -5
  8. package/dist-cjs/models/models_0.js +30 -3
  9. package/dist-cjs/protocols/Aws_json1_1.js +221 -2
  10. package/dist-es/CloudWatchLogs.js +45 -0
  11. package/dist-es/commands/DeleteDataProtectionPolicyCommand.js +42 -0
  12. package/dist-es/commands/GetDataProtectionPolicyCommand.js +42 -0
  13. package/dist-es/commands/PutDataProtectionPolicyCommand.js +42 -0
  14. package/dist-es/commands/index.js +3 -0
  15. package/dist-es/endpoint/ruleset.js +5 -5
  16. package/dist-es/models/models_0.js +22 -0
  17. package/dist-es/protocols/Aws_json1_1.js +213 -0
  18. package/dist-types/CloudWatchLogs.d.ts +184 -114
  19. package/dist-types/CloudWatchLogsClient.d.ts +20 -16
  20. package/dist-types/commands/AssociateKmsKeyCommand.d.ts +11 -10
  21. package/dist-types/commands/CreateExportTaskCommand.d.ts +11 -11
  22. package/dist-types/commands/CreateLogGroupCommand.d.ts +14 -12
  23. package/dist-types/commands/CreateLogStreamCommand.d.ts +1 -1
  24. package/dist-types/commands/DeleteDataProtectionPolicyCommand.d.ts +38 -0
  25. package/dist-types/commands/DescribeLogGroupsCommand.d.ts +3 -0
  26. package/dist-types/commands/DescribeLogStreamsCommand.d.ts +3 -0
  27. package/dist-types/commands/DescribeQueriesCommand.d.ts +3 -3
  28. package/dist-types/commands/DisassociateKmsKeyCommand.d.ts +5 -3
  29. package/dist-types/commands/FilterLogEventsCommand.d.ts +8 -4
  30. package/dist-types/commands/GetDataProtectionPolicyCommand.d.ts +37 -0
  31. package/dist-types/commands/GetLogEventsCommand.d.ts +4 -0
  32. package/dist-types/commands/GetLogGroupFieldsCommand.d.ts +10 -6
  33. package/dist-types/commands/GetQueryResultsCommand.d.ts +4 -2
  34. package/dist-types/commands/PutDataProtectionPolicyCommand.d.ts +51 -0
  35. package/dist-types/commands/PutDestinationCommand.d.ts +3 -3
  36. package/dist-types/commands/PutLogEventsCommand.d.ts +11 -8
  37. package/dist-types/commands/PutMetricFilterCommand.d.ts +5 -5
  38. package/dist-types/commands/PutQueryDefinitionCommand.d.ts +7 -7
  39. package/dist-types/commands/PutRetentionPolicyCommand.d.ts +11 -10
  40. package/dist-types/commands/PutSubscriptionFilterCommand.d.ts +10 -11
  41. package/dist-types/commands/StartQueryCommand.d.ts +9 -4
  42. package/dist-types/commands/index.d.ts +3 -0
  43. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  44. package/dist-types/models/models_0.d.ts +369 -115
  45. package/dist-types/protocols/Aws_json1_1.d.ts +9 -0
  46. package/dist-types/ts3.4/CloudWatchLogs.d.ts +51 -0
  47. package/dist-types/ts3.4/CloudWatchLogsClient.d.ts +18 -0
  48. package/dist-types/ts3.4/commands/DeleteDataProtectionPolicyCommand.d.ts +37 -0
  49. package/dist-types/ts3.4/commands/GetDataProtectionPolicyCommand.d.ts +41 -0
  50. package/dist-types/ts3.4/commands/PutDataProtectionPolicyCommand.d.ts +41 -0
  51. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  52. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  53. package/dist-types/ts3.4/models/models_0.d.ts +53 -0
  54. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
  55. package/package.json +4 -4
@@ -8,19 +8,20 @@ export interface PutRetentionPolicyCommandInput extends PutRetentionPolicyReques
8
8
  export interface PutRetentionPolicyCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
- * <p>Sets the retention of the specified log group. A retention policy allows you to
11
+ * <p>Sets the retention of the specified log group. With a retention policy, you can
12
12
  * configure the number of days for which to retain log events in the specified log
13
13
  * group.</p>
14
14
  * <note>
15
- * <p>CloudWatch Logs doesn’t immediately delete log events when they reach their retention setting.
16
- * It typically takes up to 72 hours after that before log events are deleted, but in rare situations might take longer.</p>
17
- * <p>This means that if you change a log group to have a longer retention setting when it contains log events
18
- * that are past the expiration date, but haven’t been actually deleted, those log events will take
19
- * up to 72 hours to be deleted after the new retention date is reached. To make sure
20
- * that log data is deleted permanently, keep a log group at its lower retention setting until 72 hours has passed
21
- * after the end of the previous
22
- * retention period, or you have confirmed that the older log events are deleted.
23
- * </p>
15
+ * <p>CloudWatch Logs doesn’t immediately delete log events when they reach their retention
16
+ * setting. It typically takes up to 72 hours after that before log events are deleted, but in
17
+ * rare situations might take longer.</p>
18
+ * <p>To illustrate, imagine that you change a log group to have a longer retention setting
19
+ * when it contains log events that are past the expiration date, but haven’t been deleted.
20
+ * Those log events will take up to 72 hours to be deleted after the new retention date is
21
+ * reached. To make sure that log data is deleted permanently, keep a log group at its lower
22
+ * retention setting until 72 hours after the previous retention period ends. Alternatively,
23
+ * wait to change the retention setting until you confirm that the earlier log events are
24
+ * deleted. </p>
24
25
  * </note>
25
26
  * @example
26
27
  * Use a bare-bones client and the command you need to make an API call.
@@ -9,27 +9,26 @@ export interface PutSubscriptionFilterCommandOutput extends __MetadataBearer {
9
9
  }
10
10
  /**
11
11
  * <p>Creates or updates a subscription filter and associates it with the specified log
12
- * group. Subscription filters allow you to subscribe to a real-time stream of log events
13
- * ingested through <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a> and have them delivered to a specific
14
- * destination. When log events are sent to the
15
- * receiving service, they are Base64 encoded
16
- * and compressed with the gzip format.</p>
12
+ * group. With subscription filters, you can subscribe to a real-time stream of log events
13
+ * ingested through <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>
14
+ * and have them delivered to a specific destination. When log events are sent to the receiving
15
+ * service, they are Base64 encoded and compressed with the GZIP format.</p>
17
16
  * <p>The following destinations are supported for subscription filters:</p>
18
17
  * <ul>
19
18
  * <li>
20
- * <p>An Amazon Kinesis stream belonging to the same account as the subscription filter,
21
- * for same-account delivery.</p>
19
+ * <p>An Amazon Kinesis data stream belonging to the same account as the subscription
20
+ * filter, for same-account delivery.</p>
22
21
  * </li>
23
22
  * <li>
24
23
  * <p>A logical destination that belongs to a different account, for cross-account delivery.</p>
25
24
  * </li>
26
25
  * <li>
27
- * <p>An Amazon Kinesis Firehose delivery stream that belongs to the same account as the
28
- * subscription filter, for same-account delivery.</p>
26
+ * <p>An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as
27
+ * the subscription filter, for same-account delivery.</p>
29
28
  * </li>
30
29
  * <li>
31
- * <p>An Lambda function that belongs to the same account as the subscription filter,
32
- * for same-account delivery.</p>
30
+ * <p>An Lambda function that belongs to the same account as the
31
+ * subscription filter, for same-account delivery.</p>
33
32
  * </li>
34
33
  * </ul>
35
34
  * <p>Each log group can have up to two subscription filters associated with it. If you are
@@ -12,12 +12,17 @@ export interface StartQueryCommandOutput extends StartQueryResponse, __MetadataB
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
14
  *
15
- * <p>Queries time out after 15 minutes of execution. If your queries are timing out, reduce the
15
+ * <p>Queries time out after 15 minutes of runtime. If your queries are timing out, reduce the
16
16
  * time range being searched or partition your query into a number of queries.</p>
17
17
  *
18
- * <p>
19
- * You are limited to 20 concurrent CloudWatch Logs insights queries, including queries that have been added to dashboards.
20
- * </p>
18
+ * <p>If you are using CloudWatch cross-account observability, you can use this operation in a
19
+ * monitoring account to start a query in a linked source account. For more information, see
20
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch
21
+ * cross-account observability</a>. For a cross-account <code>StartQuery</code> operation,
22
+ * the query definition must be defined in the monitoring account.</p>
23
+ *
24
+ * <p>You can have up to 20 concurrent CloudWatch Logs insights queries, including queries
25
+ * that have been added to dashboards. </p>
21
26
  * @example
22
27
  * Use a bare-bones client and the command you need to make an API call.
23
28
  * ```javascript
@@ -3,6 +3,7 @@ export * from "./CancelExportTaskCommand";
3
3
  export * from "./CreateExportTaskCommand";
4
4
  export * from "./CreateLogGroupCommand";
5
5
  export * from "./CreateLogStreamCommand";
6
+ export * from "./DeleteDataProtectionPolicyCommand";
6
7
  export * from "./DeleteDestinationCommand";
7
8
  export * from "./DeleteLogGroupCommand";
8
9
  export * from "./DeleteLogStreamCommand";
@@ -22,12 +23,14 @@ export * from "./DescribeResourcePoliciesCommand";
22
23
  export * from "./DescribeSubscriptionFiltersCommand";
23
24
  export * from "./DisassociateKmsKeyCommand";
24
25
  export * from "./FilterLogEventsCommand";
26
+ export * from "./GetDataProtectionPolicyCommand";
25
27
  export * from "./GetLogEventsCommand";
26
28
  export * from "./GetLogGroupFieldsCommand";
27
29
  export * from "./GetLogRecordCommand";
28
30
  export * from "./GetQueryResultsCommand";
29
31
  export * from "./ListTagsForResourceCommand";
30
32
  export * from "./ListTagsLogGroupCommand";
33
+ export * from "./PutDataProtectionPolicyCommand";
31
34
  export * from "./PutDestinationCommand";
32
35
  export * from "./PutDestinationPolicyCommand";
33
36
  export * from "./PutLogEventsCommand";
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region?: string;
15
+ Region: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;