docs(client-cloudwatch-logs): Documentation-only update to address doc errors

Author: awstools

clients/client-cloudwatch-logs/src/commands/AssociateKmsKeyCommand.ts

@@ -34,7 +34,7 @@ export interface AssociateKmsKeyCommandOutput extends __MetadataBearer {}
  *     or the <code>resourceIdentifier</code> parameter. You can't specify both of those parameters in the same operation.</p>
  *          <ul>
  *             <li>
- *                <p>Specify the <code>logGroupName</code> parameter to cause all log events stored in the log group to
+ *                <p>Specify the <code>logGroupName</code> parameter to cause log events ingested into that log group to
  *     be encrypted with that key. Only the log events ingested after the key is associated are encrypted with that key.</p>
  *                <p>Associating a KMS key with a log group overrides any existing
  *       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

clients/client-cloudwatch-logs/src/commands/CreateExportTaskCommand.ts

@@ -45,6 +45,11 @@ export interface CreateExportTaskCommandOutput extends CreateExportTaskResponse,
  *       bucket. To separate log data for each export task, specify a prefix to be used as the Amazon
  *       S3 key prefix for all exported objects.</p>
  *          <note>
+ *             <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 instaed recommend that
+ *       you use 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 with subscriptions</a>.</p>
+ *          </note>
+ *          <note>
  *             <p>Time-based sorting on chunks of log data inside an exported file is not guaranteed. You can
  *         sort the exported log field data by using Linux utilities.</p>
  *          </note>

clients/client-cloudwatch-logs/src/commands/DeleteDeliveryCommand.ts

@@ -28,7 +28,7 @@ export interface DeleteDeliveryCommandInput extends DeleteDeliveryRequest {}
 export interface DeleteDeliveryCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes s <i>delivery</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical
+ * <p>Deletes a <i>delivery</i>. A delivery is a connection between a logical <i>delivery source</i> and a logical
  *        <i>delivery destination</i>. Deleting a delivery only deletes the connection between the delivery source and delivery destination. It does
  *      not delete the delivery destination or the delivery source.</p>
  * @example

clients/client-cloudwatch-logs/src/commands/DescribeAccountPoliciesCommand.ts

@@ -29,6 +29,24 @@ export interface DescribeAccountPoliciesCommandOutput extends DescribeAccountPol
 
 /**
  * <p>Returns a list of all CloudWatch Logs account policies 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 retrieving information for.</p>
+ *          <ul>
+ *             <li>
+ *                <p>To see data protection policies, you must have the <code>logs:GetDataProtectionPolicy</code> and
+ *         <code>logs:DescribeAccountPolicies</code> permissions.</p>
+ *             </li>
+ *             <li>
+ *                <p>To see subscription filter policies, you must have the <code>logs:DescrubeSubscriptionFilters</code> and
+ *         <code>logs:DescribeAccountPolicies</code> permissions.</p>
+ *             </li>
+ *             <li>
+ *                <p>To see transformer policies, you must have the <code>logs:GetTransformer</code> and <code>logs:DescribeAccountPolicies</code> permissions.</p>
+ *             </li>
+ *             <li>
+ *                <p>To see field index policies, you must have the <code>logs:DescribeIndexPolicies</code> and
+ *         <code>logs:DescribeAccountPolicies</code> permissions.</p>
+ *             </li>
+ *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-cloudwatch-logs/src/commands/DescribeLogStreamsCommand.ts

@@ -34,7 +34,7 @@ export interface DescribeLogStreamsCommandOutput extends DescribeLogStreamsRespo
  *          <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>This operation has a limit of five transactions per second, after which transactions are throttled.</p>
+ *          <p>This operation has a limit of 25 transactions per second, after which transactions are throttled.</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>

clients/client-cloudwatch-logs/src/commands/PutAccountPolicyCommand.ts

@@ -31,6 +31,24 @@ export interface PutAccountPolicyCommandOutput extends PutAccountPolicyResponse,
  * <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>
+ *             </li>
+ *             <li>
+ *                <p>To create a subscription filter policy, you must have the <code>logs:PutSubscriptionFilter</code> and
+ *         <code>logs:PutccountPolicy</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>
+ *             </li>
+ *             <li>
+ *                <p>To create a field index policy, you must have the <code>logs:PutIndexPolicy</code> and
+ *         <code>logs:PutAccountPolicy</code> permissions.</p>
+ *             </li>
+ *          </ul>
  *          <p>
  *             <b>Data protection policy</b>
  *          </p>

clients/client-cloudwatch-logs/src/commands/PutDeliveryDestinationCommand.ts

@@ -39,7 +39,8 @@ export interface PutDeliveryDestinationCommandOutput extends PutDeliveryDestinat
  *          information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">PutDeliverySource</a>.</p>
  *             </li>
  *             <li>
- *                <p>Use <code>PutDeliveryDestination</code> to create a <i>delivery destination</i>, which is a logical object that represents the actual
+ *                <p>Use <code>PutDeliveryDestination</code> to create a <i>delivery destination</i> in the same account of the actual delivery destination.
+ *          The delivery destination that you create is a logical object that represents the actual
  *          delivery destination.  </p>
  *             </li>
  *             <li>

clients/client-cloudwatch-logs/src/commands/PutMetricFilterCommand.ts

@@ -33,10 +33,10 @@ export interface PutMetricFilterCommandOutput extends __MetadataBearer {}
  *       through <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>.</p>
  *          <p>The maximum number of metric filters that can be associated with a log group is
  *       100.</p>
- *          <p>Using regular expressions to create metric filters is supported. For these filters,
+ *          <p>Using regular expressions in filter patterns is supported. For these filters,
  *       there is a quota of two regular expression patterns within a single filter pattern. There
  *       is also a quota of five regular expression patterns per log group.
- *     For more information about using regular expressions in metric filters,
+ *     For more information about using regular expressions in filter patterns,
  *     see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html">
  *       Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail</a>.</p>
  *          <p>When you create a metric filter, you can also optionally assign a unit and dimensions

clients/client-cloudwatch-logs/src/commands/PutSubscriptionFilterCommand.ts

@@ -55,10 +55,10 @@ export interface PutSubscriptionFilterCommandOutput extends __MetadataBearer {}
  *          <p>Each log group can have up to two subscription filters associated with it. If you are
  *       updating an existing filter, you must specify the correct name in <code>filterName</code>.
  *       </p>
- *          <p>Using regular expressions to create subscription filters is supported. For these filters,
+ *          <p>Using regular expressions in filter patterns is supported. For these filters,
  *       there is a quotas of quota of two regular expression patterns within a single filter pattern. There
  *       is also a quota of five regular expression patterns per log group.
- *       For more information about using regular expressions in subscription filters,
+ *       For more information about using regular expressions in filter patterns,
  *       see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html">
  *         Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail</a>.</p>
  *          <p>To perform a <code>PutSubscriptionFilter</code> operation for any destination except a Lambda function,

clients/client-cloudwatch-logs/src/models/models_0.ts

@@ -676,8 +676,9 @@ export type OutputFormat = (typeof OutputFormat)[keyof typeof OutputFormat];
 export interface S3DeliveryConfiguration {
   /**
    * <p>This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables
-   *       to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for
-   *       more info on what values are supported in the suffix path for each log source.</p>
+   *       to use in the suffix path will vary by each log source. To find the values supported for the suffix path for each log source,
+   *       use the <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeConfigurationTemplates.html">DescribeConfigurationTemplates</a> operation and check the
+   *       <code>allowedSuffixPathFields</code> field in the response.</p>
    * @public
    */
   suffixPath?: string | undefined;
@@ -6295,16 +6296,37 @@ export interface PutDeliverySourceRequest {
    *          <code>APPLICATION_LOGS</code>.</p>
    *             </li>
    *             <li>
+   *                <p>For CloudFront, the valid value is
+   *          <code>ACCESS_LOGS</code>.</p>
+   *             </li>
+   *             <li>
    *                <p>For Amazon CodeWhisperer, the valid value is
    *         <code>EVENT_LOGS</code>.</p>
    *             </li>
    *             <li>
+   *                <p>For Elemental MediaPackage, the valid values are
+   *          <code>EGRESS_ACCESS_LOGS</code> and <code>INGRESS_ACCESS_LOGS</code>.</p>
+   *             </li>
+   *             <li>
+   *                <p>For Elemental MediaTailor, the valid values are
+   *          <code>AD_DECISION_SERVER_LOGS</code>, <code>MANIFEST_SERVICE_LOGS</code>, and <code>TRANSCODE_LOGS</code>.</p>
+   *             </li>
+   *             <li>
    *                <p>For IAM Identity Center, the valid value is
    *          <code>ERROR_LOGS</code>.</p>
    *             </li>
    *             <li>
+   *                <p>For Amazon Q, the valid value is
+   *          <code>EVENT_LOGS</code>.</p>
+   *             </li>
+   *             <li>
+   *                <p>For Amazon SES mail manager, the valid value is
+   *          <code>APPLICATION_LOG</code>.</p>
+   *             </li>
+   *             <li>
    *                <p>For Amazon WorkMail, the valid values are
-   *          <code>ACCESS_CONTROL_LOGS</code>, <code>AUTHENTICATION_LOGS</code>, <code>WORKMAIL_AVAILABILITY_PROVIDER_LOGS</code>, and <code>WORKMAIL_MAILBOX_ACCESS_LOGS</code>.</p>
+   *          <code>ACCESS_CONTROL_LOGS</code>, <code>AUTHENTICATION_LOGS</code>, <code>WORKMAIL_AVAILABILITY_PROVIDER_LOGS</code>, <code>WORKMAIL_MAILBOX_ACCESS_LOGS</code>,
+   *          and <code>WORKMAIL_PERSONAL_ACCESS_TOKEN_LOGS</code>.</p>
    *             </li>
    *          </ul>
    * @public
@@ -6459,16 +6481,16 @@ export interface OpenSearchResourceConfig {
 
   /**
    * <p>Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service
-   *         collection to be able to create the dashboards. For more information about the permissions needed, see  <a href="https://docs.aws.amazon.com/OpenSearch-Dashboards-CreateRole">Create an IAM role to access the OpenSearch Service collection</a> in the CloudWatch Logs User Guide.</p>
+   *         collection to be able to create the dashboards. For more information about the permissions needed, see  <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-CreateRole.html">Permissions that the integration needs</a> in the CloudWatch Logs User Guide.</p>
    * @public
    */
   dataSourceRoleArn: string | undefined;
 
   /**
    * <p>Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.</p>
    *          <important>
-   *             <p>In addition to specifying these users here, you must also grant them the <b>CloudWatchOpenSearchDashboardsAccess</b>
-   *        IAM policy. For more information, see </p>
+   *             <p>In addition to specifying these users here, you must also grant them the <b>CloudWatchOpenSearchDashboardAccess</b>
+   *        IAM policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/OpenSearch-Dashboards-UserRoles.html">IAM policies for users</a>.</p>
    *          </important>
    * @public
    */
@@ -7042,7 +7064,7 @@ export interface StartLiveTailRequest {
 }
 
 /**
- * <p>his exception is returned if an unknown error occurs during a Live Tail session.</p>
+ * <p>This exception is returned if an unknown error occurs during a Live Tail session.</p>
  * @public
  */
 export class SessionStreamingException extends __BaseException {