Logging Amazon Serverless Application Repository API Calls with Amazon CloudTrail - Amazon Serverless Application Repository
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Logging Amazon Serverless Application Repository API Calls with Amazon CloudTrail

Amazon Serverless Application Repository is integrated with Amazon CloudTrail, which is a service that provides a record of actions taken by a user, role, or an Amazon service in the Amazon Serverless Application Repository. CloudTrail captures all API calls for the Amazon Serverless Application Repository as events. The calls captured include calls from the Amazon Serverless Application Repository console and code calls to the Amazon Serverless Application Repository API operations.

If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for the Amazon Serverless Application Repository. 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 the Amazon Serverless Application Repository. You can also determine the IP address from which the request was made, who made the request, when the request was made, and additional details.

To learn more about CloudTrail, see the Amazon CloudTrail User Guide.

Amazon Serverless Application Repository Information in CloudTrail

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

For an ongoing record of events in your Amazon account, including events for the Amazon Serverless Application Repository, 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 Amazon Regions. The trail logs events from all Amazon Regions in the Amazon partition and delivers the log files to the Amazon S3 bucket that you specify. Additionally, you can configure other Amazon services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following:

All Amazon Serverless Application Repository actions are logged by CloudTrail and are documented on the Amazon Serverless Application Repository Resources page. For example, calls to the CreateApplication, UpdateApplications, and ListApplications operations 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 Amazon 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 Amazon service.

For more information, see the CloudTrail userIdentity Element.

Understanding Amazon Serverless Application Repository 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 CreateApplication action.

{ "eventVersion": "1.05", "userIdentity": { "type": "Root", "principalId": "999999999999", "arn": "arn:aws:iam::999999999999:root", "accountId": "999999999999", "accessKeyId": "ASIAUVPLBDH76HEXAMPLE", "sessionContext": { "attributes": { "mfaAuthenticated": "false", "creationDate": "2018-07-30T16:40:42Z" } }, "invokedBy": "signin.amazonaws.com" }, "eventTime": "2018-07-30T17:37:37Z", "eventSource": "serverlessrepo.amazonaws.com", "eventName": "CreateApplication", "awsRegion": "us-east-1", "sourceIPAddress": "72.21.217.161", "userAgent": "signin.amazonaws.com", "requestParameters": { "licenseBody": "<content of license>", "sourceCodeUrl": "<sample url>", "spdxLicenseId": "<sample license id>", "readmeBody": "<content of readme>", "author": "<author name>", "templateBody": "<content of SAM template>", "name": "<application name>", "semanticVersion": "<version>", "description": "<content of description>", "homePageUrl": "<sample url>", "labels": [ "<label1>", "<label2>" ] }, "responseElements": { "licenseUrl": "<url to access content of license>", "readmeUrl": "<url to access content of readme>", "spdxLicenseId": "<sample license id>", "creationTime": "2018-07-30T17:37:37.045Z", "author": "<author name>", "name": "<application name>", "description": "<content of description>", "applicationId": "arn:aws:serverlessrepo:us-east-1:999999999999:applications/<application name>", "homePageUrl": "<sample url>", "version": { "applicationId": "arn:aws:serverlessrepo:us-east-1:999999999999:applications/<application name>", "semanticVersion": "<version>", "sourceCodeUrl": "<sample url>", "templateUrl": "<url to access content of SAM template>", "creationTime": "2018-07-30T17:37:37.027Z", "parameterDefinitions": [ { "name": "<parameter name>", "description": "<parameter description>", "type": "<parameter type>" } ] }, "labels": [ "<label1>", "<label2>" ] }, "requestID": "3f50d899-941f-11e8-ab18-01063f863be5", "eventID": "a66a6490-d388-4a4f-8c7b-9d6ec61ab262", "readOnly": false, "eventType": "AwsApiCall", "recipientAccountId": "999999999999" }