Logging Amazon Cost Management API calls with Amazon CloudTrail - Amazon Cost Management
Amazon Cost Management information in CloudTrailUnderstanding Amazon Cost Management log file entriesUnderstanding Cost Optimization Hub log file entries
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 Amazon Cost Management API calls with Amazon CloudTrail

Amazon Cost Management is integrated with Amazon CloudTrail, a service that provides a record of actions taken by a user, role, or an Amazon Web Service in Amazon Cost Management. CloudTrail captures API calls for Amazon Cost Management as events. The calls captured include API calls from the Amazon Cost Management console and from your applications.

If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Amazon Cost Management. 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 Amazon Cost Management, 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 Amazon CloudTrail User Guide.

Amazon Cost Management information in CloudTrail

CloudTrail is enabled on your Amazon Web Services account when you create the account. When activity occurs in Amazon Cost Management, that activity is recorded in a CloudTrail event along with other Amazon Web Service events in Event history. You can view, search, and download recent events in your Amazon Web Services account. For more information, see Viewing Events with CloudTrail Event History.

For an ongoing record of events in your Amazon Web Services account, including events for Amazon Cost Management, 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 CloudTrail console, the trail applies to all Amazon Regions. The trail logs events from all Regions in the Amazon partitions and delivers the log files to the Amazon S3 bucket that you specify. Additionally, you can configure other Amazon Web Services to analyze and act on the event data collected in CloudTrail logs.

For more information, see the following in the CloudTrail User Guide:

Amazon Cost Management actions are logged by CloudTrail and documented in the Amazon Billing and Cost Management API Reference. For example, calls to the GetDimensionValues, GetCostCategories, and GetCostandUsage endpoints 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 whether the request was made:

  • With root or user role credentials.

  • With temporary security credentials for a role or federated user.

  • By another Amazon Web Service.

For more information, see the CloudTrail userIdentity Element.

Understanding Amazon Cost Management log file entries

A trail is a configuration that enables delivery of events as log files to an Amazon S3 bucket that you specify. 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 contain one or more log entries. CloudTrail log files are not an ordered stack trace of the public API calls, so they do not appear in any specific order.

The following example shows a CloudTrail log entry for the GetCostandUsage endpoint.

{
        "eventVersion":"1.08",
        "userIdentity":{
            "accountId":"111122223333",
            "accessKeyId":"AIDACKCEVSQ6C2EXAMPLE"
        },
        "eventTime":"2022-05-24T22:38:51Z",
        "eventSource":"ce.amazonaws.com",
        "eventName":"GetCostandUsage",
        "awsRegion":"us-east-1",
        "sourceIPAddress":"100.100.10.10",
        "requestParameters":{
           "TimePeriod":{
              "Start":"2022-01-01",
              "End":"2022-01-31"
           },
           "Metrics":[
              "UnblendedCost",
              "UsageQuantity"
           ],
           "Granularity":"MONTHLY",
           "GroupBy":[
              {
                 "Type":"DIMENSION",
                 "Key":"SERVICE"
              }
           ]
        },
        "responseElements":null,
        "requestID":"3295c994-063e-44ac-80fb-b40example9f",
        "eventID":"5923c499-063e-44ac-80fb-b40example9f",
        "readOnly":true,
        "eventType":"AwsApiCall",
        "managementEvent":true,
        "recipientAccountId":"1111-2222-3333",
        "eventCategory":"Management",
        "tlsDetails":{
           "tlsVersion":"TLSv1.2",
           "clientProvidedHostHeader":"ce.us-east-1.amazonaws.com"
        }
}

Understanding Cost Optimization Hub 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 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.

The following examples show CloudTrail log entries that demonstrate API actions and exceptions for Cost Optimization Hub.

Examples

Throttling Exception

The following example shows a log entry for a throttling exception.

    {
      "eventVersion": "1.09",
      "userIdentity": {
        "type": "AssumedRole",
        "principalId": "EXAMPLEAIZ5FYRFP3POCC:john-doe",
        "arn": "arn:aws:sts::111122223333:assumed-role/Admin/john-doe",
        "accountId": "111122223333",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
        "sessionContext": {
          "sessionIssuer": {
            "type": "Role",
            "principalId": "EXAMPLEAIZ5FYRFP3POCC",
            "arn": "arn:aws:iam::111122223333:role/Admin",
            "accountId": "111122223333",
            "john-doe": "Admin"
          },
          "attributes": {
            "creationDate": "2023-10-14T00:48:50Z",
            "mfaAuthenticated": "false"
          }
        }
      },
      "eventTime": "2023-10-14T01:16:45Z",
      "eventSource": "cost-optimization-hub.amazonaws.com",
      "eventName": "ListEnrollmentStatuses",
      "awsRegion": "us-east-1",
      "sourceIPAddress": "192.0.2.0",
      "userAgent": "PostmanRuntime/7.28.3",
      "errorCode": "ThrottlingException",
      "requestParameters": null,
      "responseElements": null,
      "requestID": "cc04aa10-7417-4c46-b1eb-EXAMPLE1df2b",
      "eventID": "754a3aad-1b54-456a-ac1f-EXAMPLE0e9c3",
      "readOnly": true,
      "eventType": "AwsApiCall",
      "managementEvent": true,
      "recipientAccountId": "111122223333",
      "eventCategory": "Management",
      "tlsDetails": {
        "clientProvidedHostHeader": "localhost:8080"
      }
    }

