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

GetMicrosoftTeamsChannelConfiguration

Returns a Microsoft Teams channel configuration in an AWS account.

Request Syntax


POST /get-ms-teams-channel-configuration HTTP/1.1
Content-type: application/json

{
   "ChatConfigurationArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ChatConfigurationArn

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration to retrieve.

Type: String

Length Constraints: Minimum length of 19. Maximum length of 1169.

Pattern: arn:aws:(wheatley|chatbot):[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ChannelConfiguration": { 
      "ChannelId": "string",
      "ChannelName": "string",
      "ChatConfigurationArn": "string",
      "ConfigurationName": "string",
      "GuardrailPolicyArns": [ "string" ],
      "IamRoleArn": "string",
      "LoggingLevel": "string",
      "SnsTopicArns": [ "string" ],
      "State": "string",
      "StateReason": "string",
      "Tags": [ 
         { 
            "TagKey": "string",
            "TagValue": "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.

ChannelConfiguration

The configuration for a Microsoft Teams channel configured with AWS Chatbot.

Type: TeamsChannelConfiguration object

Errors

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

GetTeamsChannelConfigurationException

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

HTTP Status Code: 500

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