Menu
Amazon WorkMail
Administrator Guide (Version 1.0)

Logging Amazon WorkMail API Calls with AWS CloudTrail

Amazon WorkMail is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, Amazon CloudWatch Logs, and Amazon CloudWatch Events. Using the information collected by CloudTrail, you can determine the request that was made to Amazon WorkMail, the IP address from which the request was made, who made the request, when it was made, and additional details.

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

Amazon WorkMail Information in CloudTrail

All Amazon WorkMail actions are logged by CloudTrail and are documented in the Amazon WorkMail API Reference. For example, calls to the ListUsers, RegisterToWorkMail and DescribeGroup APIs generate entries in the CloudTrail log files.

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

You can also create a trail and store your log files in your Amazon S3 bucket for as long as needed, and define Amazon S3 lifecycle rules to archive or delete log files automatically. By default, your log files are encrypted with Amazon S3 server-side encryption (SSE).

To be notified of log file delivery, configure CloudTrail to publish Amazon SNS notifications when new log files are delivered. For more information, see Configuring Amazon SNS Notifications for CloudTrail.

You can also aggregate Amazon WorkMail log files from multiple AWS Regions and multiple AWS accounts into a single Amazon S3 bucket.

For more information, see Receiving CloudTrail Log Files from Multiple Regions and Receiving CloudTrail Log Files from Multiple Accounts.

Understanding Amazon WorkMail 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 are not an ordered stack trace of the public API calls, so they do not appear in any specific order.

The following example shows a CloudTrail log entry that demonstrates the CreateUser action.

{ "eventVersion": "1.05", "userIdentity": { "type": "IAMUser", "principalId": "AIDACKCEVSQ6C2EXAMPLE", "arn": "arn:aws:iam::111111111111:user/WMSDK", "accountId": "111111111111", "accessKeyId": "AKIAIOSFODNN7EXAMPLE" "userName": "WMSDK" }, "eventTime": "2017-12-12T17:49:59Z", "eventSource": "workmail.amazonaws.com", "eventName": "CreateUser", "awsRegion": "us-west-2", "sourceIPAddress": "203.0.113.12", "userAgent": "aws-sdk-java/1.11.205 Mac_OS_X/10.11.6 Java_HotSpot(TM)_64-Bit_Server_VM/25.151-b12 java/1.8.0_151", "requestParameters": { "name": "janedoe", "displayName": "Jane Doe", "organizationId": "m-5b1c980000EXAMPLE" }, "responseElements": { "userId": "a3a9176d-EXAMPLE" }, "requestID": "dec81e4a-EXAMPLE", "eventID": "9f2f09c5-EXAMPLE", "eventType": "AwsApiCall", "recipientAccountId": "111111111111" }

The following example shows a CloudTrail log entry that demonstrates the CreateAlias action.

{ "eventVersion": "1.05", "userIdentity": { "type": "IAMUser", "principalId": "AIDACKCEVSQ6C2EXAMPLE", "arn": "arn:aws:iam::111111111111:user/WMSDK", "accountId": "111111111111", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "userName": "WMSDK" }, "eventTime": "2017-12-12T18:13:44Z", "eventSource": "workmail.amazonaws.com", "eventName": "CreateAlias", "awsRegion": "us-west-2", "sourceIPAddress": "203.0.113.12", "userAgent": "aws-sdk-java/1.11.205 Mac_OS_X/10.11.6 Java_HotSpot(TM)_64-Bit_Server_VM/25.151-b12 java/1.8.0_151", "requestParameters": { "alias": "aliasjamesdoe@testofconsole.awsapps.com", "organizationId": "m-5b1c980000EXAMPLE" "entityId": "a3a9176d-EXAMPLE" }, "responseElements": null, "requestID": "dec81e4a-EXAMPLE", "eventID": "9f2f09c5-EXAMPLE", "eventType": "AwsApiCall", "recipientAccountId": "111111111111" }