View a markdown version of this page

Utilisation de vos identifiants d'attribution de revenus - AWS Partner Central
Qu'est-ce qu'un identifiant d'attribution des recettes ?Utilisation de vos identifiants d'attribution de revenus

La référence de AWS Partner Central l'API a été restructurée. Pour plus d'informations sur les opérations d'API prises en charge, consultez la référence des AWS Partner Central API.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Utilisation de vos identifiants d'attribution de revenus

Un identifiant d'attribution des revenus est un identifiant au niveau de l'offre qui associe les revenus de vos produits AWS Marketplace aux offres spécifiques du Marketplace et à des AWS opportunités centrales pour les and/or AWS partenaires. Il s'appuie sur la mise en œuvre de la mesure des revenus des partenaires (PRM) au niveau du produit : le PRM capture le total des revenus attribués à un produit Marketplace, et un identifiant d'attribution des revenus associe ces revenus à des offres spécifiques en fonction des pourcentages de répartition des coûts mensuels que vous spécifiez.

Le service d'attribution des recettes expose des API permettant de créer, de récupérer, de répertorier et de mettre à jour les identifiants d'attribution des recettes et de gérer leurs entrées de répartition des coûts mensuelles de manière asynchrone.

Qu'est-ce qu'un identifiant d'attribution des recettes ?

Un identifiant d'attribution des recettes comporte deux couches :

  • L'attribution d'une ressource nommée par le partenaire et décrite par le partenaire identifiée par un ID de ra- préfixe (par exemple) et un ARN. ra-aabbccddee001 Chaque attribution est limitée à un compte Catalog (AWSpour la production, Sandbox pour les tests) et au compte du partenaire.

  • Une ou plusieurs entrées de répartition des coûts mensuelles, chaque entrée associe une combinaison unique (ID d'offre ou ID d'opportunité, mois de facturation) à un pourcentage de répartition des coûts. Les entrées sont gérées par lots de manière asynchrone via un modèle de tâche d'allocation.

Un identifiant d'attribution des recettes peut être utilisé de deux manières :

  • En tant que superposition au niveau de l'offre à votre implémentation PRM existante au niveau du produit. Créez un identifiant d'attribution des revenus, associez vos offres de marché applicables aux opportunités and/or ACE et AWS associez les revenus de vos produits déjà mesurés à ces offres spécifiques. Aucune modification de vos balises de ressources ou chaînes d'agent utilisateur existantes n'est requise.

  • En tant qu'identifiant autonome utilisé directement comme valeur de balise de ressource (aws-apn-id=<RA ID>) ou dans une chaîne d'agent utilisateur (APN_1.1/pc_<RA ID>$) pour attribuer la AWS consommation à une offre spécifique dès le départ.

Utilisation de vos identifiants d'attribution de revenus

Les partenaires peuvent gérer les identifiants d'attribution des recettes et leurs entrées mensuelles de répartition des coûts via le service d'attribution des recettes. Le cycle de vie progresse à travers deux flux indépendants : le flux d'enregistrement d'attribution (créer, mettre à jour, récupérer, répertorier) et le flux d'allocations (démarrer une tâche groupée, interroger les résultats, récupérer des entrées individuelles, répertorier les entrées pour une attribution).

Création d'un identifiant d'attribution des recettes

La première étape consiste à créer un identifiant d'attribution des recettes à l'aide de l'action de l'CreateRevenueAttributionAPI. La valeur renvoyée Id et Arn peut être utilisée immédiatement comme valeur de balise de ressource ou dans une chaîne d'agent utilisateur pour attribuer la consommation. AWS

Lors de la création d'un identifiant d'attribution des recettes, les partenaires doivent fournir :

  • Catalog— AWS pour la production ou Sandbox pour les essais.

  • Name— un nom lisible par l'homme pour l'attribution. Doit être unique dans le catalogue et dans le compte du partenaire. 128 caractères maximum.

