@aws-sdk/client-support

@aws-sdk/client-support

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 doesn't 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.

You can also use the Amazon Web Services Support API to access features for Trusted Advisor. You can return a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

You can manage your support cases with the following Amazon Web Services Support API operations:

• The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create Amazon Web Services Support cases, retrieve information about cases, and resolve cases.

• The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to Amazon Web Services Support cases.

• The DescribeServices and DescribeSeverityLevels operations return Amazon Web Services service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.

You can also use the Amazon Web Services Support API to call the Trusted Advisor operations. For more information, see Trusted Advisor in the Amazon Web Services Support User Guide.

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

For more information about this service and the endpoints to use, see About the Amazon Web Services Support API in the Amazon Web Services Support User Guide.

Installing

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

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

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

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

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

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.

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

import { Support } from "@aws-sdk/client-support";

const client = new Support({ region: "REGION" });

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

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

// callbacks (not recommended).
client.describeCases(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;
   * }
   */
}

See also docs/ERROR_HANDLING.

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

Client Commands (Operations List)

AddAttachmentsToSet

Command API Reference / Input / Output

AddCommunicationToCase

Command API Reference / Input / Output

CreateCase

Command API Reference / Input / Output

DescribeAttachment

Command API Reference / Input / Output

DescribeCases

Command API Reference / Input / Output

DescribeCommunications

Command API Reference / Input / Output

DescribeCreateCaseOptions

Command API Reference / Input / Output

DescribeServices

Command API Reference / Input / Output

DescribeSeverityLevels

Command API Reference / Input / Output

DescribeSupportedLanguages

Command API Reference / Input / Output

DescribeTrustedAdvisorCheckRefreshStatuses

Command API Reference / Input / Output

DescribeTrustedAdvisorCheckResult

Command API Reference / Input / Output

DescribeTrustedAdvisorChecks

Command API Reference / Input / Output

DescribeTrustedAdvisorCheckSummaries

Command API Reference / Input / Output

RefreshTrustedAdvisorCheck

Command API Reference / Input / Output

ResolveCase

Command API Reference / Input / Output