@aws-sdk/client-cloudwatch-logs 3.845.0 → 3.847.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. package/README.md +2 -2
  2. package/dist-cjs/index.js +8 -1
  3. package/dist-es/models/models_0.js +5 -0
  4. package/dist-types/CloudWatchLogs.d.ts +2 -2
  5. package/dist-types/CloudWatchLogsClient.d.ts +2 -2
  6. package/dist-types/commands/AssociateKmsKeyCommand.d.ts +30 -29
  7. package/dist-types/commands/CreateDeliveryCommand.d.ts +22 -25
  8. package/dist-types/commands/CreateExportTaskCommand.d.ts +10 -9
  9. package/dist-types/commands/CreateLogAnomalyDetectorCommand.d.ts +19 -25
  10. package/dist-types/commands/CreateLogGroupCommand.d.ts +5 -3
  11. package/dist-types/commands/CreateLogStreamCommand.d.ts +6 -5
  12. package/dist-types/commands/DeleteAccountPolicyCommand.d.ts +17 -12
  13. package/dist-types/commands/DeleteDeliveryCommand.d.ts +5 -3
  14. package/dist-types/commands/DeleteDeliveryDestinationCommand.d.ts +6 -4
  15. package/dist-types/commands/DeleteDeliveryDestinationPolicyCommand.d.ts +2 -2
  16. package/dist-types/commands/DeleteDeliverySourceCommand.d.ts +6 -4
  17. package/dist-types/commands/DeleteDestinationCommand.d.ts +3 -3
  18. package/dist-types/commands/DeleteIndexPolicyCommand.d.ts +7 -6
  19. package/dist-types/commands/DeleteIntegrationCommand.d.ts +6 -5
  20. package/dist-types/commands/DeleteLogGroupCommand.d.ts +2 -2
  21. package/dist-types/commands/DeleteLogStreamCommand.d.ts +2 -2
  22. package/dist-types/commands/DeleteQueryDefinitionCommand.d.ts +2 -2
  23. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +7 -2
  24. package/dist-types/commands/DeleteRetentionPolicyCommand.d.ts +2 -1
  25. package/dist-types/commands/DeleteTransformerCommand.d.ts +6 -6
  26. package/dist-types/commands/DescribeAccountPoliciesCommand.d.ts +12 -8
  27. package/dist-types/commands/DescribeConfigurationTemplatesCommand.d.ts +5 -4
  28. package/dist-types/commands/DescribeDeliveriesCommand.d.ts +9 -11
  29. package/dist-types/commands/DescribeDeliveryDestinationsCommand.d.ts +3 -2
  30. package/dist-types/commands/DescribeDestinationsCommand.d.ts +2 -1
  31. package/dist-types/commands/DescribeExportTasksCommand.d.ts +2 -2
  32. package/dist-types/commands/DescribeFieldIndexesCommand.d.ts +2 -3
  33. package/dist-types/commands/DescribeIndexPoliciesCommand.d.ts +6 -6
  34. package/dist-types/commands/DescribeLogGroupsCommand.d.ts +13 -11
  35. package/dist-types/commands/DescribeLogStreamsCommand.d.ts +10 -10
  36. package/dist-types/commands/DescribeQueryDefinitionsCommand.d.ts +5 -4
  37. package/dist-types/commands/DescribeResourcePoliciesCommand.d.ts +5 -0
  38. package/dist-types/commands/DescribeSubscriptionFiltersCommand.d.ts +3 -2
  39. package/dist-types/commands/DisassociateKmsKeyCommand.d.ts +13 -13
  40. package/dist-types/commands/FilterLogEventsCommand.d.ts +31 -20
  41. package/dist-types/commands/GetDeliveryCommand.d.ts +12 -13
  42. package/dist-types/commands/GetDeliveryDestinationCommand.d.ts +1 -1
  43. package/dist-types/commands/GetDeliveryDestinationPolicyCommand.d.ts +2 -3
  44. package/dist-types/commands/GetLogEventsCommand.d.ts +25 -17
  45. package/dist-types/commands/GetLogGroupFieldsCommand.d.ts +8 -8
  46. package/dist-types/commands/GetQueryResultsCommand.d.ts +13 -11
  47. package/dist-types/commands/GetTransformerCommand.d.ts +2 -2
  48. package/dist-types/commands/ListAnomaliesCommand.d.ts +3 -2
  49. package/dist-types/commands/ListIntegrationsCommand.d.ts +3 -2
  50. package/dist-types/commands/ListLogGroupsCommand.d.ts +8 -7
  51. package/dist-types/commands/ListLogGroupsForQueryCommand.d.ts +6 -5
  52. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
  53. package/dist-types/commands/ListTagsLogGroupCommand.d.ts +1 -1
  54. package/dist-types/commands/PutAccountPolicyCommand.d.ts +113 -98
  55. package/dist-types/commands/PutDataProtectionPolicyCommand.d.ts +20 -19
  56. package/dist-types/commands/PutDeliveryDestinationCommand.d.ts +28 -28
  57. package/dist-types/commands/PutDeliveryDestinationPolicyCommand.d.ts +18 -20
  58. package/dist-types/commands/PutDeliverySourceCommand.d.ts +23 -25
  59. package/dist-types/commands/PutDestinationCommand.d.ts +7 -6
  60. package/dist-types/commands/PutDestinationPolicyCommand.d.ts +4 -3
  61. package/dist-types/commands/PutIndexPolicyCommand.d.ts +24 -23
  62. package/dist-types/commands/PutIntegrationCommand.d.ts +8 -6
  63. package/dist-types/commands/PutLogEventsCommand.d.ts +27 -24
  64. package/dist-types/commands/PutMetricFilterCommand.d.ts +14 -18
  65. package/dist-types/commands/PutQueryDefinitionCommand.d.ts +3 -3
  66. package/dist-types/commands/PutResourcePolicyCommand.d.ts +15 -3
  67. package/dist-types/commands/PutRetentionPolicyCommand.d.ts +4 -3
  68. package/dist-types/commands/PutSubscriptionFilterCommand.d.ts +11 -12
  69. package/dist-types/commands/PutTransformerCommand.d.ts +24 -19
  70. package/dist-types/commands/StartLiveTailCommand.d.ts +27 -28
  71. package/dist-types/commands/StartQueryCommand.d.ts +28 -30
  72. package/dist-types/commands/StopQueryCommand.d.ts +3 -2
  73. package/dist-types/commands/TagLogGroupCommand.d.ts +10 -10
  74. package/dist-types/commands/TagResourceCommand.d.ts +11 -10
  75. package/dist-types/commands/TestTransformerCommand.d.ts +3 -2
  76. package/dist-types/commands/UntagLogGroupCommand.d.ts +6 -7
  77. package/dist-types/commands/UpdateAnomalyCommand.d.ts +10 -9
  78. package/dist-types/commands/UpdateDeliveryConfigurationCommand.d.ts +3 -3
  79. package/dist-types/index.d.ts +2 -2
  80. package/dist-types/models/models_0.d.ts +1441 -1201
  81. package/dist-types/ts3.4/models/models_0.d.ts +18 -1
  82. package/package.json +5 -5
