@aws-sdk/client-cloudwatch-logs 3.312.0 → 3.316.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.
@@ -48,757 +48,333 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
48
48
  import { TestMetricFilterCommandInput, TestMetricFilterCommandOutput } from "./commands/TestMetricFilterCommand";
49
49
  import { UntagLogGroupCommandInput, UntagLogGroupCommandOutput } from "./commands/UntagLogGroupCommand";
50
50
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
51
- /**
52
- * @public
53
- * <p>You can use Amazon CloudWatch Logs to monitor, store, and access your log files from
54
- * EC2 instances, CloudTrail, and other sources. You can then retrieve the associated
55
- * log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use
56
- * CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch
57
- * Logs SDK.</p>
58
- * <p>You can use CloudWatch Logs to:</p>
59
- * <ul>
60
- * <li>
61
- * <p>
62
- * <b>Monitor logs from EC2 instances in real time</b>: You
63
- * can use CloudWatch Logs to monitor applications and systems using log data. For example,
64
- * CloudWatch Logs can track the number of errors that occur in your application logs. Then,
65
- * it can send you a notification whenever the rate of errors exceeds a threshold that you
66
- * specify. CloudWatch Logs uses your log data for monitoring so no code changes are
67
- * required. For example, you can monitor application logs for specific literal terms (such
68
- * as "NullReferenceException"). You can also count the number of occurrences of a literal
69
- * term at a particular position in log data (such as "404" status codes in an Apache access
70
- * log). When the term you are searching for is found, CloudWatch Logs reports the data to a
71
- * CloudWatch metric that you specify.</p>
72
- * </li>
73
- * <li>
74
- * <p>
75
- * <b>Monitor CloudTrail logged events</b>: You can
76
- * create alarms in CloudWatch and receive notifications of particular API activity as
77
- * captured by CloudTrail. You can use the notification to perform troubleshooting.</p>
78
- * </li>
79
- * <li>
80
- * <p>
81
- * <b>Archive log data</b>: You can use CloudWatch Logs to
82
- * store your log data in highly durable storage. You can change the log retention setting so
83
- * that any log events earlier than this setting are automatically deleted. The CloudWatch
84
- * Logs agent helps to quickly send both rotated and non-rotated log data off of a host and
85
- * into the log service. You can then access the raw log data when you need it.</p>
86
- * </li>
87
- * </ul>
88
- */
89
- export declare class CloudWatchLogs extends CloudWatchLogsClient {
90
- /**
91
- * @public
92
- * <p>Associates the specified KMS key with the specified log
93
- * group.</p>
94
- * <p>Associating a KMS key with a log group overrides any existing
95
- * 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
96
- * using the KMS key. This association is stored as long as the data encrypted
97
- * with the KMS keyis still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.</p>
98
- * <important>
99
- * <p>CloudWatch Logs supports only symmetric KMS keys. Do not use an associate
100
- * 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
101
- * Symmetric and Asymmetric Keys</a>.</p>
102
- * </important>
103
- * <p>It can take up to 5 minutes for this operation to take effect.</p>
104
- * <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
105
- * <code>InvalidParameterException</code> error. </p>
51
+ export interface CloudWatchLogs {
52
+ /**
53
+ * @see {@link AssociateKmsKeyCommand}
106
54
  */
107
55
  associateKmsKey(args: AssociateKmsKeyCommandInput, options?: __HttpHandlerOptions): Promise<AssociateKmsKeyCommandOutput>;
108
56
  associateKmsKey(args: AssociateKmsKeyCommandInput, cb: (err: any, data?: AssociateKmsKeyCommandOutput) => void): void;
109
57
  associateKmsKey(args: AssociateKmsKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateKmsKeyCommandOutput) => void): void;
110
58
  /**
111
- * @public
112
- * <p>Cancels the specified export task.</p>
113
- * <p>The task must be in the <code>PENDING</code> or <code>RUNNING</code> state.</p>
59
+ * @see {@link CancelExportTaskCommand}
114
60
  */
115
61
  cancelExportTask(args: CancelExportTaskCommandInput, options?: __HttpHandlerOptions): Promise<CancelExportTaskCommandOutput>;
116
62
  cancelExportTask(args: CancelExportTaskCommandInput, cb: (err: any, data?: CancelExportTaskCommandOutput) => void): void;
117
63
  cancelExportTask(args: CancelExportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelExportTaskCommandOutput) => void): void;
118
64
  /**
119
- * @public
120
- * <p>Creates an export task so that you can efficiently export data from a log group to an
121
- * Amazon S3 bucket. When you perform a <code>CreateExportTask</code> operation, you must use
122
- * credentials that have permission to write to the S3 bucket that you specify as the
123
- * destination.</p>
124
- * <p>Exporting log data to S3 buckets that are encrypted by KMS is supported.
125
- * Exporting log data to Amazon S3 buckets that have S3 Object Lock enabled with a
126
- * retention period is also supported.</p>
127
- * <p>Exporting to S3 buckets that are encrypted with AES-256 is supported. </p>
128
- * <p>This is an asynchronous call. If all the required information is provided, this
129
- * operation initiates an export task and responds with the ID of the task. After the task has started,
130
- * you can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeExportTasks.html">DescribeExportTasks</a> to get the status of the export task. Each account can
131
- * only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time.
132
- * To cancel an export task, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html">CancelExportTask</a>.</p>
133
- * <p>You can export logs from multiple log groups or multiple time ranges to the same S3
134
- * bucket. To separate log data for each export task, specify a prefix to be used as the Amazon
135
- * S3 key prefix for all exported objects.</p>
136
- * <note>
137
- * <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can
138
- * sort the exported log field data by using Linux utilities.</p>
139
- * </note>
65
+ * @see {@link CreateExportTaskCommand}
140
66
  */
141
67
  createExportTask(args: CreateExportTaskCommandInput, options?: __HttpHandlerOptions): Promise<CreateExportTaskCommandOutput>;
142
68
  createExportTask(args: CreateExportTaskCommandInput, cb: (err: any, data?: CreateExportTaskCommandOutput) => void): void;
143
69
  createExportTask(args: CreateExportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExportTaskCommandOutput) => void): void;
