Chatbot / Client / create_microsoft_teams_channel_configuration

create_microsoft_teams_channel_configuration#

Chatbot.Client.create_microsoft_teams_channel_configuration(**kwargs)#

Creates MS Teams Channel Configuration

See also: AWS API Documentation

Request Syntax

response = client.create_microsoft_teams_channel_configuration(
    ChannelId='string',
    ChannelName='string',
    TeamId='string',
    TeamName='string',
    TenantId='string',
    SnsTopicArns=[
        'string',
    ],
    IamRoleArn='string',
    ConfigurationName='string',
    LoggingLevel='string',
    GuardrailPolicyArns=[
        'string',
    ],
    UserAuthorizationRequired=True|False,
    Tags=[
        {
            'TagKey': 'string',
            'TagValue': 'string'
        },
    ]
)
Parameters:

  • ChannelId (string) – [REQUIRED] The ID of the Microsoft Teams channel.

  • ChannelName (string) – The name of the Microsoft Teams channel.

  • TeamId (string) – [REQUIRED] The ID of the Microsoft Team 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.

  • TeamName (string) – The name of the Microsoft Teams Team.

  • TenantId (string) – [REQUIRED] The ID of the Microsoft Teams tenant.

  • SnsTopicArns (list) –

    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

    • (string) –

  • IamRoleArn (string) – [REQUIRED] The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.

  • ConfigurationName (string) – [REQUIRED] The name of the configuration.

  • LoggingLevel (string) – Logging levels include ERROR, INFO, or NONE.

  • GuardrailPolicyArns (list) –

    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.

    • (string) –

  • UserAuthorizationRequired (boolean) – Enables use of a user role requirement in your chat configuration.

  • Tags (list) –

    A list of tags to apply to the configuration.

    • (dict) – A tag applied to the configuration.

      • TagKey (string) – [REQUIRED] The tag key.

      • TagValue (string) – [REQUIRED] The tag value.

Return type:

dict

Returns:

Response Syntax

{
    'ChannelConfiguration': {
        'ChannelId': 'string',
        'ChannelName': 'string',
        'TeamId': 'string',
        'TeamName': 'string',
        'TenantId': 'string',
        'ChatConfigurationArn': 'string',
        'IamRoleArn': 'string',
        'SnsTopicArns': [
            'string',
        ],
        'ConfigurationName': 'string',
        'LoggingLevel': 'string',
        'GuardrailPolicyArns': [
            'string',
        ],
        'UserAuthorizationRequired': True|False,
        'Tags': [
            {
                'TagKey': 'string',
                'TagValue': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • ChannelConfiguration (dict) – The configuration for a Microsoft Teams channel configured with AWS Chatbot.

      • ChannelId (string) – The ID of the Microsoft Teams channel.

      • ChannelName (string) – The name of the Microsoft Teams channel.

      • TeamId (string) – The ID of the Microsoft Team 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.

      • TeamName (string) – The name of the Microsoft Teams Team.

      • TenantId (string) – The ID of the Microsoft Teams tenant.

      • ChatConfigurationArn (string) – The ARN of the MicrosoftTeamsChannelConfiguration.

      • IamRoleArn (string) – The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.

      • SnsTopicArns (list) – The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

        • (string) –

      • ConfigurationName (string) – The name of the configuration.

      • LoggingLevel (string) – Logging levels include ERROR, INFO, or NONE.

      • GuardrailPolicyArns (list) – 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.

        • (string) –

      • UserAuthorizationRequired (boolean) – Enables use of a user role requirement in your chat configuration.

      • Tags (list) – A list of tags applied to the configuration.

        • (dict) – A tag applied to the configuration.

          • TagKey (string) – The tag key.

          • TagValue (string) – The tag value.

Exceptions

  • Chatbot.Client.exceptions.InvalidParameterException

  • Chatbot.Client.exceptions.LimitExceededException

  • Chatbot.Client.exceptions.InvalidRequestException

  • Chatbot.Client.exceptions.CreateTeamsChannelConfigurationException

  • Chatbot.Client.exceptions.ConflictException