TeamsChannelConfiguration
An AWS Chatbot configuration for Microsoft Teams.
Contents
- 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
- ChatConfigurationArn
-
The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.
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
- IamRoleArn
-
A user-defined role that AWS Chatbot assumes. This is not the service-linked role.
For more information, see IAM policies for AWS Chatbot in the AWS Chatbot 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
- SnsTopicArns
-
The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
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: Yes
- 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: Yes
- 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
- 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: No
- 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
- 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
- State
-
Either
ENABLED
orDISABLED
. The resource returnsDISABLED
if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.Type: String
Pattern:
(ENABLED|DISABLED)
Required: No
- StateReason
-
Provided if State is
DISABLED
. Provides context as to why the resource is disabled.Type: String
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
- TeamName
-
The name of the Microsoft Teams Team.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
(.*)
Required: No
- UserAuthorizationRequired
-
Enables use of a user role requirement in your chat configuration.
Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: