chatbot / Client / update_slack_channel_configuration

update_slack_channel_configuration#

chatbot.Client.update_slack_channel_configuration(**kwargs)#

Updates Slack Channel Configuration

See also: AWS API Documentation

Request Syntax

response = client.update_slack_channel_configuration(
    ChatConfigurationArn='string',
    SlackChannelId='string',
    SlackChannelName='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    LoggingLevel='string',
    GuardrailPolicyArns=[
        'string',
    ],
    UserAuthorizationRequired=True|False
)
Parameters:

  • ChatConfigurationArn (string) – [REQUIRED] The ARN of the SlackChannelConfiguration to update.

  • SlackChannelId (string) – [REQUIRED] The ID of the Slack channel. To get the 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 ARNs of the SNS topics that deliver notifications to AWS Chatbot.

    • (string) –

  • IamRoleArn (string) – The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.

  • 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.

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
    }
}

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 AWS Chatbot.

      • SlackChannelId (string) – The ID of the Slack channel. To get the 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 ARN of the SlackChannelConfiguration.

      • IamRoleArn (string) – The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.

      • 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.

Exceptions

  • chatbot.Client.exceptions.ResourceNotFoundException

  • chatbot.Client.exceptions.InvalidParameterException

  • chatbot.Client.exceptions.InvalidRequestException

  • chatbot.Client.exceptions.UpdateSlackChannelConfigurationException