Options
All
  • Public
  • Public/Protected
  • All
Menu

Support Client - AWS SDK for JavaScript v3

@aws-sdk/client-support

NPM version NPM downloads

Description

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

Amazon Web Services Support

The Amazon Web Services Support API Reference is intended for programmers who need detailed information about the Amazon Web Services Support operations and data types. You can use the API to manage your support cases programmatically. The Amazon Web Services Support API uses HTTP methods that return results in JSON format.

  • You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API.

  • If you call the Amazon Web Services Support API from an account that does not have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see Amazon Web Services Support.

The Amazon Web Services Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

The following list describes the Amazon Web Services Support case management operations:

The following list describes the operations available from the Amazon Web Services Support service for Trusted Advisor:

For authentication of requests, Amazon Web Services Support uses Signature Version 4 Signing Process.

See About the Amazon Web Services Support API in the Amazon Web Services Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.

Installing

To install the this package, simply type add or install @aws-sdk/client-support using your favorite package manager:

  • npm install @aws-sdk/client-support
  • yarn add @aws-sdk/client-support
  • pnpm add @aws-sdk/client-support

Getting Started

Import

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

// ES5 example
const { SupportClient, AddAttachmentsToSetCommand } = require("@aws-sdk/client-support");

// ES6+ example
import { SupportClient, AddAttachmentsToSetCommand } from "@aws-sdk/client-support";

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.
// a client can be shared by different commands.
const client = new SupportClient({ region: "REGION" });

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

Async/await

We recommend using 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.
}

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) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

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

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.

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

import * as AWS from "@aws-sdk/client-support";
const client = new AWS.Support({ region: "REGION" });

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

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

// callbacks.
client.addAttachmentsToSet(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 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-support 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.