Amazon Kinesis Data Analytics for SQL Applications Developer Guide
SQL Developer Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Logging Kinesis Data Analytics API Calls with AWS CloudTrail

Amazon Kinesis Data Analytics is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Kinesis Data Analytics. CloudTrail captures all API calls for Kinesis Data Analytics as events. The calls captured include calls from the Kinesis Data Analytics console and code calls to the Kinesis Data Analytics API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Kinesis Data Analytics. 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 Kinesis Data Analytics, 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, see the AWS CloudTrail User Guide.

Kinesis Data Analytics Information in CloudTrail

CloudTrail is enabled on your AWS account when you create the account. When activity occurs in Kinesis Data Analytics, 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 Kinesis Data Analytics, 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:

All Kinesis Data Analytics actions are logged by CloudTrail and are documented in the Kinesis Data Analytics API reference. For example, calls to the CreateApplication and UpdateApplication 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 AWS 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 AWS service.

For more information, see the CloudTrail userIdentity Element.

Understanding Kinesis Data Analytics 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 AddApplicationCloudWatchLoggingOption and DescribeApplication actions.

{ "Records": [ { "eventVersion": "1.05", "userIdentity": { "type": "IAMUser", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::012345678910:user/Alice", "accountId": "012345678910", "accessKeyId": "EXAMPLE_KEY_ID", "userName": "Alice" }, "eventTime": "2019-03-14T01:03:00Z", "eventSource": "kinesisanalytics.amazonaws.com", "eventName": "AddApplicationCloudWatchLoggingOption", "awsRegion": "us-east-1", "sourceIPAddress": "127.0.0.1", "userAgent": "aws-sdk-java/unknown-version Linux/x.xx", "requestParameters": { "currentApplicationVersionId": 1, "cloudWatchLoggingOption": { "roleARN": "arn:aws:iam::012345678910:role/cloudtrail_test", "logStreamARN": "arn:aws:logs:us-east-1:012345678910:log-group:cloudtrail-test:log-stream:sql-cloudwatch" }, "applicationName": "cloudtrail-test" }, "responseElements": null, "requestID": "e897cd34-45f4-11e9-8912-e52573a36cd9", "eventID": "57fe50e9-c764-47c3-a0aa-d0c271fa1cbb", "eventType": "AwsApiCall", "apiVersion": "2015-08-14", "recipientAccountId": "303967445486" }, { "eventVersion": "1.05", "userIdentity": { "type": "IAMUser", "principalId": "EX_PRINCIPAL_ID", "arn": "arn:aws:iam::012345678910:user/Alice", "accountId": "012345678910", "accessKeyId": "EXAMPLE_KEY_ID", "userName": "Alice" }, "eventTime": "2019-03-14T05:37:20Z", "eventSource": "kinesisanalytics.amazonaws.com", "eventName": "DescribeApplication", "awsRegion": "us-east-1", "sourceIPAddress": "127.0.0.1", "userAgent": "aws-sdk-java/unknown-version Linux/x.xx", "requestParameters": { "applicationName": "cloudtrail-test" }, "responseElements": null, "requestID": "3b74eb29-461b-11e9-a645-fb677e53d147", "eventID": "750d0def-17b6-4c20-ba45-06d9d45e87ee", "eventType": "AwsApiCall", "apiVersion": "2015-08-14", "recipientAccountId": "012345678910" } ] }