144
70
  /**
145
- * @public
146
- * <p>Creates a log group with the specified name. You can create up to 20,000 log groups per account.</p>
147
- * <p>You must use the following guidelines when naming a log group:</p>
148
- * <ul>
149
- * <li>
150
- * <p>Log group names must be unique within a Region for an Amazon Web Services
151
- * account.</p>
152
- * </li>
153
- * <li>
154
- * <p>Log group names can be between 1 and 512 characters long.</p>
155
- * </li>
156
- * <li>
157
- * <p>Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen),
158
- * '/' (forward slash), '.' (period), and '#' (number sign)</p>
159
- * </li>
160
- * </ul>
161
- * <p>When you create a log group, by default the log events in the log group do not expire.
162
- * To set a retention policy so that events expire and are deleted after a specified time, use
163
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutRetentionPolicy.html">PutRetentionPolicy</a>.</p>
164
- * <p>If you associate an KMS key with the log group, ingested data is
165
- * encrypted using the KMS key. This association is stored as long as the data
166
- * encrypted with the KMS key is still within CloudWatch Logs. This enables
167
- * CloudWatch Logs to decrypt this data whenever it is requested.</p>
168
- * <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
169
- * <code>InvalidParameterException</code> error. </p>
170
- * <important>
171
- * <p>CloudWatch Logs supports only symmetric KMS keys. Do not associate an
172
- * 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
173
- * Symmetric and Asymmetric Keys</a>.</p>
174
- * </important>
71
+ * @see {@link CreateLogGroupCommand}
175
72
  */
176
73
  createLogGroup(args: CreateLogGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateLogGroupCommandOutput>;
177
74
  createLogGroup(args: CreateLogGroupCommandInput, cb: (err: any, data?: CreateLogGroupCommandOutput) => void): void;
178
75
  createLogGroup(args: CreateLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLogGroupCommandOutput) => void): void;
179
76
  /**
180
- * @public
181
- * <p>Creates a log stream for the specified log group. A log stream is a sequence of log events
182
- * that originate from a single source, such as an application instance or a resource that is
183
- * being monitored.</p>
184
- * <p>There is no limit on the number of log streams that you can create for a log group. There is a limit
185
- * of 50 TPS on <code>CreateLogStream</code> operations, after which transactions are throttled.</p>
186
- * <p>You must use the following guidelines when naming a log stream:</p>
187
- * <ul>
188
- * <li>
189
- * <p>Log stream names must be unique within the log group.</p>
190
- * </li>
191
- * <li>
192
- * <p>Log stream names can be between 1 and 512 characters long.</p>
193
- * </li>
194
- * <li>
195
- * <p>Don't use ':' (colon) or '*' (asterisk) characters.</p>
196
- * </li>
197
- * </ul>
77
+ * @see {@link CreateLogStreamCommand}
198
78
  */
199
79
  createLogStream(args: CreateLogStreamCommandInput, options?: __HttpHandlerOptions): Promise<CreateLogStreamCommandOutput>;
200
80
  createLogStream(args: CreateLogStreamCommandInput, cb: (err: any, data?: CreateLogStreamCommandOutput) => void): void;
201
81
  createLogStream(args: CreateLogStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLogStreamCommandOutput) => void): void;
202
82
  /**
203
- * @public
204
- * <p>Deletes the data protection policy from the specified log group. </p>
205
- * <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>
83
+ * @see {@link DeleteDataProtectionPolicyCommand}
206
84
  */
207
85
  deleteDataProtectionPolicy(args: DeleteDataProtectionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDataProtectionPolicyCommandOutput>;
208
86
  deleteDataProtectionPolicy(args: DeleteDataProtectionPolicyCommandInput, cb: (err: any, data?: DeleteDataProtectionPolicyCommandOutput) => void): void;
209
87
  deleteDataProtectionPolicy(args: DeleteDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataProtectionPolicyCommandOutput) => void): void;
210
88
  /**
211
- * @public
212
- * <p>Deletes the specified destination, and eventually disables all the
213
- * subscription filters that publish to it. This operation does not delete the
214
- * physical resource encapsulated by the destination.</p>
89
+ * @see {@link DeleteDestinationCommand}
215
90
  */
216
91
  deleteDestination(args: DeleteDestinationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDestinationCommandOutput>;
217
92
  deleteDestination(args: DeleteDestinationCommandInput, cb: (err: any, data?: DeleteDestinationCommandOutput) => void): void;
218
93
  deleteDestination(args: DeleteDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDestinationCommandOutput) => void): void;
219
94
  /**
220
- * @public
221
- * <p>Deletes the specified log group and permanently deletes all the archived
222
- * log events associated with the log group.</p>
95
+ * @see {@link DeleteLogGroupCommand}
223
96
  */
224
97
  deleteLogGroup(args: DeleteLogGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteLogGroupCommandOutput>;
225
98
  deleteLogGroup(args: DeleteLogGroupCommandInput, cb: (err: any, data?: DeleteLogGroupCommandOutput) => void): void;
226
99
  deleteLogGroup(args: DeleteLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLogGroupCommandOutput) => void): void;
227
100
  /**
228
- * @public
229
- * <p>Deletes the specified log stream and permanently deletes all the archived log events associated
230
- * with the log stream.</p>
101
+ * @see {@link DeleteLogStreamCommand}
231
102
  */
232
103
  deleteLogStream(args: DeleteLogStreamCommandInput, options?: __HttpHandlerOptions): Promise<DeleteLogStreamCommandOutput>;
233
104
  deleteLogStream(args: DeleteLogStreamCommandInput, cb: (err: any, data?: DeleteLogStreamCommandOutput) => void): void;
234
105
  deleteLogStream(args: DeleteLogStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLogStreamCommandOutput) => void): void;
235
106
  /**
236
- * @public
237
- * <p>Deletes the specified metric filter.</p>
107
+ * @see {@link DeleteMetricFilterCommand}
238
108
  */
239
109
  deleteMetricFilter(args: DeleteMetricFilterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMetricFilterCommandOutput>;
240
110
  deleteMetricFilter(args: DeleteMetricFilterCommandInput, cb: (err: any, data?: DeleteMetricFilterCommandOutput) => void): void;
241
111
  deleteMetricFilter(args: DeleteMetricFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMetricFilterCommandOutput) => void): void;
