@aws-sdk/client-cloudwatch-logs 3.216.0 → 3.218.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 +15 -14
- package/dist-cjs/CloudWatchLogs.js +45 -0
- package/dist-cjs/commands/DeleteDataProtectionPolicyCommand.js +46 -0
- package/dist-cjs/commands/GetDataProtectionPolicyCommand.js +46 -0
- package/dist-cjs/commands/PutDataProtectionPolicyCommand.js +46 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/endpoint/ruleset.js +5 -5
- package/dist-cjs/models/models_0.js +30 -3
- package/dist-cjs/protocols/Aws_json1_1.js +221 -2
- package/dist-es/CloudWatchLogs.js +45 -0
- package/dist-es/commands/DeleteDataProtectionPolicyCommand.js +42 -0
- package/dist-es/commands/GetDataProtectionPolicyCommand.js +42 -0
- package/dist-es/commands/PutDataProtectionPolicyCommand.js +42 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/endpoint/ruleset.js +5 -5
- package/dist-es/models/models_0.js +22 -0
- package/dist-es/protocols/Aws_json1_1.js +213 -0
- package/dist-types/CloudWatchLogs.d.ts +184 -114
- package/dist-types/CloudWatchLogsClient.d.ts +20 -16
- package/dist-types/commands/AssociateKmsKeyCommand.d.ts +11 -10
- package/dist-types/commands/CreateExportTaskCommand.d.ts +11 -11
- package/dist-types/commands/CreateLogGroupCommand.d.ts +14 -12
- package/dist-types/commands/CreateLogStreamCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDataProtectionPolicyCommand.d.ts +38 -0
- package/dist-types/commands/DescribeLogGroupsCommand.d.ts +3 -0
- package/dist-types/commands/DescribeLogStreamsCommand.d.ts +3 -0
- package/dist-types/commands/DescribeQueriesCommand.d.ts +3 -3
- package/dist-types/commands/DisassociateKmsKeyCommand.d.ts +5 -3
- package/dist-types/commands/FilterLogEventsCommand.d.ts +8 -4
- package/dist-types/commands/GetDataProtectionPolicyCommand.d.ts +37 -0
- package/dist-types/commands/GetLogEventsCommand.d.ts +4 -0
- package/dist-types/commands/GetLogGroupFieldsCommand.d.ts +10 -6
- package/dist-types/commands/GetQueryResultsCommand.d.ts +4 -2
- package/dist-types/commands/PutDataProtectionPolicyCommand.d.ts +51 -0
- package/dist-types/commands/PutDestinationCommand.d.ts +3 -3
- package/dist-types/commands/PutLogEventsCommand.d.ts +11 -8
- package/dist-types/commands/PutMetricFilterCommand.d.ts +5 -5
- package/dist-types/commands/PutQueryDefinitionCommand.d.ts +7 -7
- package/dist-types/commands/PutRetentionPolicyCommand.d.ts +11 -10
- package/dist-types/commands/PutSubscriptionFilterCommand.d.ts +10 -11
- package/dist-types/commands/StartQueryCommand.d.ts +9 -4
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +369 -115
- package/dist-types/protocols/Aws_json1_1.d.ts +9 -0
- package/dist-types/ts3.4/CloudWatchLogs.d.ts +51 -0
- package/dist-types/ts3.4/CloudWatchLogsClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/DeleteDataProtectionPolicyCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/GetDataProtectionPolicyCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/PutDataProtectionPolicyCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +53 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
- package/package.json +3 -3
|
@@ -12,6 +12,7 @@ import { CancelExportTaskCommandInput, CancelExportTaskCommandOutput } from "./c
|
|
|
12
12
|
import { CreateExportTaskCommandInput, CreateExportTaskCommandOutput } from "./commands/CreateExportTaskCommand";
|
|
13
13
|
import { CreateLogGroupCommandInput, CreateLogGroupCommandOutput } from "./commands/CreateLogGroupCommand";
|
|
14
14
|
import { CreateLogStreamCommandInput, CreateLogStreamCommandOutput } from "./commands/CreateLogStreamCommand";
|
|
15
|
+
import { DeleteDataProtectionPolicyCommandInput, DeleteDataProtectionPolicyCommandOutput } from "./commands/DeleteDataProtectionPolicyCommand";
|
|
15
16
|
import { DeleteDestinationCommandInput, DeleteDestinationCommandOutput } from "./commands/DeleteDestinationCommand";
|
|
16
17
|
import { DeleteLogGroupCommandInput, DeleteLogGroupCommandOutput } from "./commands/DeleteLogGroupCommand";
|
|
17
18
|
import { DeleteLogStreamCommandInput, DeleteLogStreamCommandOutput } from "./commands/DeleteLogStreamCommand";
|
|
@@ -31,12 +32,14 @@ import { DescribeResourcePoliciesCommandInput, DescribeResourcePoliciesCommandOu
|
|
|
31
32
|
import { DescribeSubscriptionFiltersCommandInput, DescribeSubscriptionFiltersCommandOutput } from "./commands/DescribeSubscriptionFiltersCommand";
|
|
32
33
|
import { DisassociateKmsKeyCommandInput, DisassociateKmsKeyCommandOutput } from "./commands/DisassociateKmsKeyCommand";
|
|
33
34
|
import { FilterLogEventsCommandInput, FilterLogEventsCommandOutput } from "./commands/FilterLogEventsCommand";
|
|
35
|
+
import { GetDataProtectionPolicyCommandInput, GetDataProtectionPolicyCommandOutput } from "./commands/GetDataProtectionPolicyCommand";
|
|
34
36
|
import { GetLogEventsCommandInput, GetLogEventsCommandOutput } from "./commands/GetLogEventsCommand";
|
|
35
37
|
import { GetLogGroupFieldsCommandInput, GetLogGroupFieldsCommandOutput } from "./commands/GetLogGroupFieldsCommand";
|
|
36
38
|
import { GetLogRecordCommandInput, GetLogRecordCommandOutput } from "./commands/GetLogRecordCommand";
|
|
37
39
|
import { GetQueryResultsCommandInput, GetQueryResultsCommandOutput } from "./commands/GetQueryResultsCommand";
|
|
38
40
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
39
41
|
import { ListTagsLogGroupCommandInput, ListTagsLogGroupCommandOutput } from "./commands/ListTagsLogGroupCommand";
|
|
42
|
+
import { PutDataProtectionPolicyCommandInput, PutDataProtectionPolicyCommandOutput } from "./commands/PutDataProtectionPolicyCommand";
|
|
40
43
|
import { PutDestinationCommandInput, PutDestinationCommandOutput } from "./commands/PutDestinationCommand";
|
|
41
44
|
import { PutDestinationPolicyCommandInput, PutDestinationPolicyCommandOutput } from "./commands/PutDestinationPolicyCommand";
|
|
42
45
|
import { PutLogEventsCommandInput, PutLogEventsCommandOutput } from "./commands/PutLogEventsCommand";
|
|
@@ -53,8 +56,8 @@ import { TestMetricFilterCommandInput, TestMetricFilterCommandOutput } from "./c
|
|
|
53
56
|
import { UntagLogGroupCommandInput, UntagLogGroupCommandOutput } from "./commands/UntagLogGroupCommand";
|
|
54
57
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
55
58
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
56
|
-
export declare type ServiceInputTypes = AssociateKmsKeyCommandInput | CancelExportTaskCommandInput | CreateExportTaskCommandInput | CreateLogGroupCommandInput | CreateLogStreamCommandInput | DeleteDestinationCommandInput | DeleteLogGroupCommandInput | DeleteLogStreamCommandInput | DeleteMetricFilterCommandInput | DeleteQueryDefinitionCommandInput | DeleteResourcePolicyCommandInput | DeleteRetentionPolicyCommandInput | DeleteSubscriptionFilterCommandInput | DescribeDestinationsCommandInput | DescribeExportTasksCommandInput | DescribeLogGroupsCommandInput | DescribeLogStreamsCommandInput | DescribeMetricFiltersCommandInput | DescribeQueriesCommandInput | DescribeQueryDefinitionsCommandInput | DescribeResourcePoliciesCommandInput | DescribeSubscriptionFiltersCommandInput | DisassociateKmsKeyCommandInput | FilterLogEventsCommandInput | GetLogEventsCommandInput | GetLogGroupFieldsCommandInput | GetLogRecordCommandInput | GetQueryResultsCommandInput | ListTagsForResourceCommandInput | ListTagsLogGroupCommandInput | PutDestinationCommandInput | PutDestinationPolicyCommandInput | PutLogEventsCommandInput | PutMetricFilterCommandInput | PutQueryDefinitionCommandInput | PutResourcePolicyCommandInput | PutRetentionPolicyCommandInput | PutSubscriptionFilterCommandInput | StartQueryCommandInput | StopQueryCommandInput | TagLogGroupCommandInput | TagResourceCommandInput | TestMetricFilterCommandInput | UntagLogGroupCommandInput | UntagResourceCommandInput;
|
|
57
|
-
export declare type ServiceOutputTypes = AssociateKmsKeyCommandOutput | CancelExportTaskCommandOutput | CreateExportTaskCommandOutput | CreateLogGroupCommandOutput | CreateLogStreamCommandOutput | DeleteDestinationCommandOutput | DeleteLogGroupCommandOutput | DeleteLogStreamCommandOutput | DeleteMetricFilterCommandOutput | DeleteQueryDefinitionCommandOutput | DeleteResourcePolicyCommandOutput | DeleteRetentionPolicyCommandOutput | DeleteSubscriptionFilterCommandOutput | DescribeDestinationsCommandOutput | DescribeExportTasksCommandOutput | DescribeLogGroupsCommandOutput | DescribeLogStreamsCommandOutput | DescribeMetricFiltersCommandOutput | DescribeQueriesCommandOutput | DescribeQueryDefinitionsCommandOutput | DescribeResourcePoliciesCommandOutput | DescribeSubscriptionFiltersCommandOutput | DisassociateKmsKeyCommandOutput | FilterLogEventsCommandOutput | GetLogEventsCommandOutput | GetLogGroupFieldsCommandOutput | GetLogRecordCommandOutput | GetQueryResultsCommandOutput | ListTagsForResourceCommandOutput | ListTagsLogGroupCommandOutput | PutDestinationCommandOutput | PutDestinationPolicyCommandOutput | PutLogEventsCommandOutput | PutMetricFilterCommandOutput | PutQueryDefinitionCommandOutput | PutResourcePolicyCommandOutput | PutRetentionPolicyCommandOutput | PutSubscriptionFilterCommandOutput | StartQueryCommandOutput | StopQueryCommandOutput | TagLogGroupCommandOutput | TagResourceCommandOutput | TestMetricFilterCommandOutput | UntagLogGroupCommandOutput | UntagResourceCommandOutput;
|
|
59
|
+
export declare type ServiceInputTypes = AssociateKmsKeyCommandInput | CancelExportTaskCommandInput | CreateExportTaskCommandInput | CreateLogGroupCommandInput | CreateLogStreamCommandInput | DeleteDataProtectionPolicyCommandInput | DeleteDestinationCommandInput | DeleteLogGroupCommandInput | DeleteLogStreamCommandInput | DeleteMetricFilterCommandInput | DeleteQueryDefinitionCommandInput | DeleteResourcePolicyCommandInput | DeleteRetentionPolicyCommandInput | DeleteSubscriptionFilterCommandInput | DescribeDestinationsCommandInput | DescribeExportTasksCommandInput | DescribeLogGroupsCommandInput | DescribeLogStreamsCommandInput | DescribeMetricFiltersCommandInput | DescribeQueriesCommandInput | DescribeQueryDefinitionsCommandInput | DescribeResourcePoliciesCommandInput | DescribeSubscriptionFiltersCommandInput | DisassociateKmsKeyCommandInput | FilterLogEventsCommandInput | GetDataProtectionPolicyCommandInput | GetLogEventsCommandInput | GetLogGroupFieldsCommandInput | GetLogRecordCommandInput | GetQueryResultsCommandInput | ListTagsForResourceCommandInput | ListTagsLogGroupCommandInput | PutDataProtectionPolicyCommandInput | PutDestinationCommandInput | PutDestinationPolicyCommandInput | PutLogEventsCommandInput | PutMetricFilterCommandInput | PutQueryDefinitionCommandInput | PutResourcePolicyCommandInput | PutRetentionPolicyCommandInput | PutSubscriptionFilterCommandInput | StartQueryCommandInput | StopQueryCommandInput | TagLogGroupCommandInput | TagResourceCommandInput | TestMetricFilterCommandInput | UntagLogGroupCommandInput | UntagResourceCommandInput;
|
|
60
|
+
export declare type ServiceOutputTypes = AssociateKmsKeyCommandOutput | CancelExportTaskCommandOutput | CreateExportTaskCommandOutput | CreateLogGroupCommandOutput | CreateLogStreamCommandOutput | DeleteDataProtectionPolicyCommandOutput | DeleteDestinationCommandOutput | DeleteLogGroupCommandOutput | DeleteLogStreamCommandOutput | DeleteMetricFilterCommandOutput | DeleteQueryDefinitionCommandOutput | DeleteResourcePolicyCommandOutput | DeleteRetentionPolicyCommandOutput | DeleteSubscriptionFilterCommandOutput | DescribeDestinationsCommandOutput | DescribeExportTasksCommandOutput | DescribeLogGroupsCommandOutput | DescribeLogStreamsCommandOutput | DescribeMetricFiltersCommandOutput | DescribeQueriesCommandOutput | DescribeQueryDefinitionsCommandOutput | DescribeResourcePoliciesCommandOutput | DescribeSubscriptionFiltersCommandOutput | DisassociateKmsKeyCommandOutput | FilterLogEventsCommandOutput | GetDataProtectionPolicyCommandOutput | GetLogEventsCommandOutput | GetLogGroupFieldsCommandOutput | GetLogRecordCommandOutput | GetQueryResultsCommandOutput | ListTagsForResourceCommandOutput | ListTagsLogGroupCommandOutput | PutDataProtectionPolicyCommandOutput | PutDestinationCommandOutput | PutDestinationPolicyCommandOutput | PutLogEventsCommandOutput | PutMetricFilterCommandOutput | PutQueryDefinitionCommandOutput | PutResourcePolicyCommandOutput | PutRetentionPolicyCommandOutput | PutSubscriptionFilterCommandOutput | StartQueryCommandOutput | StopQueryCommandOutput | TagLogGroupCommandOutput | TagResourceCommandOutput | TestMetricFilterCommandOutput | UntagLogGroupCommandOutput | UntagResourceCommandOutput;
|
|
58
61
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
59
62
|
/**
|
|
60
63
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -170,22 +173,23 @@ export interface CloudWatchLogsClientResolvedConfig extends CloudWatchLogsClient
|
|
|
170
173
|
/**
|
|
171
174
|
* <p>You can use Amazon CloudWatch Logs to monitor, store, and access your log files from
|
|
172
175
|
* EC2 instances, CloudTrail, and other sources. You can then retrieve the associated
|
|
173
|
-
* log data from CloudWatch Logs using the CloudWatch console,
|
|
174
|
-
* Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch
|
|
176
|
+
* log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use
|
|
177
|
+
* CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch
|
|
178
|
+
* Logs SDK.</p>
|
|
175
179
|
* <p>You can use CloudWatch Logs to:</p>
|
|
176
180
|
* <ul>
|
|
177
181
|
* <li>
|
|
178
182
|
* <p>
|
|
179
|
-
* <b>Monitor logs from EC2 instances in real
|
|
183
|
+
* <b>Monitor logs from EC2 instances in real time</b>: You
|
|
180
184
|
* can use CloudWatch Logs to monitor applications and systems using log data. For example,
|
|
181
|
-
* CloudWatch Logs can track the number of errors that occur in your application logs
|
|
182
|
-
* send you a notification whenever the rate of errors exceeds a threshold that you
|
|
183
|
-
* CloudWatch Logs uses your log data for monitoring so no code changes are
|
|
184
|
-
* example, you can monitor application logs for specific literal terms (such
|
|
185
|
-
* "NullReferenceException")
|
|
186
|
-
* particular position in log data (such as "404" status codes in an Apache access
|
|
187
|
-
* the term you are searching for is found, CloudWatch Logs reports the data to a
|
|
188
|
-
* metric that you specify.</p>
|
|
185
|
+
* CloudWatch Logs can track the number of errors that occur in your application logs. Then,
|
|
186
|
+
* it can send you a notification whenever the rate of errors exceeds a threshold that you
|
|
187
|
+
* specify. CloudWatch Logs uses your log data for monitoring so no code changes are
|
|
188
|
+
* required. For example, you can monitor application logs for specific literal terms (such
|
|
189
|
+
* as "NullReferenceException"). You can also count the number of occurrences of a literal
|
|
190
|
+
* term at a particular position in log data (such as "404" status codes in an Apache access
|
|
191
|
+
* log). When the term you are searching for is found, CloudWatch Logs reports the data to a
|
|
192
|
+
* CloudWatch metric that you specify.</p>
|
|
189
193
|
* </li>
|
|
190
194
|
* <li>
|
|
191
195
|
* <p>
|
|
@@ -197,9 +201,9 @@ export interface CloudWatchLogsClientResolvedConfig extends CloudWatchLogsClient
|
|
|
197
201
|
* <p>
|
|
198
202
|
* <b>Archive log data</b>: You can use CloudWatch Logs to
|
|
199
203
|
* store your log data in highly durable storage. You can change the log retention setting so
|
|
200
|
-
* that any log events
|
|
201
|
-
* agent
|
|
202
|
-
*
|
|
204
|
+
* that any log events earlier than this setting are automatically deleted. The CloudWatch
|
|
205
|
+
* Logs agent helps to quickly send both rotated and non-rotated log data off of a host and
|
|
206
|
+
* into the log service. You can then access the raw log data when you need it.</p>
|
|
203
207
|
* </li>
|
|
204
208
|
* </ul>
|
|
205
209
|
*/
|
|
@@ -8,19 +8,20 @@ export interface AssociateKmsKeyCommandInput extends AssociateKmsKeyRequest {
|
|
|
8
8
|
export interface AssociateKmsKeyCommandOutput extends __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Associates the specified
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
11
|
+
* <p>Associates the specified KMS key with the specified log
|
|
12
|
+
* group.</p>
|
|
13
|
+
* <p>Associating a KMS key with a log group overrides any existing
|
|
14
|
+
* 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
|
|
15
|
+
* using the KMS key. This association is stored as long as the data encrypted
|
|
16
|
+
* with the KMS keyis still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.</p>
|
|
16
17
|
* <important>
|
|
17
|
-
* <p>CloudWatch Logs supports only symmetric
|
|
18
|
-
* with your log group. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
|
|
19
|
-
* Keys</a>.</p>
|
|
18
|
+
* <p>CloudWatch Logs supports only symmetric KMS keys. Do not use an associate
|
|
19
|
+
* an asymmetric KMS key with your log group. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
|
|
20
|
+
* Symmetric and Asymmetric Keys</a>.</p>
|
|
20
21
|
* </important>
|
|
21
22
|
* <p>It can take up to 5 minutes for this operation to take effect.</p>
|
|
22
|
-
* <p>If you attempt to associate a
|
|
23
|
-
*
|
|
23
|
+
* <p>If you attempt to associate a KMS key with a log group but the KMS key does not exist or the KMS key is disabled, you receive an
|
|
24
|
+
* <code>InvalidParameterException</code> error. </p>
|
|
24
25
|
* @example
|
|
25
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
27
|
* ```javascript
|
|
@@ -8,13 +8,13 @@ export interface CreateExportTaskCommandInput extends CreateExportTaskRequest {
|
|
|
8
8
|
export interface CreateExportTaskCommandOutput extends CreateExportTaskResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Creates an export task
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* <p>Exporting log data to
|
|
16
|
-
*
|
|
17
|
-
*
|
|
11
|
+
* <p>Creates an export task so that you can efficiently export data from a log group to an
|
|
12
|
+
* Amazon S3 bucket. When you perform a <code>CreateExportTask</code> operation, you must use
|
|
13
|
+
* credentials that have permission to write to the S3 bucket that you specify as the
|
|
14
|
+
* destination.</p>
|
|
15
|
+
* <p>Exporting log data to S3 buckets that are encrypted by KMS is supported.
|
|
16
|
+
* Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a
|
|
17
|
+
* retention period is also supported.</p>
|
|
18
18
|
* <p>Exporting to S3 buckets that are encrypted with AES-256 is supported. </p>
|
|
19
19
|
* <p>This is an asynchronous call. If all the required information is provided, this
|
|
20
20
|
* operation initiates an export task and responds with the ID of the task. After the task has started,
|
|
@@ -22,12 +22,12 @@ export interface CreateExportTaskCommandOutput extends CreateExportTaskResponse,
|
|
|
22
22
|
* only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time.
|
|
23
23
|
* To cancel an export task, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html">CancelExportTask</a>.</p>
|
|
24
24
|
* <p>You can export logs from multiple log groups or multiple time ranges to the same S3
|
|
25
|
-
* bucket. To separate
|
|
26
|
-
*
|
|
25
|
+
* bucket. To separate log data for each export task, specify a prefix to be used as the Amazon
|
|
26
|
+
* S3 key prefix for all exported objects.</p>
|
|
27
27
|
*
|
|
28
28
|
* <note>
|
|
29
|
-
* <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can
|
|
30
|
-
*
|
|
29
|
+
* <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can
|
|
30
|
+
* sort the exported log field data by using Linux utilities.</p>
|
|
31
31
|
* </note>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -12,7 +12,8 @@ export interface CreateLogGroupCommandOutput extends __MetadataBearer {
|
|
|
12
12
|
* <p>You must use the following guidelines when naming a log group:</p>
|
|
13
13
|
* <ul>
|
|
14
14
|
* <li>
|
|
15
|
-
* <p>Log group names must be unique within a
|
|
15
|
+
* <p>Log group names must be unique within a Region for an Amazon Web Services
|
|
16
|
+
* account.</p>
|
|
16
17
|
* </li>
|
|
17
18
|
* <li>
|
|
18
19
|
* <p>Log group names can be between 1 and 512 characters long.</p>
|
|
@@ -22,18 +23,19 @@ export interface CreateLogGroupCommandOutput extends __MetadataBearer {
|
|
|
22
23
|
* '/' (forward slash), '.' (period), and '#' (number sign)</p>
|
|
23
24
|
* </li>
|
|
24
25
|
* </ul>
|
|
25
|
-
* <p>When you create a log group, by default the log events in the log group
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
* <p>If you associate
|
|
29
|
-
* This association is stored as long as the data
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
26
|
+
* <p>When you create a log group, by default the log events in the log group do not expire.
|
|
27
|
+
* To set a retention policy so that events expire and are deleted after a specified time, use
|
|
28
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html">PutRetentionPolicy</a>.</p>
|
|
29
|
+
* <p>If you associate an KMS key with the log group, ingested data is
|
|
30
|
+
* encrypted using the KMS key. This association is stored as long as the data
|
|
31
|
+
* encrypted with the KMS key is still within CloudWatch Logs. This enables
|
|
32
|
+
* CloudWatch Logs to decrypt this data whenever it is requested.</p>
|
|
33
|
+
* <p>If you attempt to associate a KMS key with the log group but the KMS keydoes not exist or the KMS key is disabled, you receive an
|
|
34
|
+
* <code>InvalidParameterException</code> error. </p>
|
|
33
35
|
* <important>
|
|
34
|
-
* <p>CloudWatch Logs supports only symmetric
|
|
35
|
-
* your log group. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
|
|
36
|
-
* Keys</a>.</p>
|
|
36
|
+
* <p>CloudWatch Logs supports only symmetric KMS keys. Do not associate an
|
|
37
|
+
* asymmetric KMS key with your log group. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
|
|
38
|
+
* Symmetric and Asymmetric Keys</a>.</p>
|
|
37
39
|
* </important>
|
|
38
40
|
* @example
|
|
39
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -22,7 +22,7 @@ export interface CreateLogStreamCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
* <p>Log stream names can be between 1 and 512 characters long.</p>
|
|
23
23
|
* </li>
|
|
24
24
|
* <li>
|
|
25
|
-
* <p>
|
|
25
|
+
* <p>Don't use ':' (colon) or '*' (asterisk) characters.</p>
|
|
26
26
|
* </li>
|
|
27
27
|
* </ul>
|
|
28
28
|
* @example
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
|
|
5
|
+
import { DeleteDataProtectionPolicyRequest } from "../models/models_0";
|
|
6
|
+
export interface DeleteDataProtectionPolicyCommandInput extends DeleteDataProtectionPolicyRequest {
|
|
7
|
+
}
|
|
8
|
+
export interface DeleteDataProtectionPolicyCommandOutput extends __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>Deletes the data protection policy from the specified log group. </p>
|
|
12
|
+
* <p>For more information about data protection policies, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html">PutDataProtectionPolicy</a>.</p>
|
|
13
|
+
* @example
|
|
14
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
15
|
+
* ```javascript
|
|
16
|
+
* import { CloudWatchLogsClient, DeleteDataProtectionPolicyCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
|
|
17
|
+
* // const { CloudWatchLogsClient, DeleteDataProtectionPolicyCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
|
|
18
|
+
* const client = new CloudWatchLogsClient(config);
|
|
19
|
+
* const command = new DeleteDataProtectionPolicyCommand(input);
|
|
20
|
+
* const response = await client.send(command);
|
|
21
|
+
* ```
|
|
22
|
+
*
|
|
23
|
+
* @see {@link DeleteDataProtectionPolicyCommandInput} for command's `input` shape.
|
|
24
|
+
* @see {@link DeleteDataProtectionPolicyCommandOutput} for command's `response` shape.
|
|
25
|
+
* @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
export declare class DeleteDataProtectionPolicyCommand extends $Command<DeleteDataProtectionPolicyCommandInput, DeleteDataProtectionPolicyCommandOutput, CloudWatchLogsClientResolvedConfig> {
|
|
29
|
+
readonly input: DeleteDataProtectionPolicyCommandInput;
|
|
30
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
31
|
+
constructor(input: DeleteDataProtectionPolicyCommandInput);
|
|
32
|
+
/**
|
|
33
|
+
* @internal
|
|
34
|
+
*/
|
|
35
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchLogsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDataProtectionPolicyCommandInput, DeleteDataProtectionPolicyCommandOutput>;
|
|
36
|
+
private serialize;
|
|
37
|
+
private deserialize;
|
|
38
|
+
}
|
|
@@ -17,6 +17,9 @@ export interface DescribeLogGroupsCommandOutput extends DescribeLogGroupsRespons
|
|
|
17
17
|
* </code> condition key to control access.
|
|
18
18
|
* For more information about using tags to control access, see
|
|
19
19
|
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Controlling access to Amazon Web Services resources using tags</a>.</p>
|
|
20
|
+
* <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
|
|
21
|
+
* view data from the linked source accounts. For more information, see
|
|
22
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
|
|
20
23
|
* @example
|
|
21
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
25
|
* ```javascript
|
|
@@ -12,6 +12,9 @@ export interface DescribeLogStreamsCommandOutput extends DescribeLogStreamsRespo
|
|
|
12
12
|
* You can list all the log streams or filter the results by prefix.
|
|
13
13
|
* You can also control how the results are ordered.</p>
|
|
14
14
|
* <p>This operation has a limit of five transactions per second, after which transactions are throttled.</p>
|
|
15
|
+
* <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
|
|
16
|
+
* view data from the linked source accounts. For more information, see
|
|
17
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
|
|
15
18
|
* @example
|
|
16
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
20
|
* ```javascript
|
|
@@ -8,9 +8,9 @@ export interface DescribeQueriesCommandInput extends DescribeQueriesRequest {
|
|
|
8
8
|
export interface DescribeQueriesCommandOutput extends DescribeQueriesResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Returns a list of CloudWatch Logs Insights queries that are scheduled,
|
|
12
|
-
* been
|
|
13
|
-
*
|
|
11
|
+
* <p>Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have
|
|
12
|
+
* been run recently in this account. You can request all queries or limit it to queries of a
|
|
13
|
+
* specific log group or queries with a certain status.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
16
16
|
* ```javascript
|
|
@@ -8,9 +8,11 @@ export interface DisassociateKmsKeyCommandInput extends DisassociateKmsKeyReques
|
|
|
8
8
|
export interface DisassociateKmsKeyCommandOutput extends __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Disassociates the associated
|
|
12
|
-
*
|
|
13
|
-
*
|
|
11
|
+
* <p>Disassociates the associated KMS key from the specified log
|
|
12
|
+
* group.</p>
|
|
13
|
+
* <p>After the KMS key is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data
|
|
14
|
+
* remains encrypted, and CloudWatch Logs requires permissions for the KMS key
|
|
15
|
+
* whenever the encrypted data is requested.</p>
|
|
14
16
|
* <p>Note that it can take up to 5 minutes for this operation to take effect.</p>
|
|
15
17
|
* @example
|
|
16
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,13 +11,17 @@ export interface FilterLogEventsCommandOutput extends FilterLogEventsResponse, _
|
|
|
11
11
|
* <p>Lists log events from the specified log group. You can list all the log events or filter the results
|
|
12
12
|
* using a filter pattern, a time range, and the name of the log stream.</p>
|
|
13
13
|
* <p>You must have the <code>logs;FilterLogEvents</code> permission to perform this operation.</p>
|
|
14
|
+
*
|
|
14
15
|
* <p>By default, this operation returns as many log events as can fit in 1 MB (up to 10,000
|
|
15
|
-
* log events) or all the events found within the time range
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
16
|
+
* log events) or all the events found within the specified time range. If the results include a
|
|
17
|
+
* token, that means there are more log events available. You can get additional results by
|
|
18
|
+
* specifying the token in a subsequent call. This operation can return empty results while there
|
|
19
|
+
* are more log events available through the token.</p>
|
|
19
20
|
* <p>The returned log events are sorted by event timestamp, the timestamp when the event was ingested
|
|
20
21
|
* by CloudWatch Logs, and the ID of the <code>PutLogEvents</code> request.</p>
|
|
22
|
+
* <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
|
|
23
|
+
* view data from the linked source accounts. For more information, see
|
|
24
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
|
|
21
25
|
* @example
|
|
22
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
23
27
|
* ```javascript
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
|
|
5
|
+
import { GetDataProtectionPolicyRequest, GetDataProtectionPolicyResponse } from "../models/models_0";
|
|
6
|
+
export interface GetDataProtectionPolicyCommandInput extends GetDataProtectionPolicyRequest {
|
|
7
|
+
}
|
|
8
|
+
export interface GetDataProtectionPolicyCommandOutput extends GetDataProtectionPolicyResponse, __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>Returns information about a log group data protection policy.</p>
|
|
12
|
+
* @example
|
|
13
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
14
|
+
* ```javascript
|
|
15
|
+
* import { CloudWatchLogsClient, GetDataProtectionPolicyCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
|
|
16
|
+
* // const { CloudWatchLogsClient, GetDataProtectionPolicyCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
|
|
17
|
+
* const client = new CloudWatchLogsClient(config);
|
|
18
|
+
* const command = new GetDataProtectionPolicyCommand(input);
|
|
19
|
+
* const response = await client.send(command);
|
|
20
|
+
* ```
|
|
21
|
+
*
|
|
22
|
+
* @see {@link GetDataProtectionPolicyCommandInput} for command's `input` shape.
|
|
23
|
+
* @see {@link GetDataProtectionPolicyCommandOutput} for command's `response` shape.
|
|
24
|
+
* @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
export declare class GetDataProtectionPolicyCommand extends $Command<GetDataProtectionPolicyCommandInput, GetDataProtectionPolicyCommandOutput, CloudWatchLogsClientResolvedConfig> {
|
|
28
|
+
readonly input: GetDataProtectionPolicyCommandInput;
|
|
29
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
30
|
+
constructor(input: GetDataProtectionPolicyCommandInput);
|
|
31
|
+
/**
|
|
32
|
+
* @internal
|
|
33
|
+
*/
|
|
34
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchLogsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetDataProtectionPolicyCommandInput, GetDataProtectionPolicyCommandOutput>;
|
|
35
|
+
private serialize;
|
|
36
|
+
private deserialize;
|
|
37
|
+
}
|
|
@@ -14,6 +14,10 @@ export interface GetLogEventsCommandOutput extends GetLogEventsResponse, __Metad
|
|
|
14
14
|
* <p>By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events).
|
|
15
15
|
* You can get additional log events by specifying one of the tokens in a subsequent call.
|
|
16
16
|
* This operation can return empty results while there are more log events available through the token.</p>
|
|
17
|
+
*
|
|
18
|
+
* <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
|
|
19
|
+
* view data from the linked source accounts. For more information, see
|
|
20
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
|
|
17
21
|
* @example
|
|
18
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
19
23
|
* ```javascript
|
|
@@ -8,14 +8,18 @@ export interface GetLogGroupFieldsCommandInput extends GetLogGroupFieldsRequest
|
|
|
8
8
|
export interface GetLogGroupFieldsCommandOutput extends GetLogGroupFieldsResponse, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Returns a list of the fields that are included in log events in the specified log group
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData-discoverable-fields.html">Supported
|
|
11
|
+
* <p>Returns a list of the fields that are included in log events in the specified log group.
|
|
12
|
+
* Includes the percentage of log events that contain each field. The search is limited to a time
|
|
13
|
+
* period that you specify.</p>
|
|
14
|
+
* <p>In the results, fields that start with <code>@</code> are fields generated by CloudWatch
|
|
15
|
+
* Logs. For example, <code>@timestamp</code> is the timestamp of each log event. For more
|
|
16
|
+
* information about the fields that are generated by CloudWatch logs, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_AnalyzeLogData-discoverable-fields.html">Supported
|
|
17
|
+
* Logs and Discovered Fields</a>.</p>
|
|
17
18
|
* <p>The response results are sorted by the frequency percentage, starting
|
|
18
19
|
* with the highest percentage.</p>
|
|
20
|
+
* <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
|
|
21
|
+
* view data from the linked source accounts. For more information, see
|
|
22
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
|
|
19
23
|
* @example
|
|
20
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
25
|
* ```javascript
|
|
@@ -14,11 +14,13 @@ export interface GetQueryResultsCommandOutput extends GetQueryResultsResponse, _
|
|
|
14
14
|
* in a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogRecord.html">GetLogRecord</a>
|
|
15
15
|
* operation to get the full log record.</p>
|
|
16
16
|
* <p>
|
|
17
|
-
* <code>GetQueryResults</code>
|
|
18
|
-
* does not start a query execution. To run a query, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a>.</p>
|
|
17
|
+
* <code>GetQueryResults</code> does not start running a query. To run a query, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a>.</p>
|
|
19
18
|
* <p>If the value of the <code>Status</code> field in the output is <code>Running</code>, this operation
|
|
20
19
|
* returns only partial results. If you see a value of <code>Scheduled</code> or <code>Running</code> for the status,
|
|
21
20
|
* you can retry the operation later to see the final results. </p>
|
|
21
|
+
* <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start
|
|
22
|
+
* queries in linked source accounts. For more information, see
|
|
23
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
|
|
22
24
|
* @example
|
|
23
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
24
26
|
* ```javascript
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
|
|
5
|
+
import { PutDataProtectionPolicyRequest, PutDataProtectionPolicyResponse } from "../models/models_0";
|
|
6
|
+
export interface PutDataProtectionPolicyCommandInput extends PutDataProtectionPolicyRequest {
|
|
7
|
+
}
|
|
8
|
+
export interface PutDataProtectionPolicyCommandOutput extends PutDataProtectionPolicyResponse, __MetadataBearer {
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* <p>Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive
|
|
12
|
+
* data that's ingested by the log group by auditing and masking the sensitive log data.</p>
|
|
13
|
+
* <important>
|
|
14
|
+
* <p>Sensitive data is detected and masked when it is ingested into the log group. When you set a
|
|
15
|
+
* data protection policy, log events ingested into the log group before that time are not masked.</p>
|
|
16
|
+
* </important>
|
|
17
|
+
* <p>By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.
|
|
18
|
+
* A user who has the <code>logs:Unmask</code> permission can use a
|
|
19
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html">GetLogEvents</a> or
|
|
20
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html">FilterLogEvents</a>
|
|
21
|
+
* operation with the <code>unmask</code> parameter set to <code>true</code> to view the unmasked
|
|
22
|
+
* log events. Users with the <code>logs:Unmask</code> can also view unmasked data in the CloudWatch Logs
|
|
23
|
+
* console by running a CloudWatch Logs Insights query with the <code>unmask</code> query command.</p>
|
|
24
|
+
* <p>For more information, including a list of types of data that can be audited and masked, see
|
|
25
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html">Protect sensitive log data with masking</a>.</p>
|
|
26
|
+
* @example
|
|
27
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
28
|
+
* ```javascript
|
|
29
|
+
* import { CloudWatchLogsClient, PutDataProtectionPolicyCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
|
|
30
|
+
* // const { CloudWatchLogsClient, PutDataProtectionPolicyCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
|
|
31
|
+
* const client = new CloudWatchLogsClient(config);
|
|
32
|
+
* const command = new PutDataProtectionPolicyCommand(input);
|
|
33
|
+
* const response = await client.send(command);
|
|
34
|
+
* ```
|
|
35
|
+
*
|
|
36
|
+
* @see {@link PutDataProtectionPolicyCommandInput} for command's `input` shape.
|
|
37
|
+
* @see {@link PutDataProtectionPolicyCommandOutput} for command's `response` shape.
|
|
38
|
+
* @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
|
|
39
|
+
*
|
|
40
|
+
*/
|
|
41
|
+
export declare class PutDataProtectionPolicyCommand extends $Command<PutDataProtectionPolicyCommandInput, PutDataProtectionPolicyCommandOutput, CloudWatchLogsClientResolvedConfig> {
|
|
42
|
+
readonly input: PutDataProtectionPolicyCommandInput;
|
|
43
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
44
|
+
constructor(input: PutDataProtectionPolicyCommandInput);
|
|
45
|
+
/**
|
|
46
|
+
* @internal
|
|
47
|
+
*/
|
|
48
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchLogsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutDataProtectionPolicyCommandInput, PutDataProtectionPolicyCommandOutput>;
|
|
49
|
+
private serialize;
|
|
50
|
+
private deserialize;
|
|
51
|
+
}
|
|
@@ -9,9 +9,9 @@ export interface PutDestinationCommandOutput extends PutDestinationResponse, __M
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.</p>
|
|
12
|
-
* <p>A destination encapsulates a physical resource (such
|
|
13
|
-
*
|
|
14
|
-
*
|
|
12
|
+
* <p>A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With
|
|
13
|
+
* a destination, you can subscribe to a real-time stream of log events for a different account,
|
|
14
|
+
* ingested using <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>.</p>
|
|
15
15
|
* <p>Through an access policy, a destination controls what is written to it.
|
|
16
16
|
* By default, <code>PutDestination</code> does not set any access policy with the destination,
|
|
17
17
|
* which means a cross-account user cannot call <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutSubscriptionFilter.html">PutSubscriptionFilter</a> against
|
|
@@ -25,15 +25,16 @@ export interface PutLogEventsCommandOutput extends PutLogEventsResponse, __Metad
|
|
|
25
25
|
* <p>None of the log events in the batch can be more than 2 hours in the future.</p>
|
|
26
26
|
* </li>
|
|
27
27
|
* <li>
|
|
28
|
-
* <p>None of the log events in the batch can be
|
|
29
|
-
* period of the log
|
|
28
|
+
* <p>None of the log events in the batch can be more than 14 days in the past. Also,
|
|
29
|
+
* none of the log events can be from earlier than the retention period of the log
|
|
30
|
+
* group.</p>
|
|
30
31
|
* </li>
|
|
31
32
|
* <li>
|
|
32
33
|
* <p>The log events in the batch must be in chronological order by their timestamp. The
|
|
33
|
-
* timestamp is the time the event occurred, expressed as the number of milliseconds
|
|
34
|
-
* Jan 1, 1970 00:00:00 UTC
|
|
35
|
-
* timestamp is specified in .NET format:
|
|
36
|
-
*
|
|
34
|
+
* timestamp is the time that the event occurred, expressed as the number of milliseconds
|
|
35
|
+
* after <code>Jan 1, 1970 00:00:00 UTC</code>. (In Amazon Web Services Tools for PowerShell
|
|
36
|
+
* and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format:
|
|
37
|
+
* <code>yyyy-mm-ddThh:mm:ss</code>. For example, <code>2017-09-15T13:45:30</code>.) </p>
|
|
37
38
|
* </li>
|
|
38
39
|
* <li>
|
|
39
40
|
* <p>A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.</p>
|
|
@@ -42,10 +43,12 @@ export interface PutLogEventsCommandOutput extends PutLogEventsResponse, __Metad
|
|
|
42
43
|
* <p>The maximum number of log events in a batch is 10,000.</p>
|
|
43
44
|
* </li>
|
|
44
45
|
* <li>
|
|
45
|
-
* <p>There is a quota of
|
|
46
|
+
* <p>There is a quota of five requests per second per log stream. Additional requests
|
|
47
|
+
* are throttled. This quota can't be changed.</p>
|
|
46
48
|
* </li>
|
|
47
49
|
* </ul>
|
|
48
|
-
* <p>If a call to <code>PutLogEvents</code> returns "UnrecognizedClientException" the most
|
|
50
|
+
* <p>If a call to <code>PutLogEvents</code> returns "UnrecognizedClientException" the most
|
|
51
|
+
* likely cause is a non-valid Amazon Web Services access key ID or secret key. </p>
|
|
49
52
|
* @example
|
|
50
53
|
* Use a bare-bones client and the command you need to make an API call.
|
|
51
54
|
* ```javascript
|
|
@@ -8,8 +8,8 @@ export interface PutMetricFilterCommandInput extends PutMetricFilterRequest {
|
|
|
8
8
|
export interface PutMetricFilterCommandOutput extends __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Creates or updates a metric filter and associates it with the specified log group.
|
|
12
|
-
*
|
|
11
|
+
* <p>Creates or updates a metric filter and associates it with the specified log group. With
|
|
12
|
+
* metric filters, you can configure rules to extract metric data from log events ingested
|
|
13
13
|
* through <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>.</p>
|
|
14
14
|
* <p>The maximum number of metric filters that can be associated with a log group is
|
|
15
15
|
* 100.</p>
|
|
@@ -22,9 +22,9 @@ export interface PutMetricFilterCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
* found for
|
|
23
23
|
* a dimension is treated as a separate metric and accrues charges as a separate custom metric.
|
|
24
24
|
* </p>
|
|
25
|
-
* <p>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
25
|
+
* <p>CloudWatch Logs disables a metric filter if it generates 1,000 different name/value pairs for
|
|
26
|
+
* your specified dimensions within a certain amount of time. This helps to prevent accidental
|
|
27
|
+
* high charges.</p>
|
|
28
28
|
* <p>You can also set up a billing alarm to alert you if your charges are higher than
|
|
29
29
|
* expected. For more information,
|
|
30
30
|
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html">
|
|
@@ -11,13 +11,13 @@ export interface PutQueryDefinitionCommandOutput extends PutQueryDefinitionRespo
|
|
|
11
11
|
* <p>Creates or updates a query definition for CloudWatch Logs Insights. For
|
|
12
12
|
* more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html">Analyzing Log Data with CloudWatch Logs Insights</a>.</p>
|
|
13
13
|
*
|
|
14
|
-
* <p>To update a query definition, specify its
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
14
|
+
* <p>To update a query definition, specify its <code>queryDefinitionId</code> in your request.
|
|
15
|
+
* The values of <code>name</code>, <code>queryString</code>, and <code>logGroupNames</code> are
|
|
16
|
+
* changed to the values that you specify in your update operation. No current values are
|
|
17
|
+
* retained from the current query definition. For example, imagine updating a current query
|
|
18
|
+
* definition that includes log groups. If you don't specify the <code>logGroupNames</code>
|
|
19
|
+
* parameter in your update operation, the query definition changes to contain no log
|
|
20
|
+
* groups.</p>
|
|
21
21
|
* <p>You must have the <code>logs:PutQueryDefinition</code> permission to be able to perform
|
|
22
22
|
* this operation.</p>
|
|
23
23
|
* @example
|