Les partenaires peuvent éventuellement fournir :

  • Description— description en texte libre de l'attribution. 1024 caractères maximum.

  • MarketplaceProduct— le produit AWS Marketplace à associer à cette attribution. Indiquez ProductIdentifier (l'identifiant du produit Marketplace à 25 caractères) et TenancyModel (MULTI_TENANTouSINGLE_TENANT). En cas d'omission lors de la création, l'attribution s'applique à toutes les consommations mesurées sous l'identifiant d'attribution des recettes, quel que soit le produit Marketplace acheté par le client, ce qui est utile lorsqu'un seul déploiement couvre plus d'une fiche Marketplace.

  • Tags— jusqu'à 200 paires clé-valeur pour l'organisation des ressources. Les clés de tag doivent être uniques dans la demande.

Bonne pratique : indiquez MarketplaceProduct.ProductIdentifier chaque fois que votre offre est liée à une liste spécifique du Marketplace. Cela permet de AWS vérifier que le produit appartient au compte du partenaire appelant ou à un compte filiale connecté via Partner Account Connection (PAC), et de faire apparaître le « ProductCode et » résolu ProductType (par exemple SaaSAMI,,ML) dans la réponse. Si le produit n'appartient pas à un compte autorisé, l'API renvoie le produit ValidationException avec raisonPRODUCT_NOT_FOUND_OR_NOT_OWNED.

La réponse renvoie les nouveaux MarketplaceProduct attributs Id (formatra-[a-z0-9]{13}) résolus et le Version numéro initial (qui commence à 1 et augmente à chaque mise à jour suivante). Arn

Ajouter des entrées de répartition des coûts mensuelles

Une fois qu'un identifiant d'attribution des recettes est créé, les partenaires associent AWS Marketplace and/or Offers ACE Opportunities à celui-ci en soumettant un lot d'entrées mensuelles de répartition des coûts via l'action de l'StartRevenueAttributionAllocationsTaskAPI. Il s'agit d'une opération asynchrone qui accepte jusqu'à 250 changements d'allocation (CREATE and/or UPDATE) par tâche.

Chaque entrée d'allocation spécifie :

  • ID de l'offre ou ID de l'opportunité  : identifiant unique de l'offre associée. Si une offre Marketplace est déjà liée à une opportunité ACE, les partenaires n'ont qu'à fournir l'identifiant de l'offre ; les revenus AWS sont automatiquement attribués à l'opportunité associée.

  • Mois de facturation  : mois civil auquel s'applique la répartition des coûts (par exemple,2026-04).

  • % de répartition des coûts  : part de la AWS consommation totale du produit attribuable à cette offre au cours du mois de facturation en cours. Nécessaire pour les produits SaaS multi-locataires, y compris les composants hébergés par des partenaires pour les déploiements hybrides, dans le cadre desquels les clients partagent leur infrastructure.

  • ID de AWS compte client  : AWS compte du client qui consomme le produit. Obligatoire pour les produits SaaS multi-locataires.

Le pourcentage total de répartition des coûts sur toutes les entrées de répartition pour un numéro d'attribution des recettes donné et le même mois de facturation ne doit pas dépasser 100 %. Si le total dépasse 100 %, l'entrée incriminée est rejetée lors de la validation commerciale asynchrone avec un code d'erreur par enregistrement.

Validation synchrone : StartRevenueAttributionAllocationsTask effectue une validation de forme de base de manière synchrone (types de champs, modèles, taille du lot). Si la validation de base est réussie, l'API renvoie un statut TaskId avecIN_PROGRESS. La validation commerciale (vérifications des plafonds, règles d'immuabilité, recherches de dépendances par rapport à Marketplace et ACE) s'exécute de manière asynchrone et les résultats par enregistrement sont découverts via. GetRevenueAttributionAllocationsTask