Access denied exception

The following example shows a log entry for an AccessDenied exception.

{
      "eventVersion": "1.09",
      "userIdentity": {
        "type": "AssumedRole",
        "principalId": "EXAMPLEAIZ5FTKD2BZKUK:john-doe",
        "arn": "arn:aws:sts::111122223333:assumed-role/ReadOnly/john-doe",
        "accountId": "111122223333",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
        "sessionContext": {
          "sessionIssuer": {
            "type": "Role",
            "principalId": "EXAMPLEAIZ5FTKD2BZKUK",
            "arn": "arn:aws:iam::111122223333:role/ReadOnly",
            "accountId": "111122223333",
            "john-doe": "ReadOnly"
          },
          "attributes": {
            "creationDate": "2023-10-16T19:08:36Z",
            "mfaAuthenticated": "false"
          }
        }
      },
      "eventTime": "2023-10-16T19:11:04Z",
      "eventSource": "cost-optimization-hub.amazonaws.com",
      "eventName": "ListEnrollmentStatuses",
      "awsRegion": "us-east-1",
      "sourceIPAddress": "192.0.2.0",
      "userAgent": "PostmanRuntime/7.28.3",
      "errorCode": "AccessDenied",
      "errorMessage": "User: arn:aws:sts::111122223333:assumed-role/ReadOnly/john-doe is not authorized to perform: cost-optimization-hub:ListEnrollmentStatuses on resource: * because no identity-based policy allows the cost-optimization-hub:ListEnrollmentStatuses action",
      "requestParameters": null,
      "responseElements": null,
      "requestID": "1e02d84a-b04a-4b71-8615-EXAMPLEdcda7",
      "eventID": "71c86695-d4ec-4caa-a106-EXAMPLEe0d94",
      "readOnly": true,
      "eventType": "AwsApiCall",
      "managementEvent": true,
      "recipientAccountId": "111122223333",
      "eventCategory": "Management",
      "tlsDetails": {
        "clientProvidedHostHeader": "localhost:8080"
      }
    }

ListEnrollmentStatus

The following example shows a log entry for the ListEnrollmentStatus API action.

    {
      "eventVersion": "1.09",
      "userIdentity": {
        "type": "AssumedRole",
        "principalId": "EXAMPLEAIZ5FYRFP3POCC:john-doe",
        "arn": "arn:aws:sts::111122223333:assumed-role/Admin/john-doe",
        "accountId": "111122223333",
        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
        "sessionContext": {
          "sessionIssuer": {
            "type": "Role",
            "principalId": "EXAMPLEAIZ5FYRFP3POCC",
            "arn": "arn:aws:iam::111122223333:role/Admin",
            "accountId": "111122223333",
            "john-doe": "Admin"
          },
          "attributes": {
            "creationDate": "2023-10-14T00:48:50Z",
            "mfaAuthenticated": "false"
          }
        }
      },
      "eventTime": "2023-10-14T01:16:43Z",
      "eventSource": "cost-optimization-hub.amazonaws.com",
      "eventName": "ListEnrollmentStatuses",
      "awsRegion": "us-east-1",
      "sourceIPAddress": "192.0.2.0",
      "userAgent": "PostmanRuntime/7.28.3",
      "requestParameters": {
        "includeOrganizationInfo": false
      },
      "responseElements": null,
      "requestID": "cba87aa3-4678-41b8-a840-EXAMPLEaf3b8",
      "eventID": "57f04d0e-61f7-4c0f-805c-EXAMPLEbbbf5",
      "readOnly": true,
      "eventType": "AwsApiCall",
      "managementEvent": true,
      "recipientAccountId": "111122223333",
      "eventCategory": "Management",
      "tlsDetails": {
        "clientProvidedHostHeader": "localhost:8080"
      }
    }

ListRecommendations

