chime_webhook_configurations

Creates, updates, deletes, gets or lists a chime_webhook_configurations resource.

Overview

Name	chime_webhook_configurations
Type	Resource
Id	aws.chatbot.chime_webhook_configurations

Fields

The following fields are returned by SELECT queries:

describe_chime_webhook_configurations

Name	Datatype	Description
chat_configuration_arn	string	The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration. (pattern: <code>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}</code>)
configuration_name	string	The name of the configuration. (pattern: <code>[A-Za-z0-9-_]+</code>)
iam_role_arn	string	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. (pattern: <code>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}</code>)
logging_level	string	Logging levels include ERROR, INFO, or NONE. (pattern: <code>(ERROR|INFO|NONE)</code>)
sns_topic_arns	array	The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
state	string	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. (pattern: <code>(ENABLED|DISABLED)</code>)
state_reason	string	Provided if State is DISABLED. Provides context as to why the resource is disabled.
tags	array	A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
webhook_description	string	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_chime_webhook_configurations	select	region		Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn
create_chime_webhook_configuration	insert	region, WebhookDescription, WebhookUrl, SnsTopicArns, IamRoleArn, ConfigurationName		Creates an AWS Chatbot configuration for Amazon Chime.
update_chime_webhook_configuration	update	region, ChatConfigurationArn		Updates a Amazon Chime webhook configuration.
delete_chime_webhook_configuration	delete	region		Deletes a Amazon Chime webhook configuration for AWS Chatbot.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_chime_webhook_configurations

Lists Amazon Chime webhook configurations optionally filtered by ChatConfigurationArn

SELECT
chat_configuration_arn,
configuration_name,
iam_role_arn,
logging_level,
sns_topic_arns,
state,
state_reason,
tags,
webhook_description
FROM aws.chatbot.chime_webhook_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_chime_webhook_configuration

Creates an AWS Chatbot configuration for Amazon Chime.

INSERT INTO aws.chatbot.chime_webhook_configurations (
WebhookDescription,
WebhookUrl,
SnsTopicArns,
IamRoleArn,
ConfigurationName,
LoggingLevel,
Tags,
region
)
SELECT 
'{{ WebhookDescription }}' /* required */,
'{{ WebhookUrl }}' /* required */,
'{{ SnsTopicArns }}' /* required */,
'{{ IamRoleArn }}' /* required */,
'{{ ConfigurationName }}' /* required */,
'{{ LoggingLevel }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
webhook_configuration
;

Manifest

# Description fields are for documentation purposes
- name: chime_webhook_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the chime_webhook_configurations resource.
  - name: WebhookDescription
    value: "{{ WebhookDescription }}"
  - name: WebhookUrl
    value: "{{ WebhookUrl }}"
  - name: SnsTopicArns
    value:
      - "{{ SnsTopicArns }}"
  - name: IamRoleArn
    value: "{{ IamRoleArn }}"
  - name: ConfigurationName
    value: "{{ ConfigurationName }}"
  - name: LoggingLevel
    value: "{{ LoggingLevel }}"
  - name: Tags
    value:
      - TagKey: "{{ TagKey }}"
        TagValue: "{{ TagValue }}"

UPDATE examples

update_chime_webhook_configuration

Updates a Amazon Chime webhook configuration.

UPDATE aws.chatbot.chime_webhook_configurations
SET 
ChatConfigurationArn = '{{ ChatConfigurationArn }}',
WebhookDescription = '{{ WebhookDescription }}',
WebhookUrl = '{{ WebhookUrl }}',
SnsTopicArns = '{{ SnsTopicArns }}',
IamRoleArn = '{{ IamRoleArn }}',
LoggingLevel = '{{ LoggingLevel }}'
WHERE 
region = '{{ region }}' --required
AND ChatConfigurationArn = '{{ ChatConfigurationArn }}' --required
RETURNING
webhook_configuration;

DELETE examples

delete_chime_webhook_configuration

Deletes a Amazon Chime webhook configuration for AWS Chatbot.

DELETE FROM aws.chatbot.chime_webhook_configurations
WHERE region = '{{ region }}' --required
;