@aws-sdk/client-application-auto-scaling 3.295.0 → 3.297.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ApplicationAutoScalingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationAutoScalingClient";
 import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListTagsForResourceCommand}.
  */
 export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Returns all the tags on the specified Application Auto Scaling scalable target.</p>
  *          <p>For general information about tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
  *          resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
@@ -27,6 +32,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * const response = await client.send(command);
  * ```
  *
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
+ * @returns {@link ListTagsForResourceCommandOutput}
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
  * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for ApplicationAutoScalingClient's `config` shape.
@@ -35,15 +42,42 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  *  <p>The specified resource doesn't exist.</p>
  *
  *
+ * @example To list tags for a scalable target
+ * ```javascript
+ * // This example lists the tag key names and values that are attached to the scalable target specified by its ARN.
+ * const input = {
+ *   "ResourceARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
+ * };
+ * const command = new ListTagsForResourceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Tags": {
+ *     "environment": "production"
+ *   }
+ * }
+ * *\/
+ * // example id: to-list-tags-for-a-scalable-target-1677971474903
+ * ```
+ *
  */
 export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
     readonly input: ListTagsForResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListTagsForResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationAutoScalingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ApplicationAutoScalingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationAutoScalingClient";
 import { PutScalingPolicyRequest, PutScalingPolicyResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutScalingPolicyCommand}.
  */
 export interface PutScalingPolicyCommandInput extends PutScalingPolicyRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutScalingPolicyCommand}.
  */
 export interface PutScalingPolicyCommandOutput extends PutScalingPolicyResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates or updates a scaling policy for an Application Auto Scaling scalable target.</p>
  *          <p>Each scalable target is identified by a service namespace, resource ID, and scalable
  *          dimension. A scaling policy applies to the scalable target identified by those three
@@ -49,6 +54,8 @@ export interface PutScalingPolicyCommandOutput extends PutScalingPolicyResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param PutScalingPolicyCommandInput - {@link PutScalingPolicyCommandInput}
+ * @returns {@link PutScalingPolicyCommandOutput}
  * @see {@link PutScalingPolicyCommandInput} for command's `input` shape.
  * @see {@link PutScalingPolicyCommandOutput} for command's `response` shape.
  * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for ApplicationAutoScalingClient's `config` shape.
@@ -123,11 +130,20 @@ export interface PutScalingPolicyCommandOutput extends PutScalingPolicyResponse,
 export declare class PutScalingPolicyCommand extends $Command<PutScalingPolicyCommandInput, PutScalingPolicyCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
     readonly input: PutScalingPolicyCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutScalingPolicyCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationAutoScalingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutScalingPolicyCommandInput, PutScalingPolicyCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ApplicationAutoScalingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationAutoScalingClient";
 import { PutScheduledActionRequest, PutScheduledActionResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link PutScheduledActionCommand}.
  */
 export interface PutScheduledActionCommandInput extends PutScheduledActionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link PutScheduledActionCommand}.
  */
 export interface PutScheduledActionCommandOutput extends PutScheduledActionResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates or updates a scheduled action for an Application Auto Scaling scalable target. </p>
  *          <p>Each scalable target is identified by a service namespace, resource ID, and scalable
  *          dimension. A scheduled action applies to the scalable target identified by those three
@@ -39,6 +44,8 @@ export interface PutScheduledActionCommandOutput extends PutScheduledActionRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param PutScheduledActionCommandInput - {@link PutScheduledActionCommandInput}
+ * @returns {@link PutScheduledActionCommandOutput}
  * @see {@link PutScheduledActionCommandInput} for command's `input` shape.
  * @see {@link PutScheduledActionCommandOutput} for command's `response` shape.
  * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for ApplicationAutoScalingClient's `config` shape.
@@ -65,15 +72,42 @@ export interface PutScheduledActionCommandOutput extends PutScheduledActionRespo
  *          API request.</p>
  *
  *
+ * @example To create a recurring scheduled action
+ * ```javascript
+ * // This example adds a scheduled action to a DynamoDB table called TestTable to scale out on a recurring schedule. On the specified schedule (every day at 12:15pm UTC), if the current capacity is below the value specified for MinCapacity, Application Auto Scaling scales out to the value specified by MinCapacity.
+ * const input = {
+ *   "ResourceId": "table/TestTable",
+ *   "ScalableDimension": "dynamodb:table:WriteCapacityUnits",
+ *   "ScalableTargetAction": {
+ *     "MinCapacity": 6
+ *   },
+ *   "Schedule": "cron(15 12 * * ? *)",
+ *   "ScheduledActionName": "my-recurring-action",
+ *   "ServiceNamespace": "dynamodb"
+ * };
+ * const command = new PutScheduledActionCommand(input);
+ * await client.send(command);
+ * // example id: to-create-a-recurring-scheduled-action-1677970068621
+ * ```
+ *
  */
 export declare class PutScheduledActionCommand extends $Command<PutScheduledActionCommandInput, PutScheduledActionCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
     readonly input: PutScheduledActionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: PutScheduledActionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationAutoScalingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutScheduledActionCommandInput, PutScheduledActionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ApplicationAutoScalingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationAutoScalingClient";
 import { RegisterScalableTargetRequest, RegisterScalableTargetResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link RegisterScalableTargetCommand}.
  */
 export interface RegisterScalableTargetCommandInput extends RegisterScalableTargetRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RegisterScalableTargetCommand}.
  */
 export interface RegisterScalableTargetCommandOutput extends RegisterScalableTargetResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Registers or updates a scalable target, which is the resource that you want to
  *          scale.</p>
  *          <p>Scalable targets are uniquely identified by the combination of resource ID, scalable
@@ -56,6 +61,8 @@ export interface RegisterScalableTargetCommandOutput extends RegisterScalableTar
  * const response = await client.send(command);
  * ```
  *
