AWS marketplace documentation change
Summary
Added documentation for new EventBridge event types related to agreements and licenses, including detailed examples of event payloads for purchase agreement lifecycle events (created/amended/ended) and license entitlement changes (updated/deprovisioned).
Security assessment
The changes add monitoring capabilities for business operations (agreement lifecycle and license management) but do not address security vulnerabilities or describe security-specific features. While license deprovisioning could have security implications, the documentation focuses on operational notifications rather than vulnerability mitigation.
Diff
diff --git a/marketplace/latest/userguide/notifications-eventbridge.md b/marketplace/latest/userguide/notifications-eventbridge.md index 39a32a57b..2c34dae7a 100644 --- a//marketplace/latest/userguide/notifications-eventbridge.md +++ b//marketplace/latest/userguide/notifications-eventbridge.md @@ -5 +5 @@ -Events for new offersEvents for change setsEvents for security summary reportEvents for disbursements +Events for new offersEvents for change setsEvents for security summary reportEvents for disbursementsEvents for agreementsEvents for licenses @@ -20,0 +21,4 @@ As a seller, you can use Amazon EventBridge to receive notifications for events + * Events for agreements + + * Events for licenses + @@ -34,0 +39,5 @@ Security vulnerabilities were detected on the ISV's product | `Products Security +Customer subscribes to SaaS product | `Purchase Agreement Created` | Events for agreements +Customer's SaaS agreement is amended | `Purchase Agreement Amended` | Events for agreements +Customer cancels SaaS subscription | `Purchase Agreement Ended` | Events for agreements +Customer's SaaS entitlements change | `License Updated` | Events for licenses +Customer's SaaS entitlements are revoked | `License Deprovisioned` | Events for licenses @@ -323,0 +333,326 @@ For more information about creating Amazon EventBridge rules, see [Rules in Amaz +## Events for agreements + +When agreement events occur, sellers can receive notifications for purchase agreement lifecycle changes. + +For information on creating EventBridge rules, see [Amazon EventBridge rules](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rules.html) in the _Amazon EventBridge User Guide_. + +The following is an example event body for **Purchase Agreement Created - Proposer**. + +###### Note + +Resale Authorization Id in case of Channel Partner Private Offer (CPPO) will be populated, and in case of Marketplace direct offer (MPPO), this value would be null. + + + { + "version": "0", + "id": "12345678-1234-1234-1234-123456789012", + "detail-type": "Purchase Agreement Created - Proposer", + "source": "aws.agreement-marketplace", + "account": "<ISV's or CP's account id>", + "time": "2024-08-30T21:36:03Z", + "region": "us-east-1", + "resources": [ + "arn:aws:aws-marketplace::aws:agreement:agmt-4mwg1nevbokzw95eca5797ixs" + ], + "detail": { + "requestId": "3d4c9f9b-b809-4f5e-9fac-a9ae98b05cbb", + "catalog": "AWSMarketplace", + "agreement": { + "id": "agmt-4mwg1nevbokzw95eca5797ixs", + "intent": "NEW", + "status": "ACTIVE", + "acceptanceTime": "2024-06-26T21:36:03Z", + "startTime": "2024-08-30T21:36:03Z", + "endTime": "2025-05-30T21:36:03Z" + }, + "resaleAuthorization": { + "id": "resaleauthz-yaxjqxiskysxa" + }, + "acceptor": { + "accountId": "845735284135" + }, + "proposer": { + "accountId": "123456512334" + }, + "offer": { + "id": "offer-1234567890123" + } + } + } + +The following is an example event body for **Purchase Agreement Created - Manufacturer**. + + + { + "version": "0", + "id": "12345678-1234-1234-1234-123456789012", + "detail-type": "Purchase Agreement Created - Manufacturer", + "source": "aws.agreement-marketplace", + "account": "<ISV's account id>", + "time": "2024-08-30T21:36:03Z", + "region": "us-east-1", + "resources": [ + "arn:aws:aws-marketplace::aws:agreement:agmt-4mwg1nevbokzw95eca5797ixs" + ], + "detail": { + "requestId": "3d4c9f9b-b809-4f5e-9fac-a9ae98b05cbb", + "catalog": "AWSMarketplace", + "agreement": { + "id": "agmt-4mwg1nevbokzw95eca5797ixs", + "intent": "NEW", + "status": "ACTIVE", + "acceptanceTime": "2024-06-26T21:36:03Z", + "startTime": "2024-08-30T21:36:03Z", + "endTime": "2025-05-30T21:36:03Z" + }, + "resaleAuthorization": { + "id": "resaleauthz-yaxjqxiskysxa" + }, + "acceptor": { + "accountId": "845735284135" + }, + "proposer": { + "accountId": "123456512334" + }, + "offer": { + "id": "offer-1234567890123" + } + } + } + +The following is an example event body for **Purchase Agreement Amended - Proposer**. + + + { + "version": "0", + "id": "12345678-1234-1234-1234-123456789012", + "detail-type": "Purchase Agreement Amended - Proposer", + "source": "aws.agreement-marketplace", + "account": "<ISV or CP's account id>", + "time": "2024-08-30T21:36:03Z", + "region": "us-east-1", + "resources": [ + "arn:aws:aws-marketplace::aws:agreement:agmt-4mwg1nevbokzw95eca5797ixs" + ], + "detail": { + "requestId": "3d4c9f9b-b809-4f5e-9fac-a9ae98b05cbb", + "catalog": "AWSMarketplace", + "agreement": { + "id": "agmt-4mwg1nevbokzw95eca5797ixs", + "intent": "AMEND", + "status": "ACTIVE", + "acceptanceTime": "2024-06-26T21:36:03Z", + "startTime": "2024-08-30T21:36:03Z", + "endTime": "2025-05-30T21:36:03Z" + }, + "resaleAuthorization": { + "id": "resaleauthz-yaxjqxiskysxa" + }, + "acceptor": { + "accountId": "845735284135" + }, + "proposer": { + "accountId": "123456512334" + }, + "offer": { + "id": "offer-1234567890123" + } + } + } + +The following is an example event body for **Purchase Agreement Amended - Manufacturer**. + + + { + "version": "0", + "id": "12345678-1234-1234-1234-123456789012", + "detail-type": "Purchase Agreement Amended - Manufacturer", + "source": "aws.agreement-marketplace", + "account": "<ISV's account id>", + "time": "2024-08-30T21:36:03Z", + "region": "us-east-1", + "resources": [ + "arn:aws:aws-marketplace::aws:agreement:agmt-4mwg1nevbokzw95eca5797ixs" + ], + "detail": { + "requestId": "3d4c9f9b-b809-4f5e-9fac-a9ae98b05cbb", + "catalog": "AWSMarketplace", + "agreement": { + "id": "agmt-4mwg1nevbokzw95eca5797ixs", + "intent": "AMEND", + "status": "ACTIVE", + "acceptanceTime": "2024-06-26T21:36:03Z", + "startTime": "2024-08-30T21:36:03Z", + "endTime": "2025-05-30T21:36:03Z" + }, + "resaleAuthorization": { + "id": "resaleauthz-yaxjqxiskysxa" + }, + "acceptor": { + "accountId": "845735284135" + }, + "proposer": { + "accountId": "123456512334" + }, + "offer": { + "id": "offer-1234567890123" + } + } + } + +The following is an example event body for **Purchase Agreement Ended - Proposer**. + + + { + "version": "0", + "id": "12345678-1234-1234-1234-123456789012", + "detail-type": "Purchase Agreement Ended - Proposer", + "source": "aws.agreement-marketplace", + "account": "<ISV's account id>", + "time": "2024-08-30T21:36:03Z", + "region": "us-east-1",