Logging Timestream for LiveAnalytics API calls with AWS CloudTrail - Amazon Timestream
Timestream for LiveAnalytics information in CloudTrail

Logging Timestream for LiveAnalytics API calls with AWS CloudTrail

Timestream for LiveAnalytics is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Timestream for LiveAnalytics. CloudTrail captures Data Definition Language (DDL) API calls for Timestream for LiveAnalytics as events. The calls that are captured include calls from the Timestream for LiveAnalytics console and code calls to the Timestream for LiveAnalytics API operations. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon Simple Storage Service (Amazon S3) bucket, including events for Timestream for LiveAnalytics. If you don't configure a trail, you can still view the most recent events on the CloudTrail console in Event history. Using the information collected by CloudTrail, you can determine the request that was made to Timestream for LiveAnalytics, 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.

Timestream for LiveAnalytics information in CloudTrail

CloudTrail is enabled on your AWS account when you create the account. When activity occurs in Timestream for LiveAnalytics, 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.

Warning

Currently, Timestream for LiveAnalytics generates CloudTrail events for all management and Query API operations, but does not generate events for WriteRecords and DescribeEndpoints APIs.

For an ongoing record of events in your AWS account, including events for Timestream for LiveAnalytics, 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 topics in the AWS CloudTrail User Guide:

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.

For Query API events:

  • Create a trail that receives all events or select events with Timestream for LiveAnalytics resource type AWS::Timestream::Database or AWS::Timestream::Table.

  • Query API requests that do not access any database or table or that result in a validation exception due to a malformed query string are recorded in CloudTrail with a resource type AWS::Timestream::Database and an ARN value of:

    arn:aws:timestream:(region):(accountId):database/NO_RESOURCE_ACCESSED

    These events are delivered only to trails that receive events with resource type AWS::Timestream::Database.