@aws-sdk/client-compute-optimizer
Description
AWS SDK for JavaScript ComputeOptimizer Client for Node.js, Browser and React Native.
Compute Optimizer is a service that analyzes the configuration and utilization
metrics of your Amazon Web Services compute resources, such as Amazon EC2
instances, Amazon EC2 Auto Scaling groups, Lambda functions, Amazon EBS volumes, and Amazon ECS services on Fargate.
It reports whether your resources are optimal, and generates
optimization recommendations to reduce the cost and improve the performance of your
workloads. Compute Optimizer also provides recent utilization metric data, in addition
to projected utilization metric data for the recommendations, which you can use to
evaluate which recommendation provides the best price-performance trade-off. The
analysis of your usage patterns can help you decide when to move or resize your running
resources, and still meet your performance and capacity requirements. For more
information about Compute Optimizer, including the required permissions to use the
service, see the Compute Optimizer User Guide.
Installing
To install this package, simply type add or install @aws-sdk/client-compute-optimizer
using your favorite package manager:
npm install @aws-sdk/client-compute-optimizer
yarn add @aws-sdk/client-compute-optimizer
pnpm add @aws-sdk/client-compute-optimizer
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the ComputeOptimizerClient
and
the commands you need, for example GetEnrollmentStatusCommand
:
const { ComputeOptimizerClient, GetEnrollmentStatusCommand } = require("@aws-sdk/client-compute-optimizer");
import { ComputeOptimizerClient, GetEnrollmentStatusCommand } from "@aws-sdk/client-compute-optimizer";
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 ComputeOptimizerClient({ region: "REGION" });
const params = {
};
const command = new GetEnrollmentStatusCommand(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-compute-optimizer";
const client = new AWS.ComputeOptimizer({ region: "REGION" });
try {
const data = await client.getEnrollmentStatus(params);
} catch (error) {
}
client
.getEnrollmentStatus(params)
.then((data) => {
})
.catch((error) => {
});
client.getEnrollmentStatus(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-compute-optimizer
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)
DeleteRecommendationPreferences
Command API Reference / Input / Output
DescribeRecommendationExportJobs
Command API Reference / Input / Output
ExportAutoScalingGroupRecommendations
Command API Reference / Input / Output
ExportEBSVolumeRecommendations
Command API Reference / Input / Output
ExportEC2InstanceRecommendations
Command API Reference / Input / Output
ExportECSServiceRecommendations
Command API Reference / Input / Output
ExportIdleRecommendations
Command API Reference / Input / Output
ExportLambdaFunctionRecommendations
Command API Reference / Input / Output
ExportLicenseRecommendations
Command API Reference / Input / Output
ExportRDSDatabaseRecommendations
Command API Reference / Input / Output
GetAutoScalingGroupRecommendations
Command API Reference / Input / Output
GetEBSVolumeRecommendations
Command API Reference / Input / Output
GetEC2InstanceRecommendations
Command API Reference / Input / Output
GetEC2RecommendationProjectedMetrics
Command API Reference / Input / Output
GetECSServiceRecommendationProjectedMetrics
Command API Reference / Input / Output
GetECSServiceRecommendations
Command API Reference / Input / Output
GetEffectiveRecommendationPreferences
Command API Reference / Input / Output
GetEnrollmentStatus
Command API Reference / Input / Output
GetEnrollmentStatusesForOrganization
Command API Reference / Input / Output
GetIdleRecommendations
Command API Reference / Input / Output
GetLambdaFunctionRecommendations
Command API Reference / Input / Output
GetLicenseRecommendations
Command API Reference / Input / Output
GetRDSDatabaseRecommendationProjectedMetrics
Command API Reference / Input / Output
GetRDSDatabaseRecommendations
Command API Reference / Input / Output
GetRecommendationPreferences
Command API Reference / Input / Output
GetRecommendationSummaries
Command API Reference / Input / Output
PutRecommendationPreferences
Command API Reference / Input / Output
UpdateEnrollmentStatus
Command API Reference / Input / Output