Chatbot / Client / list_microsoft_teams_configured_teams

list_microsoft_teams_configured_teams¶

Chatbot.Client.list_microsoft_teams_configured_teams(**kwargs)¶

Lists all authorized Microsoft Teams for an AWS Account

Request Syntax

response = client.list_microsoft_teams_configured_teams(
    MaxResults=123,
    NextToken='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.

Return type:

dict

Returns:

Response Syntax

{
    'ConfiguredTeams': [
        {
            'TenantId': 'string',
            'TeamId': 'string',
            'TeamName': 'string',
            'State': 'string',
            'StateReason': 'string'
        },
    ],
    'NextToken': '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.
- 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.

Exceptions

Chatbot.Client.exceptions.InvalidParameterException
Chatbot.Client.exceptions.InvalidRequestException
Chatbot.Client.exceptions.ListMicrosoftTeamsConfiguredTeamsException