baidu_channels

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

Overview

Name	baidu_channels
Type	Resource
Id	aws.pinpoint.baidu_channels

Fields

The following fields are returned by SELECT queries:

get_baidu_channel

Name	Datatype	Description
application_id	string	The unique identifier for the application that the Baidu channel applies to.
creation_date	string	The date and time when the Baidu channel was enabled.
credential	string	The API key that you received from the Baidu Cloud Push service to communicate with the service.
enabled	boolean	Specifies whether the Baidu 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 Baidu channel. This property is retained only for backward compatibility.
is_archived	boolean	Specifies whether the Baidu channel is archived.
last_modified_by	string	The user who last modified the Baidu channel.
last_modified_date	string	The date and time when the Baidu channel was last modified.
platform	string	The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
version	integer	The current version of the Baidu channel.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_baidu_channel	select	application-id, region		Retrieves information about the status and settings of the Baidu channel for an application.
update_baidu_channel	update	application-id, region, BaiduChannelRequest		Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
delete_baidu_channel	delete	application-id, region		Disables the Baidu 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_baidu_channel

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

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

UPDATE examples

update_baidu_channel

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

UPDATE aws.pinpoint.baidu_channels
SET 
BaiduChannelRequest = '{{ BaiduChannelRequest }}'
WHERE 
`application-id` = '{{ application-id }}' --required
AND region = '{{ region }}' --required
AND BaiduChannelRequest = '{{ BaiduChannelRequest }}' --required
RETURNING
baidu_channel_response;

DELETE examples

delete_baidu_channel

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

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