adm_channels

Creates, updates, deletes, gets or lists an adm_channels resource.

Overview

Name	adm_channels
Type	Resource
Id	aws.pinpoint.adm_channels

Fields

The following fields are returned by SELECT queries:

get_adm_channel

Name	Datatype	Description
application_id	string	The unique identifier for the application that the ADM channel applies to.
creation_date	string	The date and time when the ADM channel was enabled.
enabled	boolean	Specifies whether the ADM channel is enabled for the application.
has_credential	boolean	(Not used) This property is retained only for backward compatibility.
id	string	(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.
is_archived	boolean	Specifies whether the ADM channel is archived.
last_modified_by	string	The user who last modified the ADM channel.
last_modified_date	string	The date and time when the ADM channel was last modified.
platform	string	The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.
version	integer	The current version of the ADM channel.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_adm_channel	select	application-id, region		Retrieves information about the status and settings of the ADM channel for an application.
update_adm_channel	update	application-id, region, ADMChannelRequest		Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
delete_adm_channel	delete	application-id, region		Disables the ADM channel for an application and deletes any existing settings for the 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
application-id	string	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
region	string	AWS region (default: us-east-1)

SELECT examples

get_adm_channel

Retrieves information about the status and settings of the ADM channel for an application.

SELECT
application_id,
creation_date,
enabled,
has_credential,
id,
is_archived,
last_modified_by,
last_modified_date,
platform,
version
FROM aws.pinpoint.adm_channels
WHERE `application-id` = '{{ application-id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_adm_channel

Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

UPDATE aws.pinpoint.adm_channels
SET 
ADMChannelRequest = '{{ ADMChannelRequest }}'
WHERE 
`application-id` = '{{ application-id }}' --required
AND region = '{{ region }}' --required
AND ADMChannelRequest = '{{ ADMChannelRequest }}' --required
RETURNING
adm_channel_response;

DELETE examples

delete_adm_channel

Disables the ADM channel for an application and deletes any existing settings for the channel.

DELETE FROM aws.pinpoint.adm_channels
WHERE `application-id` = '{{ application-id }}' --required
AND region = '{{ region }}' --required
;