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

UpdateSlackChannelConfiguration

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

Request Syntax


POST /control/update-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 Slack channel name that you want to update.

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 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: No

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, at least one of the following parameters must be true:

notifyOnAddCorrespondenceToCase
notifyOnCreateOrReopenCase
notifyOnResolveCase

If you specify none, any of the following parameters that you specify in your request must be false:

notifyOnAddCorrespondenceToCase
notifyOnCreateOrReopenCase
notifyOnResolveCase

Note

If you don't specify these parameters in your request, the Support App uses the current values by default.

Type: String

Valid Values: none | all | high

Required: No

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
Content-type: application/json

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

Response Elements

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

The following data is returned in JSON format by the service.

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+

channelName

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

Type: String

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

Pattern: .+

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 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/(.+)

notifyOnAddCorrespondenceToCase

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

Type: Boolean

notifyOnCaseSeverity

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

Type: String

Valid Values: none | all | high

notifyOnCreateOrReopenCase

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

Type: Boolean

notifyOnResolveCase

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

Type: Boolean

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+

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

ResourceNotFoundException

The specified resource is missing or doesn't exist, such as an account alias, Slack channel configuration, or Slack workspace configuration.

HTTP Status Code: 404

ValidationException

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

HTTP Status Code: 400