sms_channels

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

Overview

Name	sms_channels
Type	Resource
Id	aws.pinpoint.sms_channels

Fields

The following fields are returned by SELECT queries:

get_sms_channel

Name	Datatype	Description
application_id	string	The unique identifier for the application that the SMS channel applies to.
creation_date	string	The date and time, in ISO 8601 format, when the SMS channel was enabled.
enabled	boolean	Specifies whether the SMS 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 SMS channel. This property is retained only for backward compatibility.
is_archived	boolean	Specifies whether the SMS channel is archived.
last_modified_by	string	The user who last modified the SMS channel.
last_modified_date	string	The date and time, in ISO 8601 format, when the SMS channel was last modified.
platform	string	The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
promotional_messages_per_second	integer	The maximum number of promotional messages that you can send through the SMS channel each second.
sender_id	string	The identity that displays on recipients' devices when they receive messages from the SMS channel.
short_code	string	The registered short code to use when you send messages through the SMS channel.
transactional_messages_per_second	integer	The maximum number of transactional messages that you can send through the SMS channel each second.
version	integer	The current version of the SMS channel.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sms_channel	select	application-id, region		Retrieves information about the status and settings of the SMS channel for an application.
update_sms_channel	update	application-id, region, SMSChannelRequest		Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
delete_sms_channel	delete	application-id, region		Disables the SMS 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_sms_channel

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

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

UPDATE examples

update_sms_channel

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

UPDATE aws.pinpoint.sms_channels
SET 
SMSChannelRequest = '{{ SMSChannelRequest }}'
WHERE 
`application-id` = '{{ application-id }}' --required
AND region = '{{ region }}' --required
AND SMSChannelRequest = '{{ SMSChannelRequest }}' --required
RETURNING
sms_channel_response;

DELETE examples

delete_sms_channel

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

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