242
112
  /**
243
- * @public
244
- * <p>Deletes a saved CloudWatch Logs Insights query definition.
245
- * A query definition contains details about a saved CloudWatch Logs Insights query.</p>
246
- * <p>Each <code>DeleteQueryDefinition</code> operation can delete one query definition.</p>
247
- * <p>You must have the <code>logs:DeleteQueryDefinition</code> permission to be able to perform
248
- * this operation.</p>
113
+ * @see {@link DeleteQueryDefinitionCommand}
249
114
  */
250
115
  deleteQueryDefinition(args: DeleteQueryDefinitionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteQueryDefinitionCommandOutput>;
251
116
  deleteQueryDefinition(args: DeleteQueryDefinitionCommandInput, cb: (err: any, data?: DeleteQueryDefinitionCommandOutput) => void): void;
252
117
  deleteQueryDefinition(args: DeleteQueryDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQueryDefinitionCommandOutput) => void): void;
253
118
  /**
254
- * @public
255
- * <p>Deletes a resource policy from this account. This revokes
256
- * the access of the identities in that policy to put log events to this account.</p>
119
+ * @see {@link DeleteResourcePolicyCommand}
257
120
  */
258
121
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourcePolicyCommandOutput>;
259
122
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
260
123
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
261
124
  /**
262
- * @public
263
- * <p>Deletes the specified retention policy.</p>
264
- * <p>Log events do not expire if they belong to log groups without a retention policy.</p>
125
+ * @see {@link DeleteRetentionPolicyCommand}
265
126
  */
266
127
  deleteRetentionPolicy(args: DeleteRetentionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRetentionPolicyCommandOutput>;
267
128
  deleteRetentionPolicy(args: DeleteRetentionPolicyCommandInput, cb: (err: any, data?: DeleteRetentionPolicyCommandOutput) => void): void;
268
129
  deleteRetentionPolicy(args: DeleteRetentionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRetentionPolicyCommandOutput) => void): void;
269
130
  /**
270
- * @public
271
- * <p>Deletes the specified subscription filter.</p>
131
+ * @see {@link DeleteSubscriptionFilterCommand}
272
132
  */
273
133
  deleteSubscriptionFilter(args: DeleteSubscriptionFilterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSubscriptionFilterCommandOutput>;
274
134
  deleteSubscriptionFilter(args: DeleteSubscriptionFilterCommandInput, cb: (err: any, data?: DeleteSubscriptionFilterCommandOutput) => void): void;
275
135
  deleteSubscriptionFilter(args: DeleteSubscriptionFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriptionFilterCommandOutput) => void): void;
276
136
  /**
277
- * @public
278
- * <p>Lists all your destinations. The results are ASCII-sorted by destination name.</p>
137
+ * @see {@link DescribeDestinationsCommand}
279
138
  */
280
139
  describeDestinations(args: DescribeDestinationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDestinationsCommandOutput>;
281
140
  describeDestinations(args: DescribeDestinationsCommandInput, cb: (err: any, data?: DescribeDestinationsCommandOutput) => void): void;
282
141
  describeDestinations(args: DescribeDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDestinationsCommandOutput) => void): void;
283
142
  /**
284
- * @public
285
- * <p>Lists the specified export tasks. You can list all your export tasks or filter
286
- * the results based on task ID or task status.</p>
143
+ * @see {@link DescribeExportTasksCommand}
287
144
  */
288
145
  describeExportTasks(args: DescribeExportTasksCommandInput, options?: __HttpHandlerOptions): Promise<DescribeExportTasksCommandOutput>;
289
146
  describeExportTasks(args: DescribeExportTasksCommandInput, cb: (err: any, data?: DescribeExportTasksCommandOutput) => void): void;
290
147
  describeExportTasks(args: DescribeExportTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExportTasksCommandOutput) => void): void;
291
148
  /**
292
- * @public
293
- * <p>Lists the specified log groups. You can list all your log groups or filter the results by prefix.
294
- * The results are ASCII-sorted by log group name.</p>
295
- * <p>CloudWatch Logs doesn’t support IAM policies that control access to the <code>DescribeLogGroups</code> action by using the
296
- * <code>aws:ResourceTag/<i>key-name</i>
297
- * </code> condition key. Other CloudWatch Logs actions
298
- * do support the use of the <code>aws:ResourceTag/<i>key-name</i>
299
- * </code> condition key to control access.
300
- * For more information about using tags to control access, see
301
- * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Controlling access to Amazon Web Services resources using tags</a>.</p>
302
- * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
303
- * view data from the linked source accounts. For more information, see
304
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
149
+ * @see {@link DescribeLogGroupsCommand}
305
150
  */
306
151
  describeLogGroups(args: DescribeLogGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLogGroupsCommandOutput>;
307
152
  describeLogGroups(args: DescribeLogGroupsCommandInput, cb: (err: any, data?: DescribeLogGroupsCommandOutput) => void): void;
308
153
  describeLogGroups(args: DescribeLogGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLogGroupsCommandOutput) => void): void;
309
154
  /**
310
- * @public
311
- * <p>Lists the log streams for the specified log group.
312
- * You can list all the log streams or filter the results by prefix.
313
- * You can also control how the results are ordered.</p>
314
- * <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
315
- * You must include one of these two parameters, but you can't include both.
316
- * </p>
317
- * <p>This operation has a limit of five transactions per second, after which transactions are throttled.</p>
318
- * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
319
- * view data from the linked source accounts. For more information, see
320
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
155
+ * @see {@link DescribeLogStreamsCommand}
321
156
  */
322
157
  describeLogStreams(args: DescribeLogStreamsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeLogStreamsCommandOutput>;
323
158
  describeLogStreams(args: DescribeLogStreamsCommandInput, cb: (err: any, data?: DescribeLogStreamsCommandOutput) => void): void;
324
159
  describeLogStreams(args: DescribeLogStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLogStreamsCommandOutput) => void): void;
325
160
  /**
326
- * @public
327
- * <p>Lists the specified metric filters. You can list all of the metric filters or filter
328
- * the results by log name, prefix, metric name, or metric namespace. The results are
329
- * ASCII-sorted by filter name.</p>
161
+ * @see {@link DescribeMetricFiltersCommand}
330
162
  */
331
163
  describeMetricFilters(args: DescribeMetricFiltersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMetricFiltersCommandOutput>;
332
164
  describeMetricFilters(args: DescribeMetricFiltersCommandInput, cb: (err: any, data?: DescribeMetricFiltersCommandOutput) => void): void;
333
165
  describeMetricFilters(args: DescribeMetricFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMetricFiltersCommandOutput) => void): void;
