apns_voip_channels

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

Overview

Name	apns_voip_channels
Type	Resource
Id	aws.pinpoint.apns_voip_channels

Fields

The following fields are returned by SELECT queries:

get_apns_voip_channel

Name	Datatype	Description
application_id	string	The unique identifier for the application that the APNs VoIP channel applies to.
creation_date	string	The date and time when the APNs VoIP channel was enabled.
default_authentication_method	string	The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
enabled	boolean	Specifies whether the APNs VoIP channel is enabled for the application.
has_credential	boolean	(Not used) This property is retained only for backward compatibility.
has_token_key	boolean	Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
id	string	(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
is_archived	boolean	Specifies whether the APNs VoIP channel is archived.
last_modified_by	string	The user who last modified the APNs VoIP channel.
last_modified_date	string	The date and time when the APNs VoIP channel was last modified.
platform	string	The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.
version	integer	The current version of the APNs VoIP channel.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_apns_voip_channel	select	application-id, region		Retrieves information about the status and settings of the APNs VoIP channel for an application.
update_apns_voip_channel	update	application-id, region, APNSVoipChannelRequest		Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
delete_apns_voip_channel	delete	application-id, region		Disables the APNs VoIP 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_apns_voip_channel

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

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

UPDATE examples

update_apns_voip_channel

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

UPDATE aws.pinpoint.apns_voip_channels
SET 
APNSVoipChannelRequest = '{{ APNSVoipChannelRequest }}'
WHERE 
`application-id` = '{{ application-id }}' --required
AND region = '{{ region }}' --required
AND APNSVoipChannelRequest = '{{ APNSVoipChannelRequest }}' --required
RETURNING
apns_voip_channel_response;

DELETE examples

delete_apns_voip_channel

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

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