Pour suivre une tâche soumise, les partenaires effectuent un sondage à l'GetRevenueAttributionAllocationsTaskaide de l'ID de ressource d'attribution des recettes ou de l'ARN. La réponse progresse de IN_PROGRESS à COMPLETED (que les enregistrements individuels aient réussi ou échoué) et renvoie :

  • TaskStatus— IN_PROGRESSCOMPLETED, ou FAILED (échec de la tâche de niveau supérieur).

  • RecordResults— pour chaque enregistrement saisi : le statut attribué AllocationId (en cas de succès), le statut par enregistrement (SUCCEEDEDouFAILED), et un code d'erreur structuré et un message en cas d'échec de l'enregistrement.

Les partenaires doivent récupérer rapidement les résultats des tâches. Une fois la tâche terminée, les résultats par enregistrement peuvent être réconciliés et toutes les entrées échouées peuvent être corrigées et soumises à nouveau dans une nouvelle tâche.

Modifier les entrées de répartition des coûts mensuelles

Les entrées de répartition des coûts sont gérées par mois de facturation selon les règles suivantes :

  • Les partenaires peuvent ajouter à tout moment une nouvelle entrée mensuelle pour le mois de facturation en cours ou futur.

  • Les partenaires peuvent mettre à jour à tout moment une entrée mensuelle pour le mois de facturation en cours ou futur.

  • Les partenaires peuvent mettre à jour l'entrée du mois dernier jusqu'au 7 du mois en cours. Cette fenêtre permet aux partenaires de vérifier l'utilisation réelle dans AWS Cost Explorer avant de finaliser l'allocation du mois précédent.

Après le 7 du mois en cours, l'attribution pour le mois de facturation précédent ne peut plus être modifiée. Les mises à jour apportées à l'entrée d'un mois en cours ou à venir s'appliquent à compter du cycle de facturation mensuel suivant. L'attribution historique pour les mois précédents n'est pas recalculée rétroactivement.

Les mises à jour des entrées d'allocation sont soumises via la même action d'StartRevenueAttributionAllocationsTaskAPI, Operation définie sur UPDATE pour chaque entrée concernée. Le modèle de tâche asynchrone gère les mises à jour et les créations de manière uniforme.

Mettre à jour un identifiant d'attribution de revenus

Les partenaires peuvent mettre à jour un identifiant d'attribution Description de revenus existant à l'aide de l'action UpdateRevenueAttribution API. L'enregistrement d'attribution lui-même est par ailleurs immuable NameMarketplaceProduct, et les valeurs tag-on-create ne peuvent pas être modifiées après la création. Pour réétiqueter la ressource, utilisez les opérations de AWS balisage standard sur l'ARN de l'attribution.

Lors de la mise à jour d'un numéro d'attribution des recettes, les partenaires doivent fournir :

  • Catalog— AWS ouSandbox.

  • Identifier— l'ra-identifiant de l'attribution à mettre à jour.

  • Version— la version actuelle de l'attribution pour le verrouillage optimiste.

Les partenaires peuvent éventuellement fournir :

  • Description— la description en texte libre mise à jour. 1024 caractères maximum.

  • ClientToken— un jeton d'idempotence pour la mise à jour.

Verrouillage optimiste : le Version champ garantit que les mises à jour ne s'appliquent que si l'attribution n'a pas changé depuis sa dernière récupération. Si la version soumise Version ne correspond pas à la version actuelle de la ressource, la mise à jour est rejetée ConflictException et un message contenant les numéros de version soumis et actuel est envoyé. La meilleure pratique consiste à récupérer la dernière version GetRevenueAttribution avant chaque mise à jour.

Affichage des détails de l'identifiant d'attribution des recettes

Les partenaires peuvent récupérer des informations complètes pour un seul identifiant d'attribution des recettes à l'aide de l'action GetRevenueAttribution API. Cela renvoie :

Métadonnées des ressources :

  • Identifiant unique (Id) et Amazon Resource Name (Arn).

  • Le Catalog domaine dans lequel l'attribution existe.

  • Name et Description.

  • Le récupéré Version et le LatestVersion (utilisez la dernière version pour les mises à jour ultérieures).

