Skip to main content

microsoft_teams_channel_configurations

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

Overview​

Namemicrosoft_teams_channel_configurations
TypeResource
Idaws.chatbot.microsoft_teams_channel_configurations

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
channel_idstringThe ID of the Microsoft Teams channel. (pattern: <code>([a-zA-Z0-9-=+/.,])*%3[aA]([a-zA-Z0-9-=+/.,])%40([a-zA-Z0-9-_=+/.,])</code>)
channel_namestringThe name of the Microsoft Teams channel. (pattern: <code>(.*)</code>)
chat_configuration_arnstringThe Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete. (pattern: <code>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}</code>)
configuration_namestringThe name of the configuration. (pattern: <code>[A-Za-z0-9-_]+</code>)
guardrail_policy_arnsarrayThe 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.
iam_role_arnstringA 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. (pattern: <code>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}</code>)
logging_levelstringLogging levels include ERROR, INFO, or NONE. (pattern: <code>(ERROR|INFO|NONE)</code>)
sns_topic_arnsarrayThe Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
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.
tagsarrayA map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
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>(.*)</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>)
user_authorization_requiredbooleanEnables use of a user role requirement in your chat configuration.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_microsoft_teams_channel_configurationselectregionReturns a Microsoft Teams channel configuration in an AWS account.
list_microsoft_teams_channel_configurationsselectregionLists all AWS Chatbot Microsoft Teams channel configurations in an AWS account.
create_microsoft_teams_channel_configurationinsertregion, ChannelId, TeamId, TenantId, IamRoleArn, ConfigurationNameCreates an AWS Chatbot configuration for Microsoft Teams.
update_microsoft_teams_channel_configurationupdateregion, ChatConfigurationArn, ChannelIdUpdates an Microsoft Teams channel configuration.
delete_microsoft_teams_channel_configurationdeleteregionDeletes a Microsoft Teams channel configuration for AWS Chatbot

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​

Returns a Microsoft Teams channel configuration in an AWS account.

SELECT
channel_id,
channel_name,
chat_configuration_arn,
configuration_name,
guardrail_policy_arns,
iam_role_arn,
logging_level,
sns_topic_arns,
state,
state_reason,
tags,
team_id,
team_name,
tenant_id,
user_authorization_required
FROM aws.chatbot.microsoft_teams_channel_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Creates an AWS Chatbot configuration for Microsoft Teams.

INSERT INTO aws.chatbot.microsoft_teams_channel_configurations (
ChannelId,
ChannelName,
TeamId,
TeamName,
TenantId,
SnsTopicArns,
IamRoleArn,
ConfigurationName,
LoggingLevel,
GuardrailPolicyArns,
UserAuthorizationRequired,
Tags,
region
)
SELECT 
'{{ ChannelId }}' /* required */,
'{{ ChannelName }}',
'{{ TeamId }}' /* required */,
'{{ TeamName }}',
'{{ TenantId }}' /* required */,
'{{ SnsTopicArns }}',
'{{ IamRoleArn }}' /* required */,
'{{ ConfigurationName }}' /* required */,
'{{ LoggingLevel }}',
'{{ GuardrailPolicyArns }}',
{{ UserAuthorizationRequired }},
'{{ Tags }}',
'{{ region }}'
RETURNING
channel_configuration
;

UPDATE examples​

Updates an Microsoft Teams channel configuration.

UPDATE aws.chatbot.microsoft_teams_channel_configurations
SET 
ChatConfigurationArn = '{{ ChatConfigurationArn }}',
ChannelId = '{{ ChannelId }}',
ChannelName = '{{ ChannelName }}',
SnsTopicArns = '{{ SnsTopicArns }}',
IamRoleArn = '{{ IamRoleArn }}',
LoggingLevel = '{{ LoggingLevel }}',
GuardrailPolicyArns = '{{ GuardrailPolicyArns }}',
UserAuthorizationRequired = {{ UserAuthorizationRequired }}
WHERE 
region = '{{ region }}' --required
AND ChatConfigurationArn = '{{ ChatConfigurationArn }}' --required
AND ChannelId = '{{ ChannelId }}' --required
RETURNING
channel_configuration;

DELETE examples​

Deletes a Microsoft Teams channel configuration for AWS Chatbot

DELETE FROM aws.chatbot.microsoft_teams_channel_configurations
WHERE region = '{{ region }}' --required
;
Last updated on