CreateMicrosoftTeamsChannelConfiguration
Creates an Amazon Q Developer configuration for Microsoft Teams.
Request Syntax
POST /create-ms-teams-channel-configuration HTTP/1.1
Content-type: application/json
{
"ChannelId": "string
",
"ChannelName": "string
",
"ConfigurationName": "string
",
"GuardrailPolicyArns": [ "string
" ],
"IamRoleArn": "string
",
"LoggingLevel": "string
",
"SnsTopicArns": [ "string
" ],
"Tags": [
{
"TagKey": "string
",
"TagValue": "string
"
}
],
"TeamId": "string
",
"TeamName": "string
",
"TenantId": "string
",
"UserAuthorizationRequired": boolean
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- ChannelId
-
The ID of the Microsoft Teams channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
([a-zA-Z0-9-_=+\/.,])*%3[aA]([a-zA-Z0-9-_=+\/.,])*%40([a-zA-Z0-9-_=+\/.,])*
Required: Yes
- ChannelName
-
The name of the Microsoft Teams channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
(.*)
Required: No
- ConfigurationName
-
The name of the configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[A-Za-z0-9-_]+
Required: Yes
- GuardrailPolicyArns
-
The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed
AdministratorAccess
policy is applied by default if this is not set.Type: Array of strings
Length Constraints: Minimum length of 11. Maximum length of 1163.
Pattern:
(^$|(?!.*\/aws-service-role\/.*)arn:aws:iam:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_\/+=,@.-]{0,1023})
Required: No
- IamRoleArn
-
A user-defined role that Amazon Q Developer assumes. This is not the service-linked role.
For more information, see IAM policies for Amazon Q Developer in the Amazon Q Developer Administrator Guide.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 1224.
Pattern:
arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}
Required: Yes
- LoggingLevel
-
Logging levels include
ERROR
,INFO
, orNONE
.Type: String
Length Constraints: Minimum length of 4. Maximum length of 5.
Pattern:
(ERROR|INFO|NONE)
Required: No
- SnsTopicArns
-
The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to Amazon Q Developer.
Type: Array of strings
Length Constraints: Minimum length of 12. Maximum length of 1224.
Pattern:
arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}
Required: No
- Tags
-
A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
Type: Array of Tag objects
Required: No
- TeamId
-
The ID of the Microsoft Teams authorized with Amazon Q Developer.
To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the Amazon Q Developer 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 Amazon Q Developer 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: Yes
- TeamName
-
The name of the Microsoft Teams Team.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
(.*)
Required: No
- TenantId
-
The ID of the Microsoft Teams tenant.
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: Yes
- UserAuthorizationRequired
-
Enables use of a user role requirement in your chat configuration.
Type: Boolean
Required: No
Response Syntax
HTTP/1.1 201
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 201 response.
The following data is returned in JSON format by the service.
- ChannelConfiguration
-
The configuration for a Microsoft Teams channel configured with Amazon Q Developer.
Type: TeamsChannelConfiguration object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
There was an issue processing your request.
HTTP Status Code: 409
- CreateTeamsChannelConfigurationException
-
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 Amazon Q Developer.
HTTP Status Code: 400
- InvalidRequestException
-
Your request input doesn't meet the constraints required by Amazon Q Developer.
HTTP Status Code: 400
- LimitExceededException
-
You have exceeded a service limit for Amazon Q Developer.
HTTP Status Code: 403
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: