email_channels

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

Overview

Name	email_channels
Type	Resource
Id	aws.pinpoint.email_channels

Fields

The following fields are returned by SELECT queries:

get_email_channel

Name	Datatype	Description
application_id	string	The unique identifier for the application that the email channel applies to.
configuration_set	string	The Amazon SES configuration set that's applied to messages that are sent through the channel.
creation_date	string	The date and time, in ISO 8601 format, when the email channel was enabled.
enabled	boolean	Specifies whether the email channel is enabled for the application.
from_address	string	The verified email address that email is sent from when you send email through the channel.
has_credential	boolean	(Not used) This property is retained only for backward compatibility.
id	string	(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
identity	string	The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.
is_archived	boolean	Specifies whether the email channel is archived.
last_modified_by	string	The user who last modified the email channel.
last_modified_date	string	The date and time, in ISO 8601 format, when the email channel was last modified.
messages_per_second	integer	The maximum number of emails that can be sent through the channel each second.
orchestration_sending_role_arn	string	The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES.
platform	string	The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
role_arn	string	The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
version	integer	The current version of the email channel.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_email_channel	select	application-id, region		Retrieves information about the status and settings of the email channel for an application.
update_email_channel	update	application-id, region, EmailChannelRequest		Enables the email channel for an application or updates the status and settings of the email channel for an application.
delete_email_channel	delete	application-id, region		Disables the email 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_email_channel

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

SELECT
application_id,
configuration_set,
creation_date,
enabled,
from_address,
has_credential,
id,
identity,
is_archived,
last_modified_by,
last_modified_date,
messages_per_second,
orchestration_sending_role_arn,
platform,
role_arn,
version
FROM aws.pinpoint.email_channels
WHERE `application-id` = '{{ application-id }}' -- required
AND region = '{{ region }}' -- required
;

UPDATE examples

update_email_channel

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

UPDATE aws.pinpoint.email_channels
SET 
EmailChannelRequest = '{{ EmailChannelRequest }}'
WHERE 
`application-id` = '{{ application-id }}' --required
AND region = '{{ region }}' --required
AND EmailChannelRequest = '{{ EmailChannelRequest }}' --required
RETURNING
email_channel_response;

DELETE examples

delete_email_channel

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

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