Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListMicrosoftTeamsChannelConfigurations

Lists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.

Request Syntax


POST /list-ms-teams-channel-configurations HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string",
   "TeamId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1276.

Pattern: ^[a-zA-Z0-9=\/+_.\-,#:\\"{}]{4,1276}$

Required: No

TeamId

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.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "TeamChannelConfigurations": [ 
      { 
         "ChannelId": "string",
         "ChannelName": "string",
         "ChatConfigurationArn": "string",
         "ConfigurationName": "string",
         "GuardrailPolicyArns": [ "string" ],
         "IamRoleArn": "string",
         "LoggingLevel": "string",
         "SnsTopicArns": [ "string" ],
         "TeamId": "string",
         "TeamName": "string",
         "TenantId": "string",
         "UserAuthorizationRequired": boolean
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1276.

Pattern: ^[a-zA-Z0-9=\/+_.\-,#:\\"{}]{4,1276}$

TeamChannelConfigurations

A list of AWS Chatbot channel configurations for Microsoft Teams.

Type: Array of TeamsChannelConfiguration objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterException

Your request input doesn't meet the constraints required by AWS Chatbot.

HTTP Status Code: 400

InvalidRequestException

Your request input doesn't meet the constraints required by AWS Chatbot.

HTTP Status Code: 400

ListTeamsChannelConfigurationsException

We can’t process your request right now because of a server issue. Try again later.

HTTP Status Code: 500