@aws-sdk/client-cloudwatch-logs 3.245.0 → 3.252.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.
@@ -292,6 +292,9 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
292
292
  * <p>Lists the log streams for the specified log group.
293
293
  * You can list all the log streams or filter the results by prefix.
294
294
  * You can also control how the results are ordered.</p>
295
+ * <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
296
+ * You must include one of these two parameters, but you can't include both.
297
+ * </p>
295
298
  * <p>This operation has a limit of five transactions per second, after which transactions are throttled.</p>
296
299
  * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
297
300
  * view data from the linked source accounts. For more information, see
@@ -352,6 +355,9 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
352
355
  * <p>Lists log events from the specified log group. You can list all the log events or filter the results
353
356
  * using a filter pattern, a time range, and the name of the log stream.</p>
354
357
  * <p>You must have the <code>logs;FilterLogEvents</code> permission to perform this operation.</p>
358
+ * <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
359
+ * You must include one of these two parameters, but you can't include both.
360
+ * </p>
355
361
  * <p>By default, this operation returns as many log events as can fit in 1 MB (up to 10,000
356
362
  * log events) or all the events found within the specified time range. If the results include a
357
363
  * token, that means there are more log events available. You can get additional results by
@@ -381,6 +387,9 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
381
387
  * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
382
388
  * view data from the linked source accounts. For more information, see
383
389
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
390
+ * <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
391
+ * You must include one of these two parameters, but you can't include both.
392
+ * </p>
384
393
  */
385
394
  getLogEvents(args: GetLogEventsCommandInput, options?: __HttpHandlerOptions): Promise<GetLogEventsCommandOutput>;
386
395
  getLogEvents(args: GetLogEventsCommandInput, cb: (err: any, data?: GetLogEventsCommandOutput) => void): void;
@@ -389,6 +398,9 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
389
398
  * <p>Returns a list of the fields that are included in log events in the specified log group.
390
399
  * Includes the percentage of log events that contain each field. The search is limited to a time
391
400
  * period that you specify.</p>
401
+ * <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
402
+ * You must specify one of these parameters, but you can't specify both.
403
+ * </p>
392
404
  * <p>In the results, fields that start with <code>@</code> are fields generated by CloudWatch
393
405
  * Logs. For example, <code>@timestamp</code> is the timestamp of each log event. For more
394
406
  * 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
@@ -11,6 +11,9 @@ export interface DescribeLogStreamsCommandOutput extends DescribeLogStreamsRespo
11
11
  * <p>Lists the log streams for the specified log group.
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
+ * <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
15
+ * You must include one of these two parameters, but you can't include both.
16
+ * </p>
14
17
  * <p>This operation has a limit of five transactions per second, after which transactions are throttled.</p>
15
18
  * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
16
19
  * view data from the linked source accounts. For more information, see
@@ -11,6 +11,9 @@ 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
+ * <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
15
+ * You must include one of these two parameters, but you can't include both.
16
+ * </p>
14
17
  * <p>By default, this operation returns as many log events as can fit in 1 MB (up to 10,000
15
18
  * log events) or all the events found within the specified time range. If the results include a
16
19
  * token, that means there are more log events available. You can get additional results by
@@ -16,6 +16,9 @@ export interface GetLogEventsCommandOutput extends GetLogEventsResponse, __Metad
16
16
  * <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
17
17
  * view data from the linked source accounts. For more information, see
18
18
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
19
+ * <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
20
+ * You must include one of these two parameters, but you can't include both.
21
+ * </p>
19
22
  * @example
20
23
  * Use a bare-bones client and the command you need to make an API call.