334
166
  /**
335
- * @public
336
- * <p>Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have
337
- * been run recently in this account. You can request all queries or limit it to queries of a
338
- * specific log group or queries with a certain status.</p>
167
+ * @see {@link DescribeQueriesCommand}
339
168
  */
340
169
  describeQueries(args: DescribeQueriesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeQueriesCommandOutput>;
341
170
  describeQueries(args: DescribeQueriesCommandInput, cb: (err: any, data?: DescribeQueriesCommandOutput) => void): void;
342
171
  describeQueries(args: DescribeQueriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQueriesCommandOutput) => void): void;
343
172
  /**
344
- * @public
345
- * <p>This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.</p>
346
- * <p>You can use the <code>queryDefinitionNamePrefix</code> parameter to limit the results to only the
347
- * query definitions that have names that start with a certain string.</p>
173
+ * @see {@link DescribeQueryDefinitionsCommand}
348
174
  */
349
175
  describeQueryDefinitions(args: DescribeQueryDefinitionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeQueryDefinitionsCommandOutput>;
350
176
  describeQueryDefinitions(args: DescribeQueryDefinitionsCommandInput, cb: (err: any, data?: DescribeQueryDefinitionsCommandOutput) => void): void;
351
177
  describeQueryDefinitions(args: DescribeQueryDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQueryDefinitionsCommandOutput) => void): void;
352
178
  /**
353
- * @public
354
- * <p>Lists the resource policies in this account.</p>
179
+ * @see {@link DescribeResourcePoliciesCommand}
355
180
  */
356
181
  describeResourcePolicies(args: DescribeResourcePoliciesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeResourcePoliciesCommandOutput>;
357
182
  describeResourcePolicies(args: DescribeResourcePoliciesCommandInput, cb: (err: any, data?: DescribeResourcePoliciesCommandOutput) => void): void;
358
183
  describeResourcePolicies(args: DescribeResourcePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourcePoliciesCommandOutput) => void): void;
359
184
  /**
360
- * @public
361
- * <p>Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix.
362
- * The results are ASCII-sorted by filter name.</p>
185
+ * @see {@link DescribeSubscriptionFiltersCommand}
363
186
  */
364
187
  describeSubscriptionFilters(args: DescribeSubscriptionFiltersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSubscriptionFiltersCommandOutput>;
365
188
  describeSubscriptionFilters(args: DescribeSubscriptionFiltersCommandInput, cb: (err: any, data?: DescribeSubscriptionFiltersCommandOutput) => void): void;
366
189
  describeSubscriptionFilters(args: DescribeSubscriptionFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubscriptionFiltersCommandOutput) => void): void;
367
190
  /**
368
- * @public
369
- * <p>Disassociates the associated KMS key from the specified log
370
- * group.</p>
371
- * <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
372
- * remains encrypted, and CloudWatch Logs requires permissions for the KMS key
373
- * whenever the encrypted data is requested.</p>
374
- * <p>Note that it can take up to 5 minutes for this operation to take effect.</p>
191
+ * @see {@link DisassociateKmsKeyCommand}
375
192
  */
376
193
  disassociateKmsKey(args: DisassociateKmsKeyCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateKmsKeyCommandOutput>;
377
194
  disassociateKmsKey(args: DisassociateKmsKeyCommandInput, cb: (err: any, data?: DisassociateKmsKeyCommandOutput) => void): void;
378
195
  disassociateKmsKey(args: DisassociateKmsKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateKmsKeyCommandOutput) => void): void;
379
196
  /**
380
- * @public
381
- * <p>Lists log events from the specified log group. You can list all the log events or filter the results
382
- * using a filter pattern, a time range, and the name of the log stream.</p>
383
- * <p>You must have the <code>logs;FilterLogEvents</code> permission to perform this operation.</p>
384
- * <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
385
- * You must include one of these two parameters, but you can't include both.
386
- * </p>
387
- * <p>By default, this operation returns as many log events as can fit in 1 MB (up to 10,000
388
- * log events) or all the events found within the specified time range. If the results include a
389
- * token, that means there are more log events available. You can get additional results by
390
- * specifying the token in a subsequent call. This operation can return empty results while there
391
- * are more log events available through the token.</p>
392
- * <p>The returned log events are sorted by event timestamp, the timestamp when the event was ingested
393
- * by CloudWatch Logs, and the ID of the <code>PutLogEvents</code> request.</p>
394
- * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
395
- * view data from the linked source accounts. For more information, see
396
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
197
+ * @see {@link FilterLogEventsCommand}
397
198
  */
398
199
  filterLogEvents(args: FilterLogEventsCommandInput, options?: __HttpHandlerOptions): Promise<FilterLogEventsCommandOutput>;
399
200
  filterLogEvents(args: FilterLogEventsCommandInput, cb: (err: any, data?: FilterLogEventsCommandOutput) => void): void;
400
201
  filterLogEvents(args: FilterLogEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FilterLogEventsCommandOutput) => void): void;
401
202
  /**
402
- * @public
403
- * <p>Returns information about a log group data protection policy.</p>
203
+ * @see {@link GetDataProtectionPolicyCommand}
404
204
  */
405
205
  getDataProtectionPolicy(args: GetDataProtectionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetDataProtectionPolicyCommandOutput>;
406
206
  getDataProtectionPolicy(args: GetDataProtectionPolicyCommandInput, cb: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void): void;
407
207
  getDataProtectionPolicy(args: GetDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void): void;
408
208
  /**
409
- * @public
410
- * <p>Lists log events from the specified log stream. You can list all of the log events or
411
- * filter using a time range.</p>
412
- * <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).
413
- * You can get additional log events by specifying one of the tokens in a subsequent call.
414
- * This operation can return empty results while there are more log events available through the token.</p>
415
- * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
416
- * view data from the linked source accounts. For more information, see
417
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
418
- * <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
419
- * You must include one of these two parameters, but you can't include both.
420
- * </p>
209
+ * @see {@link GetLogEventsCommand}
421
210
  */
422
211
  getLogEvents(args: GetLogEventsCommandInput, options?: __HttpHandlerOptions): Promise<GetLogEventsCommandOutput>;
423
212
  getLogEvents(args: GetLogEventsCommandInput, cb: (err: any, data?: GetLogEventsCommandOutput) => void): void;
424
213
  getLogEvents(args: GetLogEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLogEventsCommandOutput) => void): void;
