Chatbot / Paginator / ListMicrosoftTeamsUserIdentities

ListMicrosoftTeamsUserIdentities

class Chatbot.Paginator.ListMicrosoftTeamsUserIdentities

paginator = client.get_paginator('list_microsoft_teams_user_identities')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Chatbot.Client.list_microsoft_teams_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 Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identities to list.

• 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

{
    'TeamsUserIdentities': [
        {
            'IamRoleArn': 'string',
            'ChatConfigurationArn': 'string',
            'TeamId': 'string',
            'UserId': 'string',
            'AwsUserIdentity': 'string',
            'TeamsChannelId': 'string',
            'TeamsTenantId': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • TeamsUserIdentities (list) –

    User level permissions associated to a channel configuration.

    • (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 Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

      • TeamId (string) –

        The ID of the Microsoft Teams authorized with AWS Chatbot.

        To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.

      • UserId (string) –

        The Microsoft Teams user ID.

      • AwsUserIdentity (string) –

        The AWS user identity ARN used to associate a Microsoft Teams user Identity with an IAM Role.

      • TeamsChannelId (string) –

        The ID of the Microsoft Teams channel.

      • TeamsTenantId (string) –

        The ID of the Microsoft Teams tenant.