@aws-sdk/client-compute-optimizer

Description

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

<p>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 <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/">Compute Optimizer User Guide</a>.</p>

Installing

To install this package, use the CLI of 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:

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

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

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 ComputeOptimizerClient({ region: "REGION" });

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

Supported Message Protocols

This client supports multiple protocols.

The default for this client is AWS JSON (RPC) 1.0.

We have selected this default based on our evaluation of the performance characteristics of this protocol format in JavaScript. You don't need to change it, but you have the option to do so, for example to support existing integrations or tests. Selecting a non-default protocol changes the format of the data sent over the network, but does not affect how you interact with the client using JavaScript objects.

Install the @aws-sdk/config package to access alternate protocols.

See AWS Protocols for more information.

AWS JSON (RPC) 1.0

This protocol uses JSON payloads.

import { AwsJson1_0Protocol } from "@aws-sdk/config/protocol";

const client = new ComputeOptimizerClient({
  protocol: AwsJson1_0Protocol
});

Smithy RPC v2 CBOR

This protocol uses CBOR payloads.

import { AwsSmithyRpcV2CborProtocol } from "@aws-sdk/config/protocol";

const client = new ComputeOptimizerClient({
  protocol: AwsSmithyRpcV2CborProtocol
});

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.

ComputeOptimizer extends ComputeOptimizerClient 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 (ComputeOptimizerClient). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { ComputeOptimizer } from "@aws-sdk/client-compute-optimizer";

const client = new 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 (not recommended).
client.getEnrollmentStatus(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-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)

<details> <summary> DeleteRecommendationPreferences </summary>