@aws-sdk/client-cloudwatch-logs 3.845.0 → 3.847.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist-cjs/index.js +8 -1
- package/dist-es/models/models_0.js +5 -0
- package/dist-types/CloudWatchLogs.d.ts +2 -2
- package/dist-types/CloudWatchLogsClient.d.ts +2 -2
- package/dist-types/commands/AssociateKmsKeyCommand.d.ts +30 -29
- package/dist-types/commands/CreateDeliveryCommand.d.ts +22 -25
- package/dist-types/commands/CreateExportTaskCommand.d.ts +10 -9
- package/dist-types/commands/CreateLogAnomalyDetectorCommand.d.ts +19 -25
- package/dist-types/commands/CreateLogGroupCommand.d.ts +5 -3
- package/dist-types/commands/CreateLogStreamCommand.d.ts +6 -5
- package/dist-types/commands/DeleteAccountPolicyCommand.d.ts +17 -12
- package/dist-types/commands/DeleteDeliveryCommand.d.ts +5 -3
- package/dist-types/commands/DeleteDeliveryDestinationCommand.d.ts +6 -4
- package/dist-types/commands/DeleteDeliveryDestinationPolicyCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDeliverySourceCommand.d.ts +6 -4
- package/dist-types/commands/DeleteDestinationCommand.d.ts +3 -3
- package/dist-types/commands/DeleteIndexPolicyCommand.d.ts +7 -6
- package/dist-types/commands/DeleteIntegrationCommand.d.ts +6 -5
- package/dist-types/commands/DeleteLogGroupCommand.d.ts +2 -2
- package/dist-types/commands/DeleteLogStreamCommand.d.ts +2 -2
- package/dist-types/commands/DeleteQueryDefinitionCommand.d.ts +2 -2
- package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +7 -2
- package/dist-types/commands/DeleteRetentionPolicyCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTransformerCommand.d.ts +6 -6
- package/dist-types/commands/DescribeAccountPoliciesCommand.d.ts +12 -8
- package/dist-types/commands/DescribeConfigurationTemplatesCommand.d.ts +5 -4
- package/dist-types/commands/DescribeDeliveriesCommand.d.ts +9 -11
- package/dist-types/commands/DescribeDeliveryDestinationsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeDestinationsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeExportTasksCommand.d.ts +2 -2
- package/dist-types/commands/DescribeFieldIndexesCommand.d.ts +2 -3
- package/dist-types/commands/DescribeIndexPoliciesCommand.d.ts +6 -6
- package/dist-types/commands/DescribeLogGroupsCommand.d.ts +13 -11
- package/dist-types/commands/DescribeLogStreamsCommand.d.ts +10 -10
- package/dist-types/commands/DescribeQueryDefinitionsCommand.d.ts +5 -4
- package/dist-types/commands/DescribeResourcePoliciesCommand.d.ts +5 -0
- package/dist-types/commands/DescribeSubscriptionFiltersCommand.d.ts +3 -2
- package/dist-types/commands/DisassociateKmsKeyCommand.d.ts +13 -13
- package/dist-types/commands/FilterLogEventsCommand.d.ts +31 -20
- package/dist-types/commands/GetDeliveryCommand.d.ts +12 -13
- package/dist-types/commands/GetDeliveryDestinationCommand.d.ts +1 -1
- package/dist-types/commands/GetDeliveryDestinationPolicyCommand.d.ts +2 -3
- package/dist-types/commands/GetLogEventsCommand.d.ts +25 -17
- package/dist-types/commands/GetLogGroupFieldsCommand.d.ts +8 -8
- package/dist-types/commands/GetQueryResultsCommand.d.ts +13 -11
- package/dist-types/commands/GetTransformerCommand.d.ts +2 -2
- package/dist-types/commands/ListAnomaliesCommand.d.ts +3 -2
- package/dist-types/commands/ListIntegrationsCommand.d.ts +3 -2
- package/dist-types/commands/ListLogGroupsCommand.d.ts +8 -7
- package/dist-types/commands/ListLogGroupsForQueryCommand.d.ts +6 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
- package/dist-types/commands/ListTagsLogGroupCommand.d.ts +1 -1
- package/dist-types/commands/PutAccountPolicyCommand.d.ts +113 -98
- package/dist-types/commands/PutDataProtectionPolicyCommand.d.ts +20 -19
- package/dist-types/commands/PutDeliveryDestinationCommand.d.ts +28 -28
- package/dist-types/commands/PutDeliveryDestinationPolicyCommand.d.ts +18 -20
- package/dist-types/commands/PutDeliverySourceCommand.d.ts +23 -25
- package/dist-types/commands/PutDestinationCommand.d.ts +7 -6
- package/dist-types/commands/PutDestinationPolicyCommand.d.ts +4 -3
- package/dist-types/commands/PutIndexPolicyCommand.d.ts +24 -23
- package/dist-types/commands/PutIntegrationCommand.d.ts +8 -6
- package/dist-types/commands/PutLogEventsCommand.d.ts +27 -24
- package/dist-types/commands/PutMetricFilterCommand.d.ts +14 -18
- package/dist-types/commands/PutQueryDefinitionCommand.d.ts +3 -3
- package/dist-types/commands/PutResourcePolicyCommand.d.ts +15 -3
- package/dist-types/commands/PutRetentionPolicyCommand.d.ts +4 -3
- package/dist-types/commands/PutSubscriptionFilterCommand.d.ts +11 -12
- package/dist-types/commands/PutTransformerCommand.d.ts +24 -19
- package/dist-types/commands/StartLiveTailCommand.d.ts +27 -28
- package/dist-types/commands/StartQueryCommand.d.ts +28 -30
- package/dist-types/commands/StopQueryCommand.d.ts +3 -2
- package/dist-types/commands/TagLogGroupCommand.d.ts +10 -10
- package/dist-types/commands/TagResourceCommand.d.ts +11 -10
- package/dist-types/commands/TestTransformerCommand.d.ts +3 -2
- package/dist-types/commands/UntagLogGroupCommand.d.ts +6 -7
- package/dist-types/commands/UpdateAnomalyCommand.d.ts +10 -9
- package/dist-types/commands/UpdateDeliveryConfigurationCommand.d.ts +3 -3
- package/dist-types/index.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +1441 -1201
- package/dist-types/ts3.4/models/models_0.d.ts +18 -1
- package/package.json +5 -5
|
@@ -27,44 +27,43 @@ declare const PutDeliveryDestinationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates or updates a logical <i>delivery destination</i>. A delivery
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
30
|
+
* <p>Creates or updates a logical <i>delivery destination</i>. A delivery
|
|
31
|
+
* destination is an Amazon Web Services resource that represents an Amazon Web Services service
|
|
32
|
+
* that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose are
|
|
33
|
+
* supported as logs delivery destinations and X-Ray as the trace delivery destination.</p>
|
|
34
|
+
* <p>To configure logs delivery between a supported Amazon Web Services service and a
|
|
35
|
+
* destination, you must do the following:</p>
|
|
34
36
|
* <ul>
|
|
35
37
|
* <li>
|
|
36
|
-
* <p>Create a delivery source, which is a logical object that represents the resource that
|
|
37
|
-
*
|
|
38
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">PutDeliverySource</a>.</p>
|
|
38
|
+
* <p>Create a delivery source, which is a logical object that represents the resource that
|
|
39
|
+
* 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>
|
|
39
40
|
* </li>
|
|
40
41
|
* <li>
|
|
41
|
-
* <p>Use <code>PutDeliveryDestination</code> to create a <i>delivery
|
|
42
|
-
*
|
|
43
|
-
*
|
|
42
|
+
* <p>Use <code>PutDeliveryDestination</code> to create a <i>delivery
|
|
43
|
+
* destination</i> in the same account of the actual delivery destination. The
|
|
44
|
+
* delivery destination that you create is a logical object that represents the actual
|
|
45
|
+
* delivery destination. </p>
|
|
44
46
|
* </li>
|
|
45
47
|
* <li>
|
|
46
|
-
* <p>If you are delivering logs cross-account, you must use
|
|
47
|
-
*
|
|
48
|
-
* in the destination account to assign an IAM policy to the
|
|
49
|
-
* destination. This policy allows delivery to that destination.
|
|
50
|
-
* </p>
|
|
48
|
+
* <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.
|
|
49
|
+
* </p>
|
|
51
50
|
* </li>
|
|
52
51
|
* <li>
|
|
53
|
-
* <p>Use <code>CreateDelivery</code> to create a <i>delivery</i> by pairing
|
|
54
|
-
*
|
|
55
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a>.
|
|
56
|
-
* </p>
|
|
52
|
+
* <p>Use <code>CreateDelivery</code> to create a <i>delivery</i> by pairing
|
|
53
|
+
* exactly one delivery source and one delivery destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a>. </p>
|
|
57
54
|
* </li>
|
|
58
55
|
* </ul>
|
|
59
|
-
* <p>You can configure a single delivery source to send logs to multiple destinations by
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
*
|
|
64
|
-
*
|
|
56
|
+
* <p>You can configure a single delivery source to send logs to multiple destinations by
|
|
57
|
+
* creating multiple deliveries. You can also create multiple deliveries to configure multiple
|
|
58
|
+
* delivery sources to send logs to the same delivery destination.</p>
|
|
59
|
+
* <p>Only some Amazon Web Services services support being configured as a delivery source. These
|
|
60
|
+
* services are listed as <b>Supported [V2 Permissions]</b> in the
|
|
61
|
+
* table at <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enabling logging from
|
|
62
|
+
* Amazon Web Services services.</a>
|
|
65
63
|
* </p>
|
|
66
|
-
* <p>If you use this operation to update an existing delivery destination, all the current
|
|
67
|
-
*
|
|
64
|
+
* <p>If you use this operation to update an existing delivery destination, all the current
|
|
65
|
+
* delivery destination parameters are overwritten with the new parameter values that you
|
|
66
|
+
* specify.</p>
|
|
68
67
|
* @example
|
|
69
68
|
* Use a bare-bones client and the command you need to make an API call.
|
|
70
69
|
* ```javascript
|
|
@@ -77,6 +76,7 @@ declare const PutDeliveryDestinationCommand_base: {
|
|
|
77
76
|
* deliveryDestinationConfiguration: { // DeliveryDestinationConfiguration
|
|
78
77
|
* destinationResourceArn: "STRING_VALUE", // required
|
|
79
78
|
* },
|
|
79
|
+
* deliveryDestinationType: "S3" || "CWL" || "FH" || "XRAY",
|
|
80
80
|
* tags: { // Tags
|
|
81
81
|
* "<keys>": "STRING_VALUE",
|
|
82
82
|
* },
|
|
@@ -87,7 +87,7 @@ declare const PutDeliveryDestinationCommand_base: {
|
|
|
87
87
|
* // deliveryDestination: { // DeliveryDestination
|
|
88
88
|
* // name: "STRING_VALUE",
|
|
89
89
|
* // arn: "STRING_VALUE",
|
|
90
|
-
* // deliveryDestinationType: "S3" || "CWL" || "FH",
|
|
90
|
+
* // deliveryDestinationType: "S3" || "CWL" || "FH" || "XRAY",
|
|
91
91
|
* // outputFormat: "json" || "plain" || "w3c" || "raw" || "parquet",
|
|
92
92
|
* // deliveryDestinationConfiguration: { // DeliveryDestinationConfiguration
|
|
93
93
|
* // destinationResourceArn: "STRING_VALUE", // required
|
|
@@ -27,37 +27,35 @@ declare const PutDeliveryDestinationPolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Creates and assigns an IAM policy that grants permissions to CloudWatch Logs to deliver logs cross-account to a specified destination in this account. To
|
|
31
|
+
* configure the delivery of logs from an Amazon Web Services service in another account to a logs
|
|
32
|
+
* delivery destination in the current account, you must do the following:</p>
|
|
33
33
|
* <ul>
|
|
34
34
|
* <li>
|
|
35
|
-
* <p>Create a delivery source, which is a logical object that represents the resource that
|
|
36
|
-
*
|
|
37
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">PutDeliverySource</a>.</p>
|
|
35
|
+
* <p>Create a delivery source, which is a logical object that represents the resource that
|
|
36
|
+
* 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>
|
|
38
37
|
* </li>
|
|
39
38
|
* <li>
|
|
40
|
-
* <p>Create a <i>delivery destination</i>, which is a logical object that
|
|
41
|
-
*
|
|
42
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html">PutDeliveryDestination</a>.</p>
|
|
39
|
+
* <p>Create a <i>delivery destination</i>, which is a logical object that
|
|
40
|
+
* 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>
|
|
43
41
|
* </li>
|
|
44
42
|
* <li>
|
|
45
|
-
* <p>Use this operation in the destination account to assign an IAM policy
|
|
46
|
-
*
|
|
47
|
-
* </p>
|
|
43
|
+
* <p>Use this operation in the destination account to assign an IAM policy
|
|
44
|
+
* to the destination. This policy allows delivery to that destination. </p>
|
|
48
45
|
* </li>
|
|
49
46
|
* <li>
|
|
50
|
-
* <p>Create a <i>delivery</i> by pairing exactly one delivery source and one
|
|
51
|
-
*
|
|
47
|
+
* <p>Create a <i>delivery</i> by pairing exactly one delivery source and one
|
|
48
|
+
* delivery destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a>.</p>
|
|
52
49
|
* </li>
|
|
53
50
|
* </ul>
|
|
54
|
-
* <p>Only some Amazon Web Services services support being configured as a delivery source. These
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
51
|
+
* <p>Only some Amazon Web Services services support being configured as a delivery source. These
|
|
52
|
+
* services are listed as <b>Supported [V2 Permissions]</b> in the
|
|
53
|
+
* table at <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enabling logging from
|
|
54
|
+
* Amazon Web Services services.</a>
|
|
58
55
|
* </p>
|
|
59
|
-
* <p>The contents of the policy must include two statements. One statement enables general logs
|
|
60
|
-
*
|
|
56
|
+
* <p>The contents of the policy must include two statements. One statement enables general logs
|
|
57
|
+
* delivery, and the other allows delivery to the chosen destination. See the examples for the
|
|
58
|
+
* needed policies.</p>
|
|
61
59
|
* @example
|
|
62
60
|
* Use a bare-bones client and the command you need to make an API call.
|
|
63
61
|
* ```javascript
|
|
@@ -27,42 +27,40 @@ declare const PutDeliverySourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates or updates a logical <i>delivery source</i>. A delivery source
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Creates or updates a logical <i>delivery source</i>. A delivery source
|
|
31
|
+
* represents an Amazon Web Services resource that sends logs to an logs delivery destination. The
|
|
32
|
+
* destination can be CloudWatch Logs, Amazon S3, Firehose or X-Ray for sending traces.</p>
|
|
33
|
+
* <p>To configure logs delivery between a delivery destination and an Amazon Web Services
|
|
34
|
+
* service that is supported as a delivery source, you must do the following:</p>
|
|
33
35
|
* <ul>
|
|
34
36
|
* <li>
|
|
35
|
-
* <p>Use <code>PutDeliverySource</code> to create a delivery source, which is a logical
|
|
36
|
-
*
|
|
37
|
+
* <p>Use <code>PutDeliverySource</code> to create a delivery source, which is a logical
|
|
38
|
+
* object that represents the resource that is actually sending the logs. </p>
|
|
37
39
|
* </li>
|
|
38
40
|
* <li>
|
|
39
|
-
* <p>Use <code>PutDeliveryDestination</code> to create a <i>delivery
|
|
40
|
-
*
|
|
41
|
-
*
|
|
41
|
+
* <p>Use <code>PutDeliveryDestination</code> to create a <i>delivery
|
|
42
|
+
* destination</i>, which is a logical object that represents the actual delivery
|
|
43
|
+
* destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestination.html">PutDeliveryDestination</a>.</p>
|
|
42
44
|
* </li>
|
|
43
45
|
* <li>
|
|
44
|
-
* <p>If you are delivering logs cross-account, you must use
|
|
45
|
-
*
|
|
46
|
-
* in the destination account to assign an IAM policy to the
|
|
47
|
-
* destination. This policy allows delivery to that destination.
|
|
48
|
-
* </p>
|
|
46
|
+
* <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.
|
|
47
|
+
* </p>
|
|
49
48
|
* </li>
|
|
50
49
|
* <li>
|
|
51
|
-
* <p>Use <code>CreateDelivery</code> to create a <i>delivery</i> by pairing
|
|
52
|
-
*
|
|
53
|
-
* information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a>.
|
|
54
|
-
* </p>
|
|
50
|
+
* <p>Use <code>CreateDelivery</code> to create a <i>delivery</i> by pairing
|
|
51
|
+
* exactly one delivery source and one delivery destination. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a>. </p>
|
|
55
52
|
* </li>
|
|
56
53
|
* </ul>
|
|
57
|
-
* <p>You can configure a single delivery source to send logs to multiple destinations by
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
54
|
+
* <p>You can configure a single delivery source to send logs to multiple destinations by
|
|
55
|
+
* creating multiple deliveries. You can also create multiple deliveries to configure multiple
|
|
56
|
+
* delivery sources to send logs to the same delivery destination.</p>
|
|
57
|
+
* <p>Only some Amazon Web Services services support being configured as a delivery source. These
|
|
58
|
+
* services are listed as <b>Supported [V2 Permissions]</b> in the
|
|
59
|
+
* table at <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enabling logging from
|
|
60
|
+
* Amazon Web Services services.</a>
|
|
63
61
|
* </p>
|
|
64
|
-
* <p>If you use this operation to update an existing delivery source, all the current delivery
|
|
65
|
-
*
|
|
62
|
+
* <p>If you use this operation to update an existing delivery source, all the current delivery
|
|
63
|
+
* source parameters are overwritten with the new parameter values that you specify.</p>
|
|
66
64
|
* @example
|
|
67
65
|
* Use a bare-bones client and the command you need to make an API call.
|
|
68
66
|
* ```javascript
|
|
@@ -27,16 +27,17 @@ declare const PutDestinationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates or updates a destination. This operation is used only to create destinations
|
|
30
|
+
* <p>Creates or updates a destination. This operation is used only to create destinations
|
|
31
|
+
* for cross-account subscriptions.</p>
|
|
31
32
|
* <p>A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With
|
|
32
33
|
* a destination, you can subscribe to a real-time stream of log events for a different account,
|
|
33
34
|
* ingested using <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>.</p>
|
|
34
|
-
* <p>Through an access policy, a destination controls what is written to it.
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
35
|
+
* <p>Through an access policy, a destination controls what is written to it. By default,
|
|
36
|
+
* <code>PutDestination</code> does not set any access policy with the destination, which means
|
|
37
|
+
* a cross-account user cannot call <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutSubscriptionFilter.html">PutSubscriptionFilter</a> against this destination. To enable this, the destination
|
|
38
|
+
* owner must call <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestinationPolicy.html">PutDestinationPolicy</a> after <code>PutDestination</code>.</p>
|
|
38
39
|
* <p>To perform a <code>PutDestination</code> operation, you must also have the
|
|
39
|
-
*
|
|
40
|
+
* <code>iam:PassRole</code> permission.</p>
|
|
40
41
|
* @example
|
|
41
42
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
43
|
* ```javascript
|
|
@@ -27,9 +27,10 @@ declare const PutDestinationPolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates or updates an access policy associated with an existing
|
|
31
|
-
*
|
|
32
|
-
*
|
|
30
|
+
* <p>Creates or updates an access policy associated with an existing destination. An access
|
|
31
|
+
* policy is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html">IAM
|
|
32
|
+
* policy document</a> that is used to authorize claims to register a subscription filter
|
|
33
|
+
* against a given destination.</p>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|
|
@@ -27,23 +27,24 @@ declare const PutIndexPolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates or updates a <i>field index policy</i> for the specified log group.
|
|
31
|
-
*
|
|
32
|
-
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html">Log
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
* <a href="https://docs.aws.amazon.com/
|
|
41
|
-
*
|
|
30
|
+
* <p>Creates or updates a <i>field index policy</i> for the specified log group.
|
|
31
|
+
* Only log groups in the Standard log class support field index policies. For more information
|
|
32
|
+
* about log classes, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html">Log
|
|
33
|
+
* classes</a>.</p>
|
|
34
|
+
* <p>You can use field index policies to create <i>field indexes</i> on fields
|
|
35
|
+
* found in log events in the log group. Creating field indexes speeds up and lowers the costs
|
|
36
|
+
* for CloudWatch Logs Insights queries that reference those field indexes, because these
|
|
37
|
+
* queries attempt to skip the processing of log events that are known to not match the indexed
|
|
38
|
+
* field. Good fields to index are fields that you often need to query for and fields or values
|
|
39
|
+
* that match only a small fraction of the total log events. Common examples of indexes include
|
|
40
|
+
* request ID, session ID, userID, and instance IDs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-Field-Indexing.html">Create field indexes to improve query performance and reduce costs</a>.</p>
|
|
41
|
+
* <p>To find the fields that are in your log group events, use the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogGroupFields.html">GetLogGroupFields</a> operation.</p>
|
|
42
42
|
* <p>For example, suppose you have created a field index for <code>requestId</code>. Then, any
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
43
|
+
* CloudWatch Logs Insights query on that log group that includes <code>requestId =
|
|
44
|
+
* <i>value</i>
|
|
45
|
+
* </code> or <code>requestId IN [<i>value</i>,
|
|
46
|
+
* <i>value</i>, ...]</code> will process fewer log events to reduce costs, and
|
|
47
|
+
* have improved performance.</p>
|
|
47
48
|
* <p>Each index policy has the following quotas and restrictions:</p>
|
|
48
49
|
* <ul>
|
|
49
50
|
* <li>
|
|
@@ -53,13 +54,13 @@ declare const PutIndexPolicyCommand_base: {
|
|
|
53
54
|
* <p>Each field name can include as many as 100 characters.</p>
|
|
54
55
|
* </li>
|
|
55
56
|
* </ul>
|
|
56
|
-
* <p>Matches of log events to the names of indexed fields are case-sensitive. For example, a
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* <code>PutIndexPolicy</code> to create a field
|
|
61
|
-
*
|
|
62
|
-
*
|
|
57
|
+
* <p>Matches of log events to the names of indexed fields are case-sensitive. For example, a
|
|
58
|
+
* field index of <code>RequestId</code> won't match a log event containing
|
|
59
|
+
* <code>requestId</code>.</p>
|
|
60
|
+
* <p>Log group-level field index policies created with <code>PutIndexPolicy</code> override
|
|
61
|
+
* account-level field index policies created with <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html">PutAccountPolicy</a>. If you use <code>PutIndexPolicy</code> to create a field index
|
|
62
|
+
* policy for a log group, that log group uses only that policy. The log group ignores any
|
|
63
|
+
* account-wide field index policy that you might have created.</p>
|
|
63
64
|
* @example
|
|
64
65
|
* Use a bare-bones client and the command you need to make an API call.
|
|
65
66
|
* ```javascript
|
|
@@ -27,12 +27,14 @@ declare const PutIntegrationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates an integration between CloudWatch Logs and another service in this account.
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
30
|
+
* <p>Creates an integration between CloudWatch Logs and another service in this account.
|
|
31
|
+
* Currently, only integrations with OpenSearch Service are supported, and currently you can have
|
|
32
|
+
* only one integration in your account.</p>
|
|
33
|
+
* <p>Integrating with OpenSearch Service makes it possible for you to create curated vended
|
|
34
|
+
* logs dashboards, powered by OpenSearch Service analytics. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs-OpenSearch-Dashboards.html">Vended log
|
|
35
|
+
* dashboards powered by Amazon OpenSearch Service</a>.</p>
|
|
36
|
+
* <p>You can use this operation only to create a new integration. You can't modify an existing
|
|
37
|
+
* integration.</p>
|
|
36
38
|
* @example
|
|
37
39
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
40
|
* ```javascript
|
|
@@ -29,11 +29,11 @@ declare const PutLogEventsCommand_base: {
|
|
|
29
29
|
/**
|
|
30
30
|
* <p>Uploads a batch of log events to the specified log stream.</p>
|
|
31
31
|
* <important>
|
|
32
|
-
* <p>The sequence token is now ignored in <code>PutLogEvents</code>
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
32
|
+
* <p>The sequence token is now ignored in <code>PutLogEvents</code> actions.
|
|
33
|
+
* <code>PutLogEvents</code> actions are always accepted and never return
|
|
34
|
+
* <code>InvalidSequenceTokenException</code> or <code>DataAlreadyAcceptedException</code>
|
|
35
|
+
* even if the sequence token is not valid. You can use parallel <code>PutLogEvents</code>
|
|
36
|
+
* actions on the same log stream. </p>
|
|
37
37
|
* </important>
|
|
38
38
|
* <p>The batch of events must satisfy the following constraints:</p>
|
|
39
39
|
* <ul>
|
|
@@ -42,20 +42,24 @@ declare const PutLogEventsCommand_base: {
|
|
|
42
42
|
* all event messages in UTF-8, plus 26 bytes for each log event.</p>
|
|
43
43
|
* </li>
|
|
44
44
|
* <li>
|
|
45
|
-
* <p>Events more than 2 hours in the future are rejected while processing remaining
|
|
45
|
+
* <p>Events more than 2 hours in the future are rejected while processing remaining
|
|
46
|
+
* valid events.</p>
|
|
46
47
|
* </li>
|
|
47
48
|
* <li>
|
|
48
|
-
* <p>Events older than 14 days or preceding the log group's retention period are
|
|
49
|
+
* <p>Events older than 14 days or preceding the log group's retention period are
|
|
50
|
+
* rejected while processing remaining valid events.</p>
|
|
49
51
|
* </li>
|
|
50
52
|
* <li>
|
|
51
53
|
* <p>The log events in the batch must be in chronological order by their timestamp. The
|
|
52
54
|
* timestamp is the time that the event occurred, expressed as the number of milliseconds
|
|
53
55
|
* after <code>Jan 1, 1970 00:00:00 UTC</code>. (In Amazon Web Services Tools for PowerShell
|
|
54
56
|
* and the Amazon Web Services SDK for .NET, the timestamp is specified in .NET format:
|
|
55
|
-
* <code>yyyy-mm-ddThh:mm:ss</code>. For example, <code>2017-09-15T13:45:30</code>.)
|
|
57
|
+
* <code>yyyy-mm-ddThh:mm:ss</code>. For example, <code>2017-09-15T13:45:30</code>.)
|
|
58
|
+
* </p>
|
|
56
59
|
* </li>
|
|
57
60
|
* <li>
|
|
58
|
-
* <p> A batch of log events in a single request must be in a chronological order.
|
|
61
|
+
* <p> A batch of log events in a single request must be in a chronological order.
|
|
62
|
+
* Otherwise, the operation fails.</p>
|
|
59
63
|
* </li>
|
|
60
64
|
* <li>
|
|
61
65
|
* <p>Each log event can be no larger than 1 MB.</p>
|
|
@@ -64,14 +68,14 @@ declare const PutLogEventsCommand_base: {
|
|
|
64
68
|
* <p>The maximum number of log events in a batch is 10,000.</p>
|
|
65
69
|
* </li>
|
|
66
70
|
* <li>
|
|
67
|
-
* <p>For valid events (within 14 days in the past to 2 hours in future), the time span
|
|
71
|
+
* <p>For valid events (within 14 days in the past to 2 hours in future), the time span
|
|
72
|
+
* in a single batch cannot exceed 24 hours. Otherwise, the operation fails.</p>
|
|
68
73
|
* </li>
|
|
69
74
|
* </ul>
|
|
70
75
|
* <important>
|
|
71
|
-
* <p>The quota of five requests per second per log stream
|
|
72
|
-
*
|
|
73
|
-
*
|
|
74
|
-
* quota by using the Service Quotas service.</p>
|
|
76
|
+
* <p>The quota of five requests per second per log stream has been removed. Instead,
|
|
77
|
+
* <code>PutLogEvents</code> actions are throttled based on a per-second per-account quota.
|
|
78
|
+
* You can request an increase to the per-second throttling quota by using the Service Quotas service.</p>
|
|
75
79
|
* </important>
|
|
76
80
|
* <p>If a call to <code>PutLogEvents</code> returns "UnrecognizedClientException" the most
|
|
77
81
|
* likely cause is a non-valid Amazon Web Services access key ID or secret key. </p>
|
|
@@ -126,24 +130,23 @@ declare const PutLogEventsCommand_base: {
|
|
|
126
130
|
* <p>The event was already logged.</p>
|
|
127
131
|
* <important>
|
|
128
132
|
* <p>
|
|
129
|
-
* <code>PutLogEvents</code>
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
* has already been accepted. </p>
|
|
133
|
+
* <code>PutLogEvents</code> actions are now always accepted and never return
|
|
134
|
+
* <code>DataAlreadyAcceptedException</code> regardless of whether a given batch of log
|
|
135
|
+
* events has already been accepted. </p>
|
|
133
136
|
* </important>
|
|
134
137
|
*
|
|
135
138
|
* @throws {@link InvalidParameterException} (client fault)
|
|
136
139
|
* <p>A parameter is specified incorrectly.</p>
|
|
137
140
|
*
|
|
138
141
|
* @throws {@link InvalidSequenceTokenException} (client fault)
|
|
139
|
-
* <p>The sequence token is not valid. You can get the correct sequence token in
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
+
* <p>The sequence token is not valid. You can get the correct sequence token in the
|
|
143
|
+
* <code>expectedSequenceToken</code> field in the <code>InvalidSequenceTokenException</code>
|
|
144
|
+
* message. </p>
|
|
142
145
|
* <important>
|
|
143
146
|
* <p>
|
|
144
|
-
* <code>PutLogEvents</code>
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
+
* <code>PutLogEvents</code> actions are now always accepted and never return
|
|
148
|
+
* <code>InvalidSequenceTokenException</code> regardless of receiving an invalid sequence
|
|
149
|
+
* token. </p>
|
|
147
150
|
* </important>
|
|
148
151
|
*
|
|
149
152
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
@@ -32,26 +32,22 @@ declare const PutMetricFilterCommand_base: {
|
|
|
32
32
|
* through <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>.</p>
|
|
33
33
|
* <p>The maximum number of metric filters that can be associated with a log group is
|
|
34
34
|
* 100.</p>
|
|
35
|
-
* <p>Using regular expressions in filter patterns is supported. For these filters,
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* to the metric that is created.</p>
|
|
35
|
+
* <p>Using regular expressions in filter patterns is supported. For these filters, there is a
|
|
36
|
+
* quota of two regular expression patterns within a single filter pattern. There is also a quota
|
|
37
|
+
* of five regular expression patterns per log group. For more information about using regular
|
|
38
|
+
* expressions in filter patterns, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html"> Filter pattern syntax for
|
|
39
|
+
* metric filters, subscription filters, filter log events, and Live Tail</a>.</p>
|
|
40
|
+
* <p>When you create a metric filter, you can also optionally assign a unit and dimensions to
|
|
41
|
+
* the metric that is created.</p>
|
|
43
42
|
* <important>
|
|
44
|
-
* <p>Metrics extracted from log events are charged as custom metrics.
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
* <p>CloudWatch Logs might disable a metric filter if it generates 1,000 different name/value pairs for
|
|
51
|
-
* your specified dimensions within one hour.</p>
|
|
43
|
+
* <p>Metrics extracted from log events are charged as custom metrics. To prevent unexpected
|
|
44
|
+
* high charges, do not specify high-cardinality fields such as <code>IPAddress</code> or
|
|
45
|
+
* <code>requestID</code> as dimensions. Each different value found for a dimension is
|
|
46
|
+
* treated as a separate metric and accrues charges as a separate custom metric. </p>
|
|
47
|
+
* <p>CloudWatch Logs might disable a metric filter if it generates 1,000 different
|
|
48
|
+
* name/value pairs for your specified dimensions within one hour.</p>
|
|
52
49
|
* <p>You can also set up a billing alarm to alert you if your charges are higher than
|
|
53
|
-
* expected. For more information,
|
|
54
|
-
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html">
|
|
50
|
+
* expected. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html">
|
|
55
51
|
* Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges</a>.
|
|
56
52
|
* </p>
|
|
57
53
|
* </important>
|
|
@@ -27,8 +27,8 @@ declare const PutQueryDefinitionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates or updates a query definition for CloudWatch Logs Insights. For
|
|
31
|
-
*
|
|
30
|
+
* <p>Creates or updates a query definition for CloudWatch Logs Insights. For more information,
|
|
31
|
+
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html">Analyzing Log Data with CloudWatch Logs Insights</a>.</p>
|
|
32
32
|
* <p>To update a query definition, specify its <code>queryDefinitionId</code> in your request.
|
|
33
33
|
* The values of <code>name</code>, <code>queryString</code>, and <code>logGroupNames</code> are
|
|
34
34
|
* changed to the values that you specify in your update operation. No current values are
|
|
@@ -37,7 +37,7 @@ declare const PutQueryDefinitionCommand_base: {
|
|
|
37
37
|
* parameter in your update operation, the query definition changes to contain no log
|
|
38
38
|
* groups.</p>
|
|
39
39
|
* <p>You must have the <code>logs:PutQueryDefinition</code> permission to be able to perform
|
|
40
|
-
*
|
|
40
|
+
* this operation.</p>
|
|
41
41
|
* @example
|
|
42
42
|
* Use a bare-bones client and the command you need to make an API call.
|
|
43
43
|
* ```javascript
|
|
@@ -27,9 +27,9 @@ declare const PutResourcePolicyCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates or updates a resource policy allowing other Amazon Web Services services to put
|
|
31
|
-
* this account, such as Amazon Route 53. An account can have up to 10 resource
|
|
32
|
-
* Region.</p>
|
|
30
|
+
* <p>Creates or updates a resource policy allowing other Amazon Web Services services to put
|
|
31
|
+
* log events to this account, such as Amazon Route 53. An account can have up to 10 resource
|
|
32
|
+
* policies per Amazon Web Services Region.</p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -39,6 +39,8 @@ declare const PutResourcePolicyCommand_base: {
|
|
|
39
39
|
* const input = { // PutResourcePolicyRequest
|
|
40
40
|
* policyName: "STRING_VALUE",
|
|
41
41
|
* policyDocument: "STRING_VALUE",
|
|
42
|
+
* resourceArn: "STRING_VALUE",
|
|
43
|
+
* expectedRevisionId: "STRING_VALUE",
|
|
42
44
|
* };
|
|
43
45
|
* const command = new PutResourcePolicyCommand(input);
|
|
44
46
|
* const response = await client.send(command);
|
|
@@ -47,7 +49,11 @@ declare const PutResourcePolicyCommand_base: {
|
|
|
47
49
|
* // policyName: "STRING_VALUE",
|
|
48
50
|
* // policyDocument: "STRING_VALUE",
|
|
49
51
|
* // lastUpdatedTime: Number("long"),
|
|
52
|
+
* // policyScope: "ACCOUNT" || "RESOURCE",
|
|
53
|
+
* // resourceArn: "STRING_VALUE",
|
|
54
|
+
* // revisionId: "STRING_VALUE",
|
|
50
55
|
* // },
|
|
56
|
+
* // revisionId: "STRING_VALUE",
|
|
51
57
|
* // };
|
|
52
58
|
*
|
|
53
59
|
* ```
|
|
@@ -64,6 +70,12 @@ declare const PutResourcePolicyCommand_base: {
|
|
|
64
70
|
* @throws {@link LimitExceededException} (client fault)
|
|
65
71
|
* <p>You have reached the maximum number of resources that can be created.</p>
|
|
66
72
|
*
|
|
73
|
+
* @throws {@link OperationAbortedException} (client fault)
|
|
74
|
+
* <p>Multiple concurrent requests to update the same resource were in conflict.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
77
|
+
* <p>The specified resource does not exist.</p>
|
|
78
|
+
*
|
|
67
79
|
* @throws {@link ServiceUnavailableException} (server fault)
|
|
68
80
|
* <p>The service cannot complete the request.</p>
|
|
69
81
|
*
|
|
@@ -41,10 +41,11 @@ declare const PutRetentionPolicyCommand_base: {
|
|
|
41
41
|
* retention setting until 72 hours after the previous retention period ends. Alternatively,
|
|
42
42
|
* wait to change the retention setting until you confirm that the earlier log events are
|
|
43
43
|
* deleted. </p>
|
|
44
|
-
* <p>When log events reach their retention setting they are marked for deletion. After
|
|
45
|
-
*
|
|
44
|
+
* <p>When log events reach their retention setting they are marked for deletion. After they
|
|
45
|
+
* are marked for deletion, they do not add to your archival storage costs anymore, even if
|
|
46
46
|
* they are not actually deleted until later. These log events marked for deletion are also not
|
|
47
|
-
* included when you use an API to retrieve the <code>storedBytes</code> value to see how many
|
|
47
|
+
* included when you use an API to retrieve the <code>storedBytes</code> value to see how many
|
|
48
|
+
* bytes a log group is storing.</p>
|
|
48
49
|
* </note>
|
|
49
50
|
* @example
|
|
50
51
|
* Use a bare-bones client and the command you need to make an API call.
|