Skip to content

CreateTeamsChannelConfigurationRequest

Source code in docs_src/capo_chatbot/types/create_teams_channel_configuration_request.py
class CreateTeamsChannelConfigurationRequest(TypedDict, closed=True):
    channel_id: "capo_chatbot.types.teams_channel_id.TeamsChannelId"
    """<p>The ID of the Microsoft Teams channel.</p>"""
    channel_name: NotRequired["capo_chatbot.types.teams_channel_name.TeamsChannelName"]
    """<p>The name of the Microsoft Teams channel.</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>"""
    team_name: NotRequired["capo_chatbot.types.team_name.TeamName"]
    """<p>The name of the Microsoft Teams Team.</p>"""
    tenant_id: "capo_chatbot.types.uuid.UUID"
    """<p>The ID of the Microsoft Teams tenant.</p>"""
    sns_topic_arns: NotRequired["capo_chatbot.types.sns_topic_arn_list.SnsTopicArnList"]
    """<p>The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.</p>"""
    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>"""
    configuration_name: "capo_chatbot.types.configuration_name.ConfigurationName"
    """<p>The name of the configuration.</p>"""
    logging_level: NotRequired[
        "capo_chatbot.types.customer_cw_log_level.CustomerCwLogLevel"
    ]
    """<p>Logging levels include <code>ERROR</code>, <code>INFO</code>, or <code>NONE</code>.</p>"""
    guardrail_policy_arns: NotRequired[
        "capo_chatbot.types.guardrail_policy_arn_list.GuardrailPolicyArnList"
    ]
    """<p>The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed <code>AdministratorAccess</code> policy is applied by default if this is not set. </p>"""
    user_authorization_required: NotRequired[
        "capo_chatbot.types.boolean_account_preference.BooleanAccountPreference"
    ]
    """<p>Enables use of a user role requirement in your chat configuration.</p>"""
    tags: NotRequired["capo_chatbot.types.tags.Tags"]
    """<p>A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.</p>"""

channel_id instance-attribute

channel_id: TeamsChannelId

The ID of the Microsoft Teams channel.

channel_name instance-attribute

channel_name: NotRequired[TeamsChannelName]

The name of the Microsoft Teams channel.

configuration_name instance-attribute

configuration_name: ConfigurationName

The name of the configuration.

guardrail_policy_arns instance-attribute

guardrail_policy_arns: NotRequired[GuardrailPolicyArnList]

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.

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.

logging_level instance-attribute

logging_level: NotRequired[CustomerCwLogLevel]

Logging levels include ERROR, INFO, or NONE.

sns_topic_arns instance-attribute

sns_topic_arns: NotRequired[SnsTopicArnList]

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

tags instance-attribute

tags: NotRequired[Tags]

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

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.

team_name instance-attribute

team_name: NotRequired[TeamName]

The name of the Microsoft Teams Team.

tenant_id instance-attribute

tenant_id: UUID

The ID of the Microsoft Teams tenant.

user_authorization_required instance-attribute

user_authorization_required: NotRequired[BooleanAccountPreference]

Enables use of a user role requirement in your chat configuration.