Chatbot / Client / describe_slack_channel_configurations

describe_slack_channel_configurations

Chatbot.Client.describe_slack_channel_configurations(**kwargs)

Lists Slack Channel Configurations optionally filtered by ChatConfigurationArn

See also: AWS API Documentation

Request Syntax

response = client.describe_slack_channel_configurations(
    MaxResults=123,
    NextToken='string',
    ChatConfigurationArn='string'
)

Parameters:

• MaxResults (integer) – The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

• NextToken (string) – An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

• ChatConfigurationArn (string) – An optional ARN of a SlackChannelConfiguration to describe.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'SlackChannelConfigurations': [
        {
            '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'
                },
            ]
        },
    ]
}

Response Structure

• (dict) –

  • NextToken (string) – An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

  • SlackChannelConfigurations (list) – A list of Slack channel configurations.

    • (dict) – An AWS Chatbot configuration for Slack.

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

      • Tags (list) – A list of tags applied to the configuration.

        • (dict) – A tag applied to the configuration.

          • TagKey (string) – The tag key.

          • TagValue (string) – The tag value.

Exceptions

• Chatbot.Client.exceptions.DescribeSlackChannelConfigurationsException

• Chatbot.Client.exceptions.InvalidParameterException

• Chatbot.Client.exceptions.InvalidRequestException