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

CreateSlackChannelConfiguration

Creates an AWS Chatbot confugration for Slack.

Request Syntax


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

{
   "ConfigurationName": "string",
   "GuardrailPolicyArns": [ "string" ],
   "IamRoleArn": "string",
   "LoggingLevel": "string",
   "SlackChannelId": "string",
   "SlackChannelName": "string",
   "SlackTeamId": "string",
   "SnsTopicArns": [ "string" ],
   "Tags": [ 
      { 
         "TagKey": "string",
         "TagValue": "string"
      }
   ],
   "UserAuthorizationRequired": boolean
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ConfigurationName

The name of the configuration.

Type: String

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

Pattern: [A-Za-z0-9-_]+

Required: Yes

GuardrailPolicyArns

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed AdministratorAccess policy is applied by default if this is not set.

Type: Array of strings

Length Constraints: Minimum length of 11. Maximum length of 1163.

Pattern: (^$|(?!.*\/aws-service-role\/.*)arn:aws:iam:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_\/+=,@.-]{0,1023})

Required: No

IamRoleArn

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 1224.

Pattern: arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}

Required: Yes

LoggingLevel

Logging levels include ERROR, INFO, or NONE.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 5.

Pattern: (ERROR|INFO|NONE)

Required: No

SlackChannelId

The ID of the Slack channel.

To get this ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.

Type: String

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

Pattern: [A-Za-z0-9]+

Required: Yes

SlackChannelName

The name of the Slack channel.

Type: String

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

Required: No

SlackTeamId

The ID of the Slack workspace authorized with AWS Chatbot.

Type: String

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

Pattern: [0-9A-Z]{1,255}

Required: Yes

SnsTopicArns

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

Type: Array of strings

Length Constraints: Minimum length of 12. Maximum length of 1224.

Pattern: arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}

Required: No

Tags

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

Type: Array of Tag objects

Required: No

UserAuthorizationRequired

Enables use of a user role requirement in your chat configuration.

Type: Boolean

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "ChannelConfiguration": { 
      "ChatConfigurationArn": "string",
      "ConfigurationName": "string",
      "GuardrailPolicyArns": [ "string" ],
      "IamRoleArn": "string",
      "LoggingLevel": "string",
      "SlackChannelId": "string",
      "SlackChannelName": "string",
      "SlackTeamId": "string",
      "SlackTeamName": "string",
      "SnsTopicArns": [ "string" ],
      "State": "string",
      "StateReason": "string",
      "Tags": [ 
         { 
            "TagKey": "string",
            "TagValue": "string"
         }
      ],
      "UserAuthorizationRequired": boolean
   }
}

Response Elements

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

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

ChannelConfiguration

The configuration for a Slack channel configured with AWS Chatbot.

Type: SlackChannelConfiguration object

Errors

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

ConflictException

There was an issue processing your request.

HTTP Status Code: 409

CreateSlackChannelConfigurationException

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

HTTP Status Code: 500

InvalidParameterException

Your request input doesn't meet the constraints required by AWS Chatbot.

HTTP Status Code: 400

InvalidRequestException

Your request input doesn't meet the constraints required by AWS Chatbot.

HTTP Status Code: 400

LimitExceededException

You have exceeded a service limit for AWS Chatbot.

HTTP Status Code: 403