The following example shows a log entry for the ListRecommendations API action.

    {
      "eventVersion": "1.09",
      "userIdentity": {
        "type": "AssumedRole",
        "principalId": "EXAMPLEAIZ5FYRFP3POCC:john-doe",
        "arn": "arn:aws:sts::111122223333:assumed-role/Admin/john-doe",
        "accountId": "111122223333",
        "accessKeyId": "AKIAI44QH8DHBEXAMPLE",
        "sessionContext": {
          "sessionIssuer": {
            "type": "Role",
            "principalId": "EXAMPLEAIZ5FYRFP3POCC",
            "arn": "arn:aws:iam::111122223333:role/Admin",
            "accountId": "111122223333",
            "john-doe": "Admin"
          },
          "attributes": {
            "creationDate": "2023-10-16T23:47:55Z",
            "mfaAuthenticated": "false"
          }
        }
      },
      "eventTime": "2023-10-17T00:45:29Z",
      "eventSource": "cost-optimization-hub.amazonaws.com",
      "eventName": "ListRecommendations",
      "awsRegion": "us-east-1",
      "sourceIPAddress": "192.0.2.0",
      "userAgent": "PostmanRuntime/7.28.3",
      "requestParameters": {
        "filter": {
          "resourceIdentifiers": [
            "arn:aws:ecs:us-east-1:111122223333:service/EXAMPLEAccountsIntegrationService-EcsCluster-ClusterEB0386A7-7fsvP2MMmxZ5/EXAMPLEAccountsIntegrationService-EcsService-Service9571FDD8-Dqm4mPMLstDn"
          ]
        },
        "includeAllRecommendations": false
      },
      "responseElements": null,
      "requestID": "a5b2df72-2cfd-4628-8a72-EXAMPLE7560a",
      "eventID": "a73bef13-6af7-4c11-a708-EXAMPLE6af5c",
      "readOnly": true,
      "eventType": "AwsApiCall",
      "managementEvent": true,
      "recipientAccountId": "111122223333",
      "eventCategory": "Management",
      "tlsDetails": {
        "clientProvidedHostHeader": "cost-optimization-hub.us-east-1.amazonaws.com"
      }
    }

ListRecommendationSummaries

The following example shows a log entry for the ListRecommendationSummaries API action.

    {
      "eventVersion": "1.09",
      "userIdentity": {
        "type": "AssumedRole",
        "principalId": "EXAMPLEAIZ5FYRFP3POCC:john-doe",
        "arn": "arn:aws:sts::111122223333:assumed-role/Admin/john-doe",
        "accountId": "111122223333",
        "accessKeyId": "AKIAI44QH8DHBEXAMPLE",
        "sessionContext": {
          "sessionIssuer": {
            "type": "Role",
            "principalId": "EXAMPLEAIZ5FYRFP3POCC",
            "arn": "arn:aws:iam::111122223333:role/Admin",
            "accountId": "111122223333",
            "userName": "Admin"
          },
          "attributes": {
            "creationDate": "2023-10-16T23:47:55Z",
            "mfaAuthenticated": "false"
          }
        }
      },
      "eventTime": "2023-10-17T00:46:16Z",
      "eventSource": "cost-optimization-hub.amazonaws.com",
      "eventName": "ListRecommendationSummaries",
      "awsRegion": "us-east-1",
      "sourceIPAddress": "192.0.2.0",
      "userAgent": "PostmanRuntime/7.28.3",
      "requestParameters": {
        "groupBy": "ResourceType"
      },
      "responseElements": null,
      "requestID": "ab54e6ad-72fe-48fe-82e9-EXAMPLEa6d1e",
      "eventID": "9288d9fa-939d-4e5f-a49a-EXAMPLEeb14b",
      "readOnly": true,
      "eventType": "AwsApiCall",
      "managementEvent": true,
      "recipientAccountId": "111122223333",
      "eventCategory": "Management",
      "tlsDetails": {
        "clientProvidedHostHeader": "cost-optimization-hub.us-east-1.amazonaws.com"
      }
    }

GetRecommendation

