Chatbot / Paginator / DescribeSlackUserIdentities

DescribeSlackUserIdentities

class Chatbot.Paginator.DescribeSlackUserIdentities

paginator = client.get_paginator('describe_slack_user_identities')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ChatConfigurationArn (string) – The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identities 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

{
    'SlackUserIdentities': [
        {
            'IamRoleArn': 'string',
            'ChatConfigurationArn': 'string',
            'SlackTeamId': 'string',
            'SlackUserId': 'string',
            'AwsUserIdentity': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • SlackUserIdentities (list) –

    A list of Slack User Identities.

    • (dict) –

      Identifes a user level permission for a channel configuration.

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

      • ChatConfigurationArn (string) –

        The Amazon Resource Number (ARN) of the SlackChannelConfiguration associated with the user identity to delete.

      • SlackTeamId (string) –

        The ID of the Slack workspace authorized with AWS Chatbot.

      • SlackUserId (string) –

        The ID of the user in Slack

      • AwsUserIdentity (string) –

        The AWS user identity ARN used to associate a Slack user ID with an IAM Role.