Amazon SES - Send email statistics

Declaration

<AMAWSSES ACTIVITY="email_statistics" PROVIDER="session_based" SESSION="text" ACCESSKEY="text" SECRETKEY="text (encrypted)" USERAGENT="text" MAXERRORRETRY="number" SERVICEURL="text" PROXYHOST="text" PROXYPORT="number" PROXYUSER="text" PROXYPWD="text (encrypted)" SIGNMETHOD="text" SIGNVERSION="number" RESULTDATASET="text" STATISTICSDATASET="text" />

Related Topics    

Description

Retrieves a user's sending statistics and usage data. Results are populated into separate datasets.

IMPORTANT: The Amazon SES activities are performed using Amazon's Simple Email Service engine, therefore, launching and operating Amazon SES through Automate requires a valid Access Key ID and Secret Access Key.

Practical Usage

Commonly used to retrieve activity data.

Parameters

Connection

Property Type Required Default Markup Description
Connection --- --- --- --- Indicates where Amazon Web Service user credentials and preferences should originate from. This is a design mode parameter used only during task construction and configuration, thus, comprises no markup. The available options are:
  • Host (default) - Specifies that user credentials and/or advanced preferences are configured individually for this activity. This option is normally chosen if only a single activity is required to complete an operation.

  • Session - Specifies that user credentials and/or advanced preferences are obtained from a pre-configured session created in an earlier step with the use of the Amazon SES - Create session activity. This option is normally chosen if a combination of related activities are required to complete an operation. Linking several activities to a single session eliminates redundancy. Additionally, a single task supports construction and simultaneous execution of multiple sessions, improving efficiency.
Session Text Yes, if Connection is set to Session SESSession1 SESSION="SESSession1" The name of an existing session to attach this activity to. This parameter is active only if the Connection parameter is set to Session. The default session name is SESSession1.
Access key Text Yes, if Connection is set to Host (Empty) ACCESSKEY="022QF06E7MXBSH9DHM02" A 20-character alphanumeric string that uniquely identifies the owner of the AWS service account, similar to a username. This key along with a corresponding secret access key forms a secure information set that AWS uses to confirm a valid user's identity. This parameter is active only if the Connection parameter is set to Host.
Secret access key Text Yes, if Connection is set to Host (Empty) SECRETKEY="text (encrypted)" A 40-character string that serves the role as password to access the AWS service account. This along with an associated access key forms a secure information set that EC2 uses to confirm a valid user's identity. This parameter is active only if the Connection parameter is set to Host.
User agent Text No Automate USERAGENT="Automate" The name of the client or application initiating requests to AWS. The default value is Automate. 
Maximum number of retries on error Number No (Empty) MAXERRORRETRY="4" The total amount of times this activity should retry its request to the server before returning an error. Network components can generate errors anytime in the life of a request, thus, implementing retries can increase reliability. 
Service URL Text No (Empty) SERVICEURL="email.us-east-1.amazonaws.com" The URL that provides the service endpoint. A complete list of EC2 regions, accompanying endpoints and valid protocols can be found below under Amazon SES Endpoints and Regions
Proxy host Text No (Empty) PROXYHOST="proxy.host.com" The host name (for example, server.domain.com) or IP address (for example, xxx.xxx.xxx.xxx) of the proxy server to use when connecting to AWS.  
Proxy port Number No (Empty) PROXYPORT="1028" The port to use to connect to the proxy server.
Proxy username Text No (Empty) PROXYUSER="username" The username to authenticate the connection with the proxy server (if required).
Proxy password Text No (Empty) PROXYPWD="text (encrypted)" The password that should be used to authenticate connection with the proxy server (if required).
Signature method Text No (Empty) SIGNMETHOD="HmacSHA256" The signature method to use for signing the request. This provides a valid hashing algorithm for signature calculation. Valid AWS signature methods are HmacSHA1 and HmacSHA256.
Signature version Number No (Empty) SIGNVERSION="2" The signature version for signing the request. Valid AWS signature versions are 2 and 4. The difference with version 4 is that it allows you to sign your message using a key that is derived from your secret access key rather than using the secret access key itself.

Email

Property Type Required Default Markup Description
Create and populate dataset with send email usage information Text Yes (Empty) RESULTDATSET="usageData" The name of the dataset to create and populate with email usage data. This represents the user's current activity limits returned from a successful 'GetSendQuota' request. For more details, see Datasets below.
Create and populate dataset with send email statistics Text Yes (Empty) STATISTICSDATASET="statsData" The name of the dataset to create and populate with email sending statistical data. Each data point contains statistics for a 15 minute period of sending activity. For more details, see Datasets below.

Description

Error Causes

On Error

Additional Notes

Amazon SES Endpoints and Regions

This table contains a complete list of Amazon SES endpoints, along with their corresponding regions and supported protocols.

Endpoint Region Protocol
email.us-east-1.amazonaws.com US East (Northern Virginia) Region HTTPS
email-smtp.us-east-1.amazonaws.com, port 465 US East (Northern Virginia) Region SMTP

Datasets

A dataset is a multi-column, multi-row object that contains a collection of information gathered during runtime and stored in memory. This activity creates and populates two datasets which are specified in the following tables:

Email Usage Statistics

Name Type Return Value
usageDataset.Max24HourSend Number The maximum number of emails the user is allowed to send in a 24-hour interval.
usageDataset.MaxSendRate Number The maximum number of emails the user is allowed to send per second.
usageDataset.SentLast24Hours Number The number of emails sent during the previous 24 hours.

Email Sending Statistics

Name Type Return Value
statsDataset.Bounces Number The number of emails that have bounced.
statsDataset.Complaints Number The number of unwanted emails that were rejected by recipients.
statsDataset.DeliveryAttempts Number The number of emails that have been enqueued for sending.
statsDataset.Rejects Number The number of emails rejected by Amazon SES.
statsDataset.Timestamp Date The date/time of the data point.
 

Example

NOTE:
  • The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
  • Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.

Description

This sample task populates a dataset with sent email usage information.

Copy
<AMAWSSES ACTIVITY="email_statistics" ACCESSKEY="AKIAJ25JAKOPAC7GSQ7A" SECRETKEY="AM3i6P77pVEBOw=aME" RESULTDATSET="usageData" STATISTICSDATASET="sendStats" />