Logging Timestream API Calls with AWS CloudTrail - Amazon Timestream

Logging Timestream API Calls with AWS CloudTrail

Timestream is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in Timestream. CloudTrail captures Data Definition Language (DDL) API calls for Timestream as events. The calls that are captured include calls from the Timestream console and code calls to the Timestream 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. 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, 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 Information in CloudTrail

CloudTrail is enabled on your AWS account when you create the account. When activity occurs in Timestream, 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 generates CloudTrail Events for management APIs, but does not generate events for data plane APIs. Specifically, Timestream DOES NOT emit events for:

  • WriteRecords

  • Query

    Note

    When using the Timestream Query API via a query string, none of Supported SQL Constructs are logged by CloudTrail. Timestream's supported SQL constructs map to the following Timestream IAM actions, as shown below:

    Query String IAM Action

    Select

    Select, SelectValues

    Show measures

    ListMeasures

    Describe Database

    DescribeDatabase

    Describe Table

    DescribeTable

    Show Databases

    ListDatabases

    Show Tables

    ListTables

    However, direct API calls to DescribeDatabase, DescribeTable, ListDatabases and ListTables, and/or Query API calls made using the Timestream SDK will be logged to CloudTrail.

  • DescribeEndpoints

For an ongoing record of events in your AWS account, including events for Timestream, 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.