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 Amazon SES activities. This allows a single task the ability to execute multiple Amazon SES operations.
IMPORTANT: The Amazon SES activities
are performed using Amazon's Simple Email Service engine, therefore,
launching and operating Amazon SES through Automate Desktop requires a
valid Access Key ID and Secret Access Key.
Practical usage
Used to create and start a new Amazon SES session. To end a session use the Amazon SES - End session activity.
Parameters
Credentials
| 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 in order 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
| 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 number of retries 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 (for example, https://email.us-east-1.amazonaws.com). Available SES endpoints are listed below under Amazon SES regions and endpoints |
| Proxy host | Text | No | (Empty) | PROXYHOST="proxy.host.com" | The hostname (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 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 (that is, HmacSHA256 or HmacSHA1). |
| 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. |
Additional notes
Amazon SES regions and endpoints
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 |
Example
NOTE:
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
This sample task populates a dataset with a list of identities. The dataset is looped and within each iteration, the current identity is verified. Once the loop is finished, the session is ended.
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" />