# Logging Amazon SageMaker AI API calls using AWS CloudTrail
Amazon SageMaker AI is integrated with [AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html), a service that provides a record of actions taken by a user, role, or an AWS service. CloudTrail captures all API calls for Amazon SageMaker AI as events. The calls captured include calls from the Amazon SageMaker AI console and code calls to the Amazon SageMaker AI API operations. Using the information collected by CloudTrail, you can determine the request that was made to Amazon SageMaker AI, the IP address from which the request was made, when it was made, and additional details.
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 user or user credentials.
+ Whether the request was made on behalf of an IAM Identity Center user.
+ Whether the request was made with temporary security credentials for a role or federated user.
+ Whether the request was made by another AWS service.
CloudTrail is active in your AWS account when you create the account and you automatically have access to the CloudTrail **Event history**. The CloudTrail **Event history** provides a viewable, searchable, downloadable, and immutable record of the past 90 days of recorded management events in an AWS Region. For more information, see [Working with CloudTrail Event history](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html) in the *AWS CloudTrail User Guide*. There are no CloudTrail charges for viewing the **Event history**.
For an ongoing record of events in your AWS account past 90 days, create a trail or a [CloudTrail Lake](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake.html) event data store.
**CloudTrail trails**
A *trail* enables CloudTrail to deliver log files to an Amazon S3 bucket. All trails created using the AWS Management Console are multi-Region. You can create a single-Region or a multi-Region trail by using the AWS CLI. Creating a multi-Region trail is recommended because you capture activity in all AWS Regions in your account. If you create a single-Region trail, you can view only the events logged in the trail's AWS Region. For more information about trails, see [Creating a trail for your AWS account](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html) and [Creating a trail for an organization](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/creating-trail-organization.html) in the *AWS CloudTrail User Guide*.
You can deliver one copy of your ongoing management events to your Amazon S3 bucket at no charge from CloudTrail by creating a trail, however, there are Amazon S3 storage charges. For more information about CloudTrail pricing, see [AWS CloudTrail Pricing](https://aws.amazon.com/cloudtrail/pricing/). For information about Amazon S3 pricing, see [Amazon S3 Pricing](https://aws.amazon.com/s3/pricing/).
**CloudTrail Lake event data stores**
*CloudTrail Lake* lets you run SQL-based queries on your events. CloudTrail Lake converts existing events in row-based JSON format to [ Apache ORC](https://orc.apache.org/) format. ORC is a columnar storage format that is optimized for fast retrieval of data. Events are aggregated into *event data stores*, which are immutable collections of events based on criteria that you select by applying [advanced event selectors](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-concepts.html#adv-event-selectors). The selectors that you apply to an event data store control which events persist and are available for you to query. For more information about CloudTrail Lake, see [Working with AWS CloudTrail Lake](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake.html) in the *AWS CloudTrail User Guide*.
CloudTrail Lake event data stores and queries incur costs. When you create an event data store, you choose the [pricing option](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-manage-costs.html#cloudtrail-lake-manage-costs-pricing-option) you want to use for the event data store. The pricing option determines the cost for ingesting and storing events, and the default and maximum retention period for the event data store. For more information about CloudTrail pricing, see [AWS CloudTrail Pricing](https://aws.amazon.com/cloudtrail/pricing/).
For security purposes, you can monitor CloudTrail logs to identify abnormal user activity. For more information about monitoring logs, see [Logging and Monitoring](sagemaker-incident-response.md).
## Amazon SageMaker AI data events in CloudTrail
[Data events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#logging-data-events) provide information about the resource operations performed on or in a resource (for example, reading or writing to an Amazon S3 object). These are also known as data plane operations. Data events are often high-volume activities. By default, CloudTrail doesn’t log data events. The CloudTrail **Event history** doesn't record data events.
Additional charges apply for data events. For more information about CloudTrail pricing, see [AWS CloudTrail Pricing](https://aws.amazon.com/cloudtrail/pricing/).
You can log data events for various Amazon SageMaker AI resource types by using the CloudTrail console, AWS CLI, or CloudTrail API operations. For more information about how to log data events, see [Logging data events with the AWS Management Console](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#logging-data-events-console) and [Logging data events with the AWS Command Line Interface](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-with-the-AWS-CLI) in the *AWS CloudTrail User Guide*.
The following table lists the Amazon SageMaker AI resource types for which you can log data events. The **Resource type (console)** column shows the value to choose from the **Resource type** list on the CloudTrail console. The **resources.type value** column shows the `resources.type` value, which you would specify when configuring advanced event selectors using the AWS CLI or CloudTrail APIs. The **Data APIs logged to CloudTrail** column shows the API calls logged to CloudTrail for the resource type.
| Resource type (console) | resources.type value | Data APIs logged to CloudTrail |
| --- | --- | --- |
| SageMaker endpoint | AWS::SageMaker::Endpoint | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/sagemaker/latest/dg/logging-using-cloudtrail.html) |
**Note**
The `InvokeEndpoint` and `InvokeEndpointAsync` API calls don't log the request parameters.
You can configure advanced event selectors to filter on the `eventName`, `readOnly`, and `resources.ARN` fields to log only those events that are important to you. For more information about these fields, see [https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedFieldSelector.html](https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedFieldSelector.html) in the *AWS CloudTrail API Reference*.
The following example shows you how to log data events for an Amazon SageMaker endpoint. In this example, you use the [put-event-selectors](https://docs.aws.amazon.com/cli/latest/reference/cloudtrail/put-event-selectors.html) AWS CLI command to add advanced event selectors that capture data events from your endpoint. You should have an existing CloudTrail trail. Before running the command, you can also save the advanced event selectors JSON object in a file like the following:
```
[
{
"FieldSelectors": [
{
"Field": "eventCategory",
"Equals": ["Data"]
},
{
"Field": "resources.ARN",
"Equals": ["arn:aws:sagemaker:us-east-1:111122223333:endpoint/your-inference-endpoint-arn"]
},
{
"Field": "resources.type",
"Equals": ["AWS::SageMaker::Endpoint"]
}
]
}
]
```
Then, you can run the following command to start logging data events from the endpoint.
```
aws cloudtrail put-event-selectors
--trail-name your-trail-name
--advanced-event-selectors=file://advanced-event-selectors.json # specify your previously created JSON file
```
## Amazon SageMaker AI management events in CloudTrail
[Management events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html#logging-management-events) provide information about management operations that are performed on resources in your AWS account. These are also known as control plane operations. By default, CloudTrail logs management events.
Amazon SageMaker AI logs all Amazon SageMaker AI control plane operations as management events. For a list of the Amazon SageMaker AI control plane operations that Amazon SageMaker AI logs to CloudTrail, see the [Amazon SageMaker AI API Reference](https://docs.aws.amazon.com/sagemaker/latest/APIReference).
## Operations Performed by Automatic Model Tuning
SageMaker AI supports logging non-API service events to your CloudTrail log files for automatic model tuning jobs. These events are related to your tuning jobs but, are not the direct result of a customer request to the public AWS API. For example, when you create a hyperparameter tuning job by calling [https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateHyperParameterTuningJob.html), SageMaker AI creates training jobs to evaluate various combinations of hyperparameters to find the best result. Similarly, when you call [https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopHyperParameterTuningJob.html](https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StopHyperParameterTuningJob.html) to stop a hyperparameter tuning job, SageMaker AI might stop any of the associated running training jobs. Non-API events for your tuning jobs are logged to CloudTrail to help you improve governance, compliance, and operational and risk auditing of your AWS account.
Log entries that result from non-API service events have an `eventType` of `AwsServiceEvent` instead of `AwsApiCall`.
## Amazon SageMaker AI event examples
An event represents a single request from any source and includes information about the requested API operation, the date and time of the operation, request parameters, and so on. CloudTrail log files aren't an ordered stack trace of the public API calls, so events don't appear in any specific order.
The following example shows a CloudTrail event that demonstrates the `CreateEndpoint` operation.
```
{
"eventVersion":"1.05",
"userIdentity": {
"type":"IAMUser",
"principalId":"AIXDAYQEXAMPLEUMLYNGL",
"arn":"arn:aws:iam::123456789012:user/intern",
"accountId":"123456789012",
"accessKeyId":"ASXIAGXEXAMPLEQULKNXV",
"userName":"intern"
},
"eventTime":"2018-01-02T13:39:06Z",
"eventSource":"sagemaker.amazonaws.com",
"eventName":"CreateEndpoint",
"awsRegion":"us-west-2",
"sourceIPAddress":"127.0.0.1",
"userAgent":"USER_AGENT",
"requestParameters": {
"endpointName":"ExampleEndpoint",
"endpointConfigName":"ExampleEndpointConfig"
},
"responseElements": {
"endpointArn":"arn:aws:sagemaker:us-west-2:123456789012:endpoint/exampleendpoint"
},
"requestID":"6b1b42b9-EXAMPLE",
"eventID":"a6f85b21-EXAMPLE",
"eventType":"AwsApiCall",
"recipientAccountId":"444455556666"
}
```
The following example shows a CloudTrail event that demonstrates the `CreateModel` operation.
```
{
"eventVersion":"1.05",
"userIdentity": {
"type":"IAMUser",
"principalId":"AIXDAYQEXAMPLEUMLYNGL",
"arn":"arn:aws:iam::123456789012:user/intern",
"accountId":"123456789012",
"accessKeyId":"ASXIAGXEXAMPLEQULKNXV",
"userName":"intern"
},
"eventTime":"2018-01-02T15:23:46Z",
"eventSource":"sagemaker.amazonaws.com",
"eventName":"CreateModel",
"awsRegion":"us-west-2",
"sourceIPAddress":"127.0.0.1",
"userAgent":"USER_AGENT",
"requestParameters": {
"modelName":"ExampleModel",
"primaryContainer": {
"image":"174872318107.dkr.ecr.us-west-2.amazonaws.com/kmeans:latest"
},
"executionRoleArn":"arn:aws:iam::123456789012:role/EXAMPLEARN"
},
"responseElements": {
"modelArn":"arn:aws:sagemaker:us-west-2:123456789012:model/barkinghappy2018-01-02t15-23-32-275z-ivrdog"
},
"requestID":"417b8dab-EXAMPLE",
"eventID":"0f2b3e81-EXAMPLE",
"eventType":"AwsApiCall",
"recipientAccountId":"444455556666"
}
```
For information about CloudTrail record contents, see [CloudTrail record contents](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-record-contents.html) in the *AWS CloudTrail User Guide*.