425
214
  /**
426
- * @public
427
- * <p>Returns a list of the fields that are included in log events in the specified log group.
428
- * Includes the percentage of log events that contain each field. The search is limited to a time
429
- * period that you specify.</p>
430
- * <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
431
- * You must specify one of these parameters, but you can't specify both.
432
- * </p>
433
- * <p>In the results, fields that start with <code>@</code> are fields generated by CloudWatch
434
- * Logs. For example, <code>@timestamp</code> is the timestamp of each log event. For more
435
- * 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
436
- * Logs and Discovered Fields</a>.</p>
437
- * <p>The response results are sorted by the frequency percentage, starting
438
- * with the highest percentage.</p>
439
- * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
440
- * view data from the linked source accounts. For more information, see
441
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
215
+ * @see {@link GetLogGroupFieldsCommand}
442
216
  */
443
217
  getLogGroupFields(args: GetLogGroupFieldsCommandInput, options?: __HttpHandlerOptions): Promise<GetLogGroupFieldsCommandOutput>;
444
218
  getLogGroupFields(args: GetLogGroupFieldsCommandInput, cb: (err: any, data?: GetLogGroupFieldsCommandOutput) => void): void;
445
219
  getLogGroupFields(args: GetLogGroupFieldsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLogGroupFieldsCommandOutput) => void): void;
446
220
  /**
447
- * @public
448
- * <p>Retrieves all of the fields and values of a single log event. All fields are retrieved,
449
- * even if the original query that produced the <code>logRecordPointer</code> retrieved only a
450
- * subset of fields. Fields are returned as field name/field value pairs.</p>
451
- * <p>The full unparsed log event is returned within <code>@message</code>.</p>
221
+ * @see {@link GetLogRecordCommand}
452
222
  */
453
223
  getLogRecord(args: GetLogRecordCommandInput, options?: __HttpHandlerOptions): Promise<GetLogRecordCommandOutput>;
454
224
  getLogRecord(args: GetLogRecordCommandInput, cb: (err: any, data?: GetLogRecordCommandOutput) => void): void;
455
225
  getLogRecord(args: GetLogRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLogRecordCommandOutput) => void): void;
456
226
  /**
457
- * @public
458
- * <p>Returns the results from the specified query.</p>
459
- * <p>Only the fields requested in the query are returned, along with a <code>@ptr</code>
460
- * field, which is the identifier for the log record. You can use the value of <code>@ptr</code>
461
- * in a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogRecord.html">GetLogRecord</a>
462
- * operation to get the full log record.</p>
463
- * <p>
464
- * <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>
465
- * <p>If the value of the <code>Status</code> field in the output is <code>Running</code>, this operation
466
- * returns only partial results. If you see a value of <code>Scheduled</code> or <code>Running</code> for the status,
467
- * you can retry the operation later to see the final results. </p>
468
- * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start
469
- * queries in linked source accounts. For more information, see
470
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
227
+ * @see {@link GetQueryResultsCommand}
471
228
  */
472
229
  getQueryResults(args: GetQueryResultsCommandInput, options?: __HttpHandlerOptions): Promise<GetQueryResultsCommandOutput>;
