Logging Amazon SES API calls with AWS CloudTrail - Amazon Simple Email Service

Logging Amazon SES API calls with AWS CloudTrail

Amazon SES is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Amazon SES. CloudTrail captures API calls for Amazon SES as events. The calls captured include calls from the Amazon SES console and code calls to the Amazon SES API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Amazon SES. If you don't configure a trail, you can still view the most recent events in the CloudTrail console in Event history. Using the information collected by CloudTrail, you can determine the request that was made to Amazon SES, the IP address from which the request was made, who made the request, when it was made, and additional details.

To learn more about CloudTrail, including how to configure and enable it, see the AWS CloudTrail User Guide.

Amazon SES Information in CloudTrail

CloudTrail is enabled on your AWS account when you create the account. When supported event activity occurs in Amazon SES, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your AWS account. For more information, see Viewing Events with CloudTrail Event History.

For an ongoing record of events in your AWS account, including events for Amazon SES, create a trail. A trail enables CloudTrail to deliver log files to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all AWS Regions. The trail logs events from all Regions in the AWS partition and delivers the log files to the Amazon S3 bucket that you specify. Additionally, you can configure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following:

Amazon SES supports logging of all the actions listed in the SES API Reference and SES API v2 Reference as events in CloudTrail log files, except for those listed in the note box below:

Note

Amazon SES delivers management events to CloudTrail. Management events include actions that are related to creating and managing resources within your AWS account. In Amazon SES, management events include actions such as creating and deleting identities or receipt rules.

Management events are different from data events. Data events are events that are related to accessing and interacting with data within your AWS account. In Amazon SES, data events include actions such as sending emails.

Because Amazon SES only delivers management events to CloudTrail, the following events aren't recorded in CloudTrail:

  • SendEmail

  • SendRawEmail

  • SendTemplatedEmail

  • SendBulkTemplatedEmail

You can use event publishing to record events related to email sending. For more information, see Monitor email sending using Amazon SES event publishing.

Every event or log entry contains information about who generated the request. The identity information helps you determine the following:

  • Whether the request was made with root or AWS Identity and Access Management (IAM) user credentials.

  • Whether the request was made with temporary security credentials for a role or federated user.

  • Whether the request was made by another AWS service.

For more information, see the CloudTrail userIdentity Element.

Example: Amazon SES Log File Entries

A trail is a configuration that enables delivery of events as log files to an Amazon S3 bucket that you specify. CloudTrail log files contain one or more log entries. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. CloudTrail log files aren't an ordered stack trace of the public API calls, so they don't appear in any specific order.

The following example shows a CloudTrail log entry that demonstrates the DeleteIdentity and VerifyEmailIdentity actions.

{ "Records":[ { "awsRegion":"us-west-2", "eventID":"0ffa308d-1467-4259-8be3-c749753be325", "eventName":"DeleteIdentity", "eventSource":"ses.amazonaws.com", "eventTime":"2018-02-02T21:34:50Z", "eventType":"AwsApiCall", "eventVersion":"1.02", "recipientAccountId":"111122223333", "requestID":"50b87bfe-ab23-11e4-9106-5b36376f9d12", "requestParameters":{ "identity":"amazon.com" }, "responseElements":null, "sourceIPAddress":"192.0.2.0", "userAgent":"aws-sdk-java/unknown-version", "userIdentity":{ "accessKeyId":"AKIAIOSFODNN7EXAMPLE", "accountId":"111122223333", "arn":"arn:aws:iam::111122223333:root", "principalId":"111122223333", "type":"Root" } }, { "awsRegion":"us-west-2", "eventID":"5613b0ff-d6c6-4526-9b53-a603a9231725", "eventName":"VerifyEmailIdentity", "eventSource":"ses.amazonaws.com", "eventTime":"2018-02-04T01:05:33Z", "eventType":"AwsApiCall", "eventVersion":"1.02", "recipientAccountId":"111122223333", "requestID":"eb2ff803-ac09-11e4-8ff5-a56a3119e253", "requestParameters":{ "emailAddress":"sender@example.com" }, "responseElements":null, "sourceIPAddress":"192.0.2.0", "userAgent":"aws-sdk-java/unknown-version", "userIdentity":{ "accessKeyId":"AKIAIOSFODNN7EXAMPLE", "accountId":"111122223333", "arn":"arn:aws:iam::111122223333:root", "principalId":"111122223333", "type":"Root" } } ] }