@aws-sdk/client-auto-scaling-plans 3.296.0 → 3.298.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AutoScalingPlansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AutoScalingPlansClient";
 import { DeleteScalingPlanRequest, DeleteScalingPlanResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DeleteScalingPlanCommand}.
  */
 export interface DeleteScalingPlanCommandInput extends DeleteScalingPlanRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DeleteScalingPlanCommand}.
  */
 export interface DeleteScalingPlanCommandOutput extends DeleteScalingPlanResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes the specified scaling plan.</p>
  *          <p>Deleting a scaling plan deletes the underlying <a>ScalingInstruction</a> for
  *          all of the scalable resources that are covered by the plan.</p>
@@ -29,6 +34,8 @@ export interface DeleteScalingPlanCommandOutput extends DeleteScalingPlanRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param DeleteScalingPlanCommandInput - {@link DeleteScalingPlanCommandInput}
+ * @returns {@link DeleteScalingPlanCommandOutput}
  * @see {@link DeleteScalingPlanCommandInput} for command's `input` shape.
  * @see {@link DeleteScalingPlanCommandOutput} for command's `response` shape.
  * @see {@link AutoScalingPlansClientResolvedConfig | config} for AutoScalingPlansClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DeleteScalingPlanCommandOutput extends DeleteScalingPlanRespons
 export declare class DeleteScalingPlanCommand extends $Command<DeleteScalingPlanCommandInput, DeleteScalingPlanCommandOutput, AutoScalingPlansClientResolvedConfig> {
     readonly input: DeleteScalingPlanCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DeleteScalingPlanCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AutoScalingPlansClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteScalingPlanCommandInput, DeleteScalingPlanCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AutoScalingPlansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AutoScalingPlansClient";
 import { DescribeScalingPlanResourcesRequest, DescribeScalingPlanResourcesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeScalingPlanResourcesCommand}.
  */
 export interface DescribeScalingPlanResourcesCommandInput extends DescribeScalingPlanResourcesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeScalingPlanResourcesCommand}.
  */
 export interface DescribeScalingPlanResourcesCommandOutput extends DescribeScalingPlanResourcesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Describes the scalable resources in the specified scaling plan.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeScalingPlanResourcesCommandOutput extends DescribeScali
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeScalingPlanResourcesCommandInput - {@link DescribeScalingPlanResourcesCommandInput}
+ * @returns {@link DescribeScalingPlanResourcesCommandOutput}
  * @see {@link DescribeScalingPlanResourcesCommandInput} for command's `input` shape.
  * @see {@link DescribeScalingPlanResourcesCommandOutput} for command's `response` shape.
  * @see {@link AutoScalingPlansClientResolvedConfig | config} for AutoScalingPlansClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DescribeScalingPlanResourcesCommandOutput extends DescribeScali
 export declare class DescribeScalingPlanResourcesCommand extends $Command<DescribeScalingPlanResourcesCommandInput, DescribeScalingPlanResourcesCommandOutput, AutoScalingPlansClientResolvedConfig> {
     readonly input: DescribeScalingPlanResourcesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeScalingPlanResourcesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AutoScalingPlansClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeScalingPlanResourcesCommandInput, DescribeScalingPlanResourcesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AutoScalingPlansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AutoScalingPlansClient";
 import { DescribeScalingPlansRequest, DescribeScalingPlansResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link DescribeScalingPlansCommand}.
  */
 export interface DescribeScalingPlansCommandInput extends DescribeScalingPlansRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link DescribeScalingPlansCommand}.
  */
 export interface DescribeScalingPlansCommandOutput extends DescribeScalingPlansResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Describes one or more of your scaling plans.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeScalingPlansCommandOutput extends DescribeScalingPlansR
  * const response = await client.send(command);
  * ```
  *
+ * @param DescribeScalingPlansCommandInput - {@link DescribeScalingPlansCommandInput}
+ * @returns {@link DescribeScalingPlansCommandOutput}
  * @see {@link DescribeScalingPlansCommandInput} for command's `input` shape.
  * @see {@link DescribeScalingPlansCommandOutput} for command's `response` shape.
  * @see {@link AutoScalingPlansClientResolvedConfig | config} for AutoScalingPlansClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DescribeScalingPlansCommandOutput extends DescribeScalingPlansR
 export declare class DescribeScalingPlansCommand extends $Command<DescribeScalingPlansCommandInput, DescribeScalingPlansCommandOutput, AutoScalingPlansClientResolvedConfig> {
     readonly input: DescribeScalingPlansCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: DescribeScalingPlansCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AutoScalingPlansClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeScalingPlansCommandInput, DescribeScalingPlansCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AutoScalingPlansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AutoScalingPlansClient";
 import { GetScalingPlanResourceForecastDataRequest, GetScalingPlanResourceForecastDataResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link GetScalingPlanResourceForecastDataCommand}.
  */
 export interface GetScalingPlanResourceForecastDataCommandInput extends GetScalingPlanResourceForecastDataRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link GetScalingPlanResourceForecastDataCommand}.
  */
 export interface GetScalingPlanResourceForecastDataCommandOutput extends GetScalingPlanResourceForecastDataResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Retrieves the forecast data for a scalable resource.</p>
  *          <p>Capacity forecasts are represented as predicted values, or data points, that are
  *          calculated using historical data points from a specified CloudWatch load metric. Data points are
@@ -28,6 +33,8 @@ export interface GetScalingPlanResourceForecastDataCommandOutput extends GetScal
  * const response = await client.send(command);
  * ```
  *
