Logging AWS Support API calls with AWS CloudTrail - AWS Support

Logging AWS Support API calls with AWS CloudTrail

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

AWS Support information in CloudTrail

CloudTrail is enabled on your AWS account when you create the account. When supported event activity occurs in AWS Support, 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 AWS Support, 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 AWS Support API operations are logged by CloudTrail and are documented in the AWS Support API Reference.

For example, calls to the CreateCase, DescribeCases and ResolveCase operations 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.

You can also aggregate AWS Support log files from multiple AWS Regions and multiple AWS accounts into a single Amazon S3 bucket.

AWS Trusted Advisor information in CloudTrail logging

Trusted Advisor is an AWS Support service that you can use to check your AWS account for ways to save costs, improve security, and optimize your account.

All Trusted Advisor API operations are logged by CloudTrail and are documented in the AWS Support API Reference.

For example, calls to the DescribeTrustedAdvisorCheckRefreshStatuses, DescribeTrustedAdvisorCheckResult and RefreshTrustedAdvisorCheck operations generate entries in the CloudTrail log files.

Note

CloudTrail also logs Trusted Advisor console actions. See Logging AWS Trusted Advisor console actions with AWS CloudTrail.

Understanding AWS Support 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. It includes information about the requested operation, the date and time of the operation, 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.

Example : Log entry for CreateCase

The following example shows a CloudTrail log entry for the CreateCase operation.

{ "Records": [ { "eventVersion": "1.04", "userIdentity": { "type": "IAMUser", "principalId": "AIDACKCEVSQ6C2EXAMPLE", "arn": "arn:aws:iam::111122223333:user/janedoe", "accountId": "111122223333", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "userName": "janedoe", "sessionContext": { "attributes": { "mfaAuthenticated": "false", "creationDate": "2016-04-13T17:51:37Z" } }, "invokedBy": "signin.amazonaws.com" }, "eventTime": "2016-04-13T18:05:53Z", "eventSource": "support.amazonaws.com", "eventName": "CreateCase", "awsRegion": "us-east-1", "sourceIPAddress": "198.51.100.15", "userAgent": "signin.amazonaws.com", "requestParameters": { "severityCode": "low", "categoryCode": "other", "language": "en", "serviceCode": "support-api", "issueType": "technical" }, "responseElements": { "caseId": "case-111122223333-muen-2016-c3f2077e504940f2" }, "requestID": "58c257ef-01a2-11e6-be2a-01c031063738", "eventID": "5aa34bfc-ad5b-4fb1-8a55-2277c86e746a", "eventType": "AwsApiCall", "recipientAccountId": "111122223333" } ], ... }

Example : Log entry for RefreshTrustedAdvisorCheck

The following example shows a CloudTrail log entry for the RefreshTrustedAdvisorCheck operation.

{ "eventVersion": "1.05", "userIdentity": { "type": "IAMUser", "principalId": "AIDACKCEVSQ6C2EXAMPLE", "arn": "arn:aws:iam::111122223333:user/Admin", "accountId": "111122223333", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "userName": "Admin" }, "eventTime": "2020-10-21T16:34:13Z", "eventSource": "support.amazonaws.com", "eventName": "RefreshTrustedAdvisorCheck", "awsRegion": "us-east-1", "sourceIPAddress": "72.21.198.67", "userAgent": "aws-cli/1.18.140 Python/3.6.12 Linux/4.9.217-0.3.ac.206.84.332.metal1.x86_64 botocore/1.17.63", "requestParameters": { "checkId": "Pfx0RwqBli" }, "responseElements": null, "requestID": "4c4d5fc8-c403-4f82-9544-41f820e0fa01", "eventID": "2f4630ac-5c27-4f0d-b93f-63742d6fc85e", "eventType": "AwsApiCall", "recipientAccountId": "111122223333" }

Logging changes to your AWS Support plan

