Amazon SES - Create session
Declaration
<AMAWSSES ACTIVITY="create_session" 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" />
Description: Creates a unique session in which to attach subsequent SES activities. This allows a single task the ability to execute multiple SES operations.
Practical Usage
Used to create and start a new AWS SES session.To end a session use the End session activity.
Credentials Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Access Key |
Text |
Yes |
(Empty) |
ACCESSKEY="[accessKey]" |
The ID that uniquely identifies the owner of the AWS service account (similar to a username). Together, the Access Key and Secret Access Key are the main credentials used to access and control basic AWS services through the API. |
Secret Access Key |
Text |
Yes |
(Empty) |
SECRETKEY="[SecretKey]" |
The secret ID that corresponds with the Access Key (similar to a password). When a request is sent, AWS verifies that this key corresponds with the Access Key to authenticate the signature and confirm that the request sender is legitimate. |
Session |
Text |
Yes |
SESSession1 |
SESSION="mySession" |
The name of the session to create. Several SES activities can be linked to this session, eliminating redundancy. Numerous sessions can exist within a single task providing efficiency. The default value for this parameter is 'SESSession1'. |
Advanced Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
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="7" |
The amount of times this activity should retry the request before returning an error. Network components can generate errors anywhere in the life of a given request, thus, applying retries can increase the likelihood that a request will complete successfully. |
Service URL |
Text |
No |
(Empty) |
SERVICEURL="https://email.us-east-1.amazonaws.com" |
The URL that specifies the service region endpoint. To make the service call to a different region, simply specify the region-specific endpoint (e.g., https://email.us-east-1.amazonaws.com). Available SES endpoints are listed 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 is used by the proxy server for client connections. |
Proxy username |
Text |
No |
(Empty) |
PROXYUSERNAME="Username" |
The username to authenticate with the proxy server. |
Proxy password |
Text |
No |
(Empty) |
PROXYPWD="encrypted" |
The password to authenticate with the proxy server. |
Signature method |
Text |
No |
(Empty) |
|
The algorithm for signature calculation (e.g., HmacSHA256 orHmacSHA1). |
Signature version |
Number |
No |
(Empty) |
SIGNVERSION="2" |
The signature version to use in to sign the request. Set this to the value that is recommended for your service. |
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.
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" />