@aws-sdk/client-cloudwatch-logs 3.731.1 → 3.734.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.
@@ -33,7 +33,7 @@ declare const AssociateKmsKeyCommand_base: {
33
33
  * or the <code>resourceIdentifier</code> parameter. You can't specify both of those parameters in the same operation.</p>
34
34
  * <ul>
35
35
  * <li>
36
- * <p>Specify the <code>logGroupName</code> parameter to cause all log events stored in the log group to
36
+ * <p>Specify the <code>logGroupName</code> parameter to cause log events ingested into that log group to
37
37
  * be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.</p>
38
38
  * <p>Associating a KMS key with a log group overrides any existing
39
39
  * associations between the log group and a KMS key. After a KMS key is associated with a log group, all newly ingested data for the log group is encrypted
@@ -44,6 +44,11 @@ declare const CreateExportTaskCommand_base: {
44
44
  * bucket. To separate log data for each export task, specify a prefix to be used as the Amazon
45
45
  * S3 key prefix for all exported objects.</p>
46
46
  * <note>
47
+ * <p>We recommend that you don't regularly export to Amazon S3 as a way to continuously archive your logs. For that use case, we instaed recommend that
48
+ * you use subscriptions. For more information about subscriptions, see
49
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Subscriptions.html">Real-time processing of log data with subscriptions</a>.</p>
50
+ * </note>
51
+ * <note>
47
52
  * <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can
48
53
  * sort the exported log field data by using Linux utilities.</p>
49
54
  * </note>
@@ -27,7 +27,7 @@ declare const DeleteDeliveryCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes s <i>delivery</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical
30
+ * <p>Deletes a <i>delivery</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical
31
31
  * <i>delivery destination</i>. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does
32
32
  * not delete the delivery destination or the delivery source.</p>
33
33
  * @example
@@ -28,6 +28,24 @@ declare const DescribeAccountPoliciesCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Returns a list of all CloudWatch Logs account policies in the account.</p>
31
+ * <p>To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are retrieving information for.</p>
32
+ * <ul>
33
+ * <li>
34
+ * <p>To see data protection policies, you must have the <code>logs:GetDataProtectionPolicy</code> and
35
+ * <code>logs:DescribeAccountPolicies</code> permissions.</p>
36
+ * </li>
37
+ * <li>
38
+ * <p>To see subscription filter policies, you must have the <code>logs:DescrubeSubscriptionFilters</code> and
39
+ * <code>logs:DescribeAccountPolicies</code> permissions.</p>
40
+ * </li>
41
+ * <li>
42
+ * <p>To see transformer policies, you must have the <code>logs:GetTransformer</code> and <code>logs:DescribeAccountPolicies</code> permissions.</p>
43
+ * </li>
44
+ * <li>
45
+ * <p>To see field index policies, you must have the <code>logs:DescribeIndexPolicies</code> and
46
+ * <code>logs:DescribeAccountPolicies</code> permissions.</p>
47
+ * </li>
48
+ * </ul>
31
49
  * @example
32
50
  * Use a bare-bones client and the command you need to make an API call.
33
51
  * ```javascript
@@ -33,7 +33,7 @@ declare const DescribeLogStreamsCommand_base: {
33
33
  * <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
34
34
  * You must include one of these two parameters, but you can't include both.
35
35
  * </p>
36
- * <p>This operation has a limit of five transactions per second, after which transactions are throttled.</p>
36
+ * <p>This operation has a limit of 25 transactions per second, after which transactions are throttled.</p>
37
37
  * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
38
38
  * view data from the linked source accounts. For more information, see
39
39
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
@@ -30,6 +30,24 @@ declare const PutAccountPolicyCommand_base: {
30
30
  * <p>Creates an account-level data protection policy, subscription filter policy, or field index policy
31
31
  * that applies to all log groups
32
32
  * or a subset of log groups in the account.</p>
33
+ * <p>To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are creating.</p>
34
+ * <ul>
35
+ * <li>
36
+ * <p>To create a data protection policy, you must have the <code>logs:PutDataProtectionPolicy</code> and
37
+ * <code>logs:PutAccountPolicy</code> permissions.</p>
38
+ * </li>
39
+ * <li>
40
+ * <p>To create a subscription filter policy, you must have the <code>logs:PutSubscriptionFilter</code> and
41
+ * <code>logs:PutccountPolicy</code> permissions.</p>
42
+ * </li>
43
+ * <li>
44
+ * <p>To create a transformer policy, you must have the <code>logs:PutTransformer</code> and <code>logs:PutAccountPolicy</code> permissions.</p>
45
+ * </li>
46
+ * <li>
47
+ * <p>To create a field index policy, you must have the <code>logs:PutIndexPolicy</code> and
48
+ * <code>logs:PutAccountPolicy</code> permissions.</p>
49
+ * </li>
50
+ * </ul>
33
51
  * <p>
34
52
  * <b>Data protection policy</b>
35
53
  * </p>
@@ -38,7 +38,8 @@ declare const PutDeliveryDestinationCommand_base: {
38
38
  * information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">PutDeliverySource</a>.</p>
39
39
  * </li>
40
40
  * <li>
41
- * <p>Use <code>PutDeliveryDestination</code> to create a <i>delivery destination</i>, which is a logical object that represents the actual
41
+ * <p>Use <code>PutDeliveryDestination</code> to create a <i>delivery destination</i> in the same account of the actual delivery destination.
42
+ * The delivery destination that you create is a logical object that represents the actual
42
43
  * delivery destination. </p>
43
44
  * </li>
44
45
  * <li>
@@ -32,10 +32,10 @@ declare const PutMetricFilterCommand_base: {
32
32
  * through <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>.</p>
33
33
  * <p>The maximum number of metric filters that can be associated with a log group is
34
34
  * 100.</p>
35
- * <p>Using regular expressions to create metric filters is supported. For these filters,
35
+ * <p>Using regular expressions in filter patterns is supported. For these filters,
36
36
  * there is a quota of two regular expression patterns within a single filter pattern. There
37
37
  * is also a quota of five regular expression patterns per log group.
38
- * For more information about using regular expressions in metric filters,
38
+ * For more information about using regular expressions in filter patterns,
39
39
  * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html">
40
40
  * Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail</a>.</p>
41
41
  * <p>When you create a metric filter, you can also optionally assign a unit and dimensions
@@ -54,10 +54,10 @@ declare const PutSubscriptionFilterCommand_base: {
54
54
  * <p>Each log group can have up to two subscription filters associated with it. If you are
55
55
  * updating an existing filter, you must specify the correct name in <code>filterName</code>.
56
56
  * </p>
57
- * <p>Using regular expressions to create subscription filters is supported. For these filters,
57
+ * <p>Using regular expressions in filter patterns is supported. For these filters,
58
58
  * there is a quotas of quota of two regular expression patterns within a single filter pattern. There
59
59
  * is also a quota of five regular expression patterns per log group.
60
- * For more information about using regular expressions in subscription filters,
60
+ * For more information about using regular expressions in filter patterns,
61
61
  * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html">
62
62
  * Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail</a>.</p>
63
63
  * <p>To perform a <code>PutSubscriptionFilter</code> operation for any destination except a Lambda function,
@@ -560,8 +560,9 @@ export type OutputFormat = (typeof OutputFormat)[keyof typeof OutputFormat];
560
560
  export interface S3DeliveryConfiguration {
561
561
  /**
562
562
  * <p>This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables
563
- * to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for
564
- * more info on what values are supported in the suffix path for each log source.</p>
563
+ * to use in the suffix path will vary by each log source. To find the values supported for the suffix path for each log source,
564
+ * use the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeConfigurationTemplates.html">DescribeConfigurationTemplates</a> operation and check the
565
+ * <code>allowedSuffixPathFields</code> field in the response.</p>
565
566
  * @public
566
567
  */
567
568
  suffixPath?: string | undefined;
@@ -5528,16 +5529,37 @@ export interface PutDeliverySourceRequest {
5528
5529
  * <code>APPLICATION_LOGS</code>.</p>
5529
5530
  * </li>
5530
5531
  * <li>
5532
+ * <p>For CloudFront, the valid value is
5533
+ * <code>ACCESS_LOGS</code>.</p>
5534
+ * </li>
5535
+ * <li>
5531
5536
  * <p>For Amazon CodeWhisperer, the valid value is
5532
5537
  * <code>EVENT_LOGS</code>.</p>
5533
5538
  * </li>
5534
5539
  * <li>
5540
+ * <p>For Elemental MediaPackage, the valid values are
5541
+ * <code>EGRESS_ACCESS_LOGS</code> and <code>INGRESS_ACCESS_LOGS</code>.</p>
5542
+ * </li>
5543
+ * <li>
5544
+ * <p>For Elemental MediaTailor, the valid values are
5545
+ * <code>AD_DECISION_SERVER_LOGS</code>, <code>MANIFEST_SERVICE_LOGS</code>, and <code>TRANSCODE_LOGS</code>.</p>
5546
+ * </li>
5547
+ * <li>
5535
5548
  * <p>For IAM Identity Center, the valid value is
5536
5549
  * <code>ERROR_LOGS</code>.</p>
5537
5550
  * </li>
5538
5551
  * <li>
5552
+ * <p>For Amazon Q, the valid value is
5553
+ * <code>EVENT_LOGS</code>.</p>
5554
+ * </li>
5555
+ * <li>
5556
+ * <p>For Amazon SES mail manager, the valid value is
5557
+ * <code>APPLICATION_LOG</code>.</p>
5558
+ * </li>
5559
+ * <li>
5539
5560
  * <p>For Amazon WorkMail, the valid values are
5540
- * <code>ACCESS_CONTROL_LOGS</code>, <code>AUTHENTICATION_LOGS</code>, <code>WORKMAIL_AVAILABILITY_PROVIDER_LOGS</code>, and <code>WORKMAIL_MAILBOX_ACCESS_LOGS</code>.</p>
5561
+ * <code>ACCESS_CONTROL_LOGS</code>, <code>AUTHENTICATION_LOGS</code>, <code>WORKMAIL_AVAILABILITY_PROVIDER_LOGS</code>, <code>WORKMAIL_MAILBOX_ACCESS_LOGS</code>,
5562
+ * and <code>WORKMAIL_PERSONAL_ACCESS_TOKEN_LOGS</code>.</p>
5541
5563
  * </li>
5542
5564
  * </ul>
5543
5565
  * @public
@@ -5677,15 +5699,15 @@ export interface OpenSearchResourceConfig {
5677
5699
  kmsKeyArn?: string | undefined;
5678
5700
  /**
5679
5701
  * <p>Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service
5680
- * collection to be able to create the dashboards. For more information about the permissions needed, see <a href="https://docs.aws.amazon.com/OpenSearch-Dashboards-CreateRole">Create an IAM role to access the OpenSearch Service collection</a> in the CloudWatch Logs User Guide.</p>
5702
+ * collection to be able to create the dashboards. For more information about the permissions needed, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-CreateRole.html">Permissions that the integration needs</a> in the CloudWatch Logs User Guide.</p>
5681
5703
  * @public
5682
5704
  */
5683
5705
  dataSourceRoleArn: string | undefined;
5684
5706
  /**
5685
5707
  * <p>Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.</p>
5686
5708
  * <important>
5687
- * <p>In addition to specifying these users here, you must also grant them the <b>CloudWatchOpenSearchDashboardsAccess</b>
5688
- * IAM policy. For more information, see </p>
5709
+ * <p>In addition to specifying these users here, you must also grant them the <b>CloudWatchOpenSearchDashboardAccess</b>
5710
+ * IAM policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-UserRoles.html">IAM policies for users</a>.</p>
5689
5711
  * </important>
5690
5712
  * @public
5691
5713
  */
@@ -6192,7 +6214,7 @@ export interface StartLiveTailRequest {
6192
6214
  logEventFilterPattern?: string | undefined;
6193
6215
  }
6194
6216
  /**
6195
- * <p>his exception is returned if an unknown error occurs during a Live Tail session.</p>
6217
+ * <p>This exception is returned if an unknown error occurs during a Live Tail session.</p>
6196
6218
  * @public
6197
6219
  */
6198
6220
  export declare class SessionStreamingException extends __BaseException {
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.731.1",
4
+ "version": "3.734.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-cloudwatch-logs",
@@ -20,44 +20,44 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/core": "3.731.0",
24
- "@aws-sdk/credential-provider-node": "3.731.1",
25
- "@aws-sdk/middleware-host-header": "3.731.0",
26
- "@aws-sdk/middleware-logger": "3.731.0",
27
- "@aws-sdk/middleware-recursion-detection": "3.731.0",
28
- "@aws-sdk/middleware-user-agent": "3.731.0",
29
- "@aws-sdk/region-config-resolver": "3.731.0",
30
- "@aws-sdk/types": "3.731.0",
31
- "@aws-sdk/util-endpoints": "3.731.0",
32
- "@aws-sdk/util-user-agent-browser": "3.731.0",
33
- "@aws-sdk/util-user-agent-node": "3.731.0",
34
- "@smithy/config-resolver": "^4.0.0",
35
- "@smithy/core": "^3.0.0",
36
- "@smithy/eventstream-serde-browser": "^4.0.0",
37
- "@smithy/eventstream-serde-config-resolver": "^4.0.0",
38
- "@smithy/eventstream-serde-node": "^4.0.0",
39
- "@smithy/fetch-http-handler": "^5.0.0",
40
- "@smithy/hash-node": "^4.0.0",
41
- "@smithy/invalid-dependency": "^4.0.0",
42
- "@smithy/middleware-content-length": "^4.0.0",
43
- "@smithy/middleware-endpoint": "^4.0.0",
44
- "@smithy/middleware-retry": "^4.0.0",
45
- "@smithy/middleware-serde": "^4.0.0",
46
- "@smithy/middleware-stack": "^4.0.0",
47
- "@smithy/node-config-provider": "^4.0.0",
48
- "@smithy/node-http-handler": "^4.0.0",
49
- "@smithy/protocol-http": "^5.0.0",
50
- "@smithy/smithy-client": "^4.0.0",
51
- "@smithy/types": "^4.0.0",
52
- "@smithy/url-parser": "^4.0.0",
23
+ "@aws-sdk/core": "3.734.0",
24
+ "@aws-sdk/credential-provider-node": "3.734.0",
25
+ "@aws-sdk/middleware-host-header": "3.734.0",
26
+ "@aws-sdk/middleware-logger": "3.734.0",
27
+ "@aws-sdk/middleware-recursion-detection": "3.734.0",
28
+ "@aws-sdk/middleware-user-agent": "3.734.0",
29
+ "@aws-sdk/region-config-resolver": "3.734.0",
30
+ "@aws-sdk/types": "3.734.0",
31
+ "@aws-sdk/util-endpoints": "3.734.0",
32
+ "@aws-sdk/util-user-agent-browser": "3.734.0",
33
+ "@aws-sdk/util-user-agent-node": "3.734.0",
34
+ "@smithy/config-resolver": "^4.0.1",
35
+ "@smithy/core": "^3.1.1",
36
+ "@smithy/eventstream-serde-browser": "^4.0.1",
37
+ "@smithy/eventstream-serde-config-resolver": "^4.0.1",
38
+ "@smithy/eventstream-serde-node": "^4.0.1",
39
+ "@smithy/fetch-http-handler": "^5.0.1",
40
+ "@smithy/hash-node": "^4.0.1",
41
+ "@smithy/invalid-dependency": "^4.0.1",
42
+ "@smithy/middleware-content-length": "^4.0.1",
43
+ "@smithy/middleware-endpoint": "^4.0.2",
44
+ "@smithy/middleware-retry": "^4.0.3",
45
+ "@smithy/middleware-serde": "^4.0.1",
46
+ "@smithy/middleware-stack": "^4.0.1",
47
+ "@smithy/node-config-provider": "^4.0.1",
48
+ "@smithy/node-http-handler": "^4.0.2",
49
+ "@smithy/protocol-http": "^5.0.1",
50
+ "@smithy/smithy-client": "^4.1.2",
51
+ "@smithy/types": "^4.1.0",
52
+ "@smithy/url-parser": "^4.0.1",
53
53
  "@smithy/util-base64": "^4.0.0",
54
54
  "@smithy/util-body-length-browser": "^4.0.0",
55
55
  "@smithy/util-body-length-node": "^4.0.0",
56
- "@smithy/util-defaults-mode-browser": "^4.0.0",
57
- "@smithy/util-defaults-mode-node": "^4.0.0",
58
- "@smithy/util-endpoints": "^3.0.0",
59
- "@smithy/util-middleware": "^4.0.0",
60
- "@smithy/util-retry": "^4.0.0",
56
+ "@smithy/util-defaults-mode-browser": "^4.0.3",
57
+ "@smithy/util-defaults-mode-node": "^4.0.3",
58
+ "@smithy/util-endpoints": "^3.0.1",
59
+ "@smithy/util-middleware": "^4.0.1",
60
+ "@smithy/util-retry": "^4.0.1",
61
61
  "@smithy/util-utf8": "^4.0.0",
62
62
  "@types/uuid": "^9.0.1",
63
63
  "tslib": "^2.6.2",