Skip to main content

microsoft_teams_configured_teams

Creates, updates, deletes, gets or lists a microsoft_teams_configured_teams resource.

Overview

Namemicrosoft_teams_configured_teams
TypeResource
Idaws.chatbot.microsoft_teams_configured_teams

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
statestringEither 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. (pattern: <code>(ENABLED|DISABLED)</code>)
state_reasonstringProvided if State is DISABLED. Provides context as to why the resource is disabled.
team_idstringThe 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. (pattern: <code>[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}</code>)
team_namestringThe name of the Microsoft Teams Team. (pattern: <code>[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}</code>)
tenant_idstringThe ID of the Microsoft Teams tenant. (pattern: <code>[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}</code>)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_microsoft_teams_configured_teamsselectregionLists all authorized Microsoft Teams for an AWS Account
delete_microsoft_teams_configured_teamdeleteregionDeletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team. Note that the Microsoft Teams team must have no channels configured to remove it.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Lists all authorized Microsoft Teams for an AWS Account

SELECT
state,
state_reason,
team_id,
team_name,
tenant_id
FROM aws.chatbot.microsoft_teams_configured_teams
WHERE region = '{{ region }}' -- required
;

DELETE examples

Deletes the Microsoft Teams team authorization allowing for channels to be configured in that Microsoft Teams team. Note that the Microsoft Teams team must have no channels configured to remove it.

DELETE FROM aws.chatbot.microsoft_teams_configured_teams
WHERE region = '{{ region }}' --required
;