Logging Amazon Server Migration Service API calls using Amazon CloudTrail - Amazon Server Migration Service
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.

Product update

We recommend Amazon Application Migration Service (Amazon MGN) as the primary migration service for lift-and-shift migrations. If Amazon MGN is unavailable in a specific Amazon Region, you can use the Amazon SMS APIs through March 2023.

Logging Amazon Server Migration Service API calls using Amazon CloudTrail

Amazon Server Migration Service is integrated with Amazon CloudTrail, a service that provides a record of actions taken by a user, role, or an Amazon service in Amazon SMS. CloudTrail captures all API calls for Amazon SMS as events. The calls captured include code calls to the Amazon SMS API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Amazon SMS. 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 SMS, the IP address from which the request was made, who made the request, when it was made, and additional details.

For more information, see the Amazon CloudTrail User Guide.

Amazon SMS information in CloudTrail

CloudTrail is enabled on your Amazon account when you create the account. When activity occurs in Amazon SMS, 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 Amazon SMS, 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 CloudTrail console, the trail applies to all Amazon Regions. The trail logs events from all 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 SMS actions are logged by CloudTrail and are documented in the Amazon SMS API Reference. For example, calls to the CreateReplicationJob , GetConnectors, and ImportServerCatalog actions 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 SMS 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 CreateReplicationJob action.

{ "eventVersion": "1.05", "userIdentity": { "type": "IAMUser", "principalId": "0123456789abcdef01234", "arn": "arn:aws:iam::0123456789ab:user/sms-user", "accountId": "0123456789ab", "accessKeyId": "0123456789abcdef0123", "userName": "sms-user" }, "eventTime": "2018-09-04T16:34:49Z", "eventSource": "sms.amazonaws.com", "eventName": "CreateReplicationJob", "awsRegion": "us-east-1", "sourceIPAddress": "", "userAgent": "aws-sdk-java/example-sdk-version Linux/example-kernel-version …", "requestParameters": { "roleName": "sms", "serverId": "s-01234567", "runOnce": true, "seedReplicationTime": "Sep 4, 2018 4:36:48 PM" }, "responseElements": { "replicationJobId": "sms-job-012345677" }, "requestID": "00000000-1111-2222-3333-444444444444", "eventID": "55555555-6666-7777-8888-999999999999", "eventType": "AwsApiCall", "recipientAccountId": "0123456789ab" }