Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateSlackChannelConfiguration

Creates a Slack channel configuration for your AWS account.

Note

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 AWS accounts. This means that only 100 accounts can add the same Slack channel to the AWS 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.

Request Syntax


POST /control/create-slack-channel-configuration HTTP/1.1
Content-type: application/json

{
   "channelId": "string",
   "channelName": "string",
   "channelRoleArn": "string",
   "notifyOnAddCorrespondenceToCase": boolean,
   "notifyOnCaseSeverity": "string",
   "notifyOnCreateOrReopenCase": boolean,
   "notifyOnResolveCase": boolean,
   "teamId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

channelId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^\S+$

Required: Yes

channelName

The name of the Slack channel that you configure for the AWS Support App.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^.+$

Required: No

channelRoleArn

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

Type: String

Length Constraints: Minimum length of 31. Maximum length of 2048.

Pattern: ^arn:aws:iam::[0-9]{12}:role/(.+)$

Required: Yes

notifyOnAddCorrespondenceToCase

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

Type: Boolean

Required: No

notifyOnCaseSeverity

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

Note

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

Type: String

Valid Values: none | all | high

Required: Yes

notifyOnCreateOrReopenCase

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

Type: Boolean

Required: No

notifyOnResolveCase

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

Type: Boolean

Required: No

teamId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^\S+$

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 403

ConflictException

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 AWS account.
Add a Slack channel configuration that already exists in your AWS account.
Delete a Slack channel configuration for a live chat channel.
Delete a Slack workspace from your AWS account that has an active live chat channel.
Call the RegisterSlackWorkspaceForOrganization API from an AWS 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.

HTTP Status Code: 409

InternalServerException

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

HTTP Status Code: 500

ServiceQuotaExceededException

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

HTTP Status Code: 402

ValidationException

Your request input doesn't meet the constraints that the AWS Support App specifies.

HTTP Status Code: 400