@aws-sdk/client-cloudwatch 3.296.0 → 3.298.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
 import { PutMetricAlarmInput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutMetricAlarmCommand}.
  */
 export interface PutMetricAlarmCommandInput extends PutMetricAlarmInput {
 }
 /**
+ * @public
+ *
  * The output of {@link PutMetricAlarmCommand}.
  */
 export interface PutMetricAlarmCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates or updates an alarm and associates it with the specified metric, metric math expression,
  * 			anomaly detection model, or Metrics Insights query. For more information about using
  * 			a Metrics Insights query for an alarm, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Metrics_Insights_Alarm.html">Create alarms on Metrics Insights queries</a>.</p>
@@ -76,6 +81,8 @@ export interface PutMetricAlarmCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param PutMetricAlarmCommandInput - {@link PutMetricAlarmCommandInput}
+ * @returns {@link PutMetricAlarmCommandOutput}
  * @see {@link PutMetricAlarmCommandInput} for command's `input` shape.
  * @see {@link PutMetricAlarmCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -88,11 +95,20 @@ export interface PutMetricAlarmCommandOutput extends __MetadataBearer {
 export declare class PutMetricAlarmCommand extends $Command<PutMetricAlarmCommandInput, PutMetricAlarmCommandOutput, CloudWatchClientResolvedConfig> {
     readonly input: PutMetricAlarmCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutMetricAlarmCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutMetricAlarmCommandInput, PutMetricAlarmCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
 import { PutMetricDataInput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutMetricDataCommand}.
  */
 export interface PutMetricDataCommandInput extends PutMetricDataInput {
 }
 /**
+ * @public
+ *
  * The output of {@link PutMetricDataCommand}.
  */
 export interface PutMetricDataCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Publishes metric data points to Amazon CloudWatch. CloudWatch associates
  * 			the data points with the specified metric. If the specified metric does not exist,
  * 			CloudWatch creates the metric. When CloudWatch creates a metric, it can
@@ -67,6 +72,8 @@ export interface PutMetricDataCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param PutMetricDataCommandInput - {@link PutMetricDataCommandInput}
+ * @returns {@link PutMetricDataCommandOutput}
  * @see {@link PutMetricDataCommandInput} for command's `input` shape.
  * @see {@link PutMetricDataCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -88,11 +95,20 @@ export interface PutMetricDataCommandOutput extends __MetadataBearer {
 export declare class PutMetricDataCommand extends $Command<PutMetricDataCommandInput, PutMetricDataCommandOutput, CloudWatchClientResolvedConfig> {
     readonly input: PutMetricDataCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutMetricDataCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutMetricDataCommandInput, PutMetricDataCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
 import { PutMetricStreamInput, PutMetricStreamOutput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutMetricStreamCommand}.
  */
 export interface PutMetricStreamCommandInput extends PutMetricStreamInput {
 }
 /**
+ * @public
+ *
  * The output of {@link PutMetricStreamCommand}.
  */
 export interface PutMetricStreamCommandOutput extends PutMetricStreamOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates or updates a metric stream. Metric streams can automatically stream CloudWatch
  * 			metrics to Amazon Web Services destinations, including Amazon S3, and to many third-party
  * 			solutions.</p>
@@ -58,6 +63,8 @@ export interface PutMetricStreamCommandOutput extends PutMetricStreamOutput, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param PutMetricStreamCommandInput - {@link PutMetricStreamCommandInput}
+ * @returns {@link PutMetricStreamCommandOutput}
  * @see {@link PutMetricStreamCommandInput} for command's `input` shape.
  * @see {@link PutMetricStreamCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -82,11 +89,20 @@ export interface PutMetricStreamCommandOutput extends PutMetricStreamOutput, __M
 export declare class PutMetricStreamCommand extends $Command<PutMetricStreamCommandInput, PutMetricStreamCommandOutput, CloudWatchClientResolvedConfig> {
     readonly input: PutMetricStreamCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutMetricStreamCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutMetricStreamCommandInput, PutMetricStreamCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
 import { SetAlarmStateInput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SetAlarmStateCommand}.
  */
 export interface SetAlarmStateCommandInput extends SetAlarmStateInput {
 }
 /**
+ * @public
+ *
  * The output of {@link SetAlarmStateCommand}.
  */
 export interface SetAlarmStateCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Temporarily sets the state of an alarm for testing purposes. When the updated
  * 			state differs from the previous value, the action configured for
  * 			the appropriate state is invoked. For example, if your alarm is configured to send an
@@ -40,6 +45,8 @@ export interface SetAlarmStateCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param SetAlarmStateCommandInput - {@link SetAlarmStateCommandInput}
+ * @returns {@link SetAlarmStateCommandOutput}
  * @see {@link SetAlarmStateCommandInput} for command's `input` shape.
  * @see {@link SetAlarmStateCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -55,11 +62,20 @@ export interface SetAlarmStateCommandOutput extends __MetadataBearer {
 export declare class SetAlarmStateCommand extends $Command<SetAlarmStateCommandInput, SetAlarmStateCommandOutput, CloudWatchClientResolvedConfig> {
     readonly input: SetAlarmStateCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SetAlarmStateCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SetAlarmStateCommandInput, SetAlarmStateCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
 import { StopMetricStreamsInput, StopMetricStreamsOutput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link StopMetricStreamsCommand}.
  */
 export interface StopMetricStreamsCommandInput extends StopMetricStreamsInput {
 }
 /**
+ * @public
+ *
  * The output of {@link StopMetricStreamsCommand}.
  */
 export interface StopMetricStreamsCommandOutput extends StopMetricStreamsOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Stops the streaming of metrics for one or more of your metric streams.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StopMetricStreamsCommandOutput extends StopMetricStreamsOutput,
  * const response = await client.send(command);
  * ```
  *
+ * @param StopMetricStreamsCommandInput - {@link StopMetricStreamsCommandInput}
+ * @returns {@link StopMetricStreamsCommandOutput}
  * @see {@link StopMetricStreamsCommandInput} for command's `input` shape.
  * @see {@link StopMetricStreamsCommandOutput} for command's `response` shape.
  * @see {@link CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -43,11 +50,20 @@ export interface StopMetricStreamsCommandOutput extends StopMetricStreamsOutput,
 export declare class StopMetricStreamsCommand extends $Command<StopMetricStreamsCommandInput, StopMetricStreamsCommandOutput, CloudWatchClientResolvedConfig> {
     readonly input: StopMetricStreamsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopMetricStreamsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopMetricStreamsCommandInput, StopMetricStreamsCommandOutput>;
+    /**
+     * @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 { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
 import { TagResourceInput, TagResourceOutput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceInput {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that
  * 			can be tagged are alarms and Contributor Insights rules.</p>
  *          <p>Tags can help you organize and categorize your resources. You can also use them to scope user
@@ -35,6 +40,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
  * 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 CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -56,11 +63,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, CloudWatchClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @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 { CloudWatchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchClient";
 import { UntagResourceInput, UntagResourceOutput } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceOutput, __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 UntagResourceOutput, __Metad
  * 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 CloudWatchClientResolvedConfig | config} for CloudWatchClient's `config` shape.
@@ -46,11 +53,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, CloudWatchClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudWatchClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/CloudWatchServiceException.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 CloudWatch service.
  */
 export declare class CloudWatchServiceException extends __ServiceException {