# Logging for the AWS Marketplace API
The following sections provide information about logging.
**Topics**
+ [Logging AWS Marketplace Catalog API calls with CloudTrail](logging-catalog-api-calls-with-cloudtrail.md)
+ [Logging AWS Marketplace Agreement API calls with CloudTrail](logging-agreement-api-calls-with-cloudtrail.md)
+ [Logging AWS Marketplace Metering API calls with CloudTrail](logging-metering-api-calls-with-cloudtrail.md)
+ [Logging AWS Marketplace Deployment API calls with CloudTrail](logging-deployment-api-calls-with-cloudtrail.md)
+ [Logging AWS Marketplace Discovery API calls with AWS CloudTrail](logging-discovery-api-calls-with-cloudtrail.md)
# Logging AWS Marketplace Catalog API calls with CloudTrail
The AWS Marketplace Catalog API is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service. CloudTrail captures all calls to the Catalog API as events, including calls from the AWS Marketplace Management Portal.
If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon Simple Storage Service (Amazon S3) bucket. 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, the IP address from which the request was made, who made the request, when it was made, and additional details.
## AWS Marketplace Catalog API information in CloudTrail
CloudTrail is enabled on your AWS account when you create the account. When activity occurs in the AWS Marketplace Catalog API, 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](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html) in the *AWS CloudTrail User Guide*.
For an ongoing record of events in your AWS account, 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 AWS 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:
+ [Overview for Creating a Trail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html)
+ [CloudTrail Supported Services and Integrations](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-aws-service-specific-topics.html#cloudtrail-aws-service-specific-topics-integrations)
+ [Configuring Amazon SNS Notifications for CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/getting_notifications_top_level.html)
+ [Receiving CloudTrail Log Files from Multiple Regions](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/receive-cloudtrail-log-files-from-multiple-regions.html)
+ [Receiving CloudTrail Log Files from Multiple Accounts](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html)
All AWS Marketplace Catalog API actions are logged by CloudTrail and are documented in this API Reference. For example, calls to the `StartChangeSet`, `DescribeChangeSet`, and `ListChangeSets` API actions 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 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 [CloudTrail userIdentity Element](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html) in the *AWS CloudTrail User Guide*.
## Understanding AWS Marketplace catalog 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 do not appear in any specific order.
**Note**
These examples have been formatted for improved readability. In a CloudTrail log file, all entries and events are concatenated into a single line. In addition, this example has been limited to a single AWS Marketplace Catalog API entry. In a real CloudTrail log file, you see entries and events from multiple AWS services.
The following example shows a AWS Marketplace Catalog API log entry that demonstrates the `ListEntities` action:
```
[
{
"eventVersion": "1.05",
"userIdentity": {
"type": "IAMUser",
"principalId": "ABCDEFGHIJKLMNOP12345",
"arn": "arn:aws:iam::123456789010:user/CloudTrailTestUser",
"accountId": "123456789010",
"accessKeyId": "ABCDEFGHIJKLMNOP1234",
"userName": "CloudTrailTestUser"
},
"eventTime": "2019-10-17T21:49:23Z",
"eventSource": "marketplacecatalog.amazonaws.com",
"eventName": "ListEntities",
"awsRegion": "us-east-1",
"sourceIPAddress": "127.0.0.1",
"userAgent": "PostmanRuntime/7.18.0",
"requestParameters": {
"catalog": "AWSMarketplace",
"entityType": "EntityProduct",
"sort": {
"sortBy": "LastUpdateTimeInMillis",
"sortOrder": "DESC"
},
"maxResults": 20
},
"responseElements": null,
"requestID": "fEXAMPLE-cb3e-4e21-86fd-6b3EXAMPLEd1",
"eventID": "7EXAMPLE-97d6-4139-91e3-01aEXAMPLE48",
"readOnly": true,
"eventType": "AwsApiCall",
"recipientAccountId": "123456789010"
}
]
```
# Logging AWS Marketplace Agreement API calls with CloudTrail
The Agreements API is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in AWS Marketplace. CloudTrail captures API calls for the Agreements API as events. The calls captured include calls from the AWS Marketplace website, console, and other interfaces leveraging the Agreements API, as well as direct code calls to Agreements API operations.
If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for the Agreements API. A *trail* enables CloudTrail to deliver log files to an Amazon S3 bucket. 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 the Agreements API, the IP address from which the request was made, who made the request, when it was made, and additional details.
For more information about CloudTrail, see the [AWS CloudTrail User Guide](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html).
## Agreements API information in CloudTrail
CloudTrail is enabled on your AWS account when you create the account. When activity occurs in the Agreements API, 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](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html) in the *AWS CloudTrail User Guide*.
For an ongoing record of events in your AWS account, including events for the Agreements API, 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:
+ [Overview for creating a trail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html)
+ [CloudTrail supported services and integrations](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-aws-service-specific-topics.html)
+ [Configuring Amazon SNS notifications for CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/configure-sns-notifications-for-cloudtrail.html)
+ [Receiving CloudTrail log files from multiple regions](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/receive-cloudtrail-log-files-from-multiple-regions.html) and [Receiving CloudTrail log files from multiple accounts](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html)
The `AcceptAgreementRequest`, `CancelAgreement`, `DescribeAgreement`, `GetAgreementTerms`, and `SearchAgreements` Agreements API actions 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 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 [CloudTrail userIdentity element](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html) in the *AWS CloudTrail User Guide*.
## Understanding Agreements API actions
The Agreements API is used to purchase software as a service (SaaS), server (including container), and professional services products on AWS Marketplace. It’s also used to manage resulting agreements or subscriptions on AWS Marketplace.
**Note**
Purchases of machine learning or AWS Data Exchange products won’t be logged by CloudTrail.
The `AcceptAgreementRequest` action is used when an AWS Identity and Access Management (IAM) user or role of an AWS account purchases an applicable product on AWS Marketplace. Similarly, the `CancelAgreement` action is used when an IAM user or role cancels their agreement or subscription. By monitoring CloudTrail logs in the Agreements API, buyers can monitor the most important purchase-related actions happening in their AWS account on AWS Marketplace.
The `DescribeAgreement` action is used when the customer specifically views meta data for a specific agreement. The `GetAgreementTerms` action is used when the terms of a particular agreement are viewed. The `SearchAgreements` action is used when an IAM user or role lists or filters out a subset of their agreements from the full list of all their agreements.
**Note**
The `AcceptAgreementRequest` and `CancelAgreement` actions are available to buyers but not sellers. However, the `DescribeAgreement`, `GetAgreementTerms`, and `SearchAgreements` actions can be used by both buyers and sellers.
Buyers can also identify the Agreement ID of the agreement from the CloudTrail log. For more information about the agreement, choose the **Manage subscriptions** tab in the AWS Marketplace console, where the Agreement ID is provided in the **Details** view. The Agreement ID can be found in `responseElements` for the `AcceptAgreementRequest` API action and in `requestParameters` for the `CancelAgreement` API action.
## Understanding Agreements API 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 display in a specific order.
The following example shows a CloudTrail log entry that demonstrates the `AcceptAgreementRequest` action.
```
{
"eventVersion": "1.08",
"userIdentity": {
"type": "Unknown",
"principalId": "ABCDEFGHIJKLMNOP12345",
"arn": "arn:aws:iam::123456789010:user/CloudTrailTestUser",
"accountId": "123456789010",
"accessKeyId": "ABCDEFGHIJKLMNOP123"
},
"eventTime": "2023-08-11T17:13:50Z",
"eventSource": "agreement-marketplace.amazonaws.com",
"eventName": "AcceptAgreementRequest",
"awsRegion": "us-west-2",
"sourceIPAddress": "127.0.0.1",
"userAgent": "Coral/Netty4",
"requestParameters": {
"agreementRequestId": "ar-6xbrddjzym594imkrrezrn5wa"
},
"responseElements": {
"agreementId": "agmt-1lnrq6riwpg2tczhv378zknlc"
},
"requestID": "fEXAMPLE-cb3e-4e21-86fd-6b3EXAMPLEd1",
"eventID": "7EXAMPLE-97d6-4139-91e3-01aEXAMPLE48",
"readOnly": false,
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "123456789010",
"eventCategory": "Management"
}
```
The following example shows a CloudTrail log entry that demonstrates the `CancelAgreement` action.
```
{
"eventVersion": "1.08",
"userIdentity": {
"type": "Unknown",
"principalId": "ABCDEFGHIJKLMNOP12345",
"arn": "arn:aws:iam::123456789010:user/CloudTrailTestUser",
"accountId": "123456789010",
"accessKeyId": "ABCDEFGHIJKLMNOP1234"
},
"eventTime": "2023-08-14T03:11:42Z",
"eventSource": "agreement-marketplace.amazonaws.com",
"eventName": "CancelAgreement",
"awsRegion": "us-west-2",
"sourceIPAddress": "127.0.0.1",
"userAgent": "Coral/Netty4",
"requestParameters": {
"agreementId": "agmt-enitbfqjebjmwmomzrucf032t"
},
"responseElements": null,
"requestID": "fEXAMPLE-cb3e-4e21-86fd-6b3EXAMPLEd1",
"eventID": "7EXAMPLE-97d6-4139-91e3-01aEXAMPLE48",
"readOnly": false,
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "123456789010",
"eventCategory": "Management"
}
```
The following example shows a CloudTrail log entry that demonstrates the `DescribeAgreement` action.
```
{
"eventVersion": "1.08",
"userIdentity": {
"type": "Unknown",
"principalId": "ABCDEFGHIJKLMNOP12345",
"arn": "arn:aws:iam::123456789010:user/CloudtrailTestUser",
"accountId": "123456789010",
"accessKeyId": "ABCDEFGHIJKLMNOP123",
},
"eventTime": "2023-10-30T22:45:24Z",
"eventSource": "agreement-marketplace.amazonaws.com",
"eventName": "DescribeAgreement",
"awsRegion": "us-west-2",
"sourceIPAddress": "127.0.0.1",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36",
"requestParameters": {
"agreementId": "agmt-6wy4rhp7l6iyuu2jrcgd1shdi"
},
"responseElements": null,
"requestID": "bEXAMPLE-347f-4c07-9645-cd2EXAMPLE61",
"eventID": "dEXAMPLE-d891-42a5-8da6-1cdEXAMPLE34",
"readOnly": true,
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "123456789010",
"eventCategory": "Management",
}
```
The following example shows a CloudTrail log entry that demonstrates the `GetAgreementTerms` action.
```
{
"eventVersion": "1.08",
"userIdentity": {
"type": "Unknown",
"principalId": "ABCDEFGHIJKLMNOP12345",
"arn": "arn:aws:iam::123456789010:user/CloudtrailTestUser",
"accountId": "123456789010",
"accessKeyId": "ABCDEFGHIJKLMNOP123",
},
"eventTime": "2023-10-30T22:48:37Z",
"eventSource": "agreement-marketplace.amazonaws.com",
"eventName": "GetAgreementTerms",
"awsRegion": "us-west-2",
"sourceIPAddress": "127.0.0.1",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36",
"requestParameters": {
"agreementId": "agmt-6wy4rhp7l6iyuu2jrcgd1shdi"
},
"responseElements": null,
"requestID": "eEXAMPLE-fc57-4127-bbda-bc1EXAMPLE03",
"eventID": "bEXAMPLE-5345-4634-8b58-925EXAMPLE3e",
"readOnly": true,
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "123456789010",
"eventCategory": "Management",
}
```
The following example shows a CloudTrail log entry that demonstrates the `SearchAgreements` action.
```
{
"eventVersion": "1.08",
"userIdentity": {
"type": "Unknown",
"principalId": "ABCDEFGHIJKLMNOP12345",
"arn": "arn:aws:iam::123456789010:user/CloudtrailTestUser",
"accountId": "123456789010",
"accessKeyId": "ABCDEFGHIJKLMNOP123",
},
"eventTime": "2023-10-30T18:41:10Z",
"eventSource": "agreement-marketplace.amazonaws.com",
"eventName": "SearchAgreements",
"awsRegion": "us-west-2",
"sourceIPAddress": "127.0.0.1",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/117.0.0.0 Safari/537.36",
"requestParameters": {
"catalog": "AWSMarketplace",
"filters": [
{
"name": "PartyType",
"values": [
"Proposer"
]
},
{
"name": "ResourceType",
"values": [
"SaaSProduct"
]
},
{
"name": "Status",
"values": [
"ACTIVE"
]
},
{
"name": "AgreementType",
"values": [
"PurchaseAgreement"
]
}
],
"maxResults": 5
},
"responseElements": null,
"requestID": "fEXAMPLE-0aa6-4e42-8715-6a1EXAMPLE95",
"eventID": "0EXAMPLE-8ce8-4814-bcf1-636EXAMPLEb5",
"readOnly": true,
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "123456789010",
"eventCategory": "Management",
}
```
# Logging AWS Marketplace Metering API calls with CloudTrail
The Metering API is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service in AWS Marketplace. CloudTrail captures API calls for the Metering API as events. The calls captured include calls from the AWS Marketplace website, console, and other interfaces leveraging the Metering API, as well as direct code calls to Metering API operations.
If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for the Metering API. A *trail* enables CloudTrail to deliver log files to an Amazon S3 bucket. 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 the Metering API, the IP address from which the request was made, who made the request, when it was made, and additional details.
For more information about CloudTrail, see the [AWS CloudTrail User Guide](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html).
## Metering API information in CloudTrail
CloudTrail is enabled on your AWS account when you create the account. When activity occurs in the Metering API, 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](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html) in the *AWS CloudTrail User Guide*.
For an ongoing record of events in your AWS account, including events for the Metering API, 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:
+ [Overview for creating a trail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html)
+ [CloudTrail supported services and integrations](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-aws-service-specific-topics.html)
+ [Configuring Amazon SNS notifications for CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/configure-sns-notifications-for-cloudtrail.html)
+ [Receiving CloudTrail log files from multiple regions](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/receive-cloudtrail-log-files-from-multiple-regions.html) and [Receiving CloudTrail log files from multiple accounts](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html)
The `BatchMeterUsage` action for SaaS-based products, `RegisterUsage` action for container-based products, and `MeterUsage` action for Amazon Machine Image (AMI)-based and container based products 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 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 [CloudTrail userIdentity element](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html) in the *AWS CloudTrail User Guide*.
## Understanding Metering API log file entries
### Example: `BatchMeterUsage` for SaaS-based products
The following example shows a CloudTrail log entry that demonstrates the `BatchMeterUsage` action from the AWS Marketplace Metering API. When the seller [sends metering records to report their customers' usage](https://docs.aws.amazon.com/marketplace/latest/userguide/metering-for-usage.html) for a software as a service (SaaS) product listed in AWS Marketplace, this CloudTrail log entry is logged in the seller's AWS account.
```
{
"eventVersion": "1.05",
"userIdentity": {
"type": "IAMUser",
"principalId": "EX_PRINCIPAL_ID",
"arn": "arn:aws:iam::123456789012:user/*****",
"accountId": "123456789012",
"accessKeyId": "EXAMPLE_KEY_ID",
"userName": "*****"
},
"eventTime": "2018-04-19T16:32:51Z",
"eventSource": "metering-marketplace.amazonaws.com",
"eventName": "BatchMeterUsage",
"awsRegion": "us-east-1",
"sourceIPAddress": "************",
"userAgent": "Coral/Netty14",
"requestParameters": {
"usageRecords": [
{
"dimension": "Dimension1",
"timestamp": "Apr 19, 2018 4:32:50 PM",
"customerIdentifier": "customer1",
"customerAWSAccountID": "987654321098",
"quantity": 1
}
],
"productCode": "EXAMPLE_proCode"
},
"responseElements": {
"results": [
{
"usageRecord": {
"dimension": "Dimension1",
"timestamp": "Apr 19, 2018 4:32:50 PM",
"customerIdentifier": "customer1",
"customerAWSAccountID": "987654321098",
"quantity": 1
},
"meteringRecordId": "bEXAMPLE-98f0-4e90-8bd2-bf0EXAMPLE1e",
"status": "Success"
}
],
"unprocessedRecords": [ ]
},
"requestID": "dEXAMPLE-251d-11e7-8d11-1f3EXAMPLE8b",
"eventID": "cEXAMPLE-e6c2-465d-b47f-150EXAMPLE97",
"readOnly": false,
"eventType": "AwsApiCall",
"recipientAccountId": "123456789012"
}
```
### Example: `RegisterUsage` for containers-based products deployed on Amazon EKS
The following example shows a CloudTrail log entry that demonstrates the `RegisterUsage` action from the AWS Marketplace Metering API. When an hourly priced container product from AWS Marketplace is deployed in the buyer's AWS account, the software in the container calls `RegisterUsage` within the buyer's AWS account to initiate the hourly metering for that Amazon Elastic Container Service (Amazon ECS) task or Amazon Elastic Kubernetes Service (Amazon EKS) pod. This CloudTrail log entry is logged in the buyer's AWS account.
```
{
"eventVersion": "1.05",
"userIdentity": {
"type": "AssumedRole",
"principalId": "EX_PRINCIPAL_ID:botocore-session-1111111111",
"arn": "arn:aws:sts::123456789012:assumed-role/Alice/botocore-session-1111111111",
"accountId": "123456789012",
"accessKeyId": "EXAMPLE_KEY_ID",
"sessionContext": {
"sessionIssuer": {
"type": "Role",
"principalId": "EX_PRINCIPAL_ID",
"arn": "arn:aws:iam::123456789012:role/Alice",
"accountId": "123456789012",
"userName": "Alice"
},
"webIdFederationData": {
"federatedProvider": "arn:aws:iam::123456789012:oidc-provider/oidc.eks.us-east-1.amazonaws.com/id/EXAMPLEFA1C58F08CDB049167EXAMPLE",
"attributes": {}
},
"attributes": {
"mfaAuthenticated": "false",
"creationDate": "2020-07-23T02:19:34Z"
}
}
},
"eventTime": "2020-07-23T02:19:46Z",
"eventSource": "metering-marketplace.amazonaws.com",
"eventName": "RegisterUsage",
"awsRegion": "us-east-1",
"sourceIPAddress": "1.2.3.4",
"userAgent": "aws-cli/1.18.103 Python/3.8.2 Linux/4.14.181-142.260.amzn2.x86_64 botocore/1.17.26",
"requestParameters": {
"productCode": "EXAMPLE_proCode",
"publicKeyVersion": 1
},
"responseElements": {
"signature": "eyJhbGciOiJQUzI1Ni..."
},
"requestID": "dEXAMPLE-251d-11e7-8d11-1f3EXAMPLE8b",
"eventID": "cEXAMPLE-e6c2-465d-b47f-150EXAMPLE97",
"eventType": "AwsApiCall",
"recipientAccountId": "123456789012"
}
```
### Example: `MeterUsage` for container-based products deployed on Amazon EKS
The following example shows a CloudTrail log entry that demonstrates the `MeterUsage` action from the AWS Marketplace Metering API for containers on Amazon EKS. When a container product with [custom metering](https://docs.aws.amazon.com/marketplace/latest/userguide/container-metering-meterusage.html) from AWS Marketplace is deployed in the buyer's AWS account, the software in the container calls `MeterUsage` within the buyer's AWS account to report each hour. This CloudTrail log entry is logged in the buyer's AWS account.
```
{
"eventVersion": "1.05",
"userIdentity": {
"type": "AssumedRole",
"principalId": "EX_PRINCIPAL_ID:botocore-session-1111111111",
"arn": "arn:aws:sts::123456789012:assumed-role/Alice/botocore-session-1111111111",
"accountId": "123456789012",
"accessKeyId": "EXAMPLE_KEY_ID",
"sessionContext": {
"sessionIssuer": {
"type": "Role",
"principalId": "EX_PRINCIPAL_ID",
"arn": "arn:aws:iam::123456789012:role/Alice",
"accountId": "123456789012",
"userName": "Alice"
},
"webIdFederationData": {
"federatedProvider": "arn:aws:iam::123456789012:oidc-provider/oidc.eks.us-east-1.amazonaws.com/id/EXAMPLEFA1C58F08CDB049167EXAMPLE",
"attributes": {}
},
"attributes": {
"mfaAuthenticated": "false",
"creationDate": "2020-07-23T01:03:26Z"
}
}
},
"eventTime": "2020-07-23T01:38:13Z",
"eventSource": "metering-marketplace.amazonaws.com",
"eventName": "MeterUsage",
"awsRegion": "us-east-1",
"sourceIPAddress": "1.2.3.4",
"userAgent": "aws-cli/1.18.103 Python/3.8.2 Linux/4.14.181-142.260.amzn2.x86_64 botocore/1.17.26",
"requestParameters": {
"timestamp": "Jul 23, 2020 1:35:44 AM",
"usageQuantity": 1,
"usageDimension": "Dimension1",
"productCode": "EXAMPLE_proCode"
},
"responseElements": {
"meteringRecordId": "bEXAMPLE-98f0-4e90-8bd2-bf0EXAMPLE1e"
},
"requestID": "dEXAMPLE-251d-11e7-8d11-1f3EXAMPLE8b",
"eventID": "cEXAMPLE-e6c2-465d-b47f-150EXAMPLE97",
"eventType": "AwsApiCall",
"recipientAccountId": "123456789012"
}
```
### Example: `MeterUsage` for AMI-based products
The following example shows a CloudTrail log entry that demonstrates the `MeterUsage` action from the AWS Marketplace Metering API for Amazon Machine Images (AMIs). When an AMI product with custom metering from AWS Marketplace is deployed in the buyer's AWS account, the software from the AMI calls `MeterUsage` within the buyer's AWS account to report usage each hour. This CloudTrail log entry is logged in the buyer's AWS account.
```
{
"eventVersion": "1.05",
"userIdentity": {
"type": "AssumedRole",
"principalId": "EX_PRINCIPAL_ID:i-exampled859aa775c",
"arn": "arn:aws:sts::123456789012:assumed-role/Alice/i-exampled859aa775c",
"accountId": "123456789012",
"accessKeyId": "EXAMPLE_KEY_ID",
"sessionContext": {
"sessionIssuer": {
"type": "Role",
"principalId": "EX_PRINCIPAL_ID",
"arn": "arn:aws:iam::123456789012:role/Alice",
"accountId": "123456789012",
"userName": "Alice"
},
"webIdFederationData": {},
"attributes": {
"mfaAuthenticated": "false",
"creationDate": "2020-07-10T23:05:20Z"
},
"ec2RoleDelivery": "1.0"
}
},
"eventTime": "2020-07-10T23:06:42Z",
"eventSource": "metering-marketplace.amazonaws.com",
"eventName": "MeterUsage",
"awsRegion": "us-east-1",
"sourceIPAddress": "1.2.3.4",
"userAgent": "aws-cli/1.16.102 Python/2.7.16 Linux/4.14.133-113.112.amzn2.x86_64 botocore/1.12.92",
"requestParameters": {
"productCode": "EXAMPLE_proCode",
"timestamp": "Jul 10, 2020 11:06:41 PM",
"usageDimension": "Dimension1",
"usageQuantity": 1,
"dryRun": false
},
"responseElements": {
"meteringRecordId": "bEXAMPLE-98f0-4e90-8bd2-bf0EXAMPLE1e"
},
"requestID": "dEXAMPLE-251d-11e7-8d11-1f3EXAMPLE8b",
"eventID": "cEXAMPLE-e6c2-465d-b47f-150EXAMPLE97",
"eventType": "AwsApiCall",
"recipientAccountId": "123456789012"
}
```
# Logging AWS Marketplace Deployment API calls with CloudTrail
The AWS Marketplace Deployment Service is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service.
If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon Simple Storage Service (Amazon S3) bucket. 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, the IP address from which the request was made, who made the request, when it was made, and additional details.
## AWS Marketplace Deployment Service information in CloudTrail
CloudTrail is enabled on your AWS account when you create the account. When activity occurs in the AWS Marketplace Deployment Service, 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](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/view-cloudtrail-events.html) in the *AWS CloudTrail User Guide*.
For an ongoing record of events in your AWS account, 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 AWS 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:
+ [Overview for Creating a Trail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-create-and-update-a-trail.html)
+ [CloudTrail Supported Services and Integrations](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-aws-service-specific-topics.html#cloudtrail-aws-service-specific-topics-integrations)
+ [Configuring Amazon SNS Notifications for CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/getting_notifications_top_level.html)
+ [Receiving CloudTrail Log Files from Multiple Regions](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/receive-cloudtrail-log-files-from-multiple-regions.html)
+ [Receiving CloudTrail Log Files from Multiple Accounts](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-receive-logs-from-multiple-accounts.html)
All Deployment Service actions are logged by CloudTrail and are documented in this API reference. For example, calls to the `PutDeploymentParameter`API action generates 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 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 [CloudTrail userIdentity Element](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-event-reference-user-identity.html) in the *AWS CloudTrail User Guide*.
## Understanding AWS Marketplace 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 do not appear in any specific order.
**Note**
These examples have been formatted for improved readability. In a CloudTrail log file, all entries and events are concatenated into a single line. In addition, this example has been limited to a single Deployment Service entry. In a real CloudTrail log file, you see entries and events from multiple AWS services.
The following example shows a Deployment Service log entry that demonstrates the `PutDeploymentParameter` action:
```
{
"eventVersion": "1.08",
"userIdentity": {
"type": "Unknown",
"principalId": "ABCDEFGHIJKLMNOP12345",
"arn": "arn:aws:iam::123456789010:user/CloudTrailTestUser",
"accountId": "123456789010",
"accessKeyId": "ABCDEFGHIJKLMNOP123"
},
"eventTime": "2023-11-16T16:32:48Z",
"eventSource": "deployment-marketplace.amazonaws.com",
"eventName": "PutDeploymentParameter",
"awsRegion": "us-east-1",
"sourceIPAddress": "192.0.2.0",
"userAgent": "aws-sdk-java/2.20.162 Mac_OS_X/13.5.2 OpenJDK_64-Bit_Server_VM/18.0.1+10-FR Java/18.0.1 vendor/Amazon.com_Inc. io/sync http/UrlConnection cfg/retry-mode/legacy",
"requestParameters": {
"productId": "prod-fEXAMPLE-cb3e-4e21-86fd-6b3EXAMPLEd1",
"catalog": "AWSMarketplace",
"clientToken": "fEXAMPLE-cb3e-4e21-86fd-6b3EXAMPLEd1",
"agreementId": "agmt-fEXAMPLE-cb3e-4e21-86fd-6b3EXAMPLEd1",
"deploymentParameter": {
"name": "PutDeploymentParameterCloudTrailTest-secret",
"secretString": "***"
},
"expirationDate": "2023-11-30T03:02:26.779241Z"
}
},
"responseElements": {
"agreementId": "agmt-fEXAMPLE-cb3e-4e21-86fd-6b3EXAMPLEd1",
"deploymentParametersId": "dp-fEXAMPLE-cb3e-4e21-86fd-6b3EXAMPLEd1",
"resourceArn": "arn:aws:aws-marketplace:us-east-1:123456789010:DeploymentParameter:catalogs/AWSMarketplace/products/prod-fEXAMPLE-cb3e-4e21-86fd-6b3EXAMPLEd1/dp-fEXAMPLE-cb3e-4e21-86fd-6b3EXAMPLEd1"
},
"requestID": "fEXAMPLE-cb3e-4e21-86fd-6b3EXAMPLEd1",
"eventID": "fEXAMPLE-cb3e-4e21-86fd-6b3EXAMPLEd1",
"readOnly": false,
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "123456789010",
"eventCategory": "Management"
}
```
# Logging AWS Marketplace Discovery API calls with AWS CloudTrail
The AWS Marketplace Discovery API is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service. CloudTrail captures all Discovery API calls as events, including calls from the AWS SDK and the AWS CLI.
## Discovery API information in CloudTrail
CloudTrail is enabled on your AWS account when you create the account. When activity occurs in the Discovery API, that activity is recorded in a CloudTrail event along with other AWS service events in **Event history**.
All Discovery API actions are logged by CloudTrail. The following operations generate entries in CloudTrail log files:
+ `GetListing`
+ `GetProduct`
+ `GetOffer`
+ `GetOfferTerms`
+ `GetOfferSet`
+ `ListPurchaseOptions`
+ `ListFulfillmentOptions`
+ `SearchFacets`
+ `SearchListings`
The event source for Discovery API events is `discovery-marketplace.amazonaws.com`.
## Example Discovery API log entry
The following example shows a CloudTrail log entry that demonstrates the `GetListing` action.
```
{
"eventVersion": "1.08",
"userIdentity": {
"type": "IAMUser",
"principalId": "EXAMPLE",
"arn": "arn:aws:iam::123456789012:user/ExampleUser",
"accountId": "123456789012",
"accessKeyId": "EXAMPLE",
"userName": "ExampleUser"
},
"eventTime": "2026-04-01T15:30:00Z",
"eventSource": "discovery-marketplace.amazonaws.com",
"eventName": "GetListing",
"awsRegion": "us-east-1",
"sourceIPAddress": "203.0.113.50",
"userAgent": "aws-sdk-python/1.34.0 Python/3.12.0",
"requestParameters": {
"listingId": "listing-saas-abc123"
},
"responseElements": null,
"requestID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"eventID": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
"readOnly": true,
"eventType": "AwsApiCall",
"managementEvent": true,
"recipientAccountId": "123456789012",
"eventCategory": "Management"
}
```