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

package/dist-types/commands/GetLogEventsCommand.d.ts

@@ -30,26 +30,34 @@ declare const GetLogEventsCommand_base: {
  * <p>Lists log events from the specified log stream. You can list all of the log events or
  *       filter using a time range.</p>
  *          <p>
- *             <code>GetLogEvents</code> is a paginated operation. Each page returned can contain up to 1 MB of log events or up to 10,000 log events. A returned page might only be partially full, or even empty.
- *       For example, if the result of a query would return 15,000 log events, the first page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.</p>
- *          <p>Partially full or empty pages
- *       don't necessarily mean that pagination is finished. As long as the <code>nextBackwardToken</code> or <code>nextForwardToken</code> returned is NOT equal to the <code>nextToken</code>
- *       that you passed into the API call, there might be more
- *       log events available. The token that you use depends on the direction you want to move in along the log stream. The returned tokens are never null.</p>
+ *             <code>GetLogEvents</code> is a paginated operation. Each page returned can contain up to 1
+ *       MB of log events or up to 10,000 log events. A returned page might only be partially full, or
+ *       even empty. For example, if the result of a query would return 15,000 log events, the first
+ *       page isn't guaranteed to have 10,000 log events even if they all fit into 1 MB.</p>
+ *          <p>Partially full or empty pages don't necessarily mean that pagination is finished. As long
+ *       as the <code>nextBackwardToken</code> or <code>nextForwardToken</code> returned is NOT equal
+ *       to the <code>nextToken</code> that you passed into the API call, there might be more log
+ *       events available. The token that you use depends on the direction you want to move in along
+ *       the log stream. The returned tokens are never null.</p>
  *          <note>
- *             <p>If you set <code>startFromHead</code> to <code>true</code> and you don’t include <code>endTime</code> in your request, you can end up in a situation where the pagination doesn't terminate.
- *       This can happen when the new log events are being added to the target log streams
- *       faster than they are being read. This situation is a good use case for the CloudWatch Logs <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs_LiveTail.html">Live Tail</a> feature.</p>
+ *             <p>If you set <code>startFromHead</code> to <code>true</code> and you don’t include
+ *           <code>endTime</code> in your request, you can end up in a situation where the pagination
+ *         doesn't terminate. This can happen when the new log events are being added to the target log
+ *         streams faster than they are being read. This situation is a good use case for the CloudWatch Logs
+ *         <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatchLogs_LiveTail.html">Live Tail</a> feature.</p>
  *          </note>
- *          <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
- *       view data from the linked source accounts. For more information, see
- *       <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
- *          <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
- *       You must include one of these two parameters, but you can't include both.
- *     </p>
+ *          <p>If you are using CloudWatch cross-account observability, you can use this operation
+ *       in a monitoring account and view data from the linked source accounts. For more information,
+ *       see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
+ *          <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or
+ *         <code>logGroupName</code>. You must include one of these two parameters, but you can't
+ *       include both. </p>
  *          <note>
- *             <p>If you are using <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html">log transformation</a>, the <code>GetLogEvents</code> operation returns only the original versions of log events, before they
- *       were transformed. To view the transformed versions, you must use a <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html">CloudWatch Logs query.</a>
+ *             <p>If you are using <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html">log
+ *           transformation</a>, the <code>GetLogEvents</code> operation returns only the original
+ *         versions of log events, before they were transformed. To view the transformed versions, you
+ *         must use a <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html">CloudWatch Logs
+ *         query.</a>
  *             </p>
  *          </note>
  * @example

package/dist-types/commands/GetLogGroupFieldsCommand.d.ts

@@ -30,18 +30,18 @@ declare const GetLogGroupFieldsCommand_base: {
  * <p>Returns a list of the fields that are included in log events in the specified log group.
  *       Includes the percentage of log events that contain each field. The search is limited to a time
  *       period that you specify.</p>
- *          <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or <code>logGroupName</code>.
- *       You must specify one of these parameters, but you can't specify both.
- *     </p>
+ *          <p>You can specify the log group to search by using either <code>logGroupIdentifier</code> or
+ *         <code>logGroupName</code>. You must specify one of these parameters, but you can't specify
+ *       both. </p>
  *          <p>In the results, fields that start with <code>@</code> are fields generated by CloudWatch
  *       Logs. For example, <code>@timestamp</code> is the timestamp of each log event. For more
  *       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
  *         Logs and Discovered Fields</a>.</p>
- *          <p>The response results are sorted by the frequency percentage, starting
- *     with the highest percentage.</p>
- *          <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and
- *       view data from the linked source accounts. For more information, see
- *       <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
+ *          <p>The response results are sorted by the frequency percentage, starting with the highest
+ *       percentage.</p>
+ *          <p>If you are using CloudWatch cross-account observability, you can use this operation
+ *       in a monitoring account and view data from the linked source accounts. For more information,
+ *       see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/GetQueryResultsCommand.d.ts

@@ -28,19 +28,21 @@ declare const GetQueryResultsCommand_base: {
 };
 /**
  * <p>Returns the results from the specified query.</p>
- *          <p>Only the fields requested in the query are returned, along with a <code>@ptr</code>
- *       field, which is the identifier for the log record. You can use the value of <code>@ptr</code>
- *       in a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogRecord.html">GetLogRecord</a>
+ *          <p>Only the fields requested in the query are returned, along with a <code>@ptr</code> field,
+ *       which is the identifier for the log record. You can use the value of <code>@ptr</code> in a
+ *         <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogRecord.html">GetLogRecord</a>
  *       operation to get the full log record.</p>
  *          <p>
- *             <code>GetQueryResults</code> does not start running a query. To run a query, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a>. For more information about how long results of previous queries
- *       are available, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/cloudwatch_limits_cwl.html">CloudWatch Logs quotas</a>.</p>
- *          <p>If the value of the <code>Status</code> field in the output is <code>Running</code>, this operation
- *       returns only partial results. If you see a value of <code>Scheduled</code> or <code>Running</code> for the status,
- *       you can retry the operation later to see the final results. </p>
- *          <p>If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to start
- *       queries in linked source accounts. For more information, see
- *       <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
+ *             <code>GetQueryResults</code> does not start running a query. To run a query, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a>. For more information about how long results of previous queries are
+ *       available, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/cloudwatch_limits_cwl.html">CloudWatch Logs
+ *         quotas</a>.</p>
+ *          <p>If the value of the <code>Status</code> field in the output is <code>Running</code>, this
+ *       operation returns only partial results. If you see a value of <code>Scheduled</code> or
+ *         <code>Running</code> for the status, you can retry the operation later to see the final
+ *       results. </p>
+ *          <p>If you are using CloudWatch cross-account observability, you can use this operation
+ *       in a monitoring account to start queries in linked source accounts. For more information, see
+ *         <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">CloudWatch cross-account observability</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/GetTransformerCommand.d.ts

@@ -28,8 +28,8 @@ declare const GetTransformerCommand_base: {
 };
 /**
  * <p>Returns the information about the log transformer associated with this log group.</p>
- *          <p>This operation returns data only for transformers created at the log group level. To get information
- *        for an account-level transformer, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeAccountPolicies.html">DescribeAccountPolicies</a>.</p>
+ *          <p>This operation returns data only for transformers created at the log group level. To get
+ *       information for an account-level transformer, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeAccountPolicies.html">DescribeAccountPolicies</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListAnomaliesCommand.d.ts

@@ -27,8 +27,9 @@ declare const ListAnomaliesCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a list of anomalies that log anomaly detectors have found. For details about the structure format of
- *       each anomaly object that is returned, see the example in this section.</p>
+ * <p>Returns a list of anomalies that log anomaly detectors have found. For details about the
+ *       structure format of each anomaly object that is returned, see the example in this
+ *       section.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListIntegrationsCommand.d.ts

@@ -27,8 +27,9 @@ declare const ListIntegrationsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a list of integrations between CloudWatch Logs and other services in this account. Currently, only one
- *       integration can be created in an account, and this integration must be with OpenSearch Service.</p>
+ * <p>Returns a list of integrations between CloudWatch Logs and other services in this
+ *       account. Currently, only one integration can be created in an account, and this integration
+ *       must be with OpenSearch Service.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListLogGroupsCommand.d.ts

@@ -27,14 +27,15 @@ declare const ListLogGroupsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a list of log groups in the Region in your account. If you are performing this action in a monitoring account, you can
- *       choose to also return log groups from source accounts that are linked to the monitoring account. For more information about using cross-account
- *       observability to set up monitoring accounts and source accounts, see
- *       <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">
+ * <p>Returns a list of log groups in the Region in your account. If you are performing this
+ *       action in a monitoring account, you can choose to also return log groups from source accounts
+ *       that are linked to the monitoring account. For more information about using cross-account
+ *       observability to set up monitoring accounts and source accounts, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html">
  *         CloudWatch cross-account observability</a>.</p>
- *          <p>You can optionally filter the list by log group class and by using regular expressions in your request to match strings in the log group names.</p>
- *          <p>This operation is paginated. By default, your first use of this operation returns 50 results, and includes a token to use in a subsequent operation to return
- *     more results.</p>
+ *          <p>You can optionally filter the list by log group class and by using regular expressions in
+ *       your request to match strings in the log group names.</p>
+ *          <p>This operation is paginated. By default, your first use of this operation returns 50
+ *       results, and includes a token to use in a subsequent operation to return more results.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListLogGroupsForQueryCommand.d.ts

@@ -27,11 +27,12 @@ declare const ListLogGroupsForQueryCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Returns a list of the log groups that were analyzed during a single CloudWatch Logs Insights query. This can be useful for queries
- *     that use
- *     log group name prefixes or the <code>filterIndex</code> command, because the log groups are dynamically selected in these cases.</p>
- *          <p>For more information about field indexes, 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>
+ * <p>Returns a list of the log groups that were analyzed during a single CloudWatch Logs
+ *       Insights query. This can be useful for queries that use log group name prefixes or the
+ *         <code>filterIndex</code> command, because the log groups are dynamically selected in these
+ *       cases.</p>
+ *          <p>For more information about field indexes, 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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListTagsForResourceCommand.d.ts

@@ -27,8 +27,8 @@ declare const ListTagsForResourceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Displays the tags associated with a CloudWatch Logs resource. Currently, log groups
- *       and destinations support tagging.</p>
+ * <p>Displays the tags associated with a CloudWatch Logs resource. Currently, log groups and
+ *       destinations support tagging.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListTagsLogGroupCommand.d.ts

@@ -29,7 +29,7 @@ declare const ListTagsLogGroupCommand_base: {
 /**
  * <important>
  *             <p>The ListTagsLogGroup operation is on the path to deprecation. We recommend that you use
- *       <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a> instead.</p>
+ *           <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a> instead.</p>
  *          </important>
  *          <p>Lists the tags for the specified log group.</p>
  *

package/dist-types/commands/PutAccountPolicyCommand.d.ts

@@ -27,146 +27,161 @@ declare const PutAccountPolicyCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Creates an account-level data protection policy, subscription filter policy, or field index policy
- *       that applies to all log groups
- *       or a subset of log groups in the account.</p>
- *          <p>To use this operation, you must be signed on with the correct permissions depending on the type of policy that you are creating.</p>
+ * <p>Creates an account-level data protection policy, subscription filter policy, or field
+ *       index policy that applies to all log groups or a subset of log groups in the account.</p>
+ *          <p>To use this operation, you must be signed on with the correct permissions depending on the
+ *       type of policy that you are creating.</p>
  *          <ul>
  *             <li>
- *                <p>To create a data protection policy, you must have the <code>logs:PutDataProtectionPolicy</code> and
- *         <code>logs:PutAccountPolicy</code> permissions.</p>
+ *                <p>To create a data protection policy, you must have the
+ *             <code>logs:PutDataProtectionPolicy</code> and <code>logs:PutAccountPolicy</code>
+ *           permissions.</p>
  *             </li>
  *             <li>
- *                <p>To create a subscription filter policy, you must have the <code>logs:PutSubscriptionFilter</code> and
- *         <code>logs:PutccountPolicy</code> permissions.</p>
+ *                <p>To create a subscription filter policy, you must have the
+ *             <code>logs:PutSubscriptionFilter</code> and <code>logs:PutAccountPolicy</code>
+ *           permissions.</p>
  *             </li>
  *             <li>
- *                <p>To create a transformer policy, you must have the <code>logs:PutTransformer</code> and <code>logs:PutAccountPolicy</code> permissions.</p>
+ *                <p>To create a transformer policy, you must have the <code>logs:PutTransformer</code> and
+ *             <code>logs:PutAccountPolicy</code> permissions.</p>
  *             </li>
  *             <li>
  *                <p>To create a field index policy, you must have the <code>logs:PutIndexPolicy</code> and
- *         <code>logs:PutAccountPolicy</code> permissions.</p>
+ *             <code>logs:PutAccountPolicy</code> permissions.</p>
  *             </li>
  *          </ul>
  *          <p>
  *             <b>Data protection policy</b>
  *          </p>
- *          <p>A data protection policy can help safeguard sensitive
- *       data that's ingested by your log groups by auditing and masking the sensitive log data. Each account can have only
- *     one account-level data protection policy.</p>
+ *          <p>A data protection policy can help safeguard sensitive data that's ingested by your log
+ *       groups by auditing and masking the sensitive log data. Each account can have only one
+ *       account-level data protection policy.</p>
  *          <important>
- *             <p>Sensitive data is detected and masked when it is ingested into a log group. When you set a
- *       data protection policy, log events ingested into the log groups before that time are not masked.</p>
+ *             <p>Sensitive data is detected and masked when it is ingested into a log group. When you set
+ *         a data protection policy, log events ingested into the log groups before that time are not
+ *         masked.</p>
  *          </important>
- *          <p>If you use <code>PutAccountPolicy</code> to create a data protection policy for your whole account, it applies to both existing log groups
- *     and all log groups that are created later in this account. The account-level policy is applied to existing log groups
- *     with eventual consistency. It might take up to 5 minutes before sensitive data in existing log groups begins to be masked.</p>
- *          <p>By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.
- *       A user who has the <code>logs:Unmask</code> permission can use a
- *       <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html">GetLogEvents</a> or
- *       <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html">FilterLogEvents</a>
- *       operation with the <code>unmask</code> parameter set to <code>true</code> to view the unmasked
- *       log events. Users with the <code>logs:Unmask</code> can also view unmasked data in the CloudWatch Logs
- *       console by running a CloudWatch Logs Insights query with the <code>unmask</code> query command.</p>
- *          <p>For more information, including a list of types of data that can be audited and masked, see
- *       <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html">Protect sensitive log data with masking</a>.</p>
- *          <p>To use the <code>PutAccountPolicy</code> operation for a data protection policy, you must be signed on with
- *       the <code>logs:PutDataProtectionPolicy</code>
- *     and <code>logs:PutAccountPolicy</code> permissions.</p>
- *          <p>The <code>PutAccountPolicy</code> operation applies to all log groups in the account. You can use
- *       <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html">PutDataProtectionPolicy</a>
- *       to create a data protection policy that applies to just one log group.
- *       If a log group has its own data protection policy and
- *       the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term
+ *          <p>If you use <code>PutAccountPolicy</code> to create a data protection policy for your whole
+ *       account, it applies to both existing log groups and all log groups that are created later in
+ *       this account. The account-level policy is applied to existing log groups with eventual
+ *       consistency. It might take up to 5 minutes before sensitive data in existing log groups begins
+ *       to be masked.</p>
+ *          <p>By default, when a user views a log event that includes masked data, the sensitive data is
+ *       replaced by asterisks. A user who has the <code>logs:Unmask</code> permission can use a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html">GetLogEvents</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html">FilterLogEvents</a> operation with the <code>unmask</code> parameter set to
+ *         <code>true</code> to view the unmasked log events. Users with the <code>logs:Unmask</code>
+ *       can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs
+ *       Insights query with the <code>unmask</code> query command.</p>
+ *          <p>For more information, including a list of types of data that can be audited and masked,
+ *       see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html">Protect sensitive log data
+ *         with masking</a>.</p>
+ *          <p>To use the <code>PutAccountPolicy</code> operation for a data protection policy, you must
+ *       be signed on with the <code>logs:PutDataProtectionPolicy</code> and
+ *         <code>logs:PutAccountPolicy</code> permissions.</p>
+ *          <p>The <code>PutAccountPolicy</code> operation applies to all log groups in the account. You
+ *       can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html">PutDataProtectionPolicy</a> to create a data protection policy that applies to just one
+ *       log group. If a log group has its own data protection policy and the account also has an
+ *       account-level data protection policy, then the two policies are cumulative. Any sensitive term
  *       specified in either policy is masked.</p>
  *          <p>
  *             <b>Subscription filter policy</b>
  *          </p>
- *          <p>A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services.
- *       Account-level subscription filter policies apply to both existing log groups and log groups that are created later in
- *       this account. Supported destinations are Kinesis Data Streams, Firehose, and
- *       Lambda. When log events are sent to the receiving service, they are Base64 encoded and
- *       compressed with the GZIP format.</p>
+ *          <p>A subscription filter policy sets up a real-time feed of log events from CloudWatch Logs to other Amazon Web Services services. Account-level subscription filter policies apply to
+ *       both existing log groups and log groups that are created later in this account. Supported
+ *       destinations are Kinesis Data Streams, Firehose, and Lambda. When log
+ *       events are sent to the receiving service, they are Base64 encoded and compressed with the GZIP
+ *       format.</p>
  *          <p>The following destinations are supported for subscription filters:</p>
  *          <ul>
  *             <li>
- *                <p>An Kinesis Data Streams data stream in the same account as the subscription policy, for same-account delivery.</p>
+ *                <p>An Kinesis Data Streams data stream in the same account as the subscription policy, for
+ *           same-account delivery.</p>
  *             </li>
  *             <li>
- *                <p>An Firehose data stream in the same account as the subscription policy, for same-account delivery.</p>
+ *                <p>An Firehose data stream in the same account as the subscription policy, for
+ *           same-account delivery.</p>
  *             </li>
  *             <li>
- *                <p>A Lambda function in the same account as the subscription policy, for same-account delivery.</p>
+ *                <p>A Lambda function in the same account as the subscription policy, for
+ *           same-account delivery.</p>
  *             </li>
  *             <li>
- *                <p>A logical destination in a different account created with <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html">PutDestination</a>, for cross-account
- *         delivery. Kinesis Data Streams and Firehose are supported as logical destinations.</p>
+ *                <p>A logical destination in a different account created with <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDestination.html">PutDestination</a>, for cross-account delivery. Kinesis Data Streams and Firehose are supported as logical destinations.</p>
  *             </li>
  *          </ul>
- *          <p>Each account can have one account-level subscription filter policy per Region.
- *       If you are updating an existing filter, you must specify the correct name in <code>PolicyName</code>.
- *       To perform a <code>PutAccountPolicy</code> subscription filter operation for any destination except a Lambda
- *       function, you must also have the <code>iam:PassRole</code> permission.</p>
+ *          <p>Each account can have one account-level subscription filter policy per Region. If you are
+ *       updating an existing filter, you must specify the correct name in <code>PolicyName</code>. To
+ *       perform a <code>PutAccountPolicy</code> subscription filter operation for any destination
+ *       except a Lambda function, you must also have the <code>iam:PassRole</code>
+ *       permission.</p>
  *          <p>
  *             <b>Transformer policy</b>
  *          </p>
- *          <p>Creates or updates a <i>log transformer policy</i> for your account. You use log transformers to transform log events into
- *       a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that
- *       contain
- *       relevant, source-specific information. After you have created a transformer,
- *       CloudWatch Logs performs this transformation at the time of log ingestion. You can then refer to the transformed versions of the logs during
- *       operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filters.</p>
- *          <p>You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name,
- *       log stream name, account ID and Region.</p>
- *          <p>A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events
- *       ingested into this log group. For more information about the available processors to use in a transformer, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-Processors">
- *         Processors that you can use</a>.</p>
- *          <p>Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs.
- *       CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such
- *       as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies.</p>
+ *          <p>Creates or updates a <i>log transformer policy</i> for your account. You use
+ *       log transformers to transform log events into a different format, making them easier for you
+ *       to process and analyze. You can also transform logs from different sources into standardized
+ *       formats that contain relevant, source-specific information. After you have created a
+ *       transformer, CloudWatch Logs performs this transformation at the time of log ingestion. You
+ *       can then refer to the transformed versions of the logs during operations such as querying with
+ *         CloudWatch Logs Insights or creating metric filters or subscription filters.</p>
+ *          <p>You can also use a transformer to copy metadata from metadata keys into the log events
+ *       themselves. This metadata can include log group name, log stream name, account ID and
+ *       Region.</p>
+ *          <p>A transformer for a log group is a series of processors, where each processor applies one
+ *       type of transformation to the log events ingested into this log group. For more information
+ *       about the available processors to use in a transformer, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-Processors"> Processors that you can use</a>.</p>
+ *          <p>Having log events in standardized format enables visibility across your applications for
+ *       your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation
+ *       for common log types with out-of-the-box transformation templates for major Amazon Web Services
+ *       log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use
+ *       pre-built transformation templates or create custom transformation policies.</p>
  *          <p>You can create transformers only for the log groups in the Standard log class.</p>
- *          <p>You can have one account-level transformer policy that applies to all log groups in the account.
- *       Or you can create as many as 20 account-level transformer policies that are each scoped to a subset of log groups with
- *       the <code>selectionCriteria</code> parameter. If you have multiple
- *       account-level transformer policies with selection criteria, no two of them can use the same or overlapping log group name prefixes.
- *       For example, if you have one policy filtered to log groups that start with <code>my-log</code>, you can't have another field index
+ *          <p>You can have one account-level transformer policy that applies to all log groups in the
+ *       account. Or you can create as many as 20 account-level transformer policies that are each
+ *       scoped to a subset of log groups with the <code>selectionCriteria</code> parameter. If you
+ *       have multiple account-level transformer policies with selection criteria, no two of them can
+ *       use the same or overlapping log group name prefixes. For example, if you have one policy
+ *       filtered to log groups that start with <code>my-log</code>, you can't have another field index
  *       policy filtered to <code>my-logpprod</code> or <code>my-logging</code>.</p>
- *          <p>You can also set up a transformer at the log-group level. For more information, see
- *       <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html">PutTransformer</a>. If there is both a
- *       log-group level transformer created with <code>PutTransformer</code> and an account-level transformer that could apply to the same log
- *       group, the log group uses only the log-group level transformer. It ignores the account-level transformer.</p>
+ *          <p>You can also set up a transformer at the log-group level. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html">PutTransformer</a>. If there is both a log-group level transformer created with
+ *         <code>PutTransformer</code> and an account-level transformer that could apply to the same
+ *       log group, the log group uses only the log-group level transformer. It ignores the
+ *       account-level transformer.</p>
  *          <p>
  *             <b>Field index policy</b>
  *          </p>
- *          <p>You can use field index policies to create indexes on fields found in
- *       log events in the log group. Creating field indexes can help lower the scan volume for CloudWatch Logs Insights queries that reference
- *       those fields, because these queries attempt to skip the processing of log events that are known to not match the indexed field.
- *       Good fields to index are fields that you often need to query for and fields or values that match only a small fraction of the total log events.
- *       Common examples of indexes
- *       include request ID, session ID, user IDs, or 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>You can use field index policies to create indexes on fields found in log events in the
+ *       log group. Creating field indexes can help lower the scan volume for CloudWatch Logs
+ *       Insights queries that reference those fields, because these queries attempt to skip the
+ *       processing of log events that are known to not match the indexed field. Good fields to index
+ *       are fields that you often need to query for and fields or values that match only a small
+ *       fraction of the total log events. Common examples of indexes include request ID, session ID,
+ *       user IDs, or 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>
- *          <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>
+ *          <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>
  *          <p>For example, suppose you have created a field index for <code>requestId</code>. Then, any
- *       CloudWatch Logs Insights query on that log group that includes <code>requestId = <i>value</i>
- *             </code>
- *       or <code>requestId in [<i>value</i>, <i>value</i>, ...]</code> will attempt to process only the log events where
+ *         CloudWatch Logs Insights query on that log group that includes <code>requestId =
+ *           <i>value</i>
+ *             </code> or <code>requestId in [<i>value</i>,
+ *           <i>value</i>, ...]</code> will attempt to process only the log events where
  *       the indexed field matches the specified value.</p>
- *          <p>Matches of log events to the names of indexed fields are case-sensitive. For example, an indexed field
- *       of <code>RequestId</code> won't match a log event containing <code>requestId</code>.</p>
- *          <p>You can have one account-level field index policy that applies to all log groups in the account.
- *       Or you can create as many as 20 account-level field index policies that are each scoped to a subset of log groups with
- *       the <code>selectionCriteria</code> parameter. If you have multiple
- *     account-level index policies with selection criteria, no two of them can use the same or overlapping log group name prefixes.
- *     For example, if you have one policy filtered to log groups that start with <code>my-log</code>, you can't have another field index
- *     policy filtered to <code>my-logpprod</code> or <code>my-logging</code>.</p>
- *          <p>If you create an account-level field index policy in a monitoring account in cross-account observability, the policy is applied only
- *     to the monitoring account and not to any source accounts.</p>
- *          <p>If you want to create a field index policy for a single log group, you can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html">PutIndexPolicy</a> instead of
- *       <code>PutAccountPolicy</code>. If you do so, that log group will use only that log-group level policy, and will ignore the account-level policy
- *       that you create with <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html">PutAccountPolicy</a>.</p>
+ *          <p>Matches of log events to the names of indexed fields are case-sensitive. For example, an
+ *       indexed field of <code>RequestId</code> won't match a log event containing
+ *         <code>requestId</code>.</p>
+ *          <p>You can have one account-level field index policy that applies to all log groups in the
+ *       account. Or you can create as many as 20 account-level field index policies that are each
+ *       scoped to a subset of log groups with the <code>selectionCriteria</code> parameter. If you
+ *       have multiple account-level index policies with selection criteria, no two of them can use the
+ *       same or overlapping log group name prefixes. For example, if you have one policy filtered to
+ *       log groups that start with <code>my-log</code>, you can't have another field index policy
+ *       filtered to <code>my-logpprod</code> or <code>my-logging</code>.</p>
+ *          <p>If you create an account-level field index policy in a monitoring account in cross-account
+ *       observability, the policy is applied only to the monitoring account and not to any source
+ *       accounts.</p>
+ *          <p>If you want to create a field index policy for a single log group, you can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html">PutIndexPolicy</a> instead of <code>PutAccountPolicy</code>. If you do so, that log
+ *       group will use only that log-group level policy, and will ignore the account-level policy that
+ *       you create with <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html">PutAccountPolicy</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/PutDataProtectionPolicyCommand.d.ts

@@ -27,27 +27,28 @@ declare const PutDataProtectionPolicyCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Creates a data protection policy for the specified log group. A data protection policy can help safeguard sensitive
- *       data that's ingested by the log group by auditing and masking the sensitive log data.</p>
+ * <p>Creates a data protection policy for the specified log group. A data protection policy can
+ *       help safeguard sensitive data that's ingested by the log group by auditing and masking the
+ *       sensitive log data.</p>
  *          <important>
- *             <p>Sensitive data is detected and masked when it is ingested into the log group. When you set a
- *       data protection policy, log events ingested into the log group before that time are not masked.</p>
+ *             <p>Sensitive data is detected and masked when it is ingested into the log group. When you
+ *         set a data protection policy, log events ingested into the log group before that time are
+ *         not masked.</p>
  *          </important>
- *          <p>By default, when a user views a log event that includes masked data, the sensitive data is replaced by asterisks.
- *       A user who has the <code>logs:Unmask</code> permission can use a
- *       <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html">GetLogEvents</a> or
- *       <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html">FilterLogEvents</a>
- *       operation with the <code>unmask</code> parameter set to <code>true</code> to view the unmasked
- *       log events. Users with the <code>logs:Unmask</code> can also view unmasked data in the CloudWatch Logs
- *       console by running a CloudWatch Logs Insights query with the <code>unmask</code> query command.</p>
- *          <p>For more information, including a list of types of data that can be audited and masked, see
- *       <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html">Protect sensitive log data with masking</a>.</p>
- *          <p>The <code>PutDataProtectionPolicy</code> operation applies to only the specified log group. You can also use
- *       <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html">PutAccountPolicy</a>
- *       to create an account-level data protection policy that applies to all log groups in the account,
- *     including both existing log groups and log groups that are created level. If a log group has its own data protection policy and
- *     the account also has an account-level data protection policy, then the two policies are cumulative. Any sensitive term
- *     specified in either policy is masked.</p>
+ *          <p>By default, when a user views a log event that includes masked data, the sensitive data is
+ *       replaced by asterisks. A user who has the <code>logs:Unmask</code> permission can use a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html">GetLogEvents</a> or <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_FilterLogEvents.html">FilterLogEvents</a> operation with the <code>unmask</code> parameter set to
+ *         <code>true</code> to view the unmasked log events. Users with the <code>logs:Unmask</code>
+ *       can also view unmasked data in the CloudWatch Logs console by running a CloudWatch Logs
+ *       Insights query with the <code>unmask</code> query command.</p>
+ *          <p>For more information, including a list of types of data that can be audited and masked,
+ *       see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html">Protect sensitive log data
+ *         with masking</a>.</p>
+ *          <p>The <code>PutDataProtectionPolicy</code> operation applies to only the specified log
+ *       group. You can also use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html">PutAccountPolicy</a> to create an account-level data protection policy that applies to
+ *       all log groups in the account, including both existing log groups and log groups that are
+ *       created level. If a log group has its own data protection policy and the account also has an
+ *       account-level data protection policy, then the two policies are cumulative. Any sensitive term
+ *       specified in either policy is masked.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript