@aws-sdk/client-cloudwatch-logs 3.296.0 → 3.297.0

package/dist-types/CloudWatchLogs.d.ts

@@ -49,6 +49,7 @@ import { TestMetricFilterCommandInput, TestMetricFilterCommandOutput } from "./c
 import { UntagLogGroupCommandInput, UntagLogGroupCommandOutput } from "./commands/UntagLogGroupCommand";
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
 /**
+ * @public
  * <p>You can use Amazon CloudWatch Logs to monitor, store, and access your log files from
  *       EC2 instances, CloudTrail, and other sources. You can then retrieve the associated
  *       log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use
@@ -87,6 +88,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
  */
 export declare class CloudWatchLogs extends CloudWatchLogsClient {
     /**
+     * @public
      * <p>Associates the specified KMS key with the specified log
      *       group.</p>
      *          <p>Associating a KMS key with a log group overrides any existing
@@ -106,6 +108,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     associateKmsKey(args: AssociateKmsKeyCommandInput, cb: (err: any, data?: AssociateKmsKeyCommandOutput) => void): void;
     associateKmsKey(args: AssociateKmsKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateKmsKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Cancels the specified export task.</p>
      *          <p>The task must be in the <code>PENDING</code> or <code>RUNNING</code> state.</p>
      */
@@ -113,6 +116,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     cancelExportTask(args: CancelExportTaskCommandInput, cb: (err: any, data?: CancelExportTaskCommandOutput) => void): void;
     cancelExportTask(args: CancelExportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelExportTaskCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates an export task so that you can efficiently export data from a log group to an
      *       Amazon S3 bucket. When you perform a <code>CreateExportTask</code> operation, you must use
      *       credentials that have permission to write to the S3 bucket that you specify as the
@@ -138,6 +142,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     createExportTask(args: CreateExportTaskCommandInput, cb: (err: any, data?: CreateExportTaskCommandOutput) => void): void;
     createExportTask(args: CreateExportTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExportTaskCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a log group with the specified name. You can create up to 20,000 log groups per account.</p>
      *          <p>You must use the following guidelines when naming a log group:</p>
      *          <ul>
@@ -172,6 +177,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     createLogGroup(args: CreateLogGroupCommandInput, cb: (err: any, data?: CreateLogGroupCommandOutput) => void): void;
     createLogGroup(args: CreateLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLogGroupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates a log stream for the specified log group. A log stream is a sequence of log events
      *       that originate from a single source, such as an application instance or a resource that is
      *       being monitored.</p>
@@ -194,6 +200,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     createLogStream(args: CreateLogStreamCommandInput, cb: (err: any, data?: CreateLogStreamCommandOutput) => void): void;
     createLogStream(args: CreateLogStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLogStreamCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the data protection policy from the specified log group. </p>
      *          <p>For more information about data protection policies, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html">PutDataProtectionPolicy</a>.</p>
      */
@@ -201,6 +208,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     deleteDataProtectionPolicy(args: DeleteDataProtectionPolicyCommandInput, cb: (err: any, data?: DeleteDataProtectionPolicyCommandOutput) => void): void;
     deleteDataProtectionPolicy(args: DeleteDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataProtectionPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified destination, and eventually disables all the
      *       subscription filters that publish to it. This operation does not delete the
      *       physical resource encapsulated by the destination.</p>
@@ -209,6 +217,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     deleteDestination(args: DeleteDestinationCommandInput, cb: (err: any, data?: DeleteDestinationCommandOutput) => void): void;
     deleteDestination(args: DeleteDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDestinationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified log group and permanently deletes all the archived
      *       log events associated with the log group.</p>
      */
@@ -216,6 +225,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     deleteLogGroup(args: DeleteLogGroupCommandInput, cb: (err: any, data?: DeleteLogGroupCommandOutput) => void): void;
     deleteLogGroup(args: DeleteLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLogGroupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified log stream and permanently deletes all the archived log events associated
      *       with the log stream.</p>
      */
@@ -223,12 +233,14 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     deleteLogStream(args: DeleteLogStreamCommandInput, cb: (err: any, data?: DeleteLogStreamCommandOutput) => void): void;
     deleteLogStream(args: DeleteLogStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLogStreamCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified metric filter.</p>
      */
     deleteMetricFilter(args: DeleteMetricFilterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMetricFilterCommandOutput>;
     deleteMetricFilter(args: DeleteMetricFilterCommandInput, cb: (err: any, data?: DeleteMetricFilterCommandOutput) => void): void;
     deleteMetricFilter(args: DeleteMetricFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMetricFilterCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a saved CloudWatch Logs Insights query definition.
      *       A query definition contains details about a saved CloudWatch Logs Insights query.</p>
      *          <p>Each <code>DeleteQueryDefinition</code> operation can delete one query definition.</p>
@@ -239,6 +251,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     deleteQueryDefinition(args: DeleteQueryDefinitionCommandInput, cb: (err: any, data?: DeleteQueryDefinitionCommandOutput) => void): void;
     deleteQueryDefinition(args: DeleteQueryDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQueryDefinitionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes a resource policy from this account. This revokes
      *     the access of the identities in that policy to put log events to this account.</p>
      */
@@ -246,6 +259,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
     deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified retention policy.</p>
      *          <p>Log events do not expire if they belong to log groups without a retention policy.</p>
      */
@@ -253,18 +267,21 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     deleteRetentionPolicy(args: DeleteRetentionPolicyCommandInput, cb: (err: any, data?: DeleteRetentionPolicyCommandOutput) => void): void;
     deleteRetentionPolicy(args: DeleteRetentionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRetentionPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Deletes the specified subscription filter.</p>
      */
     deleteSubscriptionFilter(args: DeleteSubscriptionFilterCommandInput, options?: __HttpHandlerOptions): Promise<DeleteSubscriptionFilterCommandOutput>;
     deleteSubscriptionFilter(args: DeleteSubscriptionFilterCommandInput, cb: (err: any, data?: DeleteSubscriptionFilterCommandOutput) => void): void;
     deleteSubscriptionFilter(args: DeleteSubscriptionFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSubscriptionFilterCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists all your destinations. The results are ASCII-sorted by destination name.</p>
      */
     describeDestinations(args: DescribeDestinationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDestinationsCommandOutput>;
     describeDestinations(args: DescribeDestinationsCommandInput, cb: (err: any, data?: DescribeDestinationsCommandOutput) => void): void;
     describeDestinations(args: DescribeDestinationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDestinationsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the specified export tasks. You can list all your export tasks or filter
      *       the results based on task ID or task status.</p>
      */
@@ -272,6 +289,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     describeExportTasks(args: DescribeExportTasksCommandInput, cb: (err: any, data?: DescribeExportTasksCommandOutput) => void): void;
     describeExportTasks(args: DescribeExportTasksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExportTasksCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the specified log groups. You can list all your log groups or filter the results by prefix.
      *       The results are ASCII-sorted by log group name.</p>
      *          <p>CloudWatch Logs doesn’t support IAM policies that control access to the <code>DescribeLogGroups</code> action by using the
@@ -289,6 +307,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     describeLogGroups(args: DescribeLogGroupsCommandInput, cb: (err: any, data?: DescribeLogGroupsCommandOutput) => void): void;
     describeLogGroups(args: DescribeLogGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLogGroupsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the log streams for the specified log group.
      *       You can list all the log streams or filter the results by prefix.
      *       You can also control how the results are ordered.</p>
@@ -304,6 +323,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     describeLogStreams(args: DescribeLogStreamsCommandInput, cb: (err: any, data?: DescribeLogStreamsCommandOutput) => void): void;
     describeLogStreams(args: DescribeLogStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeLogStreamsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the specified metric filters. You can list all of the metric filters or filter
      *       the results by log name, prefix, metric name, or metric namespace. The results are
      *       ASCII-sorted by filter name.</p>
@@ -312,6 +332,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     describeMetricFilters(args: DescribeMetricFiltersCommandInput, cb: (err: any, data?: DescribeMetricFiltersCommandOutput) => void): void;
     describeMetricFilters(args: DescribeMetricFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMetricFiltersCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have
      *       been run recently in this account. You can request all queries or limit it to queries of a
      *       specific log group or queries with a certain status.</p>
@@ -320,6 +341,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     describeQueries(args: DescribeQueriesCommandInput, cb: (err: any, data?: DescribeQueriesCommandOutput) => void): void;
     describeQueries(args: DescribeQueriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQueriesCommandOutput) => void): void;
     /**
+     * @public
      * <p>This operation returns a paginated list of your saved CloudWatch Logs Insights query definitions.</p>
      *          <p>You can use the <code>queryDefinitionNamePrefix</code> parameter to limit the results to only the
      *       query definitions that have names that start with a certain string.</p>
@@ -328,12 +350,14 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     describeQueryDefinitions(args: DescribeQueryDefinitionsCommandInput, cb: (err: any, data?: DescribeQueryDefinitionsCommandOutput) => void): void;
     describeQueryDefinitions(args: DescribeQueryDefinitionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQueryDefinitionsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the resource policies in this account.</p>
      */
     describeResourcePolicies(args: DescribeResourcePoliciesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeResourcePoliciesCommandOutput>;
     describeResourcePolicies(args: DescribeResourcePoliciesCommandInput, cb: (err: any, data?: DescribeResourcePoliciesCommandOutput) => void): void;
     describeResourcePolicies(args: DescribeResourcePoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourcePoliciesCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix.
      *       The results are ASCII-sorted by filter name.</p>
      */
@@ -341,6 +365,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     describeSubscriptionFilters(args: DescribeSubscriptionFiltersCommandInput, cb: (err: any, data?: DescribeSubscriptionFiltersCommandOutput) => void): void;
     describeSubscriptionFilters(args: DescribeSubscriptionFiltersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSubscriptionFiltersCommandOutput) => void): void;
     /**
+     * @public
      * <p>Disassociates the associated KMS key from the specified log
      *       group.</p>
      *          <p>After the KMS key is disassociated from the log group, CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data
@@ -352,6 +377,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     disassociateKmsKey(args: DisassociateKmsKeyCommandInput, cb: (err: any, data?: DisassociateKmsKeyCommandOutput) => void): void;
     disassociateKmsKey(args: DisassociateKmsKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateKmsKeyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Lists log events from the specified log group. You can list all the log events or filter the results
      *       using a filter pattern, a time range, and the name of the log stream.</p>
      *          <p>You must have the <code>logs;FilterLogEvents</code> permission to perform this operation.</p>
@@ -373,12 +399,14 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     filterLogEvents(args: FilterLogEventsCommandInput, cb: (err: any, data?: FilterLogEventsCommandOutput) => void): void;
     filterLogEvents(args: FilterLogEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: FilterLogEventsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Returns information about a log group data protection policy.</p>
      */
     getDataProtectionPolicy(args: GetDataProtectionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetDataProtectionPolicyCommandOutput>;
     getDataProtectionPolicy(args: GetDataProtectionPolicyCommandInput, cb: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void): void;
     getDataProtectionPolicy(args: GetDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataProtectionPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <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>By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events).
@@ -395,6 +423,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     getLogEvents(args: GetLogEventsCommandInput, cb: (err: any, data?: GetLogEventsCommandOutput) => void): void;
     getLogEvents(args: GetLogEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLogEventsCommandOutput) => void): void;
     /**
+     * @public
      * <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>
@@ -415,6 +444,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     getLogGroupFields(args: GetLogGroupFieldsCommandInput, cb: (err: any, data?: GetLogGroupFieldsCommandOutput) => void): void;
     getLogGroupFields(args: GetLogGroupFieldsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLogGroupFieldsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Retrieves all of the fields and values of a single log event. All fields are retrieved,
      *       even if the original query that produced the <code>logRecordPointer</code> retrieved only a
      *       subset of fields. Fields are returned as field name/field value pairs.</p>
@@ -424,6 +454,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     getLogRecord(args: GetLogRecordCommandInput, cb: (err: any, data?: GetLogRecordCommandOutput) => void): void;
     getLogRecord(args: GetLogRecordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLogRecordCommandOutput) => void): void;
     /**
+     * @public
      * <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>
@@ -442,6 +473,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     getQueryResults(args: GetQueryResultsCommandInput, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void;
     getQueryResults(args: GetQueryResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQueryResultsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Displays the tags associated with a CloudWatch Logs resource. Currently, log groups
      *       and destinations support tagging.</p>
      */
@@ -449,6 +481,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
     /**
+     * @public
      * @deprecated
      *
      * <important>
@@ -461,6 +494,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     listTagsLogGroup(args: ListTagsLogGroupCommandInput, cb: (err: any, data?: ListTagsLogGroupCommandOutput) => void): void;
     listTagsLogGroup(args: ListTagsLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsLogGroupCommandOutput) => void): void;
     /**
+     * @public
      * <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>
@@ -481,6 +515,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     putDataProtectionPolicy(args: PutDataProtectionPolicyCommandInput, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void): void;
     putDataProtectionPolicy(args: PutDataProtectionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDataProtectionPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.</p>
      *          <p>A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With
      *       a destination, you can subscribe to a real-time stream of log events for a different account,
@@ -496,6 +531,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     putDestination(args: PutDestinationCommandInput, cb: (err: any, data?: PutDestinationCommandOutput) => void): void;
     putDestination(args: PutDestinationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDestinationCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates or updates an access policy associated with an existing
      *       destination. An access policy is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html">IAM policy document</a> that is used
      *       to authorize claims to register a subscription filter against a given destination.</p>
@@ -504,6 +540,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     putDestinationPolicy(args: PutDestinationPolicyCommandInput, cb: (err: any, data?: PutDestinationPolicyCommandOutput) => void): void;
     putDestinationPolicy(args: PutDestinationPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDestinationPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Uploads a batch of log events to the specified log stream.</p>
      *          <important>
      *             <p>The sequence token is now ignored in <code>PutLogEvents</code>
@@ -555,6 +592,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     putLogEvents(args: PutLogEventsCommandInput, cb: (err: any, data?: PutLogEventsCommandOutput) => void): void;
     putLogEvents(args: PutLogEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLogEventsCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates or updates a metric filter and associates it with the specified log group. With
      *       metric filters, you can configure rules to extract metric data from log events ingested
      *       through <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>.</p>
@@ -583,6 +621,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     putMetricFilter(args: PutMetricFilterCommandInput, cb: (err: any, data?: PutMetricFilterCommandOutput) => void): void;
     putMetricFilter(args: PutMetricFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMetricFilterCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates or updates a query definition for CloudWatch Logs Insights. For
      *       more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AnalyzingLogData.html">Analyzing Log Data with CloudWatch Logs Insights</a>.</p>
      *          <p>To update a query definition, specify its <code>queryDefinitionId</code> in your request.
@@ -599,6 +638,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     putQueryDefinition(args: PutQueryDefinitionCommandInput, cb: (err: any, data?: PutQueryDefinitionCommandOutput) => void): void;
     putQueryDefinition(args: PutQueryDefinitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutQueryDefinitionCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates or updates a resource policy allowing other Amazon Web Services services to put log events to
      *       this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services
      *       Region.</p>
@@ -607,6 +647,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     putResourcePolicy(args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
     putResourcePolicy(args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Sets the retention of the specified log group. With a retention policy, you can
      *       configure the number of days for which to retain log events in the specified log
      *       group.</p>
@@ -627,6 +668,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     putRetentionPolicy(args: PutRetentionPolicyCommandInput, cb: (err: any, data?: PutRetentionPolicyCommandOutput) => void): void;
     putRetentionPolicy(args: PutRetentionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRetentionPolicyCommandOutput) => void): void;
     /**
+     * @public
      * <p>Creates or updates a subscription filter and associates it with the specified log
      *       group. With subscription filters, you can subscribe to a real-time stream of log events
      *       ingested through <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>
@@ -660,6 +702,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     putSubscriptionFilter(args: PutSubscriptionFilterCommandInput, cb: (err: any, data?: PutSubscriptionFilterCommandOutput) => void): void;
     putSubscriptionFilter(args: PutSubscriptionFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutSubscriptionFilterCommandOutput) => void): void;
     /**
+     * @public
      * <p>Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group
      *       and time range to query and the query string to use.</p>
      *          <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query Syntax</a>.</p>
@@ -677,6 +720,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     startQuery(args: StartQueryCommandInput, cb: (err: any, data?: StartQueryCommandOutput) => void): void;
     startQuery(args: StartQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartQueryCommandOutput) => void): void;
     /**
+     * @public
      * <p>Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation
      *     returns an error indicating that the specified query is not running.</p>
      */
@@ -684,6 +728,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     stopQuery(args: StopQueryCommandInput, cb: (err: any, data?: StopQueryCommandOutput) => void): void;
     stopQuery(args: StopQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopQueryCommandOutput) => void): void;
     /**
+     * @public
      * @deprecated
      *
      * <important>
@@ -705,6 +750,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     tagLogGroup(args: TagLogGroupCommandInput, cb: (err: any, data?: TagLogGroupCommandOutput) => void): void;
     tagLogGroup(args: TagLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagLogGroupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Assigns one or more tags (key-value pairs) to the specified CloudWatch Logs resource.
      *         Currently, the only CloudWatch Logs resources that
      *         can be tagged are log groups and destinations. </p>
@@ -722,6 +768,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
     /**
+     * @public
      * <p>Tests the filter pattern of a metric filter against a sample of log event messages. You
      *       can use this operation to validate the correctness of a metric filter pattern.</p>
      */
@@ -729,6 +776,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     testMetricFilter(args: TestMetricFilterCommandInput, cb: (err: any, data?: TestMetricFilterCommandOutput) => void): void;
     testMetricFilter(args: TestMetricFilterCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestMetricFilterCommandOutput) => void): void;
     /**
+     * @public
      * @deprecated
      *
      * <important>
@@ -747,6 +795,7 @@ export declare class CloudWatchLogs extends CloudWatchLogsClient {
     untagLogGroup(args: UntagLogGroupCommandInput, cb: (err: any, data?: UntagLogGroupCommandOutput) => void): void;
     untagLogGroup(args: UntagLogGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagLogGroupCommandOutput) => void): void;
     /**
+     * @public
      * <p>Removes one or more tags from the specified resource.</p>
      */
     untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;

package/dist-types/CloudWatchLogsClient.d.ts

@@ -56,15 +56,24 @@ import { TestMetricFilterCommandInput, TestMetricFilterCommandOutput } from "./c
 import { UntagLogGroupCommandInput, UntagLogGroupCommandOutput } from "./commands/UntagLogGroupCommand";
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = AssociateKmsKeyCommandInput | CancelExportTaskCommandInput | CreateExportTaskCommandInput | CreateLogGroupCommandInput | CreateLogStreamCommandInput | DeleteDataProtectionPolicyCommandInput | DeleteDestinationCommandInput | DeleteLogGroupCommandInput | DeleteLogStreamCommandInput | DeleteMetricFilterCommandInput | DeleteQueryDefinitionCommandInput | DeleteResourcePolicyCommandInput | DeleteRetentionPolicyCommandInput | DeleteSubscriptionFilterCommandInput | DescribeDestinationsCommandInput | DescribeExportTasksCommandInput | DescribeLogGroupsCommandInput | DescribeLogStreamsCommandInput | DescribeMetricFiltersCommandInput | DescribeQueriesCommandInput | DescribeQueryDefinitionsCommandInput | DescribeResourcePoliciesCommandInput | DescribeSubscriptionFiltersCommandInput | DisassociateKmsKeyCommandInput | FilterLogEventsCommandInput | GetDataProtectionPolicyCommandInput | GetLogEventsCommandInput | GetLogGroupFieldsCommandInput | GetLogRecordCommandInput | GetQueryResultsCommandInput | ListTagsForResourceCommandInput | ListTagsLogGroupCommandInput | PutDataProtectionPolicyCommandInput | PutDestinationCommandInput | PutDestinationPolicyCommandInput | PutLogEventsCommandInput | PutMetricFilterCommandInput | PutQueryDefinitionCommandInput | PutResourcePolicyCommandInput | PutRetentionPolicyCommandInput | PutSubscriptionFilterCommandInput | StartQueryCommandInput | StopQueryCommandInput | TagLogGroupCommandInput | TagResourceCommandInput | TestMetricFilterCommandInput | UntagLogGroupCommandInput | UntagResourceCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = AssociateKmsKeyCommandOutput | CancelExportTaskCommandOutput | CreateExportTaskCommandOutput | CreateLogGroupCommandOutput | CreateLogStreamCommandOutput | DeleteDataProtectionPolicyCommandOutput | DeleteDestinationCommandOutput | DeleteLogGroupCommandOutput | DeleteLogStreamCommandOutput | DeleteMetricFilterCommandOutput | DeleteQueryDefinitionCommandOutput | DeleteResourcePolicyCommandOutput | DeleteRetentionPolicyCommandOutput | DeleteSubscriptionFilterCommandOutput | DescribeDestinationsCommandOutput | DescribeExportTasksCommandOutput | DescribeLogGroupsCommandOutput | DescribeLogStreamsCommandOutput | DescribeMetricFiltersCommandOutput | DescribeQueriesCommandOutput | DescribeQueryDefinitionsCommandOutput | DescribeResourcePoliciesCommandOutput | DescribeSubscriptionFiltersCommandOutput | DisassociateKmsKeyCommandOutput | FilterLogEventsCommandOutput | GetDataProtectionPolicyCommandOutput | GetLogEventsCommandOutput | GetLogGroupFieldsCommandOutput | GetLogRecordCommandOutput | GetQueryResultsCommandOutput | ListTagsForResourceCommandOutput | ListTagsLogGroupCommandOutput | PutDataProtectionPolicyCommandOutput | PutDestinationCommandOutput | PutDestinationPolicyCommandOutput | PutLogEventsCommandOutput | PutMetricFilterCommandOutput | PutQueryDefinitionCommandOutput | PutResourcePolicyCommandOutput | PutRetentionPolicyCommandOutput | PutSubscriptionFilterCommandOutput | StartQueryCommandOutput | StopQueryCommandOutput | TagLogGroupCommandOutput | TagResourceCommandOutput | TestMetricFilterCommandOutput | UntagLogGroupCommandOutput | UntagResourceCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -154,23 +163,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type CloudWatchLogsClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of CloudWatchLogsClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of CloudWatchLogsClient class constructor that set the region, credentials and other options.
  */
 export interface CloudWatchLogsClientConfig extends CloudWatchLogsClientConfigType {
 }
+/**
+ * @public
+ */
 type CloudWatchLogsClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of CloudWatchLogsClient class. This is resolved and normalized from the {@link CloudWatchLogsClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of CloudWatchLogsClient class. This is resolved and normalized from the {@link CloudWatchLogsClientConfig | constructor configuration interface}.
  */
 export interface CloudWatchLogsClientResolvedConfig extends CloudWatchLogsClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>You can use Amazon CloudWatch Logs to monitor, store, and access your log files from
  *       EC2 instances, CloudTrail, and other sources. You can then retrieve the associated
  *       log data from CloudWatch Logs using the CloudWatch console. Alternatively, you can use

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
 import { AssociateKmsKeyRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link AssociateKmsKeyCommand}.
  */
 export interface AssociateKmsKeyCommandInput extends AssociateKmsKeyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link AssociateKmsKeyCommand}.
  */
 export interface AssociateKmsKeyCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Associates the specified KMS key with the specified log
  *       group.</p>
  *          <p>Associating a KMS key with a log group overrides any existing
@@ -38,6 +43,8 @@ export interface AssociateKmsKeyCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param AssociateKmsKeyCommandInput - {@link AssociateKmsKeyCommandInput}
+ * @returns {@link AssociateKmsKeyCommandOutput}
  * @see {@link AssociateKmsKeyCommandInput} for command's `input` shape.
  * @see {@link AssociateKmsKeyCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
@@ -59,11 +66,20 @@ export interface AssociateKmsKeyCommandOutput extends __MetadataBearer {
 export declare class AssociateKmsKeyCommand extends $Command<AssociateKmsKeyCommandInput, AssociateKmsKeyCommandOutput, CloudWatchLogsClientResolvedConfig> {
     readonly input: AssociateKmsKeyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: AssociateKmsKeyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchLogsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateKmsKeyCommandInput, AssociateKmsKeyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
 import { CancelExportTaskRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CancelExportTaskCommand}.
  */
 export interface CancelExportTaskCommandInput extends CancelExportTaskRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CancelExportTaskCommand}.
  */
 export interface CancelExportTaskCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Cancels the specified export task.</p>
  *          <p>The task must be in the <code>PENDING</code> or <code>RUNNING</code> state.</p>
  * @example
@@ -26,6 +31,8 @@ export interface CancelExportTaskCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param CancelExportTaskCommandInput - {@link CancelExportTaskCommandInput}
+ * @returns {@link CancelExportTaskCommandOutput}
  * @see {@link CancelExportTaskCommandInput} for command's `input` shape.
  * @see {@link CancelExportTaskCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
@@ -47,11 +54,20 @@ export interface CancelExportTaskCommandOutput extends __MetadataBearer {
 export declare class CancelExportTaskCommand extends $Command<CancelExportTaskCommandInput, CancelExportTaskCommandOutput, CloudWatchLogsClientResolvedConfig> {
     readonly input: CancelExportTaskCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CancelExportTaskCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchLogsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CancelExportTaskCommandInput, CancelExportTaskCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
 import { CreateExportTaskRequest, CreateExportTaskResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateExportTaskCommand}.
  */
 export interface CreateExportTaskCommandInput extends CreateExportTaskRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateExportTaskCommand}.
  */
 export interface CreateExportTaskCommandOutput extends CreateExportTaskResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates an export task so that you can efficiently export data from a log group to an
  *       Amazon S3 bucket. When you perform a <code>CreateExportTask</code> operation, you must use
  *       credentials that have permission to write to the S3 bucket that you specify as the
@@ -44,6 +49,8 @@ export interface CreateExportTaskCommandOutput extends CreateExportTaskResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateExportTaskCommandInput - {@link CreateExportTaskCommandInput}
+ * @returns {@link CreateExportTaskCommandOutput}
  * @see {@link CreateExportTaskCommandInput} for command's `input` shape.
  * @see {@link CreateExportTaskCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
@@ -71,11 +78,20 @@ export interface CreateExportTaskCommandOutput extends CreateExportTaskResponse,
 export declare class CreateExportTaskCommand extends $Command<CreateExportTaskCommandInput, CreateExportTaskCommandOutput, CloudWatchLogsClientResolvedConfig> {
     readonly input: CreateExportTaskCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateExportTaskCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchLogsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateExportTaskCommandInput, CreateExportTaskCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }