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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
 import { PutSubscriptionFilterRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutSubscriptionFilterCommand}.
  */
 export interface PutSubscriptionFilterCommandInput extends PutSubscriptionFilterRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutSubscriptionFilterCommand}.
  */
 export interface PutSubscriptionFilterCommandOutput extends __MetadataBearer {
 }
 /**
+ * @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>
@@ -52,6 +57,8 @@ export interface PutSubscriptionFilterCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param PutSubscriptionFilterCommandInput - {@link PutSubscriptionFilterCommandInput}
+ * @returns {@link PutSubscriptionFilterCommandOutput}
  * @see {@link PutSubscriptionFilterCommandInput} for command's `input` shape.
  * @see {@link PutSubscriptionFilterCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
@@ -76,11 +83,20 @@ export interface PutSubscriptionFilterCommandOutput extends __MetadataBearer {
 export declare class PutSubscriptionFilterCommand extends $Command<PutSubscriptionFilterCommandInput, PutSubscriptionFilterCommandOutput, CloudWatchLogsClientResolvedConfig> {
     readonly input: PutSubscriptionFilterCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutSubscriptionFilterCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchLogsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutSubscriptionFilterCommandInput, PutSubscriptionFilterCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
 import { StartQueryRequest, StartQueryResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StartQueryCommand}.
  */
 export interface StartQueryCommandInput extends StartQueryRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StartQueryCommand}.
  */
 export interface StartQueryCommandOutput extends StartQueryResponse, __MetadataBearer {
 }
 /**
+ * @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>
@@ -36,6 +41,8 @@ export interface StartQueryCommandOutput extends StartQueryResponse, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param StartQueryCommandInput - {@link StartQueryCommandInput}
+ * @returns {@link StartQueryCommandOutput}
  * @see {@link StartQueryCommandInput} for command's `input` shape.
  * @see {@link StartQueryCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
@@ -64,11 +71,20 @@ export interface StartQueryCommandOutput extends StartQueryResponse, __MetadataB
 export declare class StartQueryCommand extends $Command<StartQueryCommandInput, StartQueryCommandOutput, CloudWatchLogsClientResolvedConfig> {
     readonly input: StartQueryCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartQueryCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchLogsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartQueryCommandInput, StartQueryCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
 import { StopQueryRequest, StopQueryResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StopQueryCommand}.
  */
 export interface StopQueryCommandInput extends StopQueryRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link StopQueryCommand}.
  */
 export interface StopQueryCommandOutput extends StopQueryResponse, __MetadataBearer {
 }
 /**
+ * @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>
  * @example
@@ -26,6 +31,8 @@ export interface StopQueryCommandOutput extends StopQueryResponse, __MetadataBea
  * const response = await client.send(command);
  * ```
  *
+ * @param StopQueryCommandInput - {@link StopQueryCommandInput}
+ * @returns {@link StopQueryCommandOutput}
  * @see {@link StopQueryCommandInput} for command's `input` shape.
  * @see {@link StopQueryCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
@@ -44,11 +51,20 @@ export interface StopQueryCommandOutput extends StopQueryResponse, __MetadataBea
 export declare class StopQueryCommand extends $Command<StopQueryCommandInput, StopQueryCommandOutput, CloudWatchLogsClientResolvedConfig> {
     readonly input: StopQueryCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopQueryCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchLogsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopQueryCommandInput, StopQueryCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
 import { TagLogGroupRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagLogGroupCommand}.
  */
 export interface TagLogGroupCommandInput extends TagLogGroupRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagLogGroupCommand}.
  */
 export interface TagLogGroupCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * @deprecated
  *
  * <important>
@@ -40,6 +45,8 @@ export interface TagLogGroupCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param TagLogGroupCommandInput - {@link TagLogGroupCommandInput}
+ * @returns {@link TagLogGroupCommandOutput}
  * @see {@link TagLogGroupCommandInput} for command's `input` shape.
  * @see {@link TagLogGroupCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
@@ -55,11 +62,20 @@ export interface TagLogGroupCommandOutput extends __MetadataBearer {
 export declare class TagLogGroupCommand extends $Command<TagLogGroupCommandInput, TagLogGroupCommandOutput, CloudWatchLogsClientResolvedConfig> {
     readonly input: TagLogGroupCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagLogGroupCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchLogsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagLogGroupCommandInput, TagLogGroupCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
 import { TagResourceRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends __MetadataBearer {
 }
 /**
+ * @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>
@@ -36,6 +41,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
@@ -57,11 +64,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, CloudWatchLogsClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchLogsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
 import { TestMetricFilterRequest, TestMetricFilterResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TestMetricFilterCommand}.
  */
 export interface TestMetricFilterCommandInput extends TestMetricFilterRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TestMetricFilterCommand}.
  */
 export interface TestMetricFilterCommandOutput extends TestMetricFilterResponse, __MetadataBearer {
 }
 /**
+ * @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>
  * @example
@@ -26,6 +31,8 @@ export interface TestMetricFilterCommandOutput extends TestMetricFilterResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param TestMetricFilterCommandInput - {@link TestMetricFilterCommandInput}
+ * @returns {@link TestMetricFilterCommandOutput}
  * @see {@link TestMetricFilterCommandInput} for command's `input` shape.
  * @see {@link TestMetricFilterCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
@@ -41,11 +48,20 @@ export interface TestMetricFilterCommandOutput extends TestMetricFilterResponse,
 export declare class TestMetricFilterCommand extends $Command<TestMetricFilterCommandInput, TestMetricFilterCommandOutput, CloudWatchLogsClientResolvedConfig> {
     readonly input: TestMetricFilterCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TestMetricFilterCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchLogsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TestMetricFilterCommandInput, TestMetricFilterCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
 import { UntagLogGroupRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagLogGroupCommand}.
  */
 export interface UntagLogGroupCommandInput extends UntagLogGroupRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagLogGroupCommand}.
  */
 export interface UntagLogGroupCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * @deprecated
  *
  * <important>
@@ -37,6 +42,8 @@ export interface UntagLogGroupCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagLogGroupCommandInput - {@link UntagLogGroupCommandInput}
+ * @returns {@link UntagLogGroupCommandOutput}
  * @see {@link UntagLogGroupCommandInput} for command's `input` shape.
  * @see {@link UntagLogGroupCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UntagLogGroupCommandOutput extends __MetadataBearer {
 export declare class UntagLogGroupCommand extends $Command<UntagLogGroupCommandInput, UntagLogGroupCommandOutput, CloudWatchLogsClientResolvedConfig> {
     readonly input: UntagLogGroupCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagLogGroupCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchLogsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagLogGroupCommandInput, UntagLogGroupCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
 import { UntagResourceRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes one or more tags from the specified resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
@@ -43,11 +50,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, CloudWatchLogsClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchLogsClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/CloudWatchLogsServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from CloudWatchLogs service.
  */
 export declare class CloudWatchLogsServiceException extends __ServiceException {