CreateSlackChannelConfigurationCommand

Suggest an Edit

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

  • You can add up to 5 Slack workspaces for your account.

  • You can add up to 20 Slack channels for your account.

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.

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SupportAppClient, CreateSlackChannelConfigurationCommand } from "@aws-sdk/client-support-app"; // ES Modules import
// const { SupportAppClient, CreateSlackChannelConfigurationCommand } = require("@aws-sdk/client-support-app"); // CommonJS import
const client = new SupportAppClient(config);
const input = { // CreateSlackChannelConfigurationRequest
  teamId: "STRING_VALUE", // required
  channelId: "STRING_VALUE", // required
  channelName: "STRING_VALUE",
  notifyOnCreateOrReopenCase: true || false,
  notifyOnAddCorrespondenceToCase: true || false,
  notifyOnResolveCase: true || false,
  notifyOnCaseSeverity: "STRING_VALUE", // required
  channelRoleArn: "STRING_VALUE", // required
};
const command = new CreateSlackChannelConfigurationCommand(input);
const response = await client.send(command);
// {};

CreateSlackChannelConfigurationCommand Input

See CreateSlackChannelConfigurationCommandInput for more details

Parameter
Type
Description
channelId
Required
string | undefined

The channel ID in Slack. This ID identifies a channel within a Slack workspace.

channelRoleArn
Required
string | undefined

The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App  in the Amazon Web Services Support User Guide.

notifyOnCaseSeverity
Required
NotificationSeverityLevel | undefined

The case severity for a support case that you want to receive notifications.

If you specify high or all, you must specify true for at least one of the following parameters:

  • notifyOnAddCorrespondenceToCase

  • notifyOnCreateOrReopenCase

  • notifyOnResolveCase

If you specify none, the following parameters must be null or false:

  • notifyOnAddCorrespondenceToCase

  • notifyOnCreateOrReopenCase

  • notifyOnResolveCase

If you don't specify these parameters in your request, they default to false.

teamId
Required
string | undefined

The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

channelName
string | undefined

The name of the Slack channel that you configure for the Amazon Web Services Support App.

notifyOnAddCorrespondenceToCase
boolean | undefined

Whether you want to get notified when a support case has a new correspondence.

notifyOnCreateOrReopenCase
boolean | undefined

Whether you want to get notified when a support case is created or reopened.

notifyOnResolveCase
boolean | undefined

Whether you want to get notified when a support case is resolved.

CreateSlackChannelConfigurationCommand Output

See CreateSlackChannelConfigurationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have sufficient permission to perform this action.

ConflictException
client

Your request has a conflict. For example, you might receive this error if you try the following:

  • Add, update, or delete a Slack channel configuration before you add a Slack workspace to your Amazon Web Services account.

  • Add a Slack channel configuration that already exists in your Amazon Web Services account.

  • Delete a Slack channel configuration for a live chat channel.

  • Delete a Slack workspace from your Amazon Web Services account that has an active live chat channel.

  • Call the RegisterSlackWorkspaceForOrganization API from an Amazon Web Services account that doesn't belong to an organization.

  • Call the RegisterSlackWorkspaceForOrganization API from a member account, but the management account hasn't registered that workspace yet for the organization.

InternalServerException
server

We can’t process your request right now because of a server issue. Try again later.

ServiceQuotaExceededException
client

Your Service Quotas request exceeds the quota for the service. For example, your Service Quotas request to Amazon Web Services Support App might exceed the maximum number of workspaces or channels per account, or the maximum number of accounts per Slack channel.

ValidationException
client

Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.

SupportAppServiceException
Base exception class for all service exceptions from SupportApp service.