Logging WorkSpaces API Calls by Using CloudTrail - Amazon WorkSpaces Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Logging WorkSpaces API Calls by Using CloudTrail

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

WorkSpaces Information in CloudTrail

CloudTrail is enabled on your Amazon account when you create the account. When supported event activity occurs in WorkSpaces, that activity is recorded in a CloudTrail event along with other Amazon service events in Event history. For example, calls to create, rebuild, or terminate WorkSpaces generate entries in CloudTrail log files. For more information, see Actions.

You can view, search, and download recent events in your Amazon account. For more information, see Viewing Events with CloudTrail Event History.

For an ongoing record of events in your Amazon account, including events for WorkSpaces, 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 Amazon Regions. The trail logs events from all Regions in the Amazon partition and delivers the log files to the Amazon S3 bucket that you specify. Additionally, you can configure other Amazon services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see the following:

Example: WorkSpaces Log File Entry

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.

Any sensitive information, such as passwords, authentication tokens, file comments, and file contents are redacted in the log entries.

The following shows an example of a CloudTrail log entry for WorkSpaces.

{ "Records" : [ { "eventVersion" : "1.02", "userIdentity" : { "type" : "IAMUser", "principalId" : "user_id", "arn" : "user_arn", "accountId" : "account_id", "accessKeyId" : "access_key_id", "userName" : "username" }, "eventTime" : "event_time", "eventSource" : "workspaces.amazonaws.com", "eventName" : "DescribeWorkspaces", "awsRegion" : "region", "sourceIPAddress" : "IP_address", "userAgent" : "user_agent", "requestParameters" : { "requestContext" : { "awsAccountId" : "account_id" } }, "responseElements" : { "workspaces" : [ { "bundleId" : "bundle_id", "userName" : "workspace_user_name", "ipAddress" : ";ip_address", "directoryId" : ";directory_id", "state" : "state", "workspaceId" : "workspace_id", "subnetId" : "subnet_id" } ] }, "requestID" : "request_id", "eventID" : "event_id", "eventType" : "AwsApiCall", "recipientAccountId" : "account_id" } ] }