Skip to content

TeamsUserIdentity

Source code in docs_src/capo_chatbot/types/teams_user_identity.py
class TeamsUserIdentity(TypedDict, closed=True):
    iam_role_arn: "capo_chatbot.types.arn.Arn"
    """<p>A user-defined role that AWS Chatbot assumes. This is not the service-linked role.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html">IAM policies for AWS Chatbot</a> in the <i> AWS Chatbot Administrator Guide</i>. </p>"""
    chat_configuration_arn: (
        "capo_chatbot.types.chat_configuration_arn.ChatConfigurationArn"
    )
    """<p>The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.</p>"""
    team_id: "capo_chatbot.types.uuid.UUID"
    """<p> The ID of the Microsoft Teams authorized with AWS Chatbot.</p> <p>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 <a href="https://docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html#teams-client-setup">Step 1: Configure a Microsoft Teams client</a> in the <i> AWS Chatbot Administrator Guide</i>. </p>"""
    user_id: NotRequired["capo_chatbot.types.uuid.UUID"]
    """<p>The Microsoft Teams user ID.</p>"""
    aws_user_identity: NotRequired[
        "capo_chatbot.types.aws_user_identity.AwsUserIdentity"
    ]
    """<p>The AWS user identity ARN used to associate a Microsoft Teams user Identity with an IAM Role.</p>"""
    teams_channel_id: NotRequired["capo_chatbot.types.teams_channel_id.TeamsChannelId"]
    """<p>The ID of the Microsoft Teams channel.</p>"""
    teams_tenant_id: NotRequired["capo_chatbot.types.uuid.UUID"]
    """<p>The ID of the Microsoft Teams tenant.</p>"""

aws_user_identity instance-attribute

aws_user_identity: NotRequired[AwsUserIdentity]

The AWS user identity ARN used to associate a Microsoft Teams user Identity with an IAM Role.

chat_configuration_arn instance-attribute

chat_configuration_arn: ChatConfigurationArn

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

iam_role_arn instance-attribute

iam_role_arn: Arn

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.

team_id instance-attribute

team_id: UUID

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.

teams_channel_id instance-attribute

teams_channel_id: NotRequired[TeamsChannelId]

The ID of the Microsoft Teams channel.

teams_tenant_id instance-attribute

teams_tenant_id: NotRequired[UUID]

The ID of the Microsoft Teams tenant.

user_id instance-attribute

user_id: NotRequired[UUID]

The Microsoft Teams user ID.