Skip to content

Commit

Permalink
feat(client-cloudwatch-logs): Adding inferred token name for dynamic …
Browse files Browse the repository at this point in the history
…tokens in Anomalies.
  • Loading branch information
awstools committed Oct 25, 2024
1 parent 08bfafb commit 1429c43
Show file tree
Hide file tree
Showing 10 changed files with 9,941 additions and 9,913 deletions.
2 changes: 1 addition & 1 deletion clients/client-cloudwatch-logs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ into the log service. You can then access the raw log data when you need it.</p>

## Installing

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

- `npm install @aws-sdk/client-cloudwatch-logs`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export interface CreateDeliveryCommandOutput extends CreateDeliveryResponse, __M
* </ul>
* <p>You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You
* can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.</p>
* <p>You can't update an existing delivery. You can only create and delete deliveries.</p>
* <p>To update an existing delivery configuration, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export interface DescribeLogGroupsCommandOutput extends DescribeLogGroupsRespons
/**
* <p>Lists the specified log groups. You can list all your log groups or filter the results by prefix.
* The results are ASCII-sorted by log group name.</p>
* <p>CloudWatch Logs doesnt support IAM policies that control access to the <code>DescribeLogGroups</code> action by using the
* <p>CloudWatch Logs doesn't support IAM policies that control access to the <code>DescribeLogGroups</code> action by using the
* <code>aws:ResourceTag/<i>key-name</i>
* </code> condition key. Other CloudWatch Logs actions
* do support the use of the <code>aws:ResourceTag/<i>key-name</i>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ export interface ListAnomaliesCommandOutput extends ListAnomaliesResponse, __Met
* // enumerations: { // Enumerations
* // "<keys>": Number("long"),
* // },
* // inferredTokenName: "STRING_VALUE",
* // },
* // ],
* // logGroupArnList: [ // LogGroupArnList // required
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ export interface PutRetentionPolicyCommandOutput extends __MetadataBearer {}
* configure the number of days for which to retain log events in the specified log
* group.</p>
* <note>
* <p>CloudWatch Logs doesnt immediately delete log events when they reach their retention
* <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>To illustrate, imagine that you change a log group to have a longer retention setting
* when it contains log events that are past the expiration date, but havent been deleted.
* when it contains log events that are past the expiration date, but haven't been 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 after the previous retention period ends. Alternatively,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export interface TagLogGroupCommandOutput extends __MetadataBearer {}
* To remove tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
* <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>
* in the <i>Amazon CloudWatch Logs User Guide</i>.</p>
* <p>CloudWatch Logs doesnt support IAM policies that prevent users from assigning specified tags to
* <p>CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified tags to
* log groups using the <code>aws:Resource/<i>key-name</i>
* </code> or <code>aws:TagKeys</code> condition keys.
* For more information about using tags to control access, see
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export interface UntagLogGroupCommandOutput extends __MetadataBearer {}
* <p>Removes the specified tags from the specified log group.</p>
* <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>.
* To add tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
* <p>CloudWatch Logs doesnt support IAM policies that prevent users from assigning specified tags to
* <p>CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified tags to
* log groups using the <code>aws:Resource/<i>key-name</i>
* </code> or <code>aws:TagKeys</code> condition keys.
* </p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ export interface UpdateAnomalyCommandOutput extends __MetadataBearer {}

/**
* <p>Use this operation to <i>suppress</i> anomaly detection for a specified anomaly or pattern. If you suppress
* an anomaly, CloudWatch Logs wont report new occurrences of that anomaly and won't
* an anomaly, CloudWatch Logs won't report new occurrences of that anomaly and won't
* update that anomaly
* with new data. If you suppress a pattern, CloudWatch Logs wont report any anomalies related to that pattern.</p>
* with new data. If you suppress a pattern, CloudWatch Logs won't report any anomalies related to that pattern.</p>
* <p>You must specify either <code>anomalyId</code> or <code>patternId</code>, but you can't specify both parameters in the
* same operation.</p>
* <p>If you have previously used this operation to suppress detection of a pattern or anomaly, you can use it again to cause
Expand Down
27 changes: 20 additions & 7 deletions clients/client-cloudwatch-logs/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,17 @@ export interface PatternToken {
* @public
*/
enumerations?: Record<string, number>;

/**
* <p>A name that CloudWatch Logs assigned to this dynamic token to make the pattern more readable. The string part of
* the <code>inferredTokenName</code> gives you a clearer idea of the content of this token. The number part of
* the <code>inferredTokenName</code> shows where in the pattern this token appears, compared to other dynamic tokens.
* CloudWatch Logs assigns the string part of the name based on analyzing the content of the log events that contain it.</p>
* <p>For example, an inferred token name of <code>IPAddress-3</code> means that the token represents an IP address, and this
* token is the third dynamic token in the pattern.</p>
* @public
*/
inferredTokenName?: string;
}

/**
Expand Down Expand Up @@ -713,7 +724,7 @@ export interface ConfigurationTemplate {
deliveryDestinationType?: DeliveryDestinationType;

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

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

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

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

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

/**
* <p>This structure contains parameters that are valid only when the deliverys delivery destination is an S3 bucket.</p>
* <p>This structure contains parameters that are valid only when the delivery's delivery destination is an S3 bucket.</p>
* @public
*/
s3DeliveryConfiguration?: S3DeliveryConfiguration;
Expand Down
Loading

0 comments on commit 1429c43

Please sign in to comment.