Skip to content

Commit 1429c43

Browse files
author
awstools
committed
feat(client-cloudwatch-logs): Adding inferred token name for dynamic tokens in Anomalies.
1 parent 08bfafb commit 1429c43

10 files changed

+9941
-9913
lines changed

clients/client-cloudwatch-logs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ into the log service. You can then access the raw log data when you need it.</p>
4444

4545
## Installing
4646

47-
To install the this package, simply type add or install @aws-sdk/client-cloudwatch-logs
47+
To install this package, simply type add or install @aws-sdk/client-cloudwatch-logs
4848
using your favorite package manager:
4949

5050
- `npm install @aws-sdk/client-cloudwatch-logs`

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ export interface CreateDeliveryCommandOutput extends CreateDeliveryResponse, __M
6363
* </ul>
6464
* <p>You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You
6565
* can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.</p>
66-
* <p>You can't update an existing delivery. You can only create and delete deliveries.</p>
66+
* <p>To update an existing delivery configuration, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a>.</p>
6767
* @example
6868
* Use a bare-bones client and the command you need to make an API call.
6969
* ```javascript

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface DescribeLogGroupsCommandOutput extends DescribeLogGroupsRespons
3030
/**
3131
* <p>Lists the specified log groups. You can list all your log groups or filter the results by prefix.
3232
* The results are ASCII-sorted by log group name.</p>
33-
* <p>CloudWatch Logs doesnt support IAM policies that control access to the <code>DescribeLogGroups</code> action by using the
33+
* <p>CloudWatch Logs doesn't support IAM policies that control access to the <code>DescribeLogGroups</code> action by using the
3434
* <code>aws:ResourceTag/<i>key-name</i>
3535
* </code> condition key. Other CloudWatch Logs actions
3636
* do support the use of the <code>aws:ResourceTag/<i>key-name</i>

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

+1
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ export interface ListAnomaliesCommandOutput extends ListAnomaliesResponse, __Met
7575
* // enumerations: { // Enumerations
7676
* // "<keys>": Number("long"),
7777
* // },
78+
* // inferredTokenName: "STRING_VALUE",
7879
* // },
7980
* // ],
8081
* // logGroupArnList: [ // LogGroupArnList // required

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ export interface PutRetentionPolicyCommandOutput extends __MetadataBearer {}
3232
* configure the number of days for which to retain log events in the specified log
3333
* group.</p>
3434
* <note>
35-
* <p>CloudWatch Logs doesnt immediately delete log events when they reach their retention
35+
* <p>CloudWatch Logs doesn't immediately delete log events when they reach their retention
3636
* setting. It typically takes up to 72 hours after that before log events are deleted, but in
3737
* rare situations might take longer.</p>
3838
* <p>To illustrate, imagine that you change a log group to have a longer retention setting
39-
* when it contains log events that are past the expiration date, but havent been deleted.
39+
* when it contains log events that are past the expiration date, but haven't been deleted.
4040
* Those log events will take up to 72 hours to be deleted after the new retention date is
4141
* reached. To make sure that log data is deleted permanently, keep a log group at its lower
4242
* retention setting until 72 hours after the previous retention period ends. Alternatively,

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface TagLogGroupCommandOutput extends __MetadataBearer {}
3737
* To remove tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
3838
* <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>
3939
* in the <i>Amazon CloudWatch Logs User Guide</i>.</p>
40-
* <p>CloudWatch Logs doesnt support IAM policies that prevent users from assigning specified tags to
40+
* <p>CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified tags to
4141
* log groups using the <code>aws:Resource/<i>key-name</i>
4242
* </code> or <code>aws:TagKeys</code> condition keys.
4343
* For more information about using tags to control access, see

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export interface UntagLogGroupCommandOutput extends __MetadataBearer {}
3535
* <p>Removes the specified tags from the specified log group.</p>
3636
* <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>.
3737
* To add tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
38-
* <p>CloudWatch Logs doesnt support IAM policies that prevent users from assigning specified tags to
38+
* <p>CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified tags to
3939
* log groups using the <code>aws:Resource/<i>key-name</i>
4040
* </code> or <code>aws:TagKeys</code> condition keys.
4141
* </p>

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ export interface UpdateAnomalyCommandOutput extends __MetadataBearer {}
2929

3030
/**
3131
* <p>Use this operation to <i>suppress</i> anomaly detection for a specified anomaly or pattern. If you suppress
32-
* an anomaly, CloudWatch Logs wont report new occurrences of that anomaly and won't
32+
* an anomaly, CloudWatch Logs won't report new occurrences of that anomaly and won't
3333
* update that anomaly
34-
* with new data. If you suppress a pattern, CloudWatch Logs wont report any anomalies related to that pattern.</p>
34+
* with new data. If you suppress a pattern, CloudWatch Logs won't report any anomalies related to that pattern.</p>
3535
* <p>You must specify either <code>anomalyId</code> or <code>patternId</code>, but you can't specify both parameters in the
3636
* same operation.</p>
3737
* <p>If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause

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

+20-7
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,17 @@ export interface PatternToken {
175175
* @public
176176
*/
177177
enumerations?: Record<string, number>;
178+
179+
/**
180+
* <p>A name that CloudWatch Logs assigned to this dynamic token to make the pattern more readable. The string part of
181+
* the <code>inferredTokenName</code> gives you a clearer idea of the content of this token. The number part of
182+
* the <code>inferredTokenName</code> shows where in the pattern this token appears, compared to other dynamic tokens.
183+
* CloudWatch Logs assigns the string part of the name based on analyzing the content of the log events that contain it.</p>
184+
* <p>For example, an inferred token name of <code>IPAddress-3</code> means that the token represents an IP address, and this
185+
* token is the third dynamic token in the pattern.</p>
186+
* @public
187+
*/
188+
inferredTokenName?: string;
178189
}
179190

180191
/**
@@ -713,7 +724,7 @@ export interface ConfigurationTemplate {
713724
deliveryDestinationType?: DeliveryDestinationType;
714725

715726
/**
716-
* <p>A mapping that displays the default value of each property within a deliverys configuration,
727+
* <p>A mapping that displays the default value of each property within a delivery's configuration,
717728
* if it is not specified in the request.</p>
718729
* @public
719730
*/
@@ -792,7 +803,7 @@ export interface CreateDeliveryRequest {
792803

793804
/**
794805
* <p>The list of record fields to be delivered to the destination, in order.
795-
* If the deliverys log source has mandatory fields, they must be included in this list.</p>
806+
* If the delivery's log source has mandatory fields, they must be included in this list.</p>
796807
* @public
797808
*/
798809
recordFields?: string[];
@@ -805,7 +816,7 @@ export interface CreateDeliveryRequest {
805816
fieldDelimiter?: string;
806817

807818
/**
808-
* <p>This structure contains parameters that are valid only when the deliverys delivery destination is an S3 bucket.</p>
819+
* <p>This structure contains parameters that are valid only when the delivery's delivery destination is an S3 bucket.</p>
809820
* @public
810821
*/
811822
s3DeliveryConfiguration?: S3DeliveryConfiguration;
@@ -825,7 +836,7 @@ export interface CreateDeliveryRequest {
825836
* <p>A delivery is a connection between a logical <i>delivery source</i> and a logical
826837
* <i>delivery destination</i>.</p>
827838
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a>.</p>
828-
* <p>You can't update an existing delivery. You can only create and delete deliveries.</p>
839+
* <p>To update an existing delivery configuration, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a>.</p>
829840
* @public
830841
*/
831842
export interface Delivery {
@@ -1005,6 +1016,8 @@ export interface CreateExportTaskRequest {
10051016
/**
10061017
* <p>The prefix used as the start of the key for every object exported. If you don't
10071018
* specify a value, the default is <code>exportedlogs</code>.</p>
1019+
* <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,
1020+
* and can be up to 1,024 bytes.</p>
10081021
* @public
10091022
*/
10101023
destinationPrefix?: string;
@@ -5325,7 +5338,7 @@ export interface StartQueryRequest {
53255338

53265339
/**
53275340
* <p>The maximum number of log events to return in the query. If the query string uses the <code>fields</code> command,
5328-
* only the specified fields and their values are returned. The default is 1000.</p>
5341+
* only the specified fields and their values are returned. The default is 10,000.</p>
53295342
* @public
53305343
*/
53315344
limit?: number;
@@ -5634,7 +5647,7 @@ export interface UpdateDeliveryConfigurationRequest {
56345647

56355648
/**
56365649
* <p>The list of record fields to be delivered to the destination, in order.
5637-
* If the deliverys log source has mandatory fields, they must be included in this list.</p>
5650+
* If the delivery's log source has mandatory fields, they must be included in this list.</p>
56385651
* @public
56395652
*/
56405653
recordFields?: string[];
@@ -5647,7 +5660,7 @@ export interface UpdateDeliveryConfigurationRequest {
56475660
fieldDelimiter?: string;
56485661

56495662
/**
5650-
* <p>This structure contains parameters that are valid only when the deliverys delivery destination is an S3 bucket.</p>
5663+
* <p>This structure contains parameters that are valid only when the delivery's delivery destination is an S3 bucket.</p>
56515664
* @public
56525665
*/
56535666
s3DeliveryConfiguration?: S3DeliveryConfiguration;

0 commit comments

Comments
 (0)