AWS.SupportApp — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.SupportApp

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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:

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.

Note:

Sending a Request Using SupportApp

var supportapp = new AWS.SupportApp();
supportapp.createSlackChannelConfiguration(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SupportApp object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var supportapp = new AWS.SupportApp({apiVersion: '2021-08-20'});

You can also set the API version globally in AWS.config.apiVersions using the supportapp service identifier:

AWS.config.apiVersions = {
  supportapp: '2021-08-20',
  // other service API versions
};

var supportapp = new AWS.SupportApp();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.SupportApp(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request

Creates a Slack channel configuration for your Amazon Web Services account.

Note:

A Slack channel can have up to 100 Amazon Web Services accounts. This means that only 100 accounts can add the same Slack channel to the Amazon Web Services Support App. We recommend that you only add the accounts that you need to manage support cases for your organization. This can reduce the notifications about case updates that you receive in the Slack channel.

Note: We recommend that you choose a private Slack channel so that only members in that channel have read and write access to your support cases. Anyone in your Slack channel can create, update, or resolve support cases for your account. Users require an invitation to join private channels.

deleteAccountAlias(params = {}, callback) ⇒ AWS.Request

Deletes an alias for an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

deleteSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel.

deleteSlackWorkspaceConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes a Slack workspace configuration from your Amazon Web Services account. This operation doesn't delete your Slack workspace.

getAccountAlias(params = {}, callback) ⇒ AWS.Request

Retrieves the alias from an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

listSlackChannelConfigurations(params = {}, callback) ⇒ AWS.Request

Lists the Slack channel configurations for an Amazon Web Services account.

listSlackWorkspaceConfigurations(params = {}, callback) ⇒ AWS.Request

Lists the Slack workspace configurations for an Amazon Web Services account.

putAccountAlias(params = {}, callback) ⇒ AWS.Request

Creates or updates an individual alias for each Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

registerSlackWorkspaceForOrganization(params = {}, callback) ⇒ AWS.Request

Registers a Slack workspace for your Amazon Web Services account. To call this API, your account must be part of an organization in Organizations.

If you're the management account and you want to register Slack workspaces for your organization, you must complete the following tasks:

  1. Sign in to the Amazon Web Services Support Center and authorize the Slack workspaces where you want your organization to have access to. See Authorize a Slack workspace in the Amazon Web Services Support User Guide.
  2. Call the RegisterSlackWorkspaceForOrganization API to authorize each Slack workspace for the organization.

After the management account authorizes the Slack workspace, member accounts can call this API to authorize the same Slack workspace for their individual accounts. Member accounts don't need to authorize the Slack workspace manually through the Amazon Web Services Support Center.

To use the Amazon Web Services Support App, each account must then complete the following tasks:

updateSlackChannelConfiguration(params = {}, callback) ⇒ AWS.Request

Updates the configuration for a Slack channel, such as case update notifications.