Logging Amazon Pinpoint API calls with AWS CloudTrail
Amazon Pinpoint is integrated with AWS CloudTrail, which is a service that provides a record of actions taken by a user, role, or AWS service in Amazon Pinpoint. CloudTrail captures API calls for Amazon Pinpoint as events. The calls that are captured include calls from the Amazon Pinpoint console and code calls to Amazon Pinpoint API operations.
If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon Simple Storage Service (Amazon S3) bucket, including events for Amazon Pinpoint. If you don't configure a trail, you can still view the most recent events by using Event history on the CloudTrail console. Using the information collected by CloudTrail, you can determine the request that was made to Amazon Pinpoint, the IP address that the request was made from, 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 Pinpoint information in CloudTrail
CloudTrail is enabled on your AWS account when you create the account. When supported event activity occurs in Amazon Pinpoint, 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 Pinpoint, 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:
Every event or log entry contains information about who generated the request. The identity information helps you determine:
-
Whether the request was made with root or AWS Identity and Access Management 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 CloudTrail userIdentity element.
You can create a trail and store your log files in your Amazon S3 bucket for as long as you want. Also, you can 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 Pinpoint 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.
You can use CloudTrail to log actions for the following Amazon Pinpoint APIs:
Amazon Pinpoint API actions that can be logged by CloudTrail
The Amazon Pinpoint API supports logging the following actions as events in CloudTrail log files:
The following Amazon Pinpoint API actions aren't logged in CloudTrail:
-
PutEvents
-
SendMessages
-
SendUsersMessages
Amazon Pinpoint email API actions that can be logged by CloudTrail
The Amazon Pinpoint Email API supports logging the following actions as events in CloudTrail log files:
The following Amazon Pinpoint Email API action isn't logged in CloudTrail:
-
SendEmail
Amazon Pinpoint SMS and voice API version 1 actions that can be logged by CloudTrail
The Amazon Pinpoint SMS and Voice version 1 API supports logging the following actions as events in CloudTrail log files:
The following Amazon Pinpoint SMS and Voice version 1 API action isn't logged in CloudTrail:
-
SendVoiceMessage
Examples: Amazon Pinpoint 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. It 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
GetCampaigns and CreateCampaign actions of the Amazon Pinpoint
API.
{
"Records": [
{
"awsRegion": "us-east-1",
"eventID": "example0-09a3-47d6-a810-c5f9fd2534fe",
"eventName": "GetCampaigns",
"eventSource": "pinpoint.amazonaws.com",
"eventTime": "2018-02-03T00:56:48Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": true,
"recipientAccountId": "123456789012",
"requestID": "example1-b9bb-50fa-abdb-80f274981d60",
"requestParameters": {
"application-id": "example71dfa4c1aab66332a5839798f",
"page-size": "1000"
},
"responseElements": null,
"sourceIPAddress": "192.0.2.0",
"userAgent": "Jersey/${project.version} (HttpUrlConnection 1.8.0_144)",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:root",
"principalId": "123456789012",
"sessionContext": {
"attributes": {
"creationDate": "2018-02-02T16:55:29Z",
"mfaAuthenticated": "false"
}
},
"type": "Root"
}
},
{
"awsRegion": "us-east-1",
"eventID": "example0-09a3-47d6-a810-c5f9fd2534fe",
"eventName": "CreateCampaign",
"eventSource": "pinpoint.amazonaws.com",
"eventTime": "2018-02-03T01:05:16Z",
"eventType": "AwsApiCall",
"eventVersion": "1.05",
"readOnly": false,
"recipientAccountId": "123456789012",
"requestID": "example1-b9bb-50fa-abdb-80f274981d60",
"requestParameters": {
"Description": "***",
"HoldoutPercent": 0,
"IsPaused": false,
"MessageConfiguration": "***",
"Name": "***",
"Schedule": {
"Frequency": "ONCE",
"IsLocalTime": true,
"StartTime": "2018-02-03T00:00:00-08:00",
"Timezone": "utc-08"
},
"SegmentId": "exampleda204adf991a80281aa0e591",
"SegmentVersion": 1,
"application-id": "example71dfa4c1aab66332a5839798f"
},
"responseElements": {
"ApplicationId": "example71dfa4c1aab66332a5839798f",
"CreationDate": "2018-02-03T01:05:16.425Z",
"Description": "***",
"HoldoutPercent": 0,
"Id": "example54a654f80948680cbba240ede",
"IsPaused": false,
"LastModifiedDate": "2018-02-03T01:05:16.425Z",
"MessageConfiguration": "***",
"Name": "***",
"Schedule": {
"Frequency": "ONCE",
"IsLocalTime": true,
"StartTime": "2018-02-03T00:00:00-08:00",
"Timezone": "utc-08"
},
"SegmentId": "example4da204adf991a80281example",
"SegmentVersion": 1,
"State": {
"CampaignStatus": "SCHEDULED"
},
"Version": 1
},
"sourceIPAddress": "192.0.2.0",
"userAgent": "aws-cli/1.14.9 Python/3.4.3 Linux/3.4.0+ botocore/1.8.34",
"userIdentity": {
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"accountId": "123456789012",
"arn": "arn:aws:iam::123456789012:user/userName",
"principalId": "AIDAIHTHRCDA62EXAMPLE",
"type": "IAMUser",
"userName": "userName"
}
}
]
}The following example shows a CloudTrail log entry that demonstrates the
CreateConfigurationSet and
CreateConfigurationSetEventDestination actions in the Amazon Pinpoint SMS and
Voice API.
{
"Records": [
{
"eventVersion":"1.05",
"userIdentity":{
"type":"IAMUser",
"principalId":"AIDAIHTHRCDA62EXAMPLE",
"arn":"arn:aws:iam::111122223333:user/SampleUser",
"accountId":"111122223333",
"accessKeyId":"AKIAIOSFODNN7EXAMPLE",
"userName":"SampleUser"
},
"eventTime":"2018-11-06T21:45:55Z",
"eventSource":"sms-voice.amazonaws.com",
"eventName":"CreateConfigurationSet",
"awsRegion":"us-east-1",
"sourceIPAddress":"192.0.0.1",
"userAgent":"PostmanRuntime/7.3.0",
"requestParameters":{
"ConfigurationSetName":"MyConfigurationSet"
},
"responseElements":null,
"requestID":"56dcc091-e20d-11e8-87d2-9994aexample",
"eventID":"725843fc-8846-41f4-871a-7c52dexample",
"readOnly":false,
"eventType":"AwsApiCall",
"recipientAccountId":"123456789012"
},
{
"eventVersion":"1.05",
"userIdentity":{
"type":"IAMUser",
"principalId":"AIDAIHTHRCDA62EXAMPLE",
"arn":"arn:aws:iam::111122223333:user/SampleUser",
"accountId":"111122223333",
"accessKeyId":"AKIAIOSFODNN7EXAMPLE",
"userName":"SampleUser"
},
"eventTime":"2018-11-06T21:47:08Z",
"eventSource":"sms-voice.amazonaws.com",
"eventName":"CreateConfigurationSetEventDestination",
"awsRegion":"us-east-1",
"sourceIPAddress":"192.0.0.1",
"userAgent":"PostmanRuntime/7.3.0",
"requestParameters":{
"EventDestinationName":"CloudWatchEventDestination",
"ConfigurationSetName":"MyConfigurationSet",
"EventDestination":{
"Enabled":true,
"MatchingEventTypes":[
"INITIATED_CALL",
"INITIATED_CALL"
],
"CloudWatchLogsDestination":{
"IamRoleArn":"arn:aws:iam::111122223333:role/iamrole-01",
"LogGroupArn":"arn:aws:logs:us-east-1:111122223333:log-group:clientloggroup-01"
}
}
},
"responseElements":null,
"requestID":"81de1e73-e20d-11e8-b158-d5536example",
"eventID":"fcafc21f-7c93-4a3f-9e72-fca2dexample",
"readOnly":false,
"eventType":"AwsApiCall",
"recipientAccountId":"111122223333"
}
]
}