473
230
  getQueryResults(args: GetQueryResultsCommandInput, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void;
474
231
  getQueryResults(args: GetQueryResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void;
475
232
  /**
476
- * @public
477
- * <p>Displays the tags associated with a CloudWatch Logs resource. Currently, log groups
478
- * and destinations support tagging.</p>
233
+ * @see {@link ListTagsForResourceCommand}
479
234
  */
480
235
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
481
236
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
482
237
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
483
238
  /**
484
- * @public
485
- * @deprecated
486
- *
487
- * <important>
488
- * <p>The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use
489
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a> instead.</p>
490
- * </important>
491
- * <p>Lists the tags for the specified log group.</p>
239
+ * @see {@link ListTagsLogGroupCommand}
492
240
  */
493
241
  listTagsLogGroup(args: ListTagsLogGroupCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsLogGroupCommandOutput>;
494
242
  listTagsLogGroup(args: ListTagsLogGroupCommandInput, cb: (err: any, data?: ListTagsLogGroupCommandOutput) => void): void;
495
243
  listTagsLogGroup(args: ListTagsLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsLogGroupCommandOutput) => void): void;
496
244
  /**
497
- * @public
498
- * <p>Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive
499
- * data that's ingested by the log group by auditing and masking the sensitive log data.</p>
500
- * <important>
501
- * <p>Sensitive data is detected and masked when it is ingested into the log group. When you set a
502
- * data protection policy, log events ingested into the log group before that time are not masked.</p>
503
- * </important>
504
- * <p>By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.
505
- * A user who has the <code>logs:Unmask</code> permission can use a
506
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html">GetLogEvents</a> or
507
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html">FilterLogEvents</a>
508
- * operation with the <code>unmask</code> parameter set to <code>true</code> to view the unmasked
509
- * log events. Users with the <code>logs:Unmask</code> can also view unmasked data in the CloudWatch Logs
510
- * console by running a CloudWatch Logs Insights query with the <code>unmask</code> query command.</p>
511
- * <p>For more information, including a list of types of data that can be audited and masked, see
512
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html">Protect sensitive log data with masking</a>.</p>
245
+ * @see {@link PutDataProtectionPolicyCommand}
513
246
  */
514
247
  putDataProtectionPolicy(args: PutDataProtectionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutDataProtectionPolicyCommandOutput>;
515
248
  putDataProtectionPolicy(args: PutDataProtectionPolicyCommandInput, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void): void;
516
249
  putDataProtectionPolicy(args: PutDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void): void;
517
250
  /**
518
- * @public
519
- * <p>Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.</p>
520
- * <p>A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With
521
- * a destination, you can subscribe to a real-time stream of log events for a different account,
522
- * ingested using <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>.</p>
523
- * <p>Through an access policy, a destination controls what is written to it.
524
- * By default, <code>PutDestination</code> does not set any access policy with the destination,
525
- * which means a cross-account user cannot call <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutSubscriptionFilter.html">PutSubscriptionFilter</a> against
526
- * this destination. To enable this, the destination owner must call <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html">PutDestinationPolicy</a> after <code>PutDestination</code>.</p>
527
- * <p>To perform a <code>PutDestination</code> operation, you must also have the
528
- * <code>iam:PassRole</code> permission.</p>
251
+ * @see {@link PutDestinationCommand}
529
252
  */
530
253
  putDestination(args: PutDestinationCommandInput, options?: __HttpHandlerOptions): Promise<PutDestinationCommandOutput>;
531
254
  putDestination(args: PutDestinationCommandInput, cb: (err: any, data?: PutDestinationCommandOutput) => void): void;
532
255
  putDestination(args: PutDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDestinationCommandOutput) => void): void;
533
256
  /**
534
- * @public
535
- * <p>Creates or updates an access policy associated with an existing
536
- * destination. An access policy is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html">IAM policy document</a> that is used
537
- * to authorize claims to register a subscription filter against a given destination.</p>
257
+ * @see {@link PutDestinationPolicyCommand}
538
258
  */
539
259
  putDestinationPolicy(args: PutDestinationPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutDestinationPolicyCommandOutput>;
540
260
  putDestinationPolicy(args: PutDestinationPolicyCommandInput, cb: (err: any, data?: PutDestinationPolicyCommandOutput) => void): void;
541
261
  putDestinationPolicy(args: PutDestinationPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDestinationPolicyCommandOutput) => void): void;
542
262
  /**
543
- * @public
544
- * <p>Uploads a batch of log events to the specified log stream.</p>
545
- * <important>
546
- * <p>The sequence token is now ignored in <code>PutLogEvents</code>
547
- * actions. <code>PutLogEvents</code>
548
- * actions are always accepted and never return <code>InvalidSequenceTokenException</code> or
549
- * <code>DataAlreadyAcceptedException</code> even if the sequence token is not valid. You can use
550
- * parallel <code>PutLogEvents</code> actions on the same log stream. </p>
551
- * </important>
552
- * <p>The batch of events must satisfy the following constraints:</p>
553
- * <ul>
554
- * <li>
555
- * <p>The maximum batch size is 1,048,576 bytes. This size is calculated as the sum of
556
- * all event messages in UTF-8, plus 26 bytes for each log event.</p>
557
- * </li>
558
- * <li>
559
- * <p>None of the log events in the batch can be more than 2 hours in the future.</p>
560
- * </li>
561
- * <li>
562
- * <p>None of the log events in the batch can be more than 14 days in the past. Also,
563
- * none of the log events can be from earlier than the retention period of the log
564
- * group.</p>
565
- * </li>
566
- * <li>
567
- * <p>The log events in the batch must be in chronological order by their timestamp. The
568
- * timestamp is the time that the event occurred, expressed as the number of milliseconds
569
- * after <code>Jan 1, 1970 00:00:00 UTC</code>. (In Amazon Web Services Tools for PowerShell
570
- * and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format:
571
- * <code>yyyy-mm-ddThh:mm:ss</code>. For example, <code>2017-09-15T13:45:30</code>.) </p>
572
- * </li>
573
- * <li>
574
- * <p>A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.</p>
575
- * </li>
576
- * <li>
577
- * <p>The maximum number of log events in a batch is 10,000.</p>
578
- * </li>
579
- * <li>
580
- * <important>
581
- * <p>The quota of five requests per second per log stream
582
- * has been removed. Instead, <code>PutLogEvents</code> actions are throttled based on a
583
- * per-second per-account quota. You can request an increase to the per-second throttling
584
- * quota by using the Service Quotas service.</p>
585
- * </important>
586
- * </li>
587
- * </ul>
588
- * <p>If a call to <code>PutLogEvents</code> returns "UnrecognizedClientException" the most
589
- * likely cause is a non-valid Amazon Web Services access key ID or secret key. </p>
263
+ * @see {@link PutLogEventsCommand}
590
264
  */
591
265
  putLogEvents(args: PutLogEventsCommandInput, options?: __HttpHandlerOptions): Promise<PutLogEventsCommandOutput>;
592
266
  putLogEvents(args: PutLogEventsCommandInput, cb: (err: any, data?: PutLogEventsCommandOutput) => void): void;
593
267
  putLogEvents(args: PutLogEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLogEventsCommandOutput) => void): void;
594
268
  /**
595
- * @public
596
- * <p>Creates or updates a metric filter and associates it with the specified log group. With
597
- * metric filters, you can configure rules to extract metric data from log events ingested
598
- * through <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>.</p>
599
- * <p>The maximum number of metric filters that can be associated with a log group is
600
- * 100.</p>
601
- * <p>When you create a metric filter, you can also optionally assign a unit and dimensions
602
- * to the metric that is created.</p>
603
- * <important>
604
- * <p>Metrics extracted from log events are charged as custom metrics.
605
- * To prevent unexpected high charges, do not specify high-cardinality fields such as
606
- * <code>IPAddress</code> or <code>requestID</code> as dimensions. Each different value
607
- * found for
608
- * a dimension is treated as a separate metric and accrues charges as a separate custom metric.
609
- * </p>
610
- * <p>CloudWatch Logs disables a metric filter if it generates 1,000 different name/value pairs for
611
- * your specified dimensions within a certain amount of time. This helps to prevent accidental
612
- * high charges.</p>
613
- * <p>You can also set up a billing alarm to alert you if your charges are higher than
614
- * expected. For more information,
615
- * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html">
616
- * Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges</a>.
617
- * </p>
618
- * </important>
269
+ * @see {@link PutMetricFilterCommand}
619
270
  */
620
271
  putMetricFilter(args: PutMetricFilterCommandInput, options?: __HttpHandlerOptions): Promise<PutMetricFilterCommandOutput>;
621
272
  putMetricFilter(args: PutMetricFilterCommandInput, cb: (err: any, data?: PutMetricFilterCommandOutput) => void): void;
622
273
  putMetricFilter(args: PutMetricFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMetricFilterCommandOutput) => void): void;
623
274
  /**
624
- * @public
625
- * <p>Creates or updates a query definition for CloudWatch Logs Insights. For
626
- * more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html">Analyzing Log Data with CloudWatch Logs Insights</a>.</p>
627
- * <p>To update a query definition, specify its <code>queryDefinitionId</code> in your request.
628
- * The values of <code>name</code>, <code>queryString</code>, and <code>logGroupNames</code> are
629
- * changed to the values that you specify in your update operation. No current values are
630
- * retained from the current query definition. For example, imagine updating a current query
631
- * definition that includes log groups. If you don't specify the <code>logGroupNames</code>
632
- * parameter in your update operation, the query definition changes to contain no log
633
- * groups.</p>
634
- * <p>You must have the <code>logs:PutQueryDefinition</code> permission to be able to perform
635
- * this operation.</p>
275
+ * @see {@link PutQueryDefinitionCommand}
636
276
  */