When you change or view your Support plan on the Support plans page, CloudTrail logs the following console actions:

  • DescribeSupportLevelSummary – This action appears in your log when you open the Support plans page.

  • UpdateProbationAutoCancellation – After you sign up for Developer Support or Business Support and then try to cancel within 30 days, your plan will be automatically canceled at the end of that period. This action appears in your log when you choose Opt-out of automatic cancellation in the banner that appears on the Support plans page. You will resume your plan for Developer Support or Business Support.

  • UpdateSupportLevel – This action appears in your log when you change your Support plan.

Notes
  • Only a root user in your AWS account can perform these actions on the Support plans page. For more information, see Changing your AWS Support plan.

  • The eventSource field has the support-subscription.amazonaws.com namespace for these actions.

Example : Log entry for DescribeSupportLevelSummary

The following example shows a CloudTrail log entry for the DescribeSupportLevelSummary action.

{ "eventVersion": "1.08", "userIdentity": { "type": "Root", "principalId": "111122223333", "arn": "arn:aws:iam::111122223333:root", "accountId": "111122223333", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": {}, "webIdFederationData": {}, "attributes": { "mfaAuthenticated": "false", "creationDate": "2021-01-07T22:08:05Z" } } }, "eventTime": "2021-01-07T22:08:07Z", "eventSource": "support-subscription.amazonaws.com", "eventName": "DescribeSupportLevelSummary", "awsRegion": "us-east-1", "sourceIPAddress": "100.127.8.67", "userAgent": "AWS-SupportPlansConsole, aws-internal/3", "requestParameters": { "lang": "en" }, "responseElements": null, "requestID": "b423b84d-829b-4090-a239-2b639b123abc", "eventID": "e1eeda0e-d77c-487b-a7e5-4014f7123abc", "readOnly": true, "eventType": "AwsApiCall", "managementEvent": true, "eventCategory": "Management", "recipientAccountId": "111122223333" }

Example : Log entry for UpdateProbationAutoCancellation

The following example shows a CloudTrail log entry for the UpdateProbationAutoCancellation action.

{ "eventVersion": "1.08", "userIdentity": { "type": "Root", "principalId": "111122223333", "arn": "arn:aws:iam::111122223333:root", "accountId": "111122223333", "accessKeyId": "AKIAIOSFODNN7EXAMPLE" }, "eventTime": "2021-01-07T23:28:43Z", "eventSource": "support-subscription.amazonaws.com", "eventName": "UpdateProbationAutoCancellation", "awsRegion": "us-east-1", "sourceIPAddress": "100.127.8.67", "userAgent": "AWS-SupportPlansConsole, aws-internal/3", "requestParameters": { "lang": "en" }, "responseElements": null, "requestID": "5492206a-e200-4c33-9fcf-4162d4123abc", "eventID": "f4a58c09-0bb0-4ba2-a8d3-df6909123abc", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "eventCategory": "Management", "recipientAccountId": "111122223333" }

Example : Log entry for UpdateSupportLevel

The following example shows a CloudTrail log entry for the UpdateSupportLevel action to change to Developer Support.

{ "eventVersion": "1.08", "userIdentity": { "type": "Root", "principalId": "111122223333", "arn": "arn:aws:iam::111122223333:root", "accountId": "111122223333", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "sessionContext": { "sessionIssuer": {}, "webIdFederationData": {}, "attributes": { "mfaAuthenticated": "false", "creationDate": "2021-01-07T22:08:05Z" } } }, "eventTime": "2021-01-07T22:08:43Z", "eventSource": "support-subscription.amazonaws.com", "eventName": "UpdateSupportLevel", "awsRegion": "us-east-1", "sourceIPAddress": "100.127.8.247", "userAgent": "AWS-SupportPlansConsole, aws-internal/3", "requestParameters": { "supportLevel": "new_developer" }, "responseElements": { "aispl": false, "supportLevel": "new_developer" }, "requestID": "5df3da3a-61cd-4a3c-8f41-e5276b123abc", "eventID": "c69fb149-c206-47ce-8766-8df6ec123abc", "readOnly": false, "eventType": "AwsApiCall", "managementEvent": true, "eventCategory": "Management", "recipientAccountId": "111122223333" }