channels

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

Overview

Name	channels
Type	Resource
Id	aws.notifications.channels

Fields

The following fields are returned by SELECT queries:

list_channels

Name	Datatype	Description
channel	string	A list of Channels.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_channels	select	notificationConfigurationArn, region	maxResults, nextToken	Returns a list of Channels for a NotificationConfiguration.
associate_channel	update	arn, region, notificationConfigurationArn		Associates a delivery Channel with a particular NotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).
associate_managed_notification_additional_channel	update	channel_arn, region, managedNotificationConfigurationArn		Associates an additional Channel with a particular ManagedNotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).
disassociate_channel	exec	arn, region, notificationConfigurationArn		Disassociates a Channel from a specified NotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).
disassociate_managed_notification_additional_channel	exec	channel_arn, region, managedNotificationConfigurationArn		Disassociates an additional Channel from a particular ManagedNotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

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
arn	string	The Amazon Resource Name (ARN) of the Channel to disassociate.
channel_arn	string	The Amazon Resource Name (ARN) of the Channel to associate with the ManagedNotificationConfiguration.
notificationConfigurationArn	string	The Amazon Resource Name (ARN) of the NotificationConfiguration.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to be returned in this call. The default value is 20.
nextToken	string	The start token for paginated calls. Retrieved from the response of a previous ListNotificationEvents call. NextToken uses Base64 encoding.

SELECT examples

list_channels

Returns a list of Channels for a NotificationConfiguration.

SELECT
channel
FROM aws.notifications.channels
WHERE notificationConfigurationArn = '{{ notificationConfigurationArn }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

UPDATE examples

associate_channel

Associates a delivery Channel with a particular NotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

UPDATE aws.notifications.channels
SET 
notificationConfigurationArn = '{{ notificationConfigurationArn }}'
WHERE 
arn = '{{ arn }}' --required
AND region = '{{ region }}' --required
AND notificationConfigurationArn = '{{ notificationConfigurationArn }}' --required;

associate_managed_notification_additional_channel

Associates an additional Channel with a particular ManagedNotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

UPDATE aws.notifications.channels
SET 
managedNotificationConfigurationArn = '{{ managedNotificationConfigurationArn }}'
WHERE 
channel_arn = '{{ channel_arn }}' --required
AND region = '{{ region }}' --required
AND managedNotificationConfigurationArn = '{{ managedNotificationConfigurationArn }}' --required;

Lifecycle Methods

disassociate_channel

Disassociates a Channel from a specified NotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

EXEC aws.notifications.channels.disassociate_channel 
@arn='{{ arn }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"notificationConfigurationArn": "{{ notificationConfigurationArn }}"
}'
;

disassociate_managed_notification_additional_channel

Disassociates an additional Channel from a particular ManagedNotificationConfiguration. Supported Channels include Amazon Q Developer in chat applications, the Console Mobile Application, and emails (notifications-contacts).

EXEC aws.notifications.channels.disassociate_managed_notification_additional_channel 
@channel_arn='{{ channel_arn }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"managedNotificationConfigurationArn": "{{ managedNotificationConfigurationArn }}"
}'
;