slack_channel_configurations

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

Overview

Name	slack_channel_configurations
Type	Resource
Id	aws.support_app.slack_channel_configurations

Fields

The following fields are returned by SELECT queries:

list_slack_channel_configurations

Name	Datatype	Description
next_token	string	The point where pagination should resume when the response returns only partial results. (pattern: <code>^\S+$</code>)
slack_channel_configurations	array	The configurations for a Slack channel.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_slack_channel_configurations	select	region		Lists the Slack channel configurations for an Amazon Web Services account.
create_slack_channel_configuration	insert	region, channelId, channelRoleArn, notifyOnCaseSeverity, teamId		Creates a Slack channel configuration for your Amazon Web Services account. You can add up to 5 Slack workspaces for your account. You can add up to 20 Slack channels for your account. A Slack channel can have up to 100 Amazon Web Services accounts. This means that only 100 accounts can add the same Slack channel to the Amazon Web Services Support App. We recommend that you only add the accounts that you need to manage support cases for your organization. This can reduce the notifications about case updates that you receive in the Slack channel. We recommend that you choose a private Slack channel so that only members in that channel have read and write access to your support cases. Anyone in your Slack channel can create, update, or resolve support cases for your account. Users require an invitation to join private channels.
update_slack_channel_configuration	update	region, channelId, teamId		Updates the configuration for a Slack channel, such as case update notifications.
delete_slack_channel_configuration	delete	region		Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel.

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

list_slack_channel_configurations

Lists the Slack channel configurations for an Amazon Web Services account.

SELECT
next_token,
slack_channel_configurations
FROM aws.support_app.slack_channel_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_slack_channel_configuration

Creates a Slack channel configuration for your Amazon Web Services account. You can add up to 5 Slack workspaces for your account. You can add up to 20 Slack channels for your account. A Slack channel can have up to 100 Amazon Web Services accounts. This means that only 100 accounts can add the same Slack channel to the Amazon Web Services Support App. We recommend that you only add the accounts that you need to manage support cases for your organization. This can reduce the notifications about case updates that you receive in the Slack channel. We recommend that you choose a private Slack channel so that only members in that channel have read and write access to your support cases. Anyone in your Slack channel can create, update, or resolve support cases for your account. Users require an invitation to join private channels.

INSERT INTO aws.support_app.slack_channel_configurations (
channelId,
channelName,
channelRoleArn,
notifyOnAddCorrespondenceToCase,
notifyOnCaseSeverity,
notifyOnCreateOrReopenCase,
notifyOnResolveCase,
teamId,
region
)
SELECT 
'{{ channelId }}' /* required */,
'{{ channelName }}',
'{{ channelRoleArn }}' /* required */,
{{ notifyOnAddCorrespondenceToCase }},
'{{ notifyOnCaseSeverity }}' /* required */,
{{ notifyOnCreateOrReopenCase }},
{{ notifyOnResolveCase }},
'{{ teamId }}' /* required */,
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: slack_channel_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the slack_channel_configurations resource.
  - name: channelId
    value: "{{ channelId }}"
  - name: channelName
    value: "{{ channelName }}"
  - name: channelRoleArn
    value: "{{ channelRoleArn }}"
  - name: notifyOnAddCorrespondenceToCase
    value: {{ notifyOnAddCorrespondenceToCase }}
  - name: notifyOnCaseSeverity
    value: "{{ notifyOnCaseSeverity }}"
    valid_values: ['none', 'all', 'high']
  - name: notifyOnCreateOrReopenCase
    value: {{ notifyOnCreateOrReopenCase }}
  - name: notifyOnResolveCase
    value: {{ notifyOnResolveCase }}
  - name: teamId
    value: "{{ teamId }}"

UPDATE examples

update_slack_channel_configuration

Updates the configuration for a Slack channel, such as case update notifications.

UPDATE aws.support_app.slack_channel_configurations
SET 
channelId = '{{ channelId }}',
channelName = '{{ channelName }}',
channelRoleArn = '{{ channelRoleArn }}',
notifyOnAddCorrespondenceToCase = {{ notifyOnAddCorrespondenceToCase }},
notifyOnCaseSeverity = '{{ notifyOnCaseSeverity }}',
notifyOnCreateOrReopenCase = {{ notifyOnCreateOrReopenCase }},
notifyOnResolveCase = {{ notifyOnResolveCase }},
teamId = '{{ teamId }}'
WHERE 
region = '{{ region }}' --required
AND channelId = '{{ channelId }}' --required
AND teamId = '{{ teamId }}' --required
RETURNING
channel_id,
channel_name,
channel_role_arn,
notify_on_add_correspondence_to_case,
notify_on_case_severity,
notify_on_create_or_reopen_case,
notify_on_resolve_case,
team_id;

DELETE examples

delete_slack_channel_configuration

Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel.

DELETE FROM aws.support_app.slack_channel_configurations
WHERE region = '{{ region }}' --required
;