Chatbot / Client / list_microsoft_teams_channel_configurations

list_microsoft_teams_channel_configurations#

Chatbot.Client.list_microsoft_teams_channel_configurations(**kwargs)#

Lists MS Teams Channel Configurations optionally filtered by TeamId

See also: AWS API Documentation

Request Syntax

response = client.list_microsoft_teams_channel_configurations(
    MaxResults=123,
    NextToken='string',
    TeamId='string'
)
Parameters:

  • MaxResults (integer) – The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

  • NextToken (string) – An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

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

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'TeamChannelConfigurations': [
        {
            '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
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) – An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

    • TeamChannelConfigurations (list) – A list of AWS Chatbot channel configurations for Microsoft Teams.

      • (dict) – An AWS Chatbot configuration for Microsoft Teams.

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

Exceptions