@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

$3

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:

``js
// ES5 example
const { ComputeOptimizerClient, GetEnrollmentStatusCommand } = require("@aws-sdk/client-compute-optimizer");
`

`ts
// ES6+ example
import { ComputeOptimizerClient, GetEnrollmentStatusCommand } from "@aws-sdk/client-compute-optimizer";
`

$3

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.

`js
// a client can be shared by different commands.
const client = new ComputeOptimizerClient({ region: "REGION" });

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

#### Async/await

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

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// 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.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

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

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and 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

`ts
import * as AWS from "@aws-sdk/client-compute-optimizer";
const client = new AWS.ComputeOptimizer({ region: "REGION" });

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

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

// callbacks.
client.getEnrollmentStatus(params, (err, data) => {
// process err and data.
});
`

$3

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

`js
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 the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit 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-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