ChimeWebhookConfiguration - AWS Chatbot

ChimeWebhookConfiguration

An AWS Chatbot configuration for Amazon Chime.

Contents

ChatConfigurationArn

The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration.

Type: String

Length Constraints: Minimum length of 19. Maximum length of 1169.

Pattern: arn:aws:(wheatley|chatbot):[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}

Required: Yes

IamRoleArn

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.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 1224.

Pattern: arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}

Required: Yes

SnsTopicArns

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

Type: Array of strings

Length Constraints: Minimum length of 12. Maximum length of 1224.

Pattern: arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}

Required: Yes

WebhookDescription

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

ConfigurationName

The name of the configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [A-Za-z0-9-_]+

Required: No

LoggingLevel

Logging levels include ERROR, INFO, or NONE.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 5.

Pattern: (ERROR|INFO|NONE)

Required: No

State

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.

Type: String

Pattern: (ENABLED|DISABLED)

Required: No

StateReason

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

Type: String

Required: No

Tags

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

Type: Array of Tag objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: