AWS PRM documentation change
Summary
Added comprehensive troubleshooting sections for AWS Marketplace Metering and User Agent String methods, updated Resource Tagging section with clearer guidance, and expanded the common issues table to cover all three implementation methods
Security assessment
The changes are operational documentation updates focused on troubleshooting revenue attribution implementation methods for AWS partners. No security vulnerabilities, incidents, or security features are mentioned. The changes address implementation issues, tag conflicts, and CloudTrail logging verification for partner revenue measurement, which are business/operational concerns rather than security issues. The mention of CloudTrail is for verification purposes, not for security monitoring.
Diff
diff --git a/PRM/latest/aws-prm-onboarding-guide/troubleshooting.md b/PRM/latest/aws-prm-onboarding-guide/troubleshooting.md index 23283f746..21d8f608b 100644 --- a//PRM/latest/aws-prm-onboarding-guide/troubleshooting.md +++ b//PRM/latest/aws-prm-onboarding-guide/troubleshooting.md @@ -5 +5 @@ -Resource Tagging IssuesValidation and TestingCommon Implementation Errors +AWS Marketplace Metering IssuesResource Tagging IssuesUser Agent String IssuesValidation and TestingCommon Implementation Errors @@ -8,0 +9,28 @@ Resource Tagging IssuesValidation and TestingCommon Implementation Errors +This section provides troubleshooting guidance for each Partner Revenue Measurement implementation method: + + * AWS Marketplace Metering Issues + + * Resource Tagging Issues + + * User Agent String Issues + + + + +## AWS Marketplace Metering Issues + +AWS Marketplace Metering is a fully automated, zero-touch experience. Revenue attribution occurs automatically when customers purchase and use your AMI or ML product through AWS Marketplace. No additional implementation is required from partners. + +If you are experiencing issues with revenue attribution for your AWS Marketplace Metering products, open a support ticket through [APN Support](https://partnercentral.awspartner.com/partnercentral2/s/support) (Partner Central login required). Include the following details: + + * AWS account ID + + * AWS Marketplace product code + + * Product type (AMI or ML) + + * Description of the issue and expected behavior + + + + @@ -21 +49 @@ If resource tags are not generating revenue attribution: - 3. Confirm product code matches AWS Marketplace listing (see [Retrieve your product code](./product-code-retrieval.html)) + 3. Confirm product code matches AWS Marketplace listing (see [Product Code Retrieval](./product-code-retrieval.html)) @@ -23 +51 @@ If resource tags are not generating revenue attribution: - 4. Ensure resources are in [supported services](./included-aws-services.html#resource-tagging-supported-services) + 4. Ensure resources are in [supported services](./resource-tagging-included-services.html) @@ -25 +53 @@ If resource tags are not generating revenue attribution: - 5. Check that resources are actively consuming AWS services and incurring spend. Partner Revenue Measurement tracks revenue attribution based on AWS service consumption. For example, IAM is a no-cost AWS service, so tagging IAM resources will not generate revenue attribution. Focus on tagging resources that incur charges such as EC2 instances, S3 buckets with storage, RDS databases, or Lambda functions with invocations + 5. Check that resources are actively consuming AWS services and incurring spend. For example, IAM is a no-cost AWS service, so tagging IAM resources does not generate revenue attribution. Focus on tagging resources that incur charges such as EC2 instances, S3 buckets with storage, RDS databases, or Lambda functions with invocations @@ -34 +62 @@ If resource tags are not generating revenue attribution: -When multiple partners try to tag the same resource: +Since an AWS resource can only have one tag with the `aws-apn-id` key, only one partner identifier is allowed per resource. If another partner's tag exists on a resource, resource tagging creates a conflict. @@ -36 +64 @@ When multiple partners try to tag the same resource: -###### Resolve tag conflicts +For multi-partner scenarios where multiple partners operate on the same AWS resource, consider using the [User Agent String](./user-agent-string.html) method instead. Each partner can independently use their own identifier within their respective regular AWS API/CLI calls without conflicts. @@ -38 +66 @@ When multiple partners try to tag the same resource: - 1. Identify existing `aws-apn-id` tag on resource +If you must use resource tagging, coordinate with the other partner and the customer to determine tag ownership before making changes. @@ -40 +68 @@ When multiple partners try to tag the same resource: - 2. Remove existing tag: `aws resourcegroupstaggingapi untag-resources` +## User Agent String Issues @@ -42 +70 @@ When multiple partners try to tag the same resource: - 3. Add your tag: `aws resourcegroupstaggingapi tag-resources` +### User Agent string not appearing in CloudTrail @@ -44 +72 @@ When multiple partners try to tag the same resource: - 4. Document tag ownership change for audit purposes +If your User Agent string is not visible in CloudTrail logs: @@ -45,0 +74 @@ When multiple partners try to tag the same resource: +###### Verify User Agent implementation @@ -46,0 +76 @@ When multiple partners try to tag the same resource: + 1. Confirm the format is exactly: `APN_1.1/pc_<YOUR-PRODUCT-CODE>$` @@ -47,0 +78,33 @@ When multiple partners try to tag the same resource: + 2. Verify the `$` end delimiter is present and not stripped by your shell or runtime + + 3. Confirm product code matches AWS Marketplace listing (see [Product Code Retrieval](./product-code-retrieval.html)) + + 4. Ensure the User Agent string is applied to the correct AWS SDK client configuration, not just one service client + + 5. Check CloudTrail is enabled and logging the relevant API calls in the correct region + + 6. Verify the `userAgent` field in CloudTrail events contains your string + + + + +### Common format errors + +Common User Agent String Format Issues Issue | Cause | Solution +---|---|--- +Missing end delimiter | The `$` character was omitted or escaped by the shell | Ensure the string ends with `$`. Use single quotes or escape appropriately for your shell +Wrong prefix | Using incorrect prefix format | Use exactly `APN_1.1/pc_` as the prefix +Product code mismatch | Using Product ID or UUID instead of product code | Retrieve the alphanumeric product code from AWS Marketplace Management Portal (see [Product Code Retrieval](./product-code-retrieval.html)) +No API operations on resources | Resources not receiving API calls in a given month | Ensure your product performs at least one API operation on an AWS resource per month for attribution + +### CloudTrail Logs Verification + +Use the following command to verify your User Agent string appears in CloudTrail logs: + + + aws logs filter-log-events \ + --log-group-name CloudTrail/YourLogGroup \ + --filter-pattern "APN_1.1" \ + --start-time 1640995200000 + +Look for the `userAgent` field in CloudTrail events. The format should match: `APN_1.1/pc_<YOUR-PRODUCT-CODE>$` @@ -57 +120 @@ For official validation, contact your AWS partner management team or [APN Suppor - * Provide: Tag screenshots and test timestamps + * Provide: Tag screenshots or CloudTrail log excerpts and test timestamps @@ -66,5 +129,8 @@ For official validation, contact your AWS partner management team or [APN Suppor -Common Partner Revenue Measurement Implementation Issues Issue | Cause | Solution ----|---|--- -Tags not working | Wrong tag format | Use aws-apn-id key with pc:product-code value -No revenue attribution | Resources not incurring spend | Ensure resources are actively consuming AWS services and incurring charges. For example, IAM is a no-cost service, so tagging IAM resources will not generate revenue attribution. Focus on tagging resources that incur charges such as EC2 instances, S3 buckets with storage, RDS databases, or Lambda functions with invocations -Product code mismatch | Incorrect product code | Verify code in AWS Marketplace Management Portal (see Product Code Retrieval section) +Common Partner Revenue Measurement Implementation Issues Method | Issue | Cause | Solution +---|---|---|--- +Resource Tagging | Tags not working | Wrong tag format | Use `aws-apn-id` key with `pc:product-code` value +Resource Tagging | No revenue attribution | Resources not incurring spend | Ensure resources are actively consuming AWS services and incurring charges +Resource Tagging | Product code mismatch | Incorrect product code | Verify code in AWS Marketplace Management Portal (see [Product Code Retrieval](./product-code-retrieval.html)) +User Agent String | String not in CloudTrail | SDK not configured correctly | Verify SDK client configuration includes User Agent string for all service clients +User Agent String | Missing delimiter | `$` stripped by shell | Use single quotes or escape the `$` character appropriately +Marketplace Metering | No attribution | Product not purchased via Marketplace | Ensure customers purchase and use the product through AWS Marketplace. Open a support ticket via [APN Support](https://partnercentral.awspartner.com/partnercentral2/s/support)