@aws-sdk/client-auto-scaling
Description
AWS SDK for JavaScript AutoScaling Client for Node.js, Browser and React Native.
Amazon EC2 Auto Scaling
Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
based on user-defined scaling policies, scheduled actions, and health checks.
For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
Installing
To install this package, simply type add or install @aws-sdk/client-auto-scaling
using your favorite package manager:
npm install @aws-sdk/client-auto-scaling
yarn add @aws-sdk/client-auto-scaling
pnpm add @aws-sdk/client-auto-scaling
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the AutoScalingClient
and
the commands you need, for example DescribePoliciesCommand
:
const { AutoScalingClient, DescribePoliciesCommand } = require("@aws-sdk/client-auto-scaling");
import { AutoScalingClient, DescribePoliciesCommand } from "@aws-sdk/client-auto-scaling";
Usage
To send a request, you:
- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call
send
operation on client with command object as input. - If you are using a custom http handler, you may call
destroy()
to close open connections.
const client = new AutoScalingClient({ region: "REGION" });
const params = {
};
const command = new DescribePoliciesCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.
Promises
You can also use Promise chaining
to execute send operation.
client.send(command).then(
(data) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, data) => {
});
v2 compatible style
The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-auto-scaling";
const client = new AWS.AutoScaling({ region: "REGION" });
try {
const data = await client.describePolicies(params);
} catch (error) {
}
client
.describePolicies(params)
.then((data) => {
})
.catch((error) => {
});
client.describePolicies(params, (err, 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);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
Getting Help
Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
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-auto-scaling
package is updated.
To contribute to client you can check our generate clients scripts.
License
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
Client Commands (Operations List)
AttachInstances
Command API Reference / Input / Output
AttachLoadBalancers
Command API Reference / Input / Output
AttachLoadBalancerTargetGroups
Command API Reference / Input / Output
AttachTrafficSources
Command API Reference / Input / Output
BatchDeleteScheduledAction
Command API Reference / Input / Output
BatchPutScheduledUpdateGroupAction
Command API Reference / Input / Output
CancelInstanceRefresh
Command API Reference / Input / Output
CompleteLifecycleAction
Command API Reference / Input / Output
CreateAutoScalingGroup
Command API Reference / Input / Output
CreateLaunchConfiguration
Command API Reference / Input / Output
CreateOrUpdateTags
Command API Reference / Input / Output
DeleteAutoScalingGroup
Command API Reference / Input / Output
DeleteLaunchConfiguration
Command API Reference / Input / Output
DeleteLifecycleHook
Command API Reference / Input / Output
DeleteNotificationConfiguration
Command API Reference / Input / Output
DeletePolicy
Command API Reference / Input / Output
DeleteScheduledAction
Command API Reference / Input / Output
DeleteTags
Command API Reference / Input / Output
DeleteWarmPool
Command API Reference / Input / Output
DescribeAccountLimits
Command API Reference / Input / Output
DescribeAdjustmentTypes
Command API Reference / Input / Output
DescribeAutoScalingGroups
Command API Reference / Input / Output
DescribeAutoScalingInstances
Command API Reference / Input / Output
DescribeAutoScalingNotificationTypes
Command API Reference / Input / Output
DescribeInstanceRefreshes
Command API Reference / Input / Output
DescribeLaunchConfigurations
Command API Reference / Input / Output
DescribeLifecycleHooks
Command API Reference / Input / Output
DescribeLifecycleHookTypes
Command API Reference / Input / Output
DescribeLoadBalancers
Command API Reference / Input / Output
DescribeLoadBalancerTargetGroups
Command API Reference / Input / Output
DescribeMetricCollectionTypes
Command API Reference / Input / Output
DescribeNotificationConfigurations
Command API Reference / Input / Output
DescribePolicies
Command API Reference / Input / Output
DescribeScalingActivities
Command API Reference / Input / Output
DescribeScalingProcessTypes
Command API Reference / Input / Output
DescribeScheduledActions
Command API Reference / Input / Output
DescribeTags
Command API Reference / Input / Output
DescribeTerminationPolicyTypes
Command API Reference / Input / Output
DescribeTrafficSources
Command API Reference / Input / Output
DescribeWarmPool
Command API Reference / Input / Output
DetachInstances
Command API Reference / Input / Output
DetachLoadBalancers
Command API Reference / Input / Output
DetachLoadBalancerTargetGroups
Command API Reference / Input / Output
DetachTrafficSources
Command API Reference / Input / Output
DisableMetricsCollection
Command API Reference / Input / Output
EnableMetricsCollection
Command API Reference / Input / Output
EnterStandby
Command API Reference / Input / Output
ExecutePolicy
Command API Reference / Input / Output
ExitStandby
Command API Reference / Input / Output
GetPredictiveScalingForecast
Command API Reference / Input / Output
PutLifecycleHook
Command API Reference / Input / Output
PutNotificationConfiguration
Command API Reference / Input / Output
PutScalingPolicy
Command API Reference / Input / Output
PutScheduledUpdateGroupAction
Command API Reference / Input / Output
PutWarmPool
Command API Reference / Input / Output
RecordLifecycleActionHeartbeat
Command API Reference / Input / Output
ResumeProcesses
Command API Reference / Input / Output
RollbackInstanceRefresh
Command API Reference / Input / Output
SetDesiredCapacity
Command API Reference / Input / Output
SetInstanceHealth
Command API Reference / Input / Output
SetInstanceProtection
Command API Reference / Input / Output
StartInstanceRefresh
Command API Reference / Input / Output
SuspendProcesses
Command API Reference / Input / Output
TerminateInstanceInAutoScalingGroup
Command API Reference / Input / Output
UpdateAutoScalingGroup
Command API Reference / Input / Output