Amazon SES - List identities

Declaration

<AMAWSSES 
		 ACTIVITY="list_identities" ACCESSKEY="text" 
		 SECRETKEY="text (encrypted)" USERAGENT="text" 
		 MAXERRORRETRY="number" SERVICEURL="text" PROXYHOST="text" 
		 PROXYPORT="number" PROXYUSER="text" PROXYPWD="text 
		 (encrypted)" SIGNMETHOD="text" SIGNVERSION="number" 
		 RESULTDATSET="text" />

Description: Retrieves a list containing all of the identities (e-mail addresses and domains) for a specific AWS account, regardless of verification status, and populates a dataset with the results

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

Practical Usage

Can be used to retrieve a list of identities in which to loop through with the use of a Loop Dataset activity. During the loop process, specific activities can be performed one at a time on each identity found on the list. An If activity can be used within a Loop/End Loop process to add further intelligence to the task. For example, you can use the Verify identity activity to determine which identities are in the list are invalid and use the Delete identity activity to delete unidentified or invalid identities.

Parameters

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 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 session-based	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 host-based	(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 host-based	(Empty)	SECRETKEY= "kWcrlUX5JEDGM/LtmEENI/ aVmYvHNif5zB+d9+ct"	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 retry 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 SES Endpoints and Regions.
Proxy host	Text	No	(Empty)	PROXYHOST="proxy.host.com"	The host name (e.g., server.domain.com) or IP address (e.g., xxx.xxx.xxx.xxx) of the proxy server to use when connecting to AWS.
Proxy port	Number	No	(Empty)	PROXYPORT="1028"	The port that should be used to connect to the proxy server.
Proxy username	Text	No	(Empty)	PROXYUSER="username"	The username that should be used to authenticate connection with the proxy server (if required).
Proxy password	Text	No	(Empty)	PROXYPWD="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.

Identity

Property	Type	Required	Default	Markup	Description
Create and populate dataset with identity information	Text	Yes	(Empty)	RESULTDATASET="identitydata"	The name of the dataset to create and populate with information identity names and types. For more details, see Datasets below.

Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.

Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)

On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)

SES Endpoints and Regions

To see the current list of SES service endpoints and region, please refer to the AWS documentation at https://docs.aws.amazon.com/general/latest/gr/ses.html.

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 a dataset with the following fields (rows):

Name	Type	Return Value
theDataset.Identity	Text	The identity (e.g., recipient@domain.com).
theDataset.Type	Text	The type of identity currently listed. Possible values are 'EmailAddress' and 'Domain'.

Example

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description: This task populates a dataset with a list of identities. The dataset is looped and within each iteration, the current identity is verified.

<!--Create AWS SES session "SESVerify". Access key is "AKIAJ25JAKOPAC7GSQ7A".-->
<AMAWSSES ACTIVITY="create_session" 
SESSION="SESVerify" ACCESSKEY="AKIAJ25JAKOPAC7GSQ7A" 
SECRETKEY="AM3i6P77pVEBOw=aME" />
<!-- List identity information into dataset 
"IDList". Session is "SESVerify". -->
<AMAWSSES ACTIVITY="list_identities" 
PROVIDER="session_based" SESSION="SESVerify" 
RESULTDATSET="IDList" />
<!-- Loop through dataset "IDList".-->
<AMLOOP ACTIVITY="dataset" DATASET="IDList">
<!-- If "%IDList.Type%  = EmailAddress", then... -->
<AMIF EXPRESSION="%IDList.Type% = EmailAddress">
<!--Verify identity "%IDList.Identity%" of type EmailAddress. 
Session is "SESVerify". -->
<AMAWSSES 
ACTIVITY="verify_identity" PROVIDER="session_based" 
SESSION="SESVerify" IDENTITY="%IDList.Identity%" />
<!-- End if. -->
</AMIF>
<!-- End loop. -->
</AMLOOP>
<!-- End AWS SES session "SESVerify". -->
<AMAWSSES ACTIVITY="end_session" SESSION="SESVerify" />

Copyright © Fortra, LLC and its group of companies.
All trademarks and registered trademarks are the property of their respective owners.
v10 | 202212080228 | December 2022