Logging Billing and Cost Management API calls with Amazon CloudTrail
Billing and Cost Management is integrated with Amazon CloudTrail, a service that provides a record of actions taken by a user, role, or an Amazon service in Billing and Cost Management. CloudTrail captures API calls for Billing and Cost Management as events, including calls from the Billing and Cost Management console and from code calls to the Billing and Cost Management APIs. For a full list of CloudTrail events related to Billing, see Amazon Billing CloudTrail events.
If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Billing and 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 Billing and 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, including how to configure and enable it, see the Amazon CloudTrail User Guide.
Amazon Billing CloudTrail events
This section shows a full list of the CloudTrail events related to Billing and Cost Management. For a CloudTrail list for Payments events, see Payments CloudTrail events.
Notes
The following CloudTrail events use a different event source instead of
billingconsole.amazonaws.com
:
-
CreateCustomerCase
,GetTaxExemptionTypes
, andBatchGetTaxExemptions
usetaxconsole.amazonaws.com
. -
CreateCustomerVerificationDetails
,GetCustomerVerificationDetails
GetCustomerVerificationEligibility
, andUpdateCustomerVerificationDetails
usecustomer-verification.amazonaws.com
. -
AddPurchaseOrder
,DeletePurchaseOrder
,ListPurchaseOrders
,GetPurchaseOrder
,ListPurchaseOrderInvoices
,UpdatePurchaseOrderStatus
,UpdatePurchaseOrder
,TagResource
,UntagResource
, andListTagsForResource
usepurchase-orders.amazonaws.com
.
Event name | Definition |
---|---|
|
Logs the creation of a purchase order. |
|
Logs the acceptance of the terms and conditions of paying in a currency other than USD. |
|
Logs the access to US tax exemptions of an account, and any linked accounts. |
|
Logs the closing of an account. |
|
Logs the creation of a customer support case to validate US tax exemption for an account. |
|
(For customers with an India billing or contact address only) Logs the creation of the customer verification details of the account. |
|
Logs the creation of the cost and usage report; management account only. |
|
Logs the deletion of a purchase order. |
|
Logs the deletion of the cost and usage report; management account only. |
|
Logs the download of a commercial invoice. |
|
Logs the download of the eCSV file (monthly usage report) for a specific billing period. |
|
Logs the download of the tax registration document. |
|
Logs the download of a tax invoice. |
|
Logs the opt-in of receiving CloudWatch billing alerts for estimated charges. |
|
Logs the retrieval of the ECSV file for a specific billing period. |
|
Logs the retrieval of the account’s EDP status. |
|
Logs the access to tax address, billing address, and contact address of an account. |
|
Logs the access to all member account numbers of the management account. |
|
Logs the access to tax registration details of all member accounts of the management account. |
|
Logs the access of the account's usage and charges for a specific billing period. |
|
Logs the access of a management account retrieving the usage and charges of one of the member accounts in the consolidated billing family for a specific billing period. |
|
Logs the access to the account's commercial invoices metadata for the specific billing period. |
|
Logs the access of the management account retrieving the summary of the entire consolidated billing family. |
|
(For customers with an India billing or contact address only) Logs the retrieval of the customer verification eligibility of the account. |
|
(For customers with an India billing or contact address only) Logs the retrieval of the customer verification details of the account. |
|
Logs the retrieval from a management account of the member account names belonging to its consolidated billing family for a specific billing period. |
|
Logs the retrieval of a purchase order. |
|
Logs the access to all country codes supported by tax console. |
|
Logs the access to all supported US exemption types by tax console. |
|
Logs the access to tax inheritance preference (turning on or off) of an account. |
|
Logs the retrieval of tax invoices metadata. |
|
Logs the access to the tax registration number of an account. |
|
Logs the retrieval of the account’s total charges. |
|
Logs the access to the forecasted charges for the specific billing period. |
|
Logs the retrieval and listing of cost allocation tags. |
|
Logs the retrieval and listing of purchase orders. |
|
Logs of the retrieval and list of invoices associated to a purchase order. |
|
Lists the tags associated with a resource. For |
|
Logs the preview of tax registration changes before confirmation. |
|
Logs the redemption of promotional credits for an account. |
|
Logs the creation, deletion, or update of the necessary contract information for public sector customers. |
|
Logs the updates of the account name, email, and password. |
|
Logs the creation, deletion, or update of the alternate contacts for billing, operations, and security communications. |
|
Logs the creation, deletion, or update of the account owner contact information, including the address and phone number. |
|
Logs the opt-in of the awscreatedby cost allocation tag
preference. |
|
Logs the history of the credit sharing preference for the management account. |
|
Logs the preference (opt-in or opt-out) of receiving Free Tier usage alerts. |
|
Logs the creation, deletion, or update of the preferred currency used to pay your invoice. |
|
Logs the creation, deletion, or update of the IAM users ability to access to the billing console. This setting is only for customers with root access. |
|
Logs the creating, deletion, or update of PAN information under Amazon India. |
|
Logs the payment method history (invoice or credit/debit card) for the account. |
|
Logs the history of the RI/Savings Plans sharing preference for the management account. |
|
Logs the creation, deletion, or update of the security challenge questions to help Amazon identify you as the owner of the account. |
|
Logs the active or inactive state of a particular cost allocation tag. |
|
Logs the preference (opt-in or opt-out) of tax inheritance. |
|
Logs the creation, deletion, or update of the tax registration number for an account. |
|
Logs the tagging of a resource. For |
|
Logs the deletion of tags from a resource. For |
|
(For customers with an India billing or contact address only) Logs the update of the customer verification details of the account. |
|
Logs the update of the cost and usage report; management account only. |
|
Logs the update of a purchase order. |
|
Logs the update of a purchase order status. |
|
Logs the validation of the tax address of an account. |
Payments CloudTrail events
This section shows a full list of the CloudTrail events for the Payments feature in the Amazon Billing console. These CloudTrail events use payments.amazonaws.com
instead of
billingconsole.amazonaws.com
.
Event name | Definition |
---|---|
|
Logs the payment instrument authentication. |
|
Logs the creation of payment instruments. |
|
Logs the deletion of payment instruments. |
|
Logs the access of payment instruments. |
|
Logs the list of payment instrument metadata. |
|
Logs the operations before payment instrument creation. |
|
Logs the update of payment instruments. |
|
Logs the list of tags associated with a payments resource. |
|
Logs the access of payment instrument eligibility. |
|
Logs the access of payment profiles. |
|
Logs the creation of payment profiles. |
|
Logs the deletion of payment profiles. |
|
Logs the list of payment profiles metadata. |
|
Logs the update of payment profiles. |
|
Logs the tagging of a payments resource. |
|
Logs the accepted payments terms and conditions. |
|
Logs the access of accepted terms and conditions. |
|
Logs the access of recommended terms and conditions. |
|
Logs the deletion of tags from a payments resource. |
Billing and Cost Management information in CloudTrail
CloudTrail is enabled on your Amazon account when you create the account. When supported event activity occurs in Billing and Cost Management, that activity is recorded in a CloudTrail event along with other Amazon service events in Event history. You can view, search, and download recent events in your Amazon account. For more information, see Viewing Events with CloudTrail Event History in the Amazon CloudTrail User Guide.
For an ongoing record of events in your Amazon account, including events for Billing and 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 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:
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 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 Amazon service.
For more information, see the CloudTrail userIdentity Element in the Amazon CloudTrail User Guide.
CloudTrail log entry examples
The following examples are provided for specific Billing and Cost Management CloudTrail log entry scenarios.
Billing and 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. 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 are not an ordered stack trace of the public API calls, so they don't appear in any specific order.
The following example shows a CloudTrail log entry that demonstrates the SetContactAddress
action.
{ "eventVersion": "1.05", "userIdentity": { "accountId": "111122223333", "accessKeyId": "AIDACKCEVSQ6C2EXAMPLE" }, "eventTime": "2018-05-30T16:44:04Z", "eventSource": "billingconsole.amazonaws.com", "eventName": "SetContactAddress", "awsRegion": "us-east-1", "sourceIPAddress": "100.100.10.10", "requestParameters": { "website": "https://amazon.com", "city": "Seattle", "postalCode": "98108", "fullName": "Jane Doe", "districtOrCounty": null, "phoneNumber": "206-555-0100", "countryCode": "US", "addressLine1": "Nowhere Estates", "addressLine2": "100 Main Street", "company": "AnyCompany", "state": "Washington", "addressLine3": "Anytown, USA", "secondaryPhone": "206-555-0101" }, "responseElements": null, "eventID": "5923c499-063e-44ac-80fb-b40example9f", "readOnly": false, "eventType": "AwsConsoleAction", "recipientAccountId": "1111-2222-3333" }
Tax console
The following example shows a CloudTrail log entry that uses the CreateCustomerCase
action.
{ "eventVersion":"1.05", "userIdentity":{ "accountId":"111122223333", "accessKeyId":"AIDACKCEVSQ6C2EXAMPLE" }, "eventTime":"2018-05-30T16:44:04Z", "eventSource":"taxconsole.amazonaws.com", "eventName":"CreateCustomerCase", "awsRegion":"us-east-1", "sourceIPAddress":"100.100.10.10", "requestParameters":{ "state":"NJ", "exemptionType":"501C", "exemptionCertificateList":[ { "documentName":"ExemptionCertificate.png" } ] }, "responseElements":{ "caseId":"case-111122223333-iris-2022-3cd52e8dbf262242" }, "eventID":"5923c499-063e-44ac-80fb-b40example9f", "readOnly":false, "eventType":"AwsConsoleAction", "recipientAccountId":"1111-2222-3333" }
Payments
The following example shows a CloudTrail log entry that uses the Instruments_Create
action.
{ "eventVersion": "1.08", "userIdentity": { "type": "Root", "principalId": "111122223333", "arn": "arn:aws:iam::111122223333:<iam>", "accountId": "111122223333", "accessKeyId": "AIDACKCEVSQ6C2EXAMPLE", "sessionContext": { "sessionIssuer": {}, "webIdFederationData": {}, "attributes": { "creationDate": "2024-05-01T00:00:00Z", "mfaAuthenticated": "false" } } }, "eventTime": "2024-05-01T00:00:00Z", "eventSource": "payments.amazonaws.com", "eventName": "Instruments_Create", "awsRegion": "us-east-1", "sourceIPAddress": "100.100.10.10", "userAgent": "AWS", "requestParameters": { "accountId": "111122223333", "paymentMethod": "CreditCard", "address": "HIDDEN_DUE_TO_SECURITY_REASONS", "accountHolderName": "HIDDEN_DUE_TO_SECURITY_REASONS", "cardNumber": "HIDDEN_DUE_TO_SECURITY_REASONS", "cvv2": "HIDDEN_DUE_TO_SECURITY_REASONS", "expirationMonth": "HIDDEN_DUE_TO_SECURITY_REASONS", "expirationYear": "HIDDEN_DUE_TO_SECURITY_REASONS", "tags": { "Department": "Finance" } }, "responseElements": { "paymentInstrumentArn": "arn:aws:payments::111122223333:payment-instrument:4251d66c-1b05-46ea-890c-6b4acf6b24ab", "paymentInstrumentId": "111122223333", "paymentMethod": "CreditCard", "consent": "NotProvided", "creationDate": "2024-05-01T00:00:00Z", "address": "HIDDEN_DUE_TO_SECURITY_REASONS", "accountHolderName": "HIDDEN_DUE_TO_SECURITY_REASONS", "expirationMonth": "HIDDEN_DUE_TO_SECURITY_REASONS", "expirationYear": "HIDDEN_DUE_TO_SECURITY_REASONS", "issuer": "Visa", "tail": "HIDDEN_DUE_TO_SECURITY_REASONS" }, "requestID": "7c7df9c2-c381-4880-a879-2b9037ce0573", "eventID": "c251942f-6559-43d2-9dcd-2053d2a77de3", "readOnly": true, "eventType": "AwsApiCall", "managementEvent": true, "recipientAccountId": "111122223333", "eventCategory": "Management", "sessionCredentialFromConsole": "true" }