21
24
  * ```javascript
@@ -11,6 +11,9 @@ export interface GetLogGroupFieldsCommandOutput extends GetLogGroupFieldsRespons
11
11
  * <p>Returns a list of the fields that are included in log events in the specified log group.
12
12
  * Includes the percentage of log events that contain each field. The search is limited to a time
13
13
  * period that you specify.</p>
14
+ * <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
15
+ * You must specify one of these parameters, but you can't specify both.
16
+ * </p>
14
17
  * <p>In the results, fields that start with <code>@</code> are fields generated by CloudWatch
15
18
  * Logs. For example, <code>@timestamp</code> is the timestamp of each log event. For more
16
19
  * 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
@@ -558,13 +558,16 @@ export interface DescribeLogStreamsRequest {
558
558
  * </p>
559
559
  * </note>
560
560
  */
561
- logGroupName: string | undefined;
561
+ logGroupName?: string;
562
562
  /**
563
563
  * <p>Specify either the name or ARN of the log group to view. If the log group is in a source account
564
564
  * and you are using a monitoring account, you must use the log group ARN.</p>
565
- * <p>If you specify values for both <code>logGroupName</code> and
566
- * <code>logGroupIdentifier</code>, the action returns an
567
- * <code>InvalidParameterException</code> error.</p>
565
+ * <note>
566
+ * <p>
567
+ * If you specify values for both <code>logGroupName</code> and <code>logGroupIdentifier</code>,
568
+ * the action returns an <code>InvalidParameterException</code> error.
569
+ * </p>
570
+ * </note>
568
571
  */
569
572
  logGroupIdentifier?: string;
570
573
  /**
@@ -1080,13 +1083,16 @@ export interface FilterLogEventsRequest {
1080
1083
  * </p>
1081
1084
  * </note>
1082
1085
  */
1083
- logGroupName: string | undefined;
1086
+ logGroupName?: string;
1084
1087
  /**
1085
1088
  * <p>Specify either the name or ARN of the log group to view log events from. If the log group is in a source account
1086
1089
  * and you are using a monitoring account, you must use the log group ARN.</p>
1087
- * <p>If you specify values for both <code>logGroupName</code> and
1088
- * <code>logGroupIdentifier</code>, the action returns an
1089
- * <code>InvalidParameterException</code> error.</p>
1090
+ * <note>
1091
+ * <p>
1092
+ * If you specify values for both <code>logGroupName</code> and <code>logGroupIdentifier</code>,
1093
+ * the action returns an <code>InvalidParameterException</code> error.
1094
+ * </p>
1095
+ * </note>
1090
1096
  */
1091
1097
  logGroupIdentifier?: string;
1092
1098
  /**
@@ -1208,12 +1214,16 @@ export interface GetLogEventsRequest {
1208
1214
  * </p>
1209
1215
  * </note>
1210
1216
  */
1211
- logGroupName: string | undefined;
1217
+ logGroupName?: string;
1212
1218
  /**
1213
1219
  * <p>Specify either the name or ARN of the log group to view events from. If the log group is in a source account
1214
1220
  * and you are using a monitoring account, you must use the log group ARN.</p>
1215
- * <p> If you specify values for both <code>logGroupName</code> and <code>logGroupIdentifier</code>,
1216
- * the action returns an <code>InvalidParameterException</code> error.</p>
1221
+ * <note>
1222
+ * <p>
1223
+ * If you specify values for both <code>logGroupName</code> and <code>logGroupIdentifier</code>,
1224
+ * the action returns an <code>InvalidParameterException</code> error.
1225
+ * </p>
1226
+ * </note>
1217
1227
  */
1218
1228
  logGroupIdentifier?: string;
1219
1229
  /**
@@ -1297,11 +1307,14 @@ export interface GetLogEventsResponse {
1297
1307
  export interface GetLogGroupFieldsRequest {
1298
1308
  /**
1299
1309
  * <p>The name of the log group to search.</p>
1300
- * <p>If you specify values for both <code>logGroupName</code> and
1301
- * <code>logGroupIdentifier</code>, the action returns an
1302
- * <code>InvalidParameterException</code> error.</p>
1310
+ * <note>
1311
+ * <p>
1312
+ * If you specify values for both <code>logGroupName</code> and <code>logGroupIdentifier</code>,
1313
+ * the action returns an <code>InvalidParameterException</code> error.
1314
+ * </p>
1315
+ * </note>
1303
1316
  */
1304
- logGroupName: string | undefined;
1317
+ logGroupName?: string;
1305
1318
  /**
1306
1319
  * <p>The time to set as the center of the query. If you specify <code>time</code>, the 15
1307
1320
  * minutes before this time are queries. If you omit <code>time</code>, the 8 minutes before and
@@ -1313,9 +1326,12 @@ export interface GetLogGroupFieldsRequest {
1313
1326
  /**
1314
1327
  * <p>Specify either the name or ARN of the log group to view. If the log group is in a source account and
1315
1328
  * you are using a monitoring account, you must specify the ARN.</p>
1316
- * <p>If you specify values for both <code>logGroupName</code> and
1317
- * <code>logGroupIdentifier</code>, the action returns an
1318
- * <code>InvalidParameterException</code> error.</p>
1329
+ * <note>
1330
+ * <p>
1331
+ * If you specify values for both <code>logGroupName</code> and <code>logGroupIdentifier</code>,
1332
+ * the action returns an <code>InvalidParameterException</code> error.
1333
+ * </p>
1334
+ * </note>
1319
1335
  */
1320
1336
  logGroupIdentifier?: string;
1321
1337
  }
@@ -205,7 +205,7 @@ export declare enum OrderBy {
205
205
  LogStreamName = "LogStreamName",
206
206
  }
207
207
  export interface DescribeLogStreamsRequest {
208
- logGroupName: string | undefined;
208
+ logGroupName?: string;
209
209
  logGroupIdentifier?: string;
210
210
  logStreamNamePrefix?: string;
211
211
  orderBy?: OrderBy | string;
@@ -372,7 +372,7 @@ export interface FilteredLogEvent {
372
372
  eventId?: string;
373
373
  }
374
374
  export interface FilterLogEventsRequest {
375
- logGroupName: string | undefined;
375
+ logGroupName?: string;
376
376
  logGroupIdentifier?: string;
377
377
  logStreamNames?: string[];
378
378
  logStreamNamePrefix?: string;
@@ -402,7 +402,7 @@ export interface GetDataProtectionPolicyResponse {
402
402
  lastUpdatedTime?: number;
403
403
  }
404
404
  export interface GetLogEventsRequest {
405
- logGroupName: string | undefined;
405
+ logGroupName?: string;
406
406
  logGroupIdentifier?: string;
407
407
  logStreamName: string | undefined;
408
408
  startTime?: number;
@@ -423,7 +423,7 @@ export interface GetLogEventsResponse {
423
423
  nextBackwardToken?: string;
424
424
  }
425
425
  export interface GetLogGroupFieldsRequest {
426
- logGroupName: string | undefined;
426
+ logGroupName?: string;
427
427
  time?: number;
428
428
  logGroupIdentifier?: string;
429
429
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cloudwatch-logs",
3
3
  "description": "AWS SDK for JavaScript Cloudwatch Logs Client for Node.js, Browser and React Native",
4
- "version": "3.245.0",
4
+ "version": "3.252.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -11,7 +11,7 @@
11
11
  "build:types": "tsc -p tsconfig.types.json",
12
12
  "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
13
13
  "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
14
- "generate:client": "(cd ../../ && yarn generate-clients -g ./codegen/sdk-codegen/aws-models/cloudwatch-logs.json --keepFiles)"
14
+ "generate:client": "node ../../scripts/generate-clients/single-service --solo cloudwatch-logs"
15
15
  },
16
16
  "main": "./dist-cjs/index.js",
17
17
  "types": "./dist-types/index.d.ts",
@@ -20,9 +20,9 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "2.0.0",
22
22
  "@aws-crypto/sha256-js": "2.0.0",
23
- "@aws-sdk/client-sts": "3.245.0",
23
+ "@aws-sdk/client-sts": "3.252.0",
24
24
  "@aws-sdk/config-resolver": "3.234.0",
25
- "@aws-sdk/credential-provider-node": "3.245.0",
25
+ "@aws-sdk/credential-provider-node": "3.252.0",
26
26
  "@aws-sdk/fetch-http-handler": "3.226.0",
27
27
  "@aws-sdk/hash-node": "3.226.0",
28
28
  "@aws-sdk/invalid-dependency": "3.226.0",