@aws-sdk/client-application-auto-scaling

Description

AWS SDK for JavaScript ApplicationAutoScaling Client for Node.js, Browser and React Native.

With Application Auto Scaling, you can configure automatic scaling for the following resources: <ul> <li> Amazon AppStream 2.0 fleets </li> <li> Amazon Aurora Replicas </li> <li> Amazon Comprehend document classification and entity recognizer endpoints </li> <li> Amazon DynamoDB tables and global secondary indexes throughput capacity </li> <li> Amazon ECS services </li> <li> Amazon ElastiCache replication groups (Redis OSS and Valkey) and Memcached clusters </li> <li> Amazon EMR clusters </li> <li> Amazon Keyspaces (for Apache Cassandra) tables </li> <li> Lambda function provisioned concurrency </li> <li> Amazon Managed Streaming for Apache Kafka broker storage </li> <li> Amazon Neptune clusters </li> <li> Amazon SageMaker endpoint variants </li> <li> Amazon SageMaker inference components </li> <li> Amazon SageMaker serverless endpoint provisioned concurrency </li> <li> Spot Fleets (Amazon EC2) </li> <li> Pool of WorkSpaces </li> <li> Custom resources provided by your own applications or services </li> </ul> To learn more about Application Auto Scaling, see the <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html">Application Auto Scaling User Guide</a>. API Summary The Application Auto Scaling service API includes three key sets of actions: <ul> <li> Register and manage scalable targets - Register Amazon Web Services or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets. </li> <li> Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history. </li> <li> Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the <a href="https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html">RegisterScalableTarget</a> API action for any Application Auto Scaling scalable target. You can suspend and resume (individually or in combination) scale-out activities that are triggered by a scaling policy, scale-in activities that are triggered by a scaling policy, and scheduled scaling. </li> </ul>

Installing

To install this package, use the CLI of your favorite package manager:

npm install @aws-sdk/client-application-auto-scaling
yarn add @aws-sdk/client-application-auto-scaling
pnpm add @aws-sdk/client-application-auto-scaling

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the ApplicationAutoScalingClient and the commands you need, for example ListTagsForResourceCommand:

// ES5 example
const { ApplicationAutoScalingClient, ListTagsForResourceCommand } = require("@aws-sdk/client-application-auto-scaling");

// ES6+ example
import { ApplicationAutoScalingClient, ListTagsForResourceCommand } from "@aws-sdk/client-application-auto-scaling";

Usage

To send a request:

Instantiate a client with configuration (e.g. credentials, region).
- See docs/CLIENTS for configuration details.
- See @aws-sdk/config for additional options.
Instantiate a command with input parameters.
Call the send operation on the client, providing the command object as input.

const client = new ApplicationAutoScalingClient({ region: "REGION" });

const params = { /** input parameters */ };
const command = new ListTagsForResourceCommand(params);

Async/await

We recommend using the await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Promises

You can also use Promise chaining.

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

ApplicationAutoScaling extends ApplicationAutoScalingClient and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (ApplicationAutoScalingClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { ApplicationAutoScaling } from "@aws-sdk/client-application-auto-scaling";

const client = new ApplicationAutoScaling({ region: "REGION" });

// async/await.
try {
  const data = await client.listTagsForResource(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .listTagsForResource(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks (not recommended).
client.listTagsForResource(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

Visit the Developer Guide or API Reference.
Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
Ask a question on StackOverflow and tag it with aws-sdk-js.
Join the AWS JavaScript community on gitter.
If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-application-auto-scaling package is updated. To contribute to client you can check our generate clients scripts.