@aws-sdk/client-support-app

Description

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

<fullname>Amazon Web Services Support App in Slack</fullname>

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: <ul> <li> Create, search, update, and resolve your support cases </li> <li> Request service quota increases for your account </li> <li> Invite Amazon Web Services Support agents to your channel so that you can chat directly about your support cases </li> </ul> For more information about how to perform these actions in Slack, see the following documentation in the Amazon Web Services Support User Guide: <ul> <li> <a href="https://docs.aws.amazon.com/awssupport/latest/user/aws-support-app-for-slack.html">Amazon Web Services Support App in Slack</a> </li> <li> <a href="https://docs.aws.amazon.com/awssupport/latest/user/joining-a-live-chat-session.html">Joining a live chat session with Amazon Web Services Support</a> </li> <li> <a href="https://docs.aws.amazon.com/awssupport/latest/user/service-quota-increase.html">Requesting service quota increases</a> </li> <li> <a href="https://docs.aws.amazon.com/awssupport/latest/user/support-app-commands.html">Amazon Web Services Support App commands in Slack</a> </li> </ul> 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 <a href="https://docs.aws.amazon.com/awssupport/latest/user/authorize-slack-workspace.html">Authorize a Slack workspace to enable the Amazon Web Services Support App</a>. <note> <ul> <li> You must have a Business or Enterprise Support plan to use the Amazon Web Services Support App API. </li> <li> For more information about the Amazon Web Services Support App endpoints, see the <a href="https://docs.aws.amazon.com/general/latest/gr/awssupport.html#awssupport_app_region">Amazon Web Services Support App in Slack endpoints</a> in the Amazon Web Services General Reference. </li> </ul> </note>

Installing

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

// ES5 example
const { SupportAppClient, ListSlackChannelConfigurationsCommand } = require("@aws-sdk/client-support-app");

// ES6+ example
import { SupportAppClient, ListSlackChannelConfigurationsCommand } from "@aws-sdk/client-support-app";

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

const params = { /** input parameters */ };
const command = new ListSlackChannelConfigurationsCommand(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.

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

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

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

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

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

// callbacks (not recommended).
client.listSlackChannelConfigurations(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-support-app package is updated. To contribute to client you can check our generate clients scripts.