Chatbot / Client / get_microsoft_teams_channel_configuration

get_microsoft_teams_channel_configuration

Chatbot.Client.get_microsoft_teams_channel_configuration(**kwargs)

Returns a Microsoft Teams channel configuration in an AWS account.

See also: AWS API Documentation

Request Syntax

response = client.get_microsoft_teams_channel_configuration(
    ChatConfigurationArn='string'
)

Parameters:

ChatConfigurationArn (string) –

[REQUIRED]

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

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'
            },
        ],
        'State': 'string',
        'StateReason': '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 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.

    • TeamName (string) –

      The name of the Microsoft Teams Team.

    • TenantId (string) –

      The ID of the Microsoft Teams tenant.

    • ChatConfigurationArn (string) –

      The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

    • IamRoleArn (string) –

      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.

    • SnsTopicArns (list) –

      The Amazon Resource Names (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 map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

      • (dict) –

        A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

        Warning

        Do not include confidential or sensitive information in this field.

        For more information, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

        • TagKey (string) –

          The key of the tag.

        • TagValue (string) –

          The value of the tag.

    • State (string) –

      Either 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.

    • StateReason (string) –

      Provided if State is DISABLED. Provides context as to why the resource is disabled.

Exceptions

• Chatbot.Client.exceptions.InvalidParameterException

• Chatbot.Client.exceptions.InvalidRequestException

• Chatbot.Client.exceptions.GetTeamsChannelConfigurationException