package/README.md CHANGED
@@ -28,8 +28,8 @@ CloudWatch metric that you specify.</p>
28
28
  </li>
29
29
  <li>
30
30
  <p>
31
- <b>Monitor CloudTrail logged events</b>: You can
32
- create alarms in CloudWatch and receive notifications of particular API activity as
31
+ <b>Monitor CloudTrail logged events</b>: You
32
+ can create alarms in CloudWatch and receive notifications of particular API activity as
33
33
  captured by CloudTrail. You can use the notification to perform troubleshooting.</p>
34
34
  </li>
35
35
  <li>
package/dist-cjs/index.js CHANGED
@@ -114,6 +114,7 @@ __export(index_exports, {
114
114
  OperationAbortedException: () => OperationAbortedException,
115
115
  OrderBy: () => OrderBy,
116
116
  OutputFormat: () => OutputFormat,
117
+ PolicyScope: () => PolicyScope,
117
118
  PolicyType: () => PolicyType,
118
119
  PutAccountPolicyCommand: () => PutAccountPolicyCommand,
119
120
  PutDataProtectionPolicyCommand: () => PutDataProtectionPolicyCommand,
@@ -505,7 +506,8 @@ var OutputFormat = {
505
506
  var DeliveryDestinationType = {
506
507
  CWL: "CWL",
507
508
  FH: "FH",
508
- S3: "S3"
509
+ S3: "S3",
510
+ XRAY: "XRAY"
509
511
  };
510
512
  var ConflictException = class _ConflictException extends CloudWatchLogsServiceException {
511
513
  static {
@@ -708,6 +710,10 @@ var QueryStatus = {
708
710
  Timeout: "Timeout",
709
711
  Unknown: "Unknown"
710
712
  };
713
+ var PolicyScope = {
714
+ ACCOUNT: "ACCOUNT",
715
+ RESOURCE: "RESOURCE"
716
+ };
711
717
  var Distribution = {
712
718
  ByLogStream: "ByLogStream",
713
719
  Random: "Random"
@@ -4618,6 +4624,7 @@ var paginateListLogGroupsForQuery = (0, import_core.createPaginator)(CloudWatchL
4618
4624
  StandardUnit,
4619
4625
  QueryLanguage,
4620
4626
  QueryStatus,
4627
+ PolicyScope,
4621
4628
  Distribution,
4622
4629
  EntityRejectionErrorType,
4623
4630
  EventSource,
@@ -112,6 +112,7 @@ export const DeliveryDestinationType = {
112
112
  CWL: "CWL",
113
113
  FH: "FH",
114
114
  S3: "S3",
115
+ XRAY: "XRAY",
115
116
  };
116
117
  export class ConflictException extends __BaseException {
117
118
  name = "ConflictException";
@@ -272,6 +273,10 @@ export const QueryStatus = {
272
273
  Timeout: "Timeout",
273
274
  Unknown: "Unknown",
274
275
  };
276
+ export const PolicyScope = {
277
+ ACCOUNT: "ACCOUNT",
278
+ RESOURCE: "RESOURCE",
279
+ };
275
280
  export const Distribution = {
276
281
  ByLogStream: "ByLogStream",
277
282
  Random: "Random",
@@ -676,8 +676,8 @@ export interface CloudWatchLogs {
676
676
  * </li>
677
677
  * <li>
678
678
  * <p>
679
- * <b>Monitor CloudTrail logged events</b>: You can
680
- * create alarms in CloudWatch and receive notifications of particular API activity as
679
+ * <b>Monitor CloudTrail logged events</b>: You
680
+ * can create alarms in CloudWatch and receive notifications of particular API activity as
681
681
  * captured by CloudTrail. You can use the notification to perform troubleshooting.</p>
682
682
  * </li>
683
683
  * <li>
@@ -286,8 +286,8 @@ export interface CloudWatchLogsClientResolvedConfig extends CloudWatchLogsClient
286
286
  * </li>
287
287
  * <li>
288
288
  * <p>
289
- * <b>Monitor CloudTrail logged events</b>: You can
290
- * create alarms in CloudWatch and receive notifications of particular API activity as
289
+ * <b>Monitor CloudTrail logged events</b>: You
290
+ * can create alarms in CloudWatch and receive notifications of particular API activity as
291
291
  * captured by CloudTrail. You can use the notification to perform troubleshooting.</p>
292
292
  * </li>
293
293
  * <li>
@@ -27,46 +27,47 @@ declare const AssociateKmsKeyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Associates the specified KMS key with either one log group in the account, or with all stored
31
- * CloudWatch Logs query insights results in the account.</p>
32
- * <p>When you use <code>AssociateKmsKey</code>, you specify either the <code>logGroupName</code> parameter
33
- * or the <code>resourceIdentifier</code> parameter. You can't specify both of those parameters in the same operation.</p>
30
+ * <p>Associates the specified KMS key with either one log group in the
31
+ * account, or with all stored CloudWatch Logs query insights results in the
32
+ * account.</p>
33
+ * <p>When you use <code>AssociateKmsKey</code>, you specify either the
34
+ * <code>logGroupName</code> parameter or the <code>resourceIdentifier</code> parameter. You
35
+ * can't specify both of those parameters in the same operation.</p>
34
36
  * <ul>
35
37
  * <li>
36
- * <p>Specify the <code>logGroupName</code> parameter to cause log events ingested into that log group to
37
- * be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.</p>
38
+ * <p>Specify the <code>logGroupName</code> parameter to cause log events ingested into that
39
+ * log group to be encrypted with that key. Only the log events ingested after the key is
40
+ * associated are encrypted with that key.</p>
38
41
  * <p>Associating a KMS key with a log group overrides any existing
39
- * 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
40
- * using the KMS key. This association is stored as long as the data encrypted
41
- * with the KMS key is still within CloudWatch Logs. This enables CloudWatch Logs to decrypt this data whenever it is requested.</p>
42
- * <p>Associating
43
- * a key with a log group does not cause the results of queries of that log group to be encrypted with that key. To have query
44
- * results encrypted with a KMS key, you must use an <code>AssociateKmsKey</code> operation with the <code>resourceIdentifier</code>
45
- * parameter that specifies a <code>query-result</code> resource. </p>
42
+ * 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
43
+ * is encrypted using the KMS key. This association is stored as long as the
44
+ * data encrypted with the KMS key is still within CloudWatch Logs. This
45
+ * enables CloudWatch Logs to decrypt this data whenever it is requested.</p>
46
+ * <p>Associating a key with a log group does not cause the results of queries of that log
47
+ * group to be encrypted with that key. To have query results encrypted with a KMS key, you must use an <code>AssociateKmsKey</code> operation with the
48
+ * <code>resourceIdentifier</code> parameter that specifies a <code>query-result</code>
49
+ * resource. </p>
46
50
  * </li>
47
51
  * <li>
48
- * <p>Specify the <code>resourceIdentifier</code> parameter with a <code>query-result</code> resource,
49
- * to use that key to encrypt the stored results of all future
50
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a>
51
- * operations in the account. The response from a
52
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html">GetQueryResults</a>
53
- * operation will still return
54
- * the query results in plain text.</p>
55
- * <p>Even if you have not associated a key with your query results, the query results are encrypted when stored,
56
- * using the default CloudWatch Logs method.</p>
57
- * <p>If you run a query from a monitoring account that queries logs in a source account, the
58
- * query results key from the monitoring account, if any, is used.</p>
52
+ * <p>Specify the <code>resourceIdentifier</code> parameter with a <code>query-result</code>
53
+ * resource, to use that key to encrypt the stored results of all future <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> operations in the account. The response from a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html">GetQueryResults</a> operation will still return the query results in plain
54
+ * text.</p>
55
+ * <p>Even if you have not associated a key with your query results, the query results are
56
+ * encrypted when stored, using the default CloudWatch Logs method.</p>
57
+ * <p>If you run a query from a monitoring account that queries logs in a source account,
58
+ * the query results key from the monitoring account, if any, is used.</p>
59
59
  * </li>
60
60
  * </ul>
61
61
  * <important>
62
62
  * <p>If you delete the key that is used to encrypt log events or log group query results,
63
- * then all the associated stored log events or query results that were encrypted with that key
64
- * will be unencryptable and unusable.</p>
63
+ * then all the associated stored log events or query results that were encrypted with that key
64
+ * will be unencryptable and unusable.</p>
65
65
  * </important>
66
66
  * <note>
67
- * <p>CloudWatch Logs supports only symmetric KMS keys. Do not associate
68
- * an asymmetric KMS key with your log group or query results. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using
69
- * Symmetric and Asymmetric Keys</a>.</p>
67
+ * <p>CloudWatch Logs supports only symmetric KMS keys. Do not associate an
68
+ * asymmetric KMS key with your log group or query results. For more
69
+ * information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using Symmetric and Asymmetric
70
+ * Keys</a>.</p>
70
71
  * </note>
71
72
  * <p>It can take up to 5 minutes for this operation to take effect.</p>
72
73
  * <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
@@ -27,41 +27,38 @@ declare const CreateDeliveryCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a <i>delivery</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical
31
- * <i>delivery destination</i>
32
- * that you have already created.</p>
33
- * <p>Only some Amazon Web Services services support being configured as a delivery source using this operation. These services are listed
34
- * as <b>Supported [V2 Permissions]</b> in the table at
35
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enabling
36
- * logging from Amazon Web Services services.</a>
30
+ * <p>Creates a <i>delivery</i>. A delivery is a connection between a logical
31
+ * <i>delivery source</i> and a logical <i>delivery destination</i>
32
+ * that you have already created.</p>
33
+ * <p>Only some Amazon Web Services services support being configured as a delivery source using
34
+ * this operation. These services are listed as <b>Supported [V2
35
+ * Permissions]</b> in the table at <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enabling logging from
36
+ * Amazon Web Services services.</a>
37
37
  * </p>
38
- * <p>A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.</p>
39
- * <p>To configure logs delivery between a supported Amazon Web Services service and a destination, you must do the following:</p>
38
+ * <p>A delivery destination can represent a log group in CloudWatch Logs, an Amazon S3 bucket, a delivery stream in Firehose, or X-Ray.</p>
39
+ * <p>To configure logs delivery between a supported Amazon Web Services service and a
40
+ * destination, you must do the following:</p>
40
41
  * <ul>
41
42
  * <li>
42
- * <p>Create a delivery source, which is a logical object that represents the resource that is actually
43
- * sending the logs. For more
44
- * information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">PutDeliverySource</a>.</p>
43
+ * <p>Create a delivery source, which is a logical object that represents the resource that
44
+ * is actually sending the logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">PutDeliverySource</a>.</p>
45
45
  * </li>
46
46
  * <li>
47
- * <p>Create a <i>delivery destination</i>, which is a logical object that represents the actual
48
- * delivery destination. For more
49
- * information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html">PutDeliveryDestination</a>.</p>
47
+ * <p>Create a <i>delivery destination</i>, which is a logical object that
48
+ * represents the actual delivery destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html">PutDeliveryDestination</a>.</p>
50
49
  * </li>
51
50
  * <li>
52
- * <p>If you are delivering logs cross-account, you must use
53
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html">PutDeliveryDestinationPolicy</a>
54
- * in the destination account to assign an IAM policy to the
55
- * destination. This policy allows delivery to that destination.
56
- * </p>
51
+ * <p>If you are delivering logs cross-account, you must use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html">PutDeliveryDestinationPolicy</a> in the destination account to assign an IAM policy to the destination. This policy allows delivery to that destination.
52
+ * </p>
57
53
  * </li>
58
54
  * <li>
59
- * <p>Use <code>CreateDelivery</code> to create a <i>delivery</i> by pairing exactly one delivery source and one delivery destination.
60
- * </p>
55
+ * <p>Use <code>CreateDelivery</code> to create a <i>delivery</i> by pairing
56
+ * exactly one delivery source and one delivery destination. </p>
61
57
  * </li>
62
58
  * </ul>
63
- * <p>You can configure a single delivery source to send logs to multiple destinations by creating multiple deliveries. You
64
- * can also create multiple deliveries to configure multiple delivery sources to send logs to the same delivery destination.</p>
59
+ * <p>You can configure a single delivery source to send logs to multiple destinations by
60
+ * creating multiple deliveries. You can also create multiple deliveries to configure multiple
61
+ * delivery sources to send logs to the same delivery destination.</p>
65
62
  * <p>To update an existing delivery configuration, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a>.</p>
66
63
  * @example
67
64
  * Use a bare-bones client and the command you need to make an API call.
@@ -92,7 +89,7 @@ declare const CreateDeliveryCommand_base: {
92
89
  * // arn: "STRING_VALUE",
93
90
  * // deliverySourceName: "STRING_VALUE",
94
91
  * // deliveryDestinationArn: "STRING_VALUE",
95
- * // deliveryDestinationType: "S3" || "CWL" || "FH",
92
+ * // deliveryDestinationType: "S3" || "CWL" || "FH" || "XRAY",
96
93
  * // recordFields: [ // RecordFields
97
94
  * // "STRING_VALUE",
98
95
  * // ],
@@ -36,21 +36,22 @@ declare const CreateExportTaskCommand_base: {
36
36
  * retention period is also supported.</p>
37
37
  * <p>Exporting to S3 buckets that are encrypted with AES-256 is supported. </p>
38
38
  * <p>This is an asynchronous call. If all the required information is provided, this
39
- * operation initiates an export task and responds with the ID of the task. After the task has started,
40
- * 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
41
- * only have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time.
42
- * To cancel an export task, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html">CancelExportTask</a>.</p>
39
+ * operation initiates an export task and responds with the ID of the task. After the task has
40
+ * started, 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 only
41
+ * have one active (<code>RUNNING</code> or <code>PENDING</code>) export task at a time. To
42
+ * cancel an export task, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CancelExportTask.html">CancelExportTask</a>.</p>
43
43
  * <p>You can export logs from multiple log groups or multiple time ranges to the same S3
44
44
  * bucket. To separate log data for each export task, specify a prefix to be used as the Amazon
45
45
  * S3 key prefix for all exported objects.</p>
46
46
  * <note>
47
- * <p>We recommend that you don't regularly export to Amazon S3 as a way to continuously archive your logs. For that use case, we instead recommend that
48
- * you use subscriptions. For more information about subscriptions, see
49
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Subscriptions.html">Real-time processing of log data with subscriptions</a>.</p>
47
+ * <p>We recommend that you don't regularly export to Amazon S3 as a way to
48
+ * continuously archive your logs. For that use case, we instead recommend that you use
49
+ * subscriptions. For more information about subscriptions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Subscriptions.html">Real-time processing of log data
50
+ * with subscriptions</a>.</p>
50
51
  * </note>
51
52
  * <note>
52
- * <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can
53
- * sort the exported log field data by using Linux utilities.</p>
53
+ * <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You
54
+ * can sort the exported log field data by using Linux utilities.</p>
54
55
  * </note>
55
56
  * @example
56
57
  * Use a bare-bones client and the command you need to make an API call.
@@ -27,37 +27,31 @@ declare const CreateLogAnomalyDetectorCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates an <i>anomaly detector</i> that regularly scans one or more
31
- * log groups and look for patterns
32
- * and anomalies in the logs.</p>
33
- * <p>An anomaly detector can help surface issues by automatically discovering anomalies in your log event traffic.
34
- * An anomaly detector uses machine learning algorithms to scan log events and find <i>patterns</i>.
35
- *
36
- * A pattern is a shared text structure that recurs among your log fields. Patterns provide a useful tool for
37
- * analyzing large sets of logs because a large number of log events can often be
38
- * compressed into a few patterns.</p>
39
- * <p>The anomaly detector uses pattern recognition to find <code>anomalies</code>, which are unusual log
40
- * events. It uses the <code>evaluationFrequency</code> to compare current log events and patterns
41
- * with trained baselines. </p>
42
- * <p>Fields within a pattern are called <i>tokens</i>.
43
- * Fields that vary within a pattern, such as a
44
- * request ID or timestamp, are referred to as <i>dynamic tokens</i> and
45
- * represented by <code><*></code>. </p>
30
+ * <p>Creates an <i>anomaly detector</i> that regularly scans one or more log
31
+ * groups and look for patterns and anomalies in the logs.</p>
32
+ * <p>An anomaly detector can help surface issues by automatically discovering anomalies in your
33
+ * log event traffic. An anomaly detector uses machine learning algorithms to scan log events and
34
+ * find <i>patterns</i>. A pattern is a shared text structure that recurs among
35
+ * your log fields. Patterns provide a useful tool for analyzing large sets of logs because a
36
+ * large number of log events can often be compressed into a few patterns.</p>
37
+ * <p>The anomaly detector uses pattern recognition to find <code>anomalies</code>, which are
38
+ * unusual log events. It uses the <code>evaluationFrequency</code> to compare current log events
39
+ * and patterns with trained baselines. </p>
40
+ * <p>Fields within a pattern are called <i>tokens</i>. Fields that vary within a
41
+ * pattern, such as a request ID or timestamp, are referred to as <i>dynamic
42
+ * tokens</i> and represented by <code><*></code>. </p>
46
43
  * <p>The following is an example of a pattern:</p>
47
44
  * <p>
48
45
  * <code>[INFO] Request time: <*> ms</code>
49
46
  * </p>
50
- * <p>This pattern
51
- * represents log events like <code>[INFO] Request time: 327 ms</code> and other similar log events
52
- * that differ only by the number, in this csse 327. When the pattern is displayed, the different numbers are replaced
53
- * by <code><*></code>
47
+ * <p>This pattern represents log events like <code>[INFO] Request time: 327 ms</code> and other
48
+ * similar log events that differ only by the number, in this csse 327. When the pattern is
49
+ * displayed, the different numbers are replaced by <code><*></code>
54
50
  * </p>
55
51
  * <note>
56
- * <p>Any parts of log events that are masked as sensitive data are not scanned for anomalies. For more information
57
- * about masking sensitive data, see
58
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html">Help protect sensitive log data with
59
- * masking</a>.
60
- * </p>
52
+ * <p>Any parts of log events that are masked as sensitive data are not scanned for anomalies.
53
+ * For more information about masking sensitive data, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html">Help protect sensitive log
54
+ * data with masking</a>. </p>
61
55
  * </note>
62
56
  * @example
63
57
  * Use a bare-bones client and the command you need to make an API call.
@@ -27,7 +27,8 @@ declare const CreateLogGroupCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a log group with the specified name. You can create up to 1,000,000 log groups per Region per account.</p>
30
+ * <p>Creates a log group with the specified name. You can create up to 1,000,000 log groups
31
+ * per Region per account.</p>
31
32
  * <p>You must use the following guidelines when naming a log group:</p>
32
33
  * <ul>
33
34
  * <li>
@@ -38,8 +39,9 @@ declare const CreateLogGroupCommand_base: {
38
39
  * <p>Log group names can be between 1 and 512 characters long.</p>
39
40
  * </li>
40
41
  * <li>
41
- * <p>Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen),
42
- * '/' (forward slash), '.' (period), and '#' (number sign)</p>
42
+ * <p>Log group names consist of the following characters: a-z, A-Z, 0-9, '_'
43
+ * (underscore), '-' (hyphen), '/' (forward slash), '.' (period), and '#' (number
44
+ * sign)</p>
43
45
  * </li>
44
46
  * <li>
45
47
  * <p>Log group names can't start with the string <code>aws/</code>
@@ -27,11 +27,12 @@ declare const CreateLogStreamCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a log stream for the specified log group. A log stream is a sequence of log events
31
- * that originate from a single source, such as an application instance or a resource that is
32
- * being monitored.</p>
33
- * <p>There is no limit on the number of log streams that you can create for a log group. There is a limit
34
- * of 50 TPS on <code>CreateLogStream</code> operations, after which transactions are throttled.</p>
30
+ * <p>Creates a log stream for the specified log group. A log stream is a sequence of log
31
+ * events that originate from a single source, such as an application instance or a resource that
32
+ * is being monitored.</p>
33
+ * <p>There is no limit on the number of log streams that you can create for a log group.
34
+ * There is a limit of 50 TPS on <code>CreateLogStream</code> operations, after which
35
+ * transactions are throttled.</p>
35
36
  * <p>You must use the following guidelines when naming a log stream:</p>
36
37
  * <ul>
37
38
  * <li>
@@ -27,29 +27,34 @@ declare const DeleteAccountPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a CloudWatch Logs account policy. This stops the account-wide policy from applying to log groups in the account. If you delete a data protection
31
- * policy or subscription filter policy, any log-group level policies of those types remain in effect.</p>
32
- * <p>To use this operation, you must be signed on with the correct permissions depending on the type of policy
33
- * that you are deleting.</p>
30
+ * <p>Deletes a CloudWatch Logs account policy. This stops the account-wide policy from
31
+ * applying to log groups in the account. If you delete a data protection policy or subscription
32
+ * filter policy, any log-group level policies of those types remain in effect.</p>
33
+ * <p>To use this operation, you must be signed on with the correct permissions depending on the
34
+ * type of policy that you are deleting.</p>
34
35
  * <ul>
35
36
  * <li>
36
- * <p>To delete a data protection policy, you must have the <code>logs:DeleteDataProtectionPolicy</code> and
37
- * <code>logs:DeleteAccountPolicy</code> permissions.</p>
37
+ * <p>To delete a data protection policy, you must have the
38
+ * <code>logs:DeleteDataProtectionPolicy</code> and <code>logs:DeleteAccountPolicy</code>
39
+ * permissions.</p>
38
40
  * </li>
39
41
  * <li>
40
- * <p>To delete a subscription filter policy, you must have the <code>logs:DeleteSubscriptionFilter</code> and
41
- * <code>logs:DeleteAccountPolicy</code> permissions.</p>
42
+ * <p>To delete a subscription filter policy, you must have the
43
+ * <code>logs:DeleteSubscriptionFilter</code> and <code>logs:DeleteAccountPolicy</code>
44
+ * permissions.</p>
42
45
  * </li>
43
46
  * <li>
44
- * <p>To delete a transformer policy, you must have the <code>logs:DeleteTransformer</code> and <code>logs:DeleteAccountPolicy</code> permissions.</p>
47
+ * <p>To delete a transformer policy, you must have the <code>logs:DeleteTransformer</code>
48
+ * and <code>logs:DeleteAccountPolicy</code> permissions.</p>
45
49
  * </li>
46
50
  * <li>
47
- * <p>To delete a field index policy, you must have the <code>logs:DeleteIndexPolicy</code> and
48
- * <code>logs:DeleteAccountPolicy</code> permissions.</p>
51
+ * <p>To delete a field index policy, you must have the <code>logs:DeleteIndexPolicy</code>
52
+ * and <code>logs:DeleteAccountPolicy</code> permissions.</p>
49
53
  * </li>
50
54
  * </ul>
51
55
  * <p>If you delete a field index policy, the indexing of the log events that happened before
52
- * you deleted the policy will still be used for up to 30 days to improve CloudWatch Logs Insights queries.</p>
56
+ * you deleted the policy will still be used for up to 30 days to improve CloudWatch Logs
57
+ * Insights queries.</p>
53
58
  * @example
54
59
  * Use a bare-bones client and the command you need to make an API call.
55
60
  * ```javascript
@@ -27,9 +27,11 @@ declare const DeleteDeliveryCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a <i>delivery</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical
31
- * <i>delivery destination</i>. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does
32
- * not delete the delivery destination or the delivery source.</p>
30
+ * <p>Deletes a <i>delivery</i>. A delivery is a connection between a logical
31
+ * <i>delivery source</i> and a logical <i>delivery
32
+ * destination</i>. Deleting a delivery only deletes the connection between the delivery
33
+ * source and delivery destination. It does not delete the delivery destination or the delivery
34
+ * source.</p>
33
35
  * @example
34
36
  * Use a bare-bones client and the command you need to make an API call.
35
37
  * ```javascript
@@ -27,10 +27,12 @@ declare const DeleteDeliveryDestinationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a <i>delivery destination</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical
31
- * <i>delivery destination</i>.</p>
32
- * <p>You can't delete a delivery destination if any current deliveries are associated with it. To find whether any deliveries are associated with
33
- * this delivery destination, use the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html">DescribeDeliveries</a> operation and check the <code>deliveryDestinationArn</code> field in the results.</p>
30
+ * <p>Deletes a <i>delivery destination</i>. A delivery is a connection between a
31
+ * logical <i>delivery source</i> and a logical <i>delivery
32
+ * destination</i>.</p>
33
+ * <p>You can't delete a delivery destination if any current deliveries are associated with it.
34
+ * To find whether any deliveries are associated with this delivery destination, use the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html">DescribeDeliveries</a> operation and check the <code>deliveryDestinationArn</code>
35
+ * field in the results.</p>
34
36
  * @example
35
37
  * Use a bare-bones client and the command you need to make an API call.
36
38
  * ```javascript
@@ -27,8 +27,8 @@ declare const DeleteDeliveryDestinationPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a delivery destination policy. For more information about these policies,
31
- * see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html">PutDeliveryDestinationPolicy</a>.</p>
30
+ * <p>Deletes a delivery destination policy. For more information about these policies, see
31
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html">PutDeliveryDestinationPolicy</a>.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -27,10 +27,12 @@ declare const DeleteDeliverySourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a <i>delivery source</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical
31
- * <i>delivery destination</i>.</p>
32
- * <p>You can't delete a delivery source if any current deliveries are associated with it. To find whether any deliveries are associated with
33
- * this delivery source, use the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html">DescribeDeliveries</a> operation and check the <code>deliverySourceName</code> field in the results.</p>
30
+ * <p>Deletes a <i>delivery source</i>. A delivery is a connection between a
31
+ * logical <i>delivery source</i> and a logical <i>delivery
32
+ * destination</i>.</p>
33
+ * <p>You can't delete a delivery source if any current deliveries are associated with it. To
34
+ * find whether any deliveries are associated with this delivery source, use the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html">DescribeDeliveries</a> operation and check the <code>deliverySourceName</code> field in
35
+ * the results.</p>
34
36
  * @example
35
37
  * Use a bare-bones client and the command you need to make an API call.
36
38
  * ```javascript
@@ -27,9 +27,9 @@ declare const DeleteDestinationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes the specified destination, and eventually disables all the
31
- * subscription filters that publish to it. This operation does not delete the
32
- * physical resource encapsulated by the destination.</p>
30
+ * <p>Deletes the specified destination, and eventually disables all the subscription filters
31
+ * that publish to it. This operation does not delete the physical resource encapsulated by the
32
+ * destination.</p>
33
33
  * @example
34
34
  * Use a bare-bones client and the command you need to make an API call.
35
35
  * ```javascript
@@ -27,12 +27,13 @@ declare const DeleteIndexPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a log-group level field index policy that was applied to a single log group. The indexing of the log events that happened before
31
- * you delete the policy will still be used for as many as 30 days to improve CloudWatch Logs Insights queries.</p>
32
- * <p>You can't use this operation to delete an account-level index policy. Instead, use
33
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteAccountPolicy.html">DeletAccountPolicy</a>.</p>
34
- * <p>If you delete a log-group level field index policy and there is an account-level field index policy, in a few minutes the log group begins using that account-wide policy to index new
35
- * incoming log events. </p>
30
+ * <p>Deletes a log-group level field index policy that was applied to a single log group. The
31
+ * indexing of the log events that happened before you delete the policy will still be used for
32
+ * as many as 30 days to improve CloudWatch Logs Insights queries.</p>
33
+ * <p>You can't use this operation to delete an account-level index policy. Instead, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteAccountPolicy.html">DeletAccountPolicy</a>.</p>
34
+ * <p>If you delete a log-group level field index policy and there is an account-level field
35
+ * index policy, in a few minutes the log group begins using that account-wide policy to index
36
+ * new incoming log events. </p>
36
37
  * @example
37
38
  * Use a bare-bones client and the command you need to make an API call.
38
39
  * ```javascript
@@ -27,11 +27,12 @@ declare const DeleteIntegrationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes the integration between CloudWatch Logs and OpenSearch Service. If your integration has active vended logs dashboards,
31
- * you must specify <code>true</code> for the <code>force</code> parameter, otherwise the operation will fail. If you delete the integration by
32
- * setting <code>force</code> to <code>true</code>,
33
- * all your vended logs dashboards powered by OpenSearch Service will be deleted and the data that was on them
34
- * will no longer be accessible.</p>
30
+ * <p>Deletes the integration between CloudWatch Logs and OpenSearch Service. If your
31
+ * integration has active vended logs dashboards, you must specify <code>true</code> for the
32
+ * <code>force</code> parameter, otherwise the operation will fail. If you delete the
33
+ * integration by setting <code>force</code> to <code>true</code>, all your vended logs
34
+ * dashboards powered by OpenSearch Service will be deleted and the data that was on them will no
35
+ * longer be accessible.</p>
35
36
  * @example
36
37
  * Use a bare-bones client and the command you need to make an API call.
37
38
  * ```javascript
@@ -27,8 +27,8 @@ declare const DeleteLogGroupCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes the specified log group and permanently deletes all the archived
31
- * log events associated with the log group.</p>
30
+ * <p>Deletes the specified log group and permanently deletes all the archived log events
31
+ * associated with the log group.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -27,8 +27,8 @@ declare const DeleteLogStreamCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes the specified log stream and permanently deletes all the archived log events associated
31
- * with the log stream.</p>
30
+ * <p>Deletes the specified log stream and permanently deletes all the archived log events
31
+ * associated with the log stream.</p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -27,8 +27,8 @@ declare const DeleteQueryDefinitionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a saved CloudWatch Logs Insights query definition.
31
- * A query definition contains details about a saved CloudWatch Logs Insights query.</p>
30
+ * <p>Deletes a saved CloudWatch Logs Insights query definition. A query definition contains
31
+ * details about a saved CloudWatch Logs Insights query.</p>
32
32
  * <p>Each <code>DeleteQueryDefinition</code> operation can delete one query definition.</p>
33
33
  * <p>You must have the <code>logs:DeleteQueryDefinition</code> permission to be able to perform
34
34
  * this operation.</p>