Chatbot / Paginator / ListMicrosoftTeamsConfiguredTeams

ListMicrosoftTeamsConfiguredTeams

class Chatbot.Paginator.ListMicrosoftTeamsConfiguredTeams

paginator = client.get_paginator('list_microsoft_teams_configured_teams')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'ConfiguredTeams': [
        {
            'TenantId': 'string',
            'TeamId': 'string',
            'TeamName': 'string',
            'State': 'string',
            'StateReason': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • ConfiguredTeams (list) –

    A list of teams in Microsoft Teams that are configured with AWS Chatbot.

    • (dict) –

      A Microsoft Teams team that is authorized with AWS Chatbot.

      • TenantId (string) –

        The ID of the Microsoft Teams tenant.

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

      • TeamName (string) –

        The name of the Microsoft Teams Team.

      • State (string) –

        Either ENABLED or DISABLED. The resource returns DISABLED if the organization’s AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.

      • StateReason (string) –

        Provided if State is DISABLED. Provides context as to why the resource is disabled.