Attributs du produit Marketplace (s'MarketplaceProductils ont été définis lors de la création) :

  • ProductId— l'identifiant du produit Marketplace fourni par le partenaire.

  • ProductCode— le code produit AWS Marketplace résolu à partir deProductId.

  • ProductType— SaaSAMI,Container, MLData, ouProfessional Services.

  • TenancyModel— MULTI_TENANT ouSINGLE_TENANT.

Informations d'audit :

  • CreatedDate et LastModifiedDate.

Les partenaires peuvent éventuellement fournir une information spécifique Version dans la demande pour récupérer une version historique de l'attribution. Omettez Version de renvoyer la dernière version.

Pour récupérer une entrée de répartition des coûts mensuelle spécifique, les partenaires utilisent l'action d'GetRevenueAttributionAllocationAPI associée à celle de l'entréeAllocationId. Cela renvoie l'ID de l'offre ou l'ID d'opportunité, le mois de facturation, le % de répartition des coûts, l'ID du AWS compte client, le statut de l'entrée et les informations d'audit.

Afficher les identifiants d'attribution des revenus

Les partenaires peuvent consulter tous les identifiants d'attribution des revenus de leur compte à l'aide de l'action ListRevenueAttributions API. Cela renvoie une liste paginée de résumés d'attribution avec des fonctionnalités de filtrage et de tri.

Les partenaires peuvent filtrer les résultats selon les critères suivants :

  • Catalog— AWS ou Sandbox (obligatoire).

  • Identifiers— une liste contenant jusqu'à 100 ra- identifiants spécifiques à récupérer.

  • CreatedAfter/CreatedBefore— filtre par plage d'horodatage de création (incluse).

Les partenaires peuvent configurer le tri des résultats à l'aide du Sort paramètre :

  • SortBy— CreatedDate ouLastModifiedDate.

  • SortOrder— ASCENDING ouDESCENDING.

La réponse inclut un résumé pour chaque attribution :Arn,,Id,Catalog,Name, MarketplaceProduct attributs résolus,, CreatedDateLastModifiedDate, le plus récentVersion, et TotalRevenueAttributionAssociationCount (le nombre d'entrées de répartition des coûts mensuelles actives liées à l'attribution).

Utilisez MaxResults (par défaut 25, maximum 100) et NextToken pour paginer dans de grands ensembles de résultats. La réponse indique NextToken si des pages supplémentaires sont disponibles.

Répertorier les entrées mensuelles de répartition des coûts

Les partenaires peuvent répertorier les entrées de répartition des coûts mensuelles pour un ID d'attribution de revenus spécifique à l'aide de l'action ListRevenueAttributionAllocations API. Cela renvoie une liste paginée de résumés des allocations avec des fonctionnalités de filtrage.

Les partenaires peuvent filtrer les résultats selon les critères suivants :

  • MarketplaceOfferId— répertoriez uniquement les entrées associées à une offre de marché spécifique.

  • AwsPartnerCentralOpportunityId— répertoriez uniquement les entrées associées à une opportunité Partner Central spécifique.

  • BillingMonth— ne répertoriez que les entrées pour un mois civil spécifique.

La réponse inclut des informations récapitulatives pour chaque entrée : leAllocationId, l'ID d'offre ou l'ID d'opportunité associé, l'ID du AWS compte client, le mois de facturation, le % de répartition des coûts, le nom et le statut de l'entrée, et les horodatages d'audit.

Création de tableaux de bord : la combinaison de ListRevenueAttributions et ListRevenueAttributionAllocations est conçue pour faciliter la création de tableaux de bord pour les partenaires. Les partenaires peuvent développer des points de vue tels que :

  • Tous les ID d'attribution de revenus créés au cours des 30 derniers jours, triés par date de création.

  • Toutes les entrées mensuelles de répartition des coûts pour une offre de marché spécifique sur plusieurs identifiants d'attribution des revenus.

  • Toutes les entrées de répartition des coûts pour le mois de facturation en cours, afin de vérifier que les totaux ne dépassent pas 100 % par attribution.

  • Tous les ID d'attribution des recettes qui comportent au moins une entrée d'allocation active (TotalRevenueAttributionAssociationCount > 0).