Chatbot / Client / create_slack_channel_configuration

create_slack_channel_configuration#

Chatbot.Client.create_slack_channel_configuration(**kwargs)#

Creates an AWS Chatbot confugration for Slack.

Request Syntax

response = client.create_slack_channel_configuration(
    SlackTeamId='string',
    SlackChannelId='string',
    SlackChannelName='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    ConfigurationName='string',
    LoggingLevel='string',
    GuardrailPolicyArns=[
        'string',
    ],
    UserAuthorizationRequired=True|False,
    Tags=[
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ]
)

Parameters:

SlackTeamId (string) –
[REQUIRED]

The ID of the Slack workspace authorized with AWS Chatbot.
SlackChannelId (string) –
[REQUIRED]

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.
SlackChannelName (string) – The name of the Slack channel.
SnsTopicArns (list) –
The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
- (string) –
IamRoleArn (string) –
[REQUIRED]

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.
ConfigurationName (string) –
[REQUIRED]

The name of the configuration.
LoggingLevel (string) – Logging levels include ERROR, INFO, or NONE.
GuardrailPolicyArns (list) –
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.
- (string) –
UserAuthorizationRequired (boolean) – Enables use of a user role requirement in your chat configuration.
Tags (list) –
A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
- (dict) –
  
  A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
  
  Warning
  Do not include confidential or sensitive information in this field.
  
  For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
  - TagKey (string) – [REQUIRED]
    
    The key of the tag.
  - TagValue (string) – [REQUIRED]
    
    The value of the tag.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- ChannelConfiguration (dict) –
  
  The configuration for a Slack channel configured with AWS Chatbot.
  - SlackTeamName (string) –
    
    Name of the Slack workspace.
  - SlackTeamId (string) –
    
    The ID of the Slack workspace authorized with Amazon Chime.
  - SlackChannelId (string) –
    
    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.
  - SlackChannelName (string) –
    
    The name of the Slack channel.
  - ChatConfigurationArn (string) –
    
    The Amazon Resource Name (ARN) of the SlackChannelConfiguration.
  - IamRoleArn (string) –
    
    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.
  - SnsTopicArns (list) –
    
    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
    - (string) –
  - ConfigurationName (string) –
    
    The name of the configuration.
  - LoggingLevel (string) –
    
    Logging levels include ERROR, INFO, or NONE.
  - GuardrailPolicyArns (list) –
    
    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.
    - (string) –
  - UserAuthorizationRequired (boolean) –
    
    Enables use of a user role requirement in your chat configuration.
  - Tags (list) –
    
    A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
    - (dict) –
      
      A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.
      
      Warning
      Do not include confidential or sensitive information in this field.
      
      For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.
      - TagKey (string) –
        
        The key of the tag.
      - TagValue (string) –
        
        The value of the tag.
  - State (string) –
    
    Either ENABLED or DISABLED. The resource returns DISABLED if the organization’s AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.
  - StateReason (string) –
    
    Provided if State is DISABLED. Provides context as to why the resource is disabled.

Exceptions

Chatbot.Client.exceptions.InvalidParameterException
Chatbot.Client.exceptions.InvalidRequestException
Chatbot.Client.exceptions.ConflictException
Chatbot.Client.exceptions.LimitExceededException
Chatbot.Client.exceptions.CreateSlackChannelConfigurationException