+ * @param GetScalingPlanResourceForecastDataCommandInput - {@link GetScalingPlanResourceForecastDataCommandInput}
+ * @returns {@link GetScalingPlanResourceForecastDataCommandOutput}
  * @see {@link GetScalingPlanResourceForecastDataCommandInput} for command's `input` shape.
  * @see {@link GetScalingPlanResourceForecastDataCommandOutput} for command's `response` shape.
  * @see {@link AutoScalingPlansClientResolvedConfig | config} for AutoScalingPlansClient's `config` shape.
@@ -43,11 +50,20 @@ export interface GetScalingPlanResourceForecastDataCommandOutput extends GetScal
 export declare class GetScalingPlanResourceForecastDataCommand extends $Command<GetScalingPlanResourceForecastDataCommandInput, GetScalingPlanResourceForecastDataCommandOutput, AutoScalingPlansClientResolvedConfig> {
     readonly input: GetScalingPlanResourceForecastDataCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: GetScalingPlanResourceForecastDataCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AutoScalingPlansClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetScalingPlanResourceForecastDataCommandInput, GetScalingPlanResourceForecastDataCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { AutoScalingPlansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AutoScalingPlansClient";
 import { UpdateScalingPlanRequest, UpdateScalingPlanResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateScalingPlanCommand}.
  */
 export interface UpdateScalingPlanCommandInput extends UpdateScalingPlanRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateScalingPlanCommand}.
  */
 export interface UpdateScalingPlanCommandOutput extends UpdateScalingPlanResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the specified scaling plan.</p>
  *          <p>You cannot update a scaling plan if it is in the process of being created, updated, or
  *          deleted.</p>
@@ -27,6 +32,8 @@ export interface UpdateScalingPlanCommandOutput extends UpdateScalingPlanRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateScalingPlanCommandInput - {@link UpdateScalingPlanCommandInput}
+ * @returns {@link UpdateScalingPlanCommandOutput}
  * @see {@link UpdateScalingPlanCommandInput} for command's `input` shape.
  * @see {@link UpdateScalingPlanCommandOutput} for command's `response` shape.
  * @see {@link AutoScalingPlansClientResolvedConfig | config} for AutoScalingPlansClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UpdateScalingPlanCommandOutput extends UpdateScalingPlanRespons
 export declare class UpdateScalingPlanCommand extends $Command<UpdateScalingPlanCommandInput, UpdateScalingPlanCommandOutput, AutoScalingPlansClientResolvedConfig> {
     readonly input: UpdateScalingPlanCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateScalingPlanCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AutoScalingPlansClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateScalingPlanCommandInput, UpdateScalingPlanCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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