637
277
  putQueryDefinition(args: PutQueryDefinitionCommandInput, options?: __HttpHandlerOptions): Promise<PutQueryDefinitionCommandOutput>;
638
278
  putQueryDefinition(args: PutQueryDefinitionCommandInput, cb: (err: any, data?: PutQueryDefinitionCommandOutput) => void): void;
639
279
  putQueryDefinition(args: PutQueryDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutQueryDefinitionCommandOutput) => void): void;
640
280
  /**
641
- * @public
642
- * <p>Creates or updates a resource policy allowing other Amazon Web Services services to put log events to
643
- * this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services
644
- * Region.</p>
281
+ * @see {@link PutResourcePolicyCommand}
645
282
  */
646
283
  putResourcePolicy(args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutResourcePolicyCommandOutput>;
647
284
  putResourcePolicy(args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
648
285
  putResourcePolicy(args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
649
286
  /**
650
- * @public
651
- * <p>Sets the retention of the specified log group. With a retention policy, you can
652
- * configure the number of days for which to retain log events in the specified log
653
- * group.</p>
654
- * <note>
655
- * <p>CloudWatch Logs doesn’t immediately delete log events when they reach their retention
656
- * setting. It typically takes up to 72 hours after that before log events are deleted, but in
657
- * rare situations might take longer.</p>
658
- * <p>To illustrate, imagine that you change a log group to have a longer retention setting
659
- * when it contains log events that are past the expiration date, but haven’t been deleted.
660
- * Those log events will take up to 72 hours to be deleted after the new retention date is
661
- * reached. To make sure that log data is deleted permanently, keep a log group at its lower
662
- * retention setting until 72 hours after the previous retention period ends. Alternatively,
663
- * wait to change the retention setting until you confirm that the earlier log events are
664
- * deleted. </p>
665
- * </note>
287
+ * @see {@link PutRetentionPolicyCommand}
666
288
  */
667
289
  putRetentionPolicy(args: PutRetentionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutRetentionPolicyCommandOutput>;
668
290
  putRetentionPolicy(args: PutRetentionPolicyCommandInput, cb: (err: any, data?: PutRetentionPolicyCommandOutput) => void): void;
669
291
  putRetentionPolicy(args: PutRetentionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRetentionPolicyCommandOutput) => void): void;
670
292
  /**
671
- * @public
672
- * <p>Creates or updates a subscription filter and associates it with the specified log
673
- * group. With subscription filters, you can subscribe to a real-time stream of log events
674
- * ingested through <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>
675
- * and have them delivered to a specific destination. When log events are sent to the receiving
676
- * service, they are Base64 encoded and compressed with the GZIP format.</p>
677
- * <p>The following destinations are supported for subscription filters:</p>
678
- * <ul>
679
- * <li>
680
- * <p>An Amazon Kinesis data stream belonging to the same account as the subscription
681
- * filter, for same-account delivery.</p>
682
- * </li>
683
- * <li>
684
- * <p>A logical destination that belongs to a different account, for cross-account delivery.</p>
685
- * </li>
686
- * <li>
687
- * <p>An Amazon Kinesis Data Firehose delivery stream that belongs to the same account as
688
- * the subscription filter, for same-account delivery.</p>
689
- * </li>
690
- * <li>
691
- * <p>An Lambda function that belongs to the same account as the
692
- * subscription filter, for same-account delivery.</p>
693
- * </li>
694
- * </ul>
695
- * <p>Each log group can have up to two subscription filters associated with it. If you are
696
- * updating an existing filter, you must specify the correct name in <code>filterName</code>.
697
- * </p>
698
- * <p>To perform a <code>PutSubscriptionFilter</code> operation, you must also have the
699
- * <code>iam:PassRole</code> permission.</p>
293
+ * @see {@link PutSubscriptionFilterCommand}
700
294
  */
701
295
  putSubscriptionFilter(args: PutSubscriptionFilterCommandInput, options?: __HttpHandlerOptions): Promise<PutSubscriptionFilterCommandOutput>;
702
296
  putSubscriptionFilter(args: PutSubscriptionFilterCommandInput, cb: (err: any, data?: PutSubscriptionFilterCommandOutput) => void): void;
703
297
  putSubscriptionFilter(args: PutSubscriptionFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSubscriptionFilterCommandOutput) => void): void;
704
298
  /**
705
- * @public
706
- * <p>Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group
707
- * and time range to query and the query string to use.</p>
708
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query Syntax</a>.</p>
709
- * <p>Queries time out after 15 minutes of runtime. If your queries are timing out, reduce the
710
- * time range being searched or partition your query into a number of queries.</p>
711
- * <p>If you are using CloudWatch cross-account observability, you can use this operation in a
712
- * monitoring account to start a query in a linked source account. For more information, see
713
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch
714
- * cross-account observability</a>. For a cross-account <code>StartQuery</code> operation,
715
- * the query definition must be defined in the monitoring account.</p>
716
- * <p>You can have up to 20 concurrent CloudWatch Logs insights queries, including queries
717
- * that have been added to dashboards. </p>
299
+ * @see {@link StartQueryCommand}
718
300
  */
719
301
  startQuery(args: StartQueryCommandInput, options?: __HttpHandlerOptions): Promise<StartQueryCommandOutput>;
720
302
  startQuery(args: StartQueryCommandInput, cb: (err: any, data?: StartQueryCommandOutput) => void): void;
721
303
  startQuery(args: StartQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartQueryCommandOutput) => void): void;
722
304
  /**
723
- * @public
724
- * <p>Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation
725
- * returns an error indicating that the specified query is not running.</p>
305
+ * @see {@link StopQueryCommand}
726
306
  */
727
307
  stopQuery(args: StopQueryCommandInput, options?: __HttpHandlerOptions): Promise<StopQueryCommandOutput>;
728
308
  stopQuery(args: StopQueryCommandInput, cb: (err: any, data?: StopQueryCommandOutput) => void): void;
729
309
  stopQuery(args: StopQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopQueryCommandOutput) => void): void;
