Logging AWS Support Plans API calls with
AWS CloudTrail
AWS Support Plans is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service. CloudTrail captures API calls for AWS Support Plans as events. The calls captured include calls from the AWS Support Plans console and code calls to the AWS Support Plans 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 Plans. 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 Plans, 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 Plans information in
CloudTrail
CloudTrail is enabled on your AWS account when you create the account. When supported event activity occurs in AWS Support Plans, 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 account. For more information, see Viewing events with CloudTrail event history.
For an ongoing record of events in your account, including events for AWS Support Plans, 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 Plans API operations are logged by CloudTrail. 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 Plans log files from multiple AWS Regions and multiple accounts into a single Amazon S3 bucket.
Understanding AWS Support Plans 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 GetSupportPlan
The following example shows a CloudTrail log entry for the GetSupportPlan
operation.
{
"eventVersion": "1.08",
"userIdentity": {
"type": "AssumedRole",
"principalId": "AIDACKCEVSQ6C2EXAMPLE",
"arn": "arn:aws:sts::111122223333:user/janedoe",
"accountId": "111122223333",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"sessionContext": {
"sessionIssuer": {
"type": "Role",
"principalId": "AIDACKCEVSQ6C2EXAMPLE",
"arn": "arn:aws:iam::111122223333:role/Admin",
"accountId": "111122223333",
"userName": "Admin"
},
"webIdFederationData": {},
"attributes": {
"creationDate": "2022-06-29T16:30:04Z",
"mfaAuthenticated": "false"
}
}
},
"eventTime": "2022-06-29T16:39:11Z",
"eventSource": "supportplans.amazonaws.com",
"eventName": "GetSupportPlan",
"awsRegion": "us-west-2",
"sourceIPAddress": "205.251.233.183",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101 Firefox/91.0",
"requestParameters": null,
"responseElements": null,
"requestID": "7665c39a-d6bf-4d0d-8010-2f59740b8ecb",
"eventID": "b711bc30-16a5-4579-8f0d-9ada8fe6d1ce",
"readOnly": true,
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "111122223333",
"eventCategory": "Management"
}
Example : Log entry for GetSupportPlanUpdateStatus
The following example shows a CloudTrail log entry for the
GetSupportPlanUpdateStatus
operation.
{
"eventVersion": "1.08",
"userIdentity": {
"type": "AssumedRole",
"principalId": "AIDACKCEVSQ6C2EXAMPLE",
"arn": "arn:aws:sts::111122223333:user/janedoe",
"accountId": "111122223333",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"sessionContext": {
"sessionIssuer": {
"type": "Role",
"principalId": "AIDACKCEVSQ6C2EXAMPLE",
"arn": "arn:aws:iam::111122223333:role/Admin",
"accountId": "111122223333",
"userName": "Admin"
},
"webIdFederationData": {},
"attributes": {
"creationDate": "2022-06-29T16:30:04Z",
"mfaAuthenticated": "false"
}
}
},
"eventTime": "2022-06-29T16:39:02Z",
"eventSource": "supportplans.amazonaws.com",
"eventName": "GetSupportPlanUpdateStatus",
"awsRegion": "us-west-2",
"sourceIPAddress": "205.251.233.183",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101 Firefox/91.0",
"requestParameters": {
"supportPlanUpdateArn": "arn:aws:supportplans::111122223333:supportplanupdate/7f03b7a233a0e87ebc79e56d4d2bcaf19e976c37a2756181cec1b17f95da4310"
},
"responseElements": null,
"requestID": "75e5c767-8703-4ed3-b01e-4dda28020322",
"eventID": "28d1c0e3-ccb6-4fd1-8793-65be010114cc",
"readOnly": true,
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "111122223333",
"eventCategory": "Management"
}
Example : Log entry for StartSupportPlanUpdate
The following example shows a CloudTrail log entry for the StartSupportPlanUpdate
operation.
{
"eventVersion": "1.08",
"userIdentity": {
"type": "AssumedRole",
"principalId": "AIDACKCEVSQ6C2EXAMPLE",
"arn": "arn:aws:sts::111122223333:user/janedoe",
"accountId": "111122223333",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"sessionContext": {
"sessionIssuer": {
"type": "Role",
"principalId": "AIDACKCEVSQ6C2EXAMPLE",
"arn": "arn:aws:iam::111122223333:role/Admin",
"accountId": "111122223333",
"userName": "Admin"
},
"webIdFederationData": {},
"attributes": {
"creationDate": "2022-06-29T16:30:04Z",
"mfaAuthenticated": "false"
}
}
},
"eventTime": "2022-06-29T16:38:55Z",
"eventSource": "supportplans.amazonaws.com",
"eventName": "StartSupportPlanUpdate",
"awsRegion": "us-west-2",
"sourceIPAddress": "205.251.233.183",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101 Firefox/91.0",
"requestParameters": {
"clientToken": "98add111-dcc9-464d-8722-438d697fe242",
"update": {
"supportLevel": "BASIC"
}
},
"responseElements": {
"Access-Control-Expose-Headers": "x-amzn-RequestId,x-amzn-ErrorType,x-amzn-ErrorMessage,Date",
"supportPlanUpdateArn": "arn:aws:supportplans::111122223333:supportplanupdate/7f03b7a233a0e87ebc79e56d4d2bcaf19e976c37a2756181cec1b17f95da4310"
},
"requestID": "e5ff9382-5fb8-4764-9993-0f33fb0b1e17",
"eventID": "5dba89f8-2e5b-42b9-9b8f-395580c52962",
"readOnly": false,
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "111122223333",
"eventCategory": "Management"
}
Example : Log entry for CreateSupportPlanSchedule
The following example shows a CloudTrail log entry for the CreateSupportPlanSchedule
operation.
{
"eventVersion": "1.08",
"userIdentity": {
"type": "AssumedRole",
"principalId": "AIDACKCEVSQ6C2EXAMPLE",
"arn": "arn:aws:sts::111122223333:user/janedoe",
"accountId": "111122223333",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"sessionContext": {
"sessionIssuer": {
"type": "Role",
"principalId": "AIDACKCEVSQ6C2EXAMPLE",
"arn": "arn:aws:iam::111122223333:role/Admin",
"accountId": "111122223333",
"userName": "Admin"
},
"webIdFederationData": {},
"attributes": {
"creationDate": "2023-05-09T16:30:04Z",
"mfaAuthenticated": "false"
}
}
},
"eventTime": "2023-05-09T16:30:04Z",
"eventSource": "supportplans.amazonaws.com",
"eventName": "CreateSupportPlanSchedule",
"awsRegion": "us-west-2",
"sourceIPAddress": "205.251.233.183",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101 Firefox/91.0",
"requestParameters": {
"clientToken": "b998de5e-ad1c-4448-90db-2bf86d6d9e9a",
"scheduleCreationDetails": {
"startLevel": "BUSINESS",
"startOffer": "TrialPlan7FB93B",
"startTimestamp": "2023-06-03T17:23:56.109Z",
"endLevel": "BUSINESS",
"endOffer": "StandardPlan2074BB",
"endTimestamp": "2023-09-03T17:23:55.109Z"
}
},
"responseElements": {
"Access-Control-Expose-Headers": "x-amzn-RequestId,x-amzn-ErrorType,x-amzn-ErrorMessage,Date",
"supportPlanUpdateArn": "arn:aws:supportplans::111122223333:supportplanschedule/b9a9a4336a3974950a6e670f7dab79b77a4b104db548a0d57050ce4544721d4b"
},
"requestID": "150450b8-e61a-4b15-93a8-c3b557a1ca48",
"eventID": "a2a1ba44-610d-4dc8-bf16-29f1635b57a9",
"readOnly": false,
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "111122223333",
"eventCategory": "Management"
}
Example : Log entry for ListSupportPlanModifiers
The following example shows a CloudTrail log entry for the
ListSupportPlanModifiers
operation.
{
"eventVersion": "1.09",
"userIdentity": {
"type": "AssumedRole",
"principalId": "AIDACKCEVSQ6C2EXAMPLE",
"arn": "arn:aws:sts::111122223333:user/janedoe",
"accountId": "111122223333",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"sessionContext": {
"sessionIssuer": {
"type": "Role",
"principalId": "AIDACKCEVSQ6C2EXAMPLE",
"arn": "arn:aws:sts::111122223333:user/janedoe",
"accountId": "111122223333",
"userName": "Admin"
},
"attributes": {
"creationDate": "2024-08-15T15:44:43Z",
"mfaAuthenticated": "false"
}
}
},
"eventTime": "2024-08-15T16:29:59Z",
"eventSource": "supportplans.amazonaws.com",
"eventName": "ListSupportPlanModifiers",
"awsRegion": "us-west-2",
"sourceIPAddress": "205.251.233.183",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101 Firefox/91.0",
"requestParameters": null,
"responseElements": null,
"requestID": "7665c39a-d6bf-4d0d-8010-2f59740b8ecb",
"eventID": "b711bc30-16a5-4579-8f0d-9ada8fe6d1ce",
"readOnly": true,
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "111122223333",
"eventCategory": "Management"
}
Logging changes to your Support plan
Important
As of August 3, 2022, the following operations are deprecated and won't appear in your new CloudTrail logs. For a list of supported operations, see Understanding AWS Support Plans log file entries.
-
DescribeSupportLevelSummary
– This action appears in your log when you open the Support planspage. -
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 planspage. You will resume your plan for Developer Support or Business Support. -
UpdateSupportLevel
– This action appears in your log when you change your support plan.
Note
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"
}