Skip to content

ChimeWebhookConfiguration

Source code in docs_src/capo_chatbot/types/chime_webhook_configuration.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
class ChimeWebhookConfiguration(TypedDict, closed=True):
    webhook_description: (
        "capo_chatbot.types.chime_webhook_description.ChimeWebhookDescription"
    )
    """<p>A description of the webhook. We recommend using the convention <code>RoomName/WebhookName</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html">Tutorial: Get started with Amazon Chime</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 ChimeWebhookConfiguration.</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 Amazon Resource Names (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>"""
    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 ChimeWebhookConfiguration.

configuration_name instance-attribute 

configuration_name: NotRequired[ConfigurationName]

The name of the configuration.

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: SnsTopicArnList

The Amazon Resource Names (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.

webhook_description instance-attribute 

webhook_description: ChimeWebhookDescription

A description of the webhook. We recommend using the convention RoomName/WebhookName.

For more information, see Tutorial: Get started with Amazon Chime in the AWS Chatbot Administrator Guide.