The following example shows a log entry for the GetRecommendation API action.

    {
      "eventVersion": "1.09",
      "userIdentity": {
        "type": "AssumedRole",
        "principalId": "EXAMPLEAIZ5FYRFP3POCC:john-doe",
        "arn": "arn:aws:sts::111122223333:assumed-role/Admin/john-doe",
        "accountId": "111122223333",
        "accessKeyId": "AKIAI44QH8DHBEXAMPLE",
        "sessionContext": {
          "sessionIssuer": {
            "type": "Role",
            "principalId": "EXAMPLEAIZ5FYRFP3POCC",
            "arn": "arn:aws:iam::111122223333:role/Admin",
            "accountId": "111122223333",
            "john-doe": "Admin"
          },
          "attributes": {
            "creationDate": "2023-10-16T23:47:55Z",
            "mfaAuthenticated": "false"
          }
        }
      },
      "eventTime": "2023-10-17T00:47:48Z",
      "eventSource": "cost-optimization-hub.amazonaws.com",
      "eventName": "GetRecommendation",
      "awsRegion": "us-east-1",
      "sourceIPAddress": "192.0.2.0",
      "userAgent": "PostmanRuntime/7.28.3",
      "requestParameters": {
        "recommendationId": "EXAMPLEwMzEwODU5XzQyNTFhNGE4LWZkZDItNDUyZi1hMjY4LWRkOTFkOTA1MTc1MA=="
      },
      "responseElements": null,
      "requestID": "e289a76a-182c-4bc9-8093-EXAMPLEbed0e",
      "eventID": "f1ed7ee6-871c-41fd-bb27-EXAMPLE24b64",
      "readOnly": true,
      "eventType": "AwsApiCall",
      "managementEvent": true,
      "recipientAccountId": "111122223333",
      "eventCategory": "Management",
      "tlsDetails": {
        "clientProvidedHostHeader": "cost-optimization-hub.us-east-1.amazonaws.com"
      }
    }

UpdateEnrollmentStatus

The following example shows a log entry for the UpdateEnrollmentStatus API action.

{
      "eventVersion": "1.09",
      "userIdentity": {
        "type": "AssumedRole",
        "principalId": "EXAMPLEAIZ5FYRFP3POCC:john-doe",
        "arn": "arn:aws:sts::111122223333:assumed-role/Admin/john-doe",
        "accountId": "111122223333",
        "accessKeyId": "AKIAI44QH8DHBEXAMPLE",
        "sessionContext": {
          "sessionIssuer": {
            "type": "Role",
            "principalId": "EXAMPLEAIZ5FYRFP3POCC",
            "arn": "arn:aws:iam::111122223333:role/Admin",
            "accountId": "111122223333",
            "john-doe": "Admin"
          },
          "attributes": {
            "creationDate": "2023-10-16T19:11:30Z",
            "mfaAuthenticated": "false"
          }
        }
      },
      "eventTime": "2023-10-16T19:12:35Z",
      "eventSource": "cost-optimization-hub.amazonaws.com",
      "eventName": "UpdateEnrollmentStatus",
      "awsRegion": "us-east-1",
      "sourceIPAddress": "192.0.2.0",
      "userAgent": "PostmanRuntime/7.28.3",
      "requestParameters": {
        "status": "Inactive"
      },
      "responseElements": {
        "status": "Inactive"
      },
      "requestID": "6bf0c8a3-af53-4c4e-8f50-EXAMPLE477f0",
      "eventID": "d2bfa850-ef3d-4317-8ac4-EXAMPLEc16b1",
      "readOnly": false,
      "eventType": "AwsApiCall",
      "managementEvent": true,
      "recipientAccountId": "111122223333",
      "eventCategory": "Management",
      "tlsDetails": {
        "clientProvidedHostHeader": "localhost:8080"
      }
    }

UpdatePreferences

The following example shows a log entry for the UpdatePreferences API action.

    {
      "eventVersion": "1.09",
      "userIdentity": {
        "type": "AssumedRole",
        "principalId": "EXAMPLEAIZ5FYRFP3POCC:john-doe",
        "arn": "arn:aws:sts::111122223333:assumed-role/Admin/john-doe",
        "accountId": "111122223333",
        "accessKeyId": "AKIAI44QH8DHBEXAMPLE",
        "sessionContext": {
          "sessionIssuer": {
            "type": "Role",
            "principalId": "EXAMPLEAIZ5FYRFP3POCC",
            "arn": "arn:aws:iam::111122223333:role/Admin",
            "accountId": "111122223333",
            "john-doe": "Admin"
          },
          "attributes": {
            "creationDate": "2023-10-16T19:11:30Z",
            "mfaAuthenticated": "false"
          }
        }
      },
      "eventTime": "2023-10-16T19:16:00Z",
      "eventSource": "cost-optimization-hub.amazonaws.com",
      "eventName": "UpdatePreferences",
      "awsRegion": "us-east-1",
      "sourceIPAddress": "192.0.2.0",
      "userAgent": "PostmanRuntime/7.28.3",
      "requestParameters": {
        "costMetricsType": "AfterDiscounts"
      },
      "responseElements": {
        "costMetricsType": "AfterDiscounts",
        "memberAccountDiscountVisibility": "None"
      },
      "requestID": "01e56ca3-47af-45f0-85aa-EXAMPLE30b42",
      "eventID": "7350ff23-35f5-4760-98b2-EXAMPLE61f13",
      "readOnly": false,
      "eventType": "AwsApiCall",
      "managementEvent": true,
      "recipientAccountId": "111122223333",
      "eventCategory": "Management",
      "tlsDetails": {
        "clientProvidedHostHeader": "localhost:8080"
      }
    }