Chatbot / Paginator / DescribeSlackChannelConfigurations

DescribeSlackChannelConfigurations

class Chatbot.Paginator.DescribeSlackChannelConfigurations

paginator = client.get_paginator('describe_slack_channel_configurations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Chatbot.Client.describe_slack_channel_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ChatConfigurationArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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) –

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