Amazon SES - Verify identity

Declaration

<AMAWSSES ACTIVITY="verify_identity" 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" IDENTITYTYPE="text (options)" RESULTVARIABLE="text" />

Related Topics   

Description

Verifies an email address or domain identity. If verification is performed on an email address, a confirmation email message is sent to the specified address. If verification is performed on a domain, a verification token is returned.

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

Mainly used to confirm a proper email address or domain.

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 - Verify identity
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.

Identity

Property Type Required Default Markup Description
Identity type Text (options) Yes Email IDENTITYTYPE="domain" The type of identity to verify. The available options are:

  • Email - Email address verification will be performed.

  • Domain - Domain verification will be performed.
Identity Text Yes (Empty) IDENTITY="mm@netauto.com" The identity to verify. If set to an email address, this activity causes a confirmation email message to be sent to the specified address. If set to a domain, a verification token is returned. This TXT record must be placed in the DNS settings for the domain, in order to complete domain verification.
Populate variable with identity token Text Yes (Empty) RESULTVARIABLE="IDtoken" The name of an existing variable to populate with the verification token to be placed in the domain DNS settings in order to complete domain verification. This parameter is active only if the Identity type parameter is set to Domain.

Description

Error Causes

On Error

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 identity information into a dataset. The dataset is then looped and a number of identity related operations are performed. Step by step description is embedded in the task.

Copy 
<!-- Create AWS SES session "SESVerify". Access key is "AKIAJ25JAKOPAC7GSQ7A". -->
<AMAWSSES ACTIVITY="create_session" SESSION="SESVerify" ACCESSKEY="AKIAJ25JAKOPAC7GSQ7A" SECRETKEY="AM3i6P77pVEBOw=aME" />
<!-- List identity information into automate 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" />