Skip to content

SlackChannelConfiguration

Source code in docs_src/capo_chatbot/types/slack_channel_configuration.py
class SlackChannelConfiguration(TypedDict, closed=True):
    slack_team_name: "capo_chatbot.types.slack_team_name.SlackTeamName"
    """<p>Name of the Slack workspace.</p>"""
    slack_team_id: "capo_chatbot.types.slack_team_id.SlackTeamId"
    """<p>The ID of the Slack workspace authorized with Amazon Chime.</p>"""
    slack_channel_id: "capo_chatbot.types.slack_channel_id.SlackChannelId"
    """<p>The ID of the Slack channel.</p> <p>To get this ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ. </p>"""
    slack_channel_name: (
        "capo_chatbot.types.slack_channel_display_name.SlackChannelDisplayName"
    )
    """<p>The name of the Slack channel.</p>"""
    chat_configuration_arn: (
        "capo_chatbot.types.chat_configuration_arn.ChatConfigurationArn"
    )
    """<p>The Amazon Resource Name (ARN) of the SlackChannelConfiguration.</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>"""
    sns_topic_arns: "capo_chatbot.types.sns_topic_arn_list.SnsTopicArnList"
    """<p>The ARNs of the SNS topics that deliver notifications to AWS Chatbot.</p>"""
    configuration_name: NotRequired[
        "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>"""
    state: NotRequired["capo_chatbot.types.resource_state.ResourceState"]
    """<p>Either <code>ENABLED</code> or <code>DISABLED</code>. The resource returns <code>DISABLED</code> if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.</p>"""
    state_reason: NotRequired["capo_chatbot.types.string.String"]
    """<p>Provided if State is <code>DISABLED</code>. Provides context as to why the resource is disabled.</p>"""

chat_configuration_arn instance-attribute

chat_configuration_arn: ChatConfigurationArn

The Amazon Resource Name (ARN) of the SlackChannelConfiguration.

configuration_name instance-attribute

configuration_name: NotRequired[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.

slack_channel_id instance-attribute

slack_channel_id: SlackChannelId

The ID of the Slack channel.

To get this ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.

slack_channel_name instance-attribute

slack_channel_name: SlackChannelDisplayName

The name of the Slack channel.

slack_team_id instance-attribute

slack_team_id: SlackTeamId

The ID of the Slack workspace authorized with Amazon Chime.

slack_team_name instance-attribute

slack_team_name: SlackTeamName

Name of the Slack workspace.

sns_topic_arns instance-attribute

sns_topic_arns: SnsTopicArnList

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

state instance-attribute

state: NotRequired[ResourceState]

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.

state_reason instance-attribute

state_reason: NotRequired[String]

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

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.

user_authorization_required instance-attribute

user_authorization_required: NotRequired[BooleanAccountPreference]

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