gcm_channels

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

Overview

Name	gcm_channels
Type	Resource
Id	aws.pinpoint.gcm_channels

Fields

The following fields are returned by SELECT queries:

get_gcm_channel

Name	Datatype	Description
application_id	string	The unique identifier for the application that the GCM channel applies to.
creation_date	string	The date and time when the GCM channel was enabled.
credential	string	The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
default_authentication_method	string	The default authentication method used for GCM. Values are either "TOKEN" or "KEY". Defaults to "KEY".
enabled	boolean	Specifies whether the GCM channel is enabled for the application.
has_credential	boolean	(Not used) This property is retained only for backward compatibility.
has_fcm_service_credentials	boolean	Returns true if the JSON file provided by Google during registration process was used in the ServiceJson field of the request.
id	string	(Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
is_archived	boolean	Specifies whether the GCM channel is archived.
last_modified_by	string	The user who last modified the GCM channel.
last_modified_date	string	The date and time when the GCM channel was last modified.
platform	string	The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
version	integer	The current version of the GCM channel.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_gcm_channel	select	application-id, region		Retrieves information about the status and settings of the GCM channel for an application.
update_gcm_channel	update	application-id, region, GCMChannelRequest		Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
delete_gcm_channel	delete	application-id, region		Disables the GCM 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_gcm_channel

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

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

UPDATE examples

update_gcm_channel

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

UPDATE aws.pinpoint.gcm_channels
SET 
GCMChannelRequest = '{{ GCMChannelRequest }}'
WHERE 
`application-id` = '{{ application-id }}' --required
AND region = '{{ region }}' --required
AND GCMChannelRequest = '{{ GCMChannelRequest }}' --required
RETURNING
gcm_channel_response;

DELETE examples

delete_gcm_channel

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

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