Skip to content

Latest commit

 

History

History
260 lines (211 loc) · 8.09 KB

README.md

File metadata and controls

260 lines (211 loc) · 8.09 KB
Raw

@aws-sdk/client-support-app

NPM version NPM downloads

Description

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

Amazon Web Services Support App in Slack

You can use the Amazon Web Services Support App in Slack API to manage your support cases in Slack for your Amazon Web Services account. After you configure your Slack workspace and channel with the Amazon Web Services Support App, you can perform the following tasks directly in your Slack channel:

  • Create, search, update, and resolve your support cases

  • Request service quota increases for your account

  • Invite Amazon Web Services Support agents to your channel so that you can chat directly about your support cases

For more information about how to perform these actions in Slack, see the following documentation in the Amazon Web Services Support User Guide:

You can also use the Amazon Web Services Management Console instead of the Amazon Web Services Support App API to manage your Slack configurations. For more information, see Authorize a Slack workspace to enable the Amazon Web Services Support App.

  • You must have a Business or Enterprise Support plan to use the Amazon Web Services Support App API.

  • For more information about the Amazon Web Services Support App endpoints, see the Amazon Web Services Support App in Slack endpoints in the Amazon Web Services General Reference.

Installing

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

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

Getting Started

Import

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

// ES5 example
const { SupportAppClient, CreateSlackChannelConfigurationCommand } = require("@aws-sdk/client-support-app");
// ES6+ example
import { SupportAppClient, CreateSlackChannelConfigurationCommand } from "@aws-sdk/client-support-app";

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

const params = {
  /** input parameters */
};
const command = new CreateSlackChannelConfigurationCommand(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-app";
const client = new AWS.SupportApp({ region: "REGION" });

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

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

// callbacks.
client.createSlackChannelConfiguration(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-app 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.