@aws-sdk/client-cloudwatch-logs 3.845.0 → 3.847.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 +2 -2
- package/dist-cjs/index.js +8 -1
- package/dist-es/models/models_0.js +5 -0
- package/dist-types/CloudWatchLogs.d.ts +2 -2
- package/dist-types/CloudWatchLogsClient.d.ts +2 -2
- package/dist-types/commands/AssociateKmsKeyCommand.d.ts +30 -29
- package/dist-types/commands/CreateDeliveryCommand.d.ts +22 -25
- package/dist-types/commands/CreateExportTaskCommand.d.ts +10 -9
- package/dist-types/commands/CreateLogAnomalyDetectorCommand.d.ts +19 -25
- package/dist-types/commands/CreateLogGroupCommand.d.ts +5 -3
- package/dist-types/commands/CreateLogStreamCommand.d.ts +6 -5
- package/dist-types/commands/DeleteAccountPolicyCommand.d.ts +17 -12
- package/dist-types/commands/DeleteDeliveryCommand.d.ts +5 -3
- package/dist-types/commands/DeleteDeliveryDestinationCommand.d.ts +6 -4
- package/dist-types/commands/DeleteDeliveryDestinationPolicyCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDeliverySourceCommand.d.ts +6 -4
- package/dist-types/commands/DeleteDestinationCommand.d.ts +3 -3
- package/dist-types/commands/DeleteIndexPolicyCommand.d.ts +7 -6
- package/dist-types/commands/DeleteIntegrationCommand.d.ts +6 -5
- package/dist-types/commands/DeleteLogGroupCommand.d.ts +2 -2
- package/dist-types/commands/DeleteLogStreamCommand.d.ts +2 -2
- package/dist-types/commands/DeleteQueryDefinitionCommand.d.ts +2 -2
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +7 -2
- package/dist-types/commands/DeleteRetentionPolicyCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTransformerCommand.d.ts +6 -6
- package/dist-types/commands/DescribeAccountPoliciesCommand.d.ts +12 -8
- package/dist-types/commands/DescribeConfigurationTemplatesCommand.d.ts +5 -4
- package/dist-types/commands/DescribeDeliveriesCommand.d.ts +9 -11
- package/dist-types/commands/DescribeDeliveryDestinationsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeDestinationsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeExportTasksCommand.d.ts +2 -2
- package/dist-types/commands/DescribeFieldIndexesCommand.d.ts +2 -3
- package/dist-types/commands/DescribeIndexPoliciesCommand.d.ts +6 -6
- package/dist-types/commands/DescribeLogGroupsCommand.d.ts +13 -11
- package/dist-types/commands/DescribeLogStreamsCommand.d.ts +10 -10
- package/dist-types/commands/DescribeQueryDefinitionsCommand.d.ts +5 -4
- package/dist-types/commands/DescribeResourcePoliciesCommand.d.ts +5 -0
- package/dist-types/commands/DescribeSubscriptionFiltersCommand.d.ts +3 -2
- package/dist-types/commands/DisassociateKmsKeyCommand.d.ts +13 -13
- package/dist-types/commands/FilterLogEventsCommand.d.ts +31 -20
- package/dist-types/commands/GetDeliveryCommand.d.ts +12 -13
- package/dist-types/commands/GetDeliveryDestinationCommand.d.ts +1 -1
- package/dist-types/commands/GetDeliveryDestinationPolicyCommand.d.ts +2 -3
- package/dist-types/commands/GetLogEventsCommand.d.ts +25 -17
- package/dist-types/commands/GetLogGroupFieldsCommand.d.ts +8 -8
- package/dist-types/commands/GetQueryResultsCommand.d.ts +13 -11
- package/dist-types/commands/GetTransformerCommand.d.ts +2 -2
- package/dist-types/commands/ListAnomaliesCommand.d.ts +3 -2
- package/dist-types/commands/ListIntegrationsCommand.d.ts +3 -2
- package/dist-types/commands/ListLogGroupsCommand.d.ts +8 -7
- package/dist-types/commands/ListLogGroupsForQueryCommand.d.ts +6 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/ListTagsLogGroupCommand.d.ts +1 -1
- package/dist-types/commands/PutAccountPolicyCommand.d.ts +113 -98
- package/dist-types/commands/PutDataProtectionPolicyCommand.d.ts +20 -19
- package/dist-types/commands/PutDeliveryDestinationCommand.d.ts +28 -28
- package/dist-types/commands/PutDeliveryDestinationPolicyCommand.d.ts +18 -20
- package/dist-types/commands/PutDeliverySourceCommand.d.ts +23 -25
- package/dist-types/commands/PutDestinationCommand.d.ts +7 -6
- package/dist-types/commands/PutDestinationPolicyCommand.d.ts +4 -3
- package/dist-types/commands/PutIndexPolicyCommand.d.ts +24 -23
- package/dist-types/commands/PutIntegrationCommand.d.ts +8 -6
- package/dist-types/commands/PutLogEventsCommand.d.ts +27 -24
- package/dist-types/commands/PutMetricFilterCommand.d.ts +14 -18
- package/dist-types/commands/PutQueryDefinitionCommand.d.ts +3 -3
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +15 -3
- package/dist-types/commands/PutRetentionPolicyCommand.d.ts +4 -3
- package/dist-types/commands/PutSubscriptionFilterCommand.d.ts +11 -12
- package/dist-types/commands/PutTransformerCommand.d.ts +24 -19
- package/dist-types/commands/StartLiveTailCommand.d.ts +27 -28
- package/dist-types/commands/StartQueryCommand.d.ts +28 -30
- package/dist-types/commands/StopQueryCommand.d.ts +3 -2
- package/dist-types/commands/TagLogGroupCommand.d.ts +10 -10
- package/dist-types/commands/TagResourceCommand.d.ts +11 -10
- package/dist-types/commands/TestTransformerCommand.d.ts +3 -2
- package/dist-types/commands/UntagLogGroupCommand.d.ts +6 -7
- package/dist-types/commands/UpdateAnomalyCommand.d.ts +10 -9
- package/dist-types/commands/UpdateDeliveryConfigurationCommand.d.ts +3 -3
- package/dist-types/index.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +1441 -1201
- package/dist-types/ts3.4/models/models_0.d.ts +18 -1
- package/package.json +5 -5
|
@@ -40,7 +40,8 @@ declare const PutSubscriptionFilterCommand_base: {
|
|
|
40
40
|
* </li>
|
|
41
41
|
* <li>
|
|
42
42
|
* <p>A logical destination created with <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html">PutDestination</a> that belongs to a different account, for cross-account delivery.
|
|
43
|
-
* We currently support Kinesis Data Streams and Firehose as logical
|
|
43
|
+
* We currently support Kinesis Data Streams and Firehose as logical
|
|
44
|
+
* destinations.</p>
|
|
44
45
|
* </li>
|
|
45
46
|
* <li>
|
|
46
47
|
* <p>An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as
|
|
@@ -52,17 +53,15 @@ declare const PutSubscriptionFilterCommand_base: {
|
|
|
52
53
|
* </li>
|
|
53
54
|
* </ul>
|
|
54
55
|
* <p>Each log group can have up to two subscription filters associated with it. If you are
|
|
55
|
-
* updating an existing filter, you must specify the correct name in <code>filterName</code>.
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
* you must also have the
|
|
65
|
-
* <code>iam:PassRole</code> permission.</p>
|
|
56
|
+
* updating an existing filter, you must specify the correct name in <code>filterName</code>. </p>
|
|
57
|
+
* <p>Using regular expressions in filter patterns is supported. For these filters, there is a
|
|
58
|
+
* quotas of quota of two regular expression patterns within a single filter pattern. There is
|
|
59
|
+
* also a quota of five regular expression patterns per log group. For more information about
|
|
60
|
+
* using regular expressions in filter patterns, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html"> Filter pattern syntax for
|
|
61
|
+
* metric filters, subscription filters, filter log events, and Live Tail</a>.</p>
|
|
62
|
+
* <p>To perform a <code>PutSubscriptionFilter</code> operation for any destination except a
|
|
63
|
+
* Lambda function, you must also have the <code>iam:PassRole</code>
|
|
64
|
+
* permission.</p>
|
|
66
65
|
* @example
|
|
67
66
|
* Use a bare-bones client and the command you need to make an API call.
|
|
68
67
|
* ```javascript
|
|
@@ -27,26 +27,31 @@ declare const PutTransformerCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates or updates a <i>log transformer</i> for a single log group. You use
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
* <p>After you have created a transformer,
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
30
|
+
* <p>Creates or updates a <i>log transformer</i> for a single log group. You use
|
|
31
|
+
* log transformers to transform log events into a different format, making them easier for you
|
|
32
|
+
* to process and analyze. You can also transform logs from different sources into standardized
|
|
33
|
+
* formats that contains relevant, source-specific information.</p>
|
|
34
|
+
* <p>After you have created a transformer, CloudWatch Logs performs the transformations at
|
|
35
|
+
* the time of log ingestion. You can then refer to the transformed versions of the logs during
|
|
36
|
+
* operations such as querying with CloudWatch Logs Insights or creating metric filters or
|
|
37
|
+
* subscription filers.</p>
|
|
38
|
+
* <p>You can also use a transformer to copy metadata from metadata keys into the log events
|
|
39
|
+
* themselves. This metadata can include log group name, log stream name, account ID and
|
|
40
|
+
* Region.</p>
|
|
41
|
+
* <p>A transformer for a log group is a series of processors, where each processor applies one
|
|
42
|
+
* type of transformation to the log events ingested into this log group. The processors work one
|
|
43
|
+
* after another, in the order that you list them, like a pipeline. For more information about
|
|
44
|
+
* the available processors to use in a transformer, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-Processors"> Processors that you can use</a>.</p>
|
|
45
|
+
* <p>Having log events in standardized format enables visibility across your applications for
|
|
46
|
+
* your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation
|
|
47
|
+
* for common log types with out-of-the-box transformation templates for major Amazon Web Services
|
|
48
|
+
* log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use
|
|
49
|
+
* pre-built transformation templates or create custom transformation policies.</p>
|
|
45
50
|
* <p>You can create transformers only for the log groups in the Standard log class.</p>
|
|
46
|
-
* <p>You can also set up a transformer at the account level. For more information, see
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
51
|
+
* <p>You can also set up a transformer at the account level. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html">PutAccountPolicy</a>. If there is both a log-group level transformer created with
|
|
52
|
+
* <code>PutTransformer</code> and an account-level transformer that could apply to the same
|
|
53
|
+
* log group, the log group uses only the log-group level transformer. It ignores the
|
|
54
|
+
* account-level transformer.</p>
|
|
50
55
|
* @example
|
|
51
56
|
* Use a bare-bones client and the command you need to make an API call.
|
|
52
57
|
* ```javascript
|
|
@@ -27,51 +27,50 @@ declare const StartLiveTailCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Starts a Live Tail streaming session for one or more log groups. A Live Tail session
|
|
31
|
-
* log events that have
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* the server sends live log events and the client receives them.</p>
|
|
30
|
+
* <p>Starts a Live Tail streaming session for one or more log groups. A Live Tail session
|
|
31
|
+
* returns a stream of log events that have been recently ingested in the log groups. For more
|
|
32
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs_LiveTail.html">Use Live Tail to view logs
|
|
33
|
+
* in near real time</a>. </p>
|
|
34
|
+
* <p>The response to this operation is a response stream, over which the server sends live log
|
|
35
|
+
* events and the client receives them.</p>
|
|
37
36
|
* <p>The following objects are sent over the stream:</p>
|
|
38
37
|
* <ul>
|
|
39
38
|
* <li>
|
|
40
|
-
* <p>A single <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_LiveTailSessionStart.html">LiveTailSessionStart</a>
|
|
41
|
-
* object is sent at the start of the session.</p>
|
|
39
|
+
* <p>A single <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_LiveTailSessionStart.html">LiveTailSessionStart</a> object is sent at the start of the session.</p>
|
|
42
40
|
* </li>
|
|
43
41
|
* <li>
|
|
44
|
-
* <p>Every second, a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_LiveTailSessionUpdate.html">LiveTailSessionUpdate</a>
|
|
45
|
-
*
|
|
42
|
+
* <p>Every second, a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_LiveTailSessionUpdate.html">LiveTailSessionUpdate</a> object is sent. Each of these objects contains an array
|
|
43
|
+
* of the actual log events.</p>
|
|
46
44
|
* <p>If no new log events were ingested in the past second, the
|
|
47
|
-
*
|
|
45
|
+
* <code>LiveTailSessionUpdate</code> object will contain an empty array.</p>
|
|
48
46
|
* <p>The array of log events contained in a <code>LiveTailSessionUpdate</code> can include
|
|
49
|
-
* as many as 500 log events. If the number of log events matching the request exceeds 500
|
|
50
|
-
* log events are sampled down to 500 log events to be included in each
|
|
51
|
-
*
|
|
52
|
-
*
|
|
53
|
-
* which it starts dropping the oldest events.</p>
|
|
47
|
+
* as many as 500 log events. If the number of log events matching the request exceeds 500
|
|
48
|
+
* per second, the log events are sampled down to 500 log events to be included in each
|
|
49
|
+
* <code>LiveTailSessionUpdate</code> object.</p>
|
|
50
|
+
* <p>If your client consumes the log events slower than the server produces them, CloudWatch Logs buffers up to 10 <code>LiveTailSessionUpdate</code> events or 5000 log
|
|
51
|
+
* events, after which it starts dropping the oldest events.</p>
|
|
54
52
|
* </li>
|
|
55
53
|
* <li>
|
|
56
|
-
* <p>A <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTailResponseStream.html#CWL-Type-StartLiveTailResponseStream-SessionStreamingException">SessionStreamingException</a>
|
|
57
|
-
*
|
|
54
|
+
* <p>A <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTailResponseStream.html#CWL-Type-StartLiveTailResponseStream-SessionStreamingException">SessionStreamingException</a> object is returned if an unknown error occurs on the
|
|
55
|
+
* server side.</p>
|
|
58
56
|
* </li>
|
|
59
57
|
* <li>
|
|
60
|
-
* <p>A <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTailResponseStream.html#CWL-Type-StartLiveTailResponseStream-SessionTimeoutException">SessionTimeoutException</a>
|
|
61
|
-
*
|
|
58
|
+
* <p>A <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTailResponseStream.html#CWL-Type-StartLiveTailResponseStream-SessionTimeoutException">SessionTimeoutException</a> object is returned when the session times out, after it
|
|
59
|
+
* has been kept open for three hours.</p>
|
|
62
60
|
* </li>
|
|
63
61
|
* </ul>
|
|
64
62
|
* <note>
|
|
65
|
-
* <p>The <code>StartLiveTail</code> API routes requests to
|
|
66
|
-
*
|
|
63
|
+
* <p>The <code>StartLiveTail</code> API routes requests to
|
|
64
|
+
* <code>streaming-logs.<i>Region</i>.amazonaws.com</code> using SDK host
|
|
65
|
+
* prefix injection. VPC endpoint support is not available for this API.</p>
|
|
67
66
|
* </note>
|
|
68
67
|
* <important>
|
|
69
|
-
* <p>You can end a session before it times out by closing the session stream or by closing
|
|
70
|
-
*
|
|
68
|
+
* <p>You can end a session before it times out by closing the session stream or by closing
|
|
69
|
+
* the client that is receiving the stream. The session also ends if the established connection
|
|
70
|
+
* between the client and the server breaks.</p>
|
|
71
71
|
* </important>
|
|
72
|
-
* <p>For examples of using an SDK to start a Live Tail session, see
|
|
73
|
-
*
|
|
74
|
-
* Start a Live Tail session using an Amazon Web Services SDK</a>.</p>
|
|
72
|
+
* <p>For examples of using an SDK to start a Live Tail session, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/example_cloudwatch-logs_StartLiveTail_section.html"> Start
|
|
73
|
+
* a Live Tail session using an Amazon Web Services SDK</a>.</p>
|
|
75
74
|
* @example
|
|
76
75
|
* Use a bare-bones client and the command you need to make an API call.
|
|
77
76
|
* ```javascript
|
|
@@ -27,43 +27,42 @@ declare const StartQueryCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Starts a query of one or more log groups using CloudWatch Logs Insights. You specify
|
|
31
|
-
* and time range to query and the query string to use.</p>
|
|
32
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
30
|
+
* <p>Starts a query of one or more log groups using CloudWatch Logs Insights. You specify
|
|
31
|
+
* the log groups and time range to query and the query string to use.</p>
|
|
32
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query
|
|
33
|
+
* Syntax</a>.</p>
|
|
34
|
+
* <p>After you run a query using <code>StartQuery</code>, the query results are stored by
|
|
35
|
+
* CloudWatch Logs. You can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html">GetQueryResults</a> to retrieve the results of a query, using the <code>queryId</code>
|
|
36
|
+
* that <code>StartQuery</code> returns. </p>
|
|
37
37
|
* <note>
|
|
38
|
-
* <p>To specify the log groups to query, a <code>StartQuery</code> operation must include one
|
|
38
|
+
* <p>To specify the log groups to query, a <code>StartQuery</code> operation must include one
|
|
39
|
+
* of the following:</p>
|
|
39
40
|
* <ul>
|
|
40
41
|
* <li>
|
|
41
|
-
* <p>Either exactly one of the following
|
|
42
|
-
*
|
|
43
|
-
* <code>logGroupIdentifiers</code>
|
|
42
|
+
* <p>Either exactly one of the following parameters: <code>logGroupName</code>,
|
|
43
|
+
* <code>logGroupNames</code>, or <code>logGroupIdentifiers</code>
|
|
44
44
|
* </p>
|
|
45
45
|
* </li>
|
|
46
46
|
* <li>
|
|
47
|
-
* <p>Or the <code>queryString</code> must include a <code>SOURCE</code> command to select
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
*
|
|
47
|
+
* <p>Or the <code>queryString</code> must include a <code>SOURCE</code> command to select
|
|
48
|
+
* log groups for the query. The <code>SOURCE</code> command can select log groups based on
|
|
49
|
+
* log group name prefix, account ID, and log class.
|
|
50
|
+
* </p>
|
|
51
|
+
* <p>For more information about the <code>SOURCE</code> command, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax-Source.html">SOURCE</a>.</p>
|
|
52
52
|
* </li>
|
|
53
53
|
* </ul>
|
|
54
54
|
* </note>
|
|
55
|
-
* <p>If you have associated a KMS key with the query results in this
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
55
|
+
* <p>If you have associated a KMS key with the query results in this
|
|
56
|
+
* account, then <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> uses
|
|
57
|
+
* that key to encrypt the results when it stores them. If no key is associated with query
|
|
58
|
+
* results, the query results are encrypted with the default CloudWatch Logs encryption
|
|
59
|
+
* method.</p>
|
|
60
60
|
* <p>Queries time out after 60 minutes of runtime. If your queries are timing out, reduce the
|
|
61
61
|
* time range being searched or partition your query into a number of queries.</p>
|
|
62
|
-
* <p>If you are using CloudWatch cross-account observability, you can use this operation
|
|
63
|
-
* monitoring account to start a query in a linked source account. For more information, see
|
|
64
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch
|
|
65
|
-
*
|
|
66
|
-
* the query definition must be defined in the monitoring account.</p>
|
|
62
|
+
* <p>If you are using CloudWatch cross-account observability, you can use this operation
|
|
63
|
+
* in a monitoring account to start a query in a linked source account. For more information, see
|
|
64
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>. For a cross-account <code>StartQuery</code>
|
|
65
|
+
* operation, the query definition must be defined in the monitoring account.</p>
|
|
67
66
|
* <p>You can have up to 30 concurrent CloudWatch Logs insights queries, including queries
|
|
68
67
|
* that have been added to dashboards. </p>
|
|
69
68
|
* @example
|
|
@@ -108,10 +107,9 @@ declare const StartQueryCommand_base: {
|
|
|
108
107
|
*
|
|
109
108
|
* @throws {@link MalformedQueryException} (client fault)
|
|
110
109
|
* <p>The query string is not valid. Details about this error are displayed in a
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query Syntax</a>.</p>
|
|
110
|
+
* <code>QueryCompileError</code> object. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_QueryCompileError.html">QueryCompileError</a>.</p>
|
|
111
|
+
* <p>For more information about valid query syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query
|
|
112
|
+
* Syntax</a>.</p>
|
|
115
113
|
*
|
|
116
114
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
117
115
|
* <p>The specified resource does not exist.</p>
|
|
@@ -27,8 +27,9 @@ declare const StopQueryCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Stops a CloudWatch Logs Insights query that is in progress. If the query has already
|
|
31
|
-
*
|
|
30
|
+
* <p>Stops a CloudWatch Logs Insights query that is in progress. If the query has already
|
|
31
|
+
* ended, the operation returns an error indicating that the specified query is not
|
|
32
|
+
* running.</p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -29,18 +29,18 @@ declare const TagLogGroupCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <important>
|
|
31
31
|
* <p>The TagLogGroup operation is on the path to deprecation. We recommend that you use
|
|
32
|
-
*
|
|
32
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html">TagResource</a>
|
|
33
|
+
* instead.</p>
|
|
33
34
|
* </important>
|
|
34
35
|
* <p>Adds or updates the specified tags for the specified log group.</p>
|
|
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
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Controlling access to Amazon Web Services resources using tags</a>.</p>
|
|
36
|
+
* <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 remove tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
|
|
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> in the <i>Amazon CloudWatch Logs
|
|
38
|
+
* User Guide</i>.</p>
|
|
39
|
+
* <p>CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified
|
|
40
|
+
* tags to log groups using the <code>aws:Resource/<i>key-name</i>
|
|
41
|
+
* </code> or
|
|
42
|
+
* <code>aws:TagKeys</code> condition keys. For more information about using tags to control
|
|
43
|
+
* access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Controlling access to Amazon Web Services resources using tags</a>.</p>
|
|
44
44
|
*
|
|
45
45
|
* @deprecated Please use the generic tagging API TagResource
|
|
46
46
|
* @example
|
|
@@ -28,16 +28,17 @@ declare const TagResourceCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource.
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* <p>Tags can help you organize and categorize your resources. You can also use them to scope
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
31
|
+
* Currently, the only CloudWatch Logs resources that can be tagged are log groups and
|
|
32
|
+
* destinations. </p>
|
|
33
|
+
* <p>Tags can help you organize and categorize your resources. You can also use them to scope
|
|
34
|
+
* user permissions by granting a user permission to access or change only resources with certain
|
|
35
|
+
* tag values.</p>
|
|
36
|
+
* <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as
|
|
37
|
+
* strings of characters.</p>
|
|
38
|
+
* <p>You can use the <code>TagResource</code> action with a resource that already has tags. If
|
|
39
|
+
* you specify a new tag key for the alarm, this tag is appended to the list of tags associated
|
|
40
|
+
* with the alarm. If you specify a tag key that is already associated with the alarm, the new
|
|
41
|
+
* tag value that you specify replaces the previous value for that tag.</p>
|
|
41
42
|
* <p>You can associate as many as 50 tags with a CloudWatch Logs resource.</p>
|
|
42
43
|
* @example
|
|
43
44
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -27,8 +27,9 @@ declare const TestTransformerCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Use this operation to test a log transformer. You enter the transformer configuration and
|
|
31
|
-
*
|
|
30
|
+
* <p>Use this operation to test a log transformer. You enter the transformer configuration and
|
|
31
|
+
* a set of log events to test with. The operation responds with an array that includes the
|
|
32
|
+
* original log events and the transformed versions.</p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
35
|
* ```javascript
|
|
@@ -29,15 +29,14 @@ declare const UntagLogGroupCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <important>
|
|
31
31
|
* <p>The UntagLogGroup operation is on the path to deprecation. We recommend that you use
|
|
32
|
-
*
|
|
32
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html">UntagResource</a> instead.</p>
|
|
33
33
|
* </important>
|
|
34
34
|
* <p>Removes the specified tags from the specified log group.</p>
|
|
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
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
* </p>
|
|
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>. To add tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
|
|
36
|
+
* <p>CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified
|
|
37
|
+
* tags to log groups using the <code>aws:Resource/<i>key-name</i>
|
|
38
|
+
* </code> or
|
|
39
|
+
* <code>aws:TagKeys</code> condition keys. </p>
|
|
41
40
|
*
|
|
42
41
|
* @deprecated Please use the generic tagging API UntagResource
|
|
43
42
|
* @example
|
|
@@ -27,15 +27,16 @@ declare const UpdateAnomalyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Use this operation to <i>suppress</i> anomaly detection for a specified
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
* <p>You must specify either <code>anomalyId</code> or <code>patternId</code>, but you can't
|
|
35
|
-
*
|
|
36
|
-
* <p>If you have previously used this operation to suppress detection of a pattern or anomaly,
|
|
37
|
-
*
|
|
38
|
-
*
|
|
30
|
+
* <p>Use this operation to <i>suppress</i> anomaly detection for a specified
|
|
31
|
+
* anomaly or pattern. If you suppress an anomaly, CloudWatch Logs won't report new
|
|
32
|
+
* occurrences of that anomaly and won't update that anomaly with new data. If you suppress a
|
|
33
|
+
* pattern, CloudWatch Logs won't report any anomalies related to that pattern.</p>
|
|
34
|
+
* <p>You must specify either <code>anomalyId</code> or <code>patternId</code>, but you can't
|
|
35
|
+
* specify both parameters in the same operation.</p>
|
|
36
|
+
* <p>If you have previously used this operation to suppress detection of a pattern or anomaly,
|
|
37
|
+
* you can use it again to cause CloudWatch Logs to end the suppression. To do this, use this
|
|
38
|
+
* operation and specify the anomaly or pattern to stop suppressing, and omit the
|
|
39
|
+
* <code>suppressionType</code> and <code>suppressionPeriod</code> parameters.</p>
|
|
39
40
|
* @example
|
|
40
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
42
|
* ```javascript
|
|
@@ -27,9 +27,9 @@ declare const UpdateDeliveryConfigurationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Use this operation to update the configuration of a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_Delivery.html">delivery</a> to change
|
|
31
|
-
* S3 path pattern or the format of the delivered logs. You can't use this operation
|
|
32
|
-
* source or destination of the delivery.</p>
|
|
30
|
+
* <p>Use this operation to update the configuration of a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_Delivery.html">delivery</a> to change
|
|
31
|
+
* either the S3 path pattern or the format of the delivered logs. You can't use this operation
|
|
32
|
+
* to change the source or destination of the delivery.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
package/dist-types/index.d.ts
CHANGED
|
@@ -21,8 +21,8 @@
|
|
|
21
21
|
* </li>
|
|
22
22
|
* <li>
|
|
23
23
|
* <p>
|
|
24
|
-
* <b>Monitor CloudTrail logged events</b>: You
|
|
25
|
-
* create alarms in CloudWatch and receive notifications of particular API activity as
|
|
24
|
+
* <b>Monitor CloudTrail logged events</b>: You
|
|
25
|
+
* can create alarms in CloudWatch and receive notifications of particular API activity as
|
|
26
26
|
* captured by CloudTrail. You can use the notification to perform troubleshooting.</p>
|
|
27
27
|
* </li>
|
|
28
28
|
* <li>
|