Send an Email using the SES API
Use Site24x7's IT automation framework to send alert notification mails to verified email addresses using Amazon SES in response to threshold violation events or monitor status change events.
Prerequisite
- You must have enabled the Amazon SES integration.
- You must have active monitored SES endpoint(s) in your Site24x7 subscription account.
Required permissions
Site24x7 uses the Amazon Simple Email Email Service Email Service API to send email via SES. Please make sure the following write-level action(s) are present in the IAM policy JSON assigned to the Site24x7 entity (IAM user or IAM Role)
- "ses:SendEmail" : Site24x7 will compose an email based on input data and immediately queues it for sending.
- "ses:SendTemplatedEmail" : Site24x7 will compose and email using the specified email template and immediately queues it for sending.
Create action profile to send formatted email
- Open the Site24x7 web console. Choose Admin from the left navigation pane.
- Choose IT Automation templates.
- Click on the menu dropdown. Choose SES-Send Email from the list as Type.
- For Display Name, type in an appropriate name for easier identification.
- For Actions to be performed, click on the menu dropdown and choose Send Formatted Email.
- For SES Endpoint(s), choose the (HTTPS) endpoint for the Amazon SES API.
- For Identities, choose the email address or domain that you want to send mail with.
- For Recipient Address, choose from a list of verified "To" addresses from the menu dropdown to configure destination for this email.
- For Configuration Set Name, type in the name of the configuration set you want to use when we send the email.
- For Subject, type in a summary of the message topic.
- For Message, type in the email body. You may key $ to find all available tags and customize your message. Learn more about incident and custom parameters.
- For Max Allowed Action Execution Time, type the maximum number of seconds Site24x7 has to wait before the request times out. You can enter a value within the range 1- 90 seconds.
- For Send the Automation Result via Email, switch the toggle to Yes to receive an email regarding the automation result. Share automation results via an email to your User Alert Group configured in the Notification Profile. This email will contain parameters including the automation name, type of automation, incident reason, destination hosts, and more.
- Save the profile
Create action profile to send template email
- Open the Site24x7 web console. Choose Admin from the left navigation pane.
- Choose IT Automation templates.
- Click on the menu dropdown. Choose SES-Send Email from the list as Type.
- For Display Name, type in an appropriate name for easier identification.
- For Actions to be performed, click on the menu dropdown and choose Send Temple Email.
- For Identities, choose the email address or domain that you want to send mail with.
- For Recipient Address, choose from a list of verified "To" addresses from the menu dropdown to configure destination for this email.
- For Configuration Set Name, type in the name of the configuration set you want to use when we send the email.
- Type in the name of the template to use when sending the mail.
- Configure the list of tags in the form of name/value pairs to apply to the email.
- For Max Allowed Action Execution Time, type the maximum number of seconds Site24x7 has to wait before the request times out. You can enter a value within the range 1- 90 seconds.
- For Send the Automation Result via Email, switch the toggle to Yes to receive an email regarding the automation result. Share automation results via an email to your User Alert Group configured in the Notification Profile. This email will contain parameters including the automation name, type of automation, incident reason, destination hosts, and more.
- Save the profile.
Simulate the Automation
You can test the functionality of the action profile by using the Site24x7 console or our REST APIs. To manually execute a test run, go to the IT Automation summary page and click on the (play) button adjacent to the listed action profile.
Map the Automation
To automatically execute the action profile, map it to any desired alert event. You can either map the profile to a monitor level event (Up, Down or Trouble) or to a performance metric.
Monitor level mapping
To map the action profile to a monitor level event navigate to the edit section of the resource. For example, if you want to assign the profile to an RDS instance follow the steps mentioned below:
- Choose AWS from the left navigation pane. Choose the monitored AWS account, and choose RDS instance from the menu drop-down.
- Click on the hamburger icon and choose Edit.
- Under Configuration Profiles, choose IT Automation.
- Select the SES send email action profile that you just created from the menu drop-down and select an appropriate monitor status change event.
- Choose Save.
Attribute level mapping
To map the action profile to a performance metric navigate to the Edit threshold page of the resource. For example, if you want to assign the action profile to the CPU usage metric (EC2 instance) follow the steps mentioned below:
- Choose AWS from the left navigation pane. Choose the monitored AWS account.
- Choose EC2 instances from the menu drop-down. Click on the hamburger icon and choose Edit.
- Under Configuration Profiles, choose the pencil icon next to the Threshold and Availability profile name.
- Map the action profile to any desired metric by clicking on "Select Automation to Execute".
- Choose Save.
Use case
You can automatically trigger an email message with additional information via Amazon SES to your operations team when a metric crosses the usage threshold to help them better address incidents quickly and effectively.