730
310
  /**
731
- * @public
732
- * @deprecated
733
- *
734
- * <important>
735
- * <p>The TagLogGroup operation is on the path to deprecation. We recommend that you use
736
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html">TagResource</a> instead.</p>
737
- * </important>
738
- * <p>Adds or updates the specified tags for the specified log group.</p>
739
- * <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>.
740
- * To remove tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html">UntagResource</a>.</p>
741
- * <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>
742
- * in the <i>Amazon CloudWatch Logs User Guide</i>.</p>
743
- * <p>CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to
744
- * log groups using the <code>aws:Resource/<i>key-name</i>
745
- * </code> or <code>aws:TagKeys</code> condition keys.
746
- * For more information about using tags to control access, see
747
- * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Controlling access to Amazon Web Services resources using tags</a>.</p>
311
+ * @see {@link TagLogGroupCommand}
748
312
  */
749
313
  tagLogGroup(args: TagLogGroupCommandInput, options?: __HttpHandlerOptions): Promise<TagLogGroupCommandOutput>;
750
314
  tagLogGroup(args: TagLogGroupCommandInput, cb: (err: any, data?: TagLogGroupCommandOutput) => void): void;
751
315
  tagLogGroup(args: TagLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagLogGroupCommandOutput) => void): void;
752
316
  /**
753
- * @public
754
- * <p>Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource.
755
- * Currently, the only CloudWatch Logs resources that
756
- * can be tagged are log groups and destinations. </p>
757
- * <p>Tags can help you organize and categorize your resources. You can also use them to scope user
758
- * permissions by granting a user
759
- * permission to access or change only resources with certain tag values.</p>
760
- * <p>Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.</p>
761
- * <p>You can use the <code>TagResource</code> action with a resource that already has tags. If you specify a new tag key for the alarm,
762
- * this tag is appended to the list of tags associated
763
- * with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces
764
- * the previous value for that tag.</p>
765
- * <p>You can associate as many as 50 tags with a CloudWatch Logs resource.</p>
317
+ * @see {@link TagResourceCommand}
766
318
  */
767
319
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
768
320
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
769
321
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
770
322
  /**
771
- * @public
772
- * <p>Tests the filter pattern of a metric filter against a sample of log event messages. You
773
- * can use this operation to validate the correctness of a metric filter pattern.</p>
323
+ * @see {@link TestMetricFilterCommand}
774
324
  */
775
325
  testMetricFilter(args: TestMetricFilterCommandInput, options?: __HttpHandlerOptions): Promise<TestMetricFilterCommandOutput>;
776
326
  testMetricFilter(args: TestMetricFilterCommandInput, cb: (err: any, data?: TestMetricFilterCommandOutput) => void): void;
777
327
  testMetricFilter(args: TestMetricFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestMetricFilterCommandOutput) => void): void;
778
328
  /**
779
- * @public
780
- * @deprecated
781
- *
782
- * <important>
783
- * <p>The UntagLogGroup operation is on the path to deprecation. We recommend that you use
784
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UntagResource.html">UntagResource</a> instead.</p>
785
- * </important>
786
- * <p>Removes the specified tags from the specified log group.</p>
787
- * <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>.
788
- * To add tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
789
- * <p>CloudWatch Logs doesn’t support IAM policies that prevent users from assigning specified tags to
790
- * log groups using the <code>aws:Resource/<i>key-name</i>
791
- * </code> or <code>aws:TagKeys</code> condition keys.
792
- * </p>
329
+ * @see {@link UntagLogGroupCommand}
793
330
  */
794
331
  untagLogGroup(args: UntagLogGroupCommandInput, options?: __HttpHandlerOptions): Promise<UntagLogGroupCommandOutput>;
795
332
  untagLogGroup(args: UntagLogGroupCommandInput, cb: (err: any, data?: UntagLogGroupCommandOutput) => void): void;
796
333
  untagLogGroup(args: UntagLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagLogGroupCommandOutput) => void): void;
797
334
  /**
798
- * @public
799
- * <p>Removes one or more tags from the specified resource.</p>
335
+ * @see {@link UntagResourceCommand}
800
336
  */
801
337
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
802
338
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
803
339
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
804
340
  }
341
+ /**
342
+ * @public
343
+ * <p>You can use Amazon CloudWatch Logs to monitor, store, and access your log files from
344
+ * EC2 instances, CloudTrail, and other sources. You can then retrieve the associated
345
+ * log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use
346
+ * CloudWatch Logs commands in the Amazon Web Services CLI, CloudWatch Logs API, or CloudWatch
347
+ * Logs SDK.</p>
348
+ * <p>You can use CloudWatch Logs to:</p>
349
+ * <ul>
350
+ * <li>
351
+ * <p>
352
+ * <b>Monitor logs from EC2 instances in real time</b>: You
353
+ * can use CloudWatch Logs to monitor applications and systems using log data. For example,
354
+ * CloudWatch Logs can track the number of errors that occur in your application logs. Then,
355
+ * it can send you a notification whenever the rate of errors exceeds a threshold that you
356
+ * specify. CloudWatch Logs uses your log data for monitoring so no code changes are
357
+ * required. For example, you can monitor application logs for specific literal terms (such
358
+ * as "NullReferenceException"). You can also count the number of occurrences of a literal
359
+ * term at a particular position in log data (such as "404" status codes in an Apache access
360
+ * log). When the term you are searching for is found, CloudWatch Logs reports the data to a
361
+ * CloudWatch metric that you specify.</p>
362
+ * </li>
363
+ * <li>
364
+ * <p>
365
+ * <b>Monitor CloudTrail logged events</b>: You can
366
+ * create alarms in CloudWatch and receive notifications of particular API activity as
367
+ * captured by CloudTrail. You can use the notification to perform troubleshooting.</p>
368
+ * </li>
369
+ * <li>
370
+ * <p>
371
+ * <b>Archive log data</b>: You can use CloudWatch Logs to
372
+ * store your log data in highly durable storage. You can change the log retention setting so
373
+ * that any log events earlier than this setting are automatically deleted. The CloudWatch
374
+ * Logs agent helps to quickly send both rotated and non-rotated log data off of a host and
375
+ * into the log service. You can then access the raw log data when you need it.</p>
376
+ * </li>
377
+ * </ul>
378
+ */
379
+ export declare class CloudWatchLogs extends CloudWatchLogsClient implements CloudWatchLogs {
380
+ }