Logging Amazon Comprehend API calls with AWS CloudTrail

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

CloudTrail is enabled on your AWS account when you create the account. When supported event activity occurs in Amazon Comprehend, 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 Comprehend, 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:

• Overview for creating a trail

• CloudTrail supported services and integrations

• Configuring Amazon SNS notifications for CloudTrail

• Receiving CloudTrail log files from multiple regions and Receiving CloudTrail log files from multiple accounts

Amazon Comprehend supports logging the following actions as events in CloudTrail log files:

• BatchDetectDominantLanguage

• BatchDetectEntities

• BatchDetectKeyPhrases

• BatchDetectSentiment

• BatchDetectSyntax

• ClassifyDocument

• CreateDocumentClassifier

• CreateEndpoint

• CreateEntityRecognizer

• DeleteDocumentClassifier

• DeleteEndpoint

• DeleteEntityRecognizer

• DescribeDocumentClassificationJob

• DescribeDocumentClassifier

• DescribeDominantLanguageDetectionJob

• DescribeEndpoint

• DescribeEntitiesDetectionJob

• DescribeEntityRecognizer

• DescribeKeyPhrasesDetectionJob

• DescribePiiEntitiesDetectionJob

• DescribeSentimentDetectionJob

• DescribeTargetedSentimentDetectionJob

• DescribeTopicsDetectionJob

• DetectDominantLanguage

• DetectEntities

• DetectKeyPhrases

• DetectPiiEntities

• DetectSentiment

• DetectSyntax

• ListDocumentClassificationJobs

• ListDocumentClassifiers

• ListDominantLanguageDetectionJobs

• ListEndpoints

• ListEntitiesDetectionJobs

• ListEntityRecognizers

• ListKeyPhrasesDetectionJobs

• ListPiiEntitiesDetectionJobs

• ListSentimentDetectionJobs

• ListTargetedSentimentDetectionJobs

• ListTagsForResource

• ListTopicsDetectionJobs

• StartDocumentClassificationJob

• StartDominantLanguageDetectionJob

• StartEntitiesDetectionJob

• StartKeyPhrasesDetectionJob

• StartPiiEntitiesDetectionJob

• StartSentimentDetectionJob

• StartTargetedSentimentDetectionJob

• StartTopicsDetectionJob

• StopDominantLanguageDetectionJob

• StopEntitiesDetectionJob

• StopKeyPhrasesDetectionJob

• StopPiiEntitiesDetectionJob

• StopSentimentDetectionJob

• StopTargetedSentimentDetectionJob

• StopTrainingDocumentClassifier

• StopTrainingEntityRecognizer

• TagResource

• UntagResource

• UpdateEndpoint

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

Example: Amazon Comprehend 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 ClassifyDocument action.

{
    "eventVersion": "1.08",
    "userIdentity": {
        "type": "IAMUser",
        "principalId": "AROAICFHPEXAMPLE",
        "arn": "arn:aws:iam::12345678910:user/myadmin2",
        "accountId": "12345678910",
        "accessKeyId": "ASIA3VZEXAMPLE",
        "sessionContext": {
            "sessionIssuer": {},
            "webIdFederationData": {},
            "attributes": {
                "creationDate": "2023-10-19T14:22:09Z",
                "mfaAuthenticated": "false"
            }
        }
    },
    "eventTime": "2023-10-19T17:31:20Z",
    "eventSource": "comprehend.amazonaws.com",
    "eventName": "ClassifyDocument",
    "awsRegion": "us-east-2",
    "sourceIPAddress": "3.21.185.237",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/115.0",
    "requestParameters": null,
    "responseElements": null,
    "requestID": "fd916e66-caac-46c9-a1fc-81a0ef33e61b",
    "eventID": "535ca22b-b3a3-4c13-b2c5-bf51ab082794",
    "readOnly": false,
    "resources": [
        {
            "accountId": "12345678910",
            "type": "AWS::Comprehend::DocumentClassifierEndpoint",
            "ARN": "arn:aws:comprehend:us-east-2:12345678910:document-classifier-endpoint/endpointExample"
        }
    ],
    "eventType": "AwsApiCall",
    "recipientAccountId": "12345678910"
}