@aws-sdk/client-cloudwatch-logs 3.679.0 → 3.682.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 +1 -1
- package/dist-types/commands/CreateDeliveryCommand.d.ts +1 -1
- package/dist-types/commands/DescribeLogGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListAnomaliesCommand.d.ts +1 -0
- package/dist-types/commands/PutRetentionPolicyCommand.d.ts +2 -2
- package/dist-types/commands/TagLogGroupCommand.d.ts +1 -1
- package/dist-types/commands/UntagLogGroupCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAnomalyCommand.d.ts +3 -2
- package/dist-types/models/models_0.d.ts +28 -7
- package/dist-types/ts3.4/models/models_0.d.ts +2 -0
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -44,7 +44,7 @@ into the log service. You can then access the raw log data when you need it.</p>
|
|
|
44
44
|
|
|
45
45
|
## Installing
|
|
46
46
|
|
|
47
|
-
To install
|
|
47
|
+
To install this package, simply type add or install @aws-sdk/client-cloudwatch-logs
|
|
48
48
|
using your favorite package manager:
|
|
49
49
|
|
|
50
50
|
- `npm install @aws-sdk/client-cloudwatch-logs`
|
|
@@ -62,7 +62,7 @@ declare const CreateDeliveryCommand_base: {
|
|
|
62
62
|
* </ul>
|
|
63
63
|
* <p>You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You
|
|
64
64
|
* can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.</p>
|
|
65
|
-
* <p>
|
|
65
|
+
* <p>To update an existing delivery configuration, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a>.</p>
|
|
66
66
|
* @example
|
|
67
67
|
* Use a bare-bones client and the command you need to make an API call.
|
|
68
68
|
* ```javascript
|
|
@@ -29,7 +29,7 @@ declare const DescribeLogGroupsCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Lists the specified log groups. You can list all your log groups or filter the results by prefix.
|
|
31
31
|
* The results are ASCII-sorted by log group name.</p>
|
|
32
|
-
* <p>CloudWatch Logs doesn
|
|
32
|
+
* <p>CloudWatch Logs doesn't support IAM policies that control access to the <code>DescribeLogGroups</code> action by using the
|
|
33
33
|
* <code>aws:ResourceTag/<i>key-name</i>
|
|
34
34
|
* </code> condition key. Other CloudWatch Logs actions
|
|
35
35
|
* do support the use of the <code>aws:ResourceTag/<i>key-name</i>
|
|
@@ -31,11 +31,11 @@ declare const PutRetentionPolicyCommand_base: {
|
|
|
31
31
|
* configure the number of days for which to retain log events in the specified log
|
|
32
32
|
* group.</p>
|
|
33
33
|
* <note>
|
|
34
|
-
* <p>CloudWatch Logs doesn
|
|
34
|
+
* <p>CloudWatch Logs doesn't immediately delete log events when they reach their retention
|
|
35
35
|
* setting. It typically takes up to 72 hours after that before log events are deleted, but in
|
|
36
36
|
* rare situations might take longer.</p>
|
|
37
37
|
* <p>To illustrate, imagine that you change a log group to have a longer retention setting
|
|
38
|
-
* when it contains log events that are past the expiration date, but haven
|
|
38
|
+
* when it contains log events that are past the expiration date, but haven't been deleted.
|
|
39
39
|
* Those log events will take up to 72 hours to be deleted after the new retention date is
|
|
40
40
|
* reached. To make sure that log data is deleted permanently, keep a log group at its lower
|
|
41
41
|
* retention setting until 72 hours after the previous retention period ends. Alternatively,
|
|
@@ -36,7 +36,7 @@ declare const TagLogGroupCommand_base: {
|
|
|
36
36
|
* To remove tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
37
37
|
* <p>For more information about tags, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html#log-group-tagging">Tag Log Groups in Amazon CloudWatch Logs</a>
|
|
38
38
|
* in the <i>Amazon CloudWatch Logs User Guide</i>.</p>
|
|
39
|
-
* <p>CloudWatch Logs doesn
|
|
39
|
+
* <p>CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified tags to
|
|
40
40
|
* log groups using the <code>aws:Resource/<i>key-name</i>
|
|
41
41
|
* </code> or <code>aws:TagKeys</code> condition keys.
|
|
42
42
|
* For more information about using tags to control access, see
|
|
@@ -34,7 +34,7 @@ declare const UntagLogGroupCommand_base: {
|
|
|
34
34
|
* <p>Removes the specified tags from the specified log group.</p>
|
|
35
35
|
* <p>To list the tags for a log group, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>.
|
|
36
36
|
* To add tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
|
|
37
|
-
* <p>CloudWatch Logs doesn
|
|
37
|
+
* <p>CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified tags to
|
|
38
38
|
* log groups using the <code>aws:Resource/<i>key-name</i>
|
|
39
39
|
* </code> or <code>aws:TagKeys</code> condition keys.
|
|
40
40
|
* </p>
|
|
@@ -28,9 +28,9 @@ declare const UpdateAnomalyCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Use this operation to <i>suppress</i> anomaly detection for a specified anomaly or pattern. If you suppress
|
|
31
|
-
* an anomaly, CloudWatch Logs won
|
|
31
|
+
* an anomaly, CloudWatch Logs won't report new occurrences of that anomaly and won't
|
|
32
32
|
* update that anomaly
|
|
33
|
-
* with new data. If you suppress a pattern, CloudWatch Logs won
|
|
33
|
+
* with new data. If you suppress a pattern, CloudWatch Logs won't report any anomalies related to that pattern.</p>
|
|
34
34
|
* <p>You must specify either <code>anomalyId</code> or <code>patternId</code>, but you can't specify both parameters in the
|
|
35
35
|
* same operation.</p>
|
|
36
36
|
* <p>If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause
|
|
@@ -51,6 +51,7 @@ declare const UpdateAnomalyCommand_base: {
|
|
|
51
51
|
* value: Number("int"),
|
|
52
52
|
* suppressionUnit: "SECONDS" || "MINUTES" || "HOURS",
|
|
53
53
|
* },
|
|
54
|
+
* baseline: true || false,
|
|
54
55
|
* };
|
|
55
56
|
* const command = new UpdateAnomalyCommand(input);
|
|
56
57
|
* const response = await client.send(command);
|
|
@@ -146,6 +146,16 @@ export interface PatternToken {
|
|
|
146
146
|
* @public
|
|
147
147
|
*/
|
|
148
148
|
enumerations?: Record<string, number>;
|
|
149
|
+
/**
|
|
150
|
+
* <p>A name that CloudWatch Logs assigned to this dynamic token to make the pattern more readable. The string part of
|
|
151
|
+
* the <code>inferredTokenName</code> gives you a clearer idea of the content of this token. The number part of
|
|
152
|
+
* the <code>inferredTokenName</code> shows where in the pattern this token appears, compared to other dynamic tokens.
|
|
153
|
+
* CloudWatch Logs assigns the string part of the name based on analyzing the content of the log events that contain it.</p>
|
|
154
|
+
* <p>For example, an inferred token name of <code>IPAddress-3</code> means that the token represents an IP address, and this
|
|
155
|
+
* token is the third dynamic token in the pattern.</p>
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
inferredTokenName?: string;
|
|
149
159
|
}
|
|
150
160
|
/**
|
|
151
161
|
* @public
|
|
@@ -591,7 +601,7 @@ export interface ConfigurationTemplate {
|
|
|
591
601
|
*/
|
|
592
602
|
deliveryDestinationType?: DeliveryDestinationType;
|
|
593
603
|
/**
|
|
594
|
-
* <p>A mapping that displays the default value of each property within a delivery
|
|
604
|
+
* <p>A mapping that displays the default value of each property within a delivery's configuration,
|
|
595
605
|
* if it is not specified in the request.</p>
|
|
596
606
|
* @public
|
|
597
607
|
*/
|
|
@@ -654,7 +664,7 @@ export interface CreateDeliveryRequest {
|
|
|
654
664
|
deliveryDestinationArn: string | undefined;
|
|
655
665
|
/**
|
|
656
666
|
* <p>The list of record fields to be delivered to the destination, in order.
|
|
657
|
-
* If the delivery
|
|
667
|
+
* If the delivery's log source has mandatory fields, they must be included in this list.</p>
|
|
658
668
|
* @public
|
|
659
669
|
*/
|
|
660
670
|
recordFields?: string[];
|
|
@@ -665,7 +675,7 @@ export interface CreateDeliveryRequest {
|
|
|
665
675
|
*/
|
|
666
676
|
fieldDelimiter?: string;
|
|
667
677
|
/**
|
|
668
|
-
* <p>This structure contains parameters that are valid only when the delivery
|
|
678
|
+
* <p>This structure contains parameters that are valid only when the delivery's delivery destination is an S3 bucket.</p>
|
|
669
679
|
* @public
|
|
670
680
|
*/
|
|
671
681
|
s3DeliveryConfiguration?: S3DeliveryConfiguration;
|
|
@@ -683,7 +693,7 @@ export interface CreateDeliveryRequest {
|
|
|
683
693
|
* <p>A delivery is a connection between a logical <i>delivery source</i> and a logical
|
|
684
694
|
* <i>delivery destination</i>.</p>
|
|
685
695
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a>.</p>
|
|
686
|
-
* <p>
|
|
696
|
+
* <p>To update an existing delivery configuration, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a>.</p>
|
|
687
697
|
* @public
|
|
688
698
|
*/
|
|
689
699
|
export interface Delivery {
|
|
@@ -823,6 +833,8 @@ export interface CreateExportTaskRequest {
|
|
|
823
833
|
/**
|
|
824
834
|
* <p>The prefix used as the start of the key for every object exported. If you don't
|
|
825
835
|
* specify a value, the default is <code>exportedlogs</code>.</p>
|
|
836
|
+
* <p>The length of this parameter must comply with the S3 object key name length limits. The object key name is a sequence of Unicode characters with UTF-8 encoding,
|
|
837
|
+
* and can be up to 1,024 bytes.</p>
|
|
826
838
|
* @public
|
|
827
839
|
*/
|
|
828
840
|
destinationPrefix?: string;
|
|
@@ -4641,7 +4653,7 @@ export interface StartQueryRequest {
|
|
|
4641
4653
|
queryString: string | undefined;
|
|
4642
4654
|
/**
|
|
4643
4655
|
* <p>The maximum number of log events to return in the query. If the query string uses the <code>fields</code> command,
|
|
4644
|
-
* only the specified fields and their values are returned. The default is
|
|
4656
|
+
* only the specified fields and their values are returned. The default is 10,000.</p>
|
|
4645
4657
|
* @public
|
|
4646
4658
|
*/
|
|
4647
4659
|
limit?: number;
|
|
@@ -4898,6 +4910,15 @@ export interface UpdateAnomalyRequest {
|
|
|
4898
4910
|
* @public
|
|
4899
4911
|
*/
|
|
4900
4912
|
suppressionPeriod?: SuppressionPeriod;
|
|
4913
|
+
/**
|
|
4914
|
+
* <p>Set this to <code>true</code> to prevent CloudWatch Logs from displaying this behavior as an anomaly in the future. The behavior is then treated as
|
|
4915
|
+
* baseline behavior. However, if similar but
|
|
4916
|
+
* more severe occurrences of this behavior occur in the future, those will still be reported as anomalies. </p>
|
|
4917
|
+
* <p>The default is <code>false</code>
|
|
4918
|
+
* </p>
|
|
4919
|
+
* @public
|
|
4920
|
+
*/
|
|
4921
|
+
baseline?: boolean;
|
|
4901
4922
|
}
|
|
4902
4923
|
/**
|
|
4903
4924
|
* @public
|
|
@@ -4910,7 +4931,7 @@ export interface UpdateDeliveryConfigurationRequest {
|
|
|
4910
4931
|
id: string | undefined;
|
|
4911
4932
|
/**
|
|
4912
4933
|
* <p>The list of record fields to be delivered to the destination, in order.
|
|
4913
|
-
* If the delivery
|
|
4934
|
+
* If the delivery's log source has mandatory fields, they must be included in this list.</p>
|
|
4914
4935
|
* @public
|
|
4915
4936
|
*/
|
|
4916
4937
|
recordFields?: string[];
|
|
@@ -4921,7 +4942,7 @@ export interface UpdateDeliveryConfigurationRequest {
|
|
|
4921
4942
|
*/
|
|
4922
4943
|
fieldDelimiter?: string;
|
|
4923
4944
|
/**
|
|
4924
|
-
* <p>This structure contains parameters that are valid only when the delivery
|
|
4945
|
+
* <p>This structure contains parameters that are valid only when the delivery's delivery destination is an S3 bucket.</p>
|
|
4925
4946
|
* @public
|
|
4926
4947
|
*/
|
|
4927
4948
|
s3DeliveryConfiguration?: S3DeliveryConfiguration;
|
|
@@ -38,6 +38,7 @@ export interface PatternToken {
|
|
|
38
38
|
isDynamic?: boolean;
|
|
39
39
|
tokenString?: string;
|
|
40
40
|
enumerations?: Record<string, number>;
|
|
41
|
+
inferredTokenName?: string;
|
|
41
42
|
}
|
|
42
43
|
export declare const State: {
|
|
43
44
|
readonly Active: "Active";
|
|
@@ -1179,6 +1180,7 @@ export interface UpdateAnomalyRequest {
|
|
|
1179
1180
|
anomalyDetectorArn: string | undefined;
|
|
1180
1181
|
suppressionType?: SuppressionType;
|
|
1181
1182
|
suppressionPeriod?: SuppressionPeriod;
|
|
1183
|
+
baseline?: boolean;
|
|
1182
1184
|
}
|
|
1183
1185
|
export interface UpdateDeliveryConfigurationRequest {
|
|
1184
1186
|
id: string | undefined;
|
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.
|
|
4
|
+
"version": "3.682.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,19 +20,19 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/client-sso-oidc": "3.
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
23
|
+
"@aws-sdk/client-sso-oidc": "3.682.0",
|
|
24
|
+
"@aws-sdk/client-sts": "3.682.0",
|
|
25
25
|
"@aws-sdk/core": "3.679.0",
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.682.0",
|
|
27
27
|
"@aws-sdk/middleware-host-header": "3.679.0",
|
|
28
28
|
"@aws-sdk/middleware-logger": "3.679.0",
|
|
29
29
|
"@aws-sdk/middleware-recursion-detection": "3.679.0",
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.682.0",
|
|
31
31
|
"@aws-sdk/region-config-resolver": "3.679.0",
|
|
32
32
|
"@aws-sdk/types": "3.679.0",
|
|
33
33
|
"@aws-sdk/util-endpoints": "3.679.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-browser": "3.679.0",
|
|
35
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
35
|
+
"@aws-sdk/util-user-agent-node": "3.682.0",
|
|
36
36
|
"@smithy/config-resolver": "^3.0.9",
|
|
37
37
|
"@smithy/core": "^2.4.8",
|
|
38
38
|
"@smithy/eventstream-serde-browser": "^3.0.10",
|