slack_workspaces

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

Overview

Name	slack_workspaces
Type	Resource
Id	aws.chatbot.slack_workspaces

Fields

The following fields are returned by SELECT queries:

describe_slack_workspaces

Name	Datatype	Description
slack_team_id	string	The ID of the Slack workspace authorized with AWS Chatbot. (pattern: <code>[0-9A-Z]{1,255}</code>)
slack_team_name	string	The name of the Slack workspace.
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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_slack_workspaces	select	region		List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot.
delete_slack_workspace_authorization	delete	region		Deletes the Slack workspace authorization that allows channels to be configured in that workspace. This requires all configured channels in the workspace to be deleted.

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_slack_workspaces

List all authorized Slack workspaces connected to the AWS Account onboarded with AWS Chatbot.

SELECT
slack_team_id,
slack_team_name,
state,
state_reason
FROM aws.chatbot.slack_workspaces
WHERE region = '{{ region }}' -- required
;

DELETE examples

delete_slack_workspace_authorization

Deletes the Slack workspace authorization that allows channels to be configured in that workspace. This requires all configured channels in the workspace to be deleted.

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