+ * @param RegisterScalableTargetCommandInput - {@link RegisterScalableTargetCommandInput}
+ * @returns {@link RegisterScalableTargetCommandOutput}
  * @see {@link RegisterScalableTargetCommandInput} for command's `input` shape.
  * @see {@link RegisterScalableTargetCommandOutput} for command's `response` shape.
  * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for ApplicationAutoScalingClient's `config` shape.
@@ -94,11 +101,20 @@ export interface RegisterScalableTargetCommandOutput extends RegisterScalableTar
 export declare class RegisterScalableTargetCommand extends $Command<RegisterScalableTargetCommandInput, RegisterScalableTargetCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
     readonly input: RegisterScalableTargetCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RegisterScalableTargetCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationAutoScalingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RegisterScalableTargetCommandInput, RegisterScalableTargetCommandOutput>;
+    /**
+     * @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 { ApplicationAutoScalingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationAutoScalingClient";
 import { TagResourceRequest, TagResourceResponse } 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 TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds or edits tags on an Application Auto Scaling scalable target.</p>
  *          <p>Each tag consists of a tag key and a tag value, which are both case-sensitive strings.
  *          To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag
@@ -36,6 +41,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * 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 ApplicationAutoScalingClientResolvedConfig | config} for ApplicationAutoScalingClient's `config` shape.
@@ -51,15 +58,38 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  *          API request.</p>
  *
  *
+ * @example To add a tag to a scalable target
+ * ```javascript
+ * // This example adds a tag with the key name "environment" and the value "production" to the scalable target specified by its ARN.
+ * const input = {
+ *   "ResourceARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123",
+ *   "Tags": {
+ *     "environment": "production"
+ *   }
+ * };
+ * const command = new TagResourceCommand(input);
+ * await client.send(command);
+ * // example id: to-add-a-tag-to-a-scalable-target-1677970764620
+ * ```
+ *
  */
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationAutoScalingClientResolvedConfig, 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 { ApplicationAutoScalingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationAutoScalingClient";
 import { UntagResourceRequest, UntagResourceResponse } 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 UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and
  *          the Application Auto Scaling scalable target.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * 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 ApplicationAutoScalingClientResolvedConfig | config} for ApplicationAutoScalingClient's `config` shape.
@@ -38,15 +45,38 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  *          API request.</p>
  *
  *
+ * @example To remove a tag from a scalable target
+ * ```javascript
+ * // This example removes the tag pair with the key name "environment" from the scalable target specified by its ARN.
+ * const input = {
+ *   "ResourceARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123",
+ *   "TagKeys": [
+ *     "environment"
+ *   ]
+ * };
+ * const command = new UntagResourceCommand(input);
+ * await client.send(command);
+ * // example id: to-remove-a-tag-from-a-scalable-target-1677971117168
+ * ```
+ *
  */
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationAutoScalingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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