Utilisation de AWS Marketplace API d'accord

AWS Marketplace est un catalogue numérique organisé que les clients peuvent utiliser pour rechercher, acheter, déployer et gérer des logiciels, des données et des services tiers afin de créer des solutions et de gérer leur entreprise. Le service d' AWS Marketplace accord fournit une interface API qui aide AWS Marketplace les acheteurs et les vendeurs à gérer leurs accords, notamment en matière de mise en vente, de recherche et de filtrage des accords.

Concepts clés

Le tableau suivant décrit les principaux concepts utilisés dans l'API AWS Marketplace Agreement.

Concept	Description
Accepteur	Partie qui accepte la totalité ou une partie des conditions étendues par le proposant dans un accord. Dans les cas d'utilisation les plus courants, les accepteurs sont les acheteurs du produit.
Entente	Un document qui lie deux parties, y compris le proposant (généralement, le seller/ISV partenaire de distribution) et l'accepteur (généralement, l'acheteur) et qui définit les termes et conditions applicables entre elles.
Demande d'annulation du contrat	Demande initiée par le vendeur (proposant) pour annuler un accord actif. L'acheteur (accepteur) peut accepter ou rejeter la demande d'annulation. En cas d'acceptation, le flux de travail d'annulation de l'accord s'exécute de manière asynchrone et le statut de l'accord passe à annulé. En cas de rejet, le contrat reste actif et le vendeur peut soumettre une nouvelle demande d'annulation.
Proposition d'accord	Entité faisant référence à l'ensemble des terms/offer éléments proposés par le seller/proposer.
Demande d'accord	Entité faisant référence à la ressource créée à la suite d'une action du client, décrivant les creation/modification paramètres de l'accord, le cycle de vie de la demande et le résultat estimé lors de l'acceptation de la demande.
Dimension facturable	Éléments liés au prix du produit. Par exemple, des instances Amazon Elastic Compute Cloud (Amazon EC2) pour les produits Amazon Machine Image (AMI), ou des instances Premium par rapport aux utilisateurs en lecture seule pour les produits SaaS (Software as a Service).
Partenaires de distribution (CP)	Organisations autorisées par le propriétaire du produit (ISV) à revendre leurs produits en son nom sur. AWS Marketplace
Fournisseurs de logiciels indépendants (ISV)	Vendeurs qui mettent en vente et gèrent leurs propres produits dans AWS Marketplace.
Intention	L'intention représente la motivation de l'acheteur lors de la création du contrat. Les intentions actuellement prises en charge sont les suivantes : Nouveau, Modifier et Remplacer lors du processus de création de l'accord.
Demande de paiement	Demande de paiement initiée par le vendeur (proposant) associée à un accord. L'acheteur (accepteur) peut accepter ou rejeter la demande de paiement.
Proposant	Partie qui étend les conditions initiales d'un accord, le plus souvent en utilisant une offre.
Purchase Orders	Organisations demandent aux acheteurs d'utiliser des bons de commande pour acheter auprès de fournisseurs agréés, de suivre ce qu'ils achètent et de s'assurer que les dépenses sont prévues, budgétisées, approuvées et attribuées au (x) centre (s) de coûts responsable (s).
Ressource	Unité ou ressource que les vendeurs ont l'intention de vendre AWS Marketplace, souvent appelée produit de base. Un produit de base n'est pas complet pour l'acheteur tant que les informations sur le produit, les attributs de déploiement et les informations de facturation ne sont pas ajoutées. Un produit décrit les informations sur le produit, les attributs de déploiement du logiciel et le mécanisme de facturation de l'offre qu'un vendeur a l'intention de vendre. Le produit doit être associé à une offre pour devenir une unité négociable pouvant être vendue et utilisée par les acheteurs. AWS Marketplace
Durée	Unité au sein d'un accord qui régit la manière dont un accord est appliqué (par exemple, la tarification).

Endpoint

Vous pouvez accéder au service d' AWS Marketplace accord via les points de terminaison suivants :

Endpoint	Région	Protocoles IP pris en charge
`agreement-marketplace.us-east-1.api.aws`	USA Est (Virginie du Nord)	IPv4, IPv6

Permissions

L'API Agreements utilise l'authentification standard AWS Signature Version 4 (SigV4). Vous devez disposer AWS d'informations d'identification valides et des autorisations IAM appropriées pour appeler l'API. Pour en savoir plus, consultez Contrôle d'accès pour AWS Marketplace API d'accord.

Codes d’erreur

Les codes d'erreur suivants s'appliquent aux actions du service des AWS Marketplace accords. Un seul code d'erreur peut être renvoyé pour plusieurs cas d'utilisation. Reportez-vous aux descriptions ci-dessous pour identifier le scénario spécifique dans lequel chaque code d'erreur se produit. Cette liste n'est pas exhaustive et peut être mise à jour à mesure que de nouvelles fonctionnalités seront publiées.

ValidationException

Code d’erreur	Description
`INVALID_SOURCE_AGREEMENT_IDENTIFIER`	Renvoyé lorsque l'identifiant de l'accord source ne correspond pas au format attendu, ou lorsqu'un identifiant de l'accord source est fourni pour une intention qui n'en nécessite pas un (comme NEW).
`MISSING_SOURCE_AGREEMENT_IDENTIFIER`	Renvoyé lorsque l'identifiant de l'accord source n'est pas fourni pour une intention qui en nécessite un (comme REPLACE ou AMEND).
`INVALID_REQUESTED_TERM_CONFIGURATION`	Renvoyé lorsque la configuration des termes demandée n'est pas valide. Scénarios possibles : Une configuration est fournie pour un terme qui n'en accepte pas une. Il manque une configuration requise. La valeur du sélecteur n'appartient pas à la proposition d'accord. Les dimensions ne peuvent contenir qu'une seule dimension lorsque la sélection de plusieurs dimensions n'est pas autorisée. Une clé de dimension n'est pas reconnue dans la proposition d'accord ou dans les termes acceptés. La valeur d'une dimension ne peut être que 1 lorsque la configuration de la quantité n'est pas activée pour la dimension. La configuration contient des clés de dimension dupliquées. La configuration ne diffère pas de l'accord source.
`INVALID_AGREEMENT_PROPOSAL_IDENTIFIER`	Renvoyé lorsque l'identifiant de la proposition d'accord ne correspond pas au format attendu, ou lorsqu'un identifiant de proposition d'accord est fourni pour une intention qui n'en nécessite pas un (comme AMEND).
`MISSING_AGREEMENT_PROPOSAL_IDENTIFIER`	Renvoyé lorsque l'identifiant de la proposition d'accord n'est pas fourni pour une intention qui en nécessite un (par exemple NEW ou REPLACE).
`INVALID_FILTER_NAME`	Renvoyé lorsque le nom de filtre fourni n'est pas un filtre reconnu ou lorsque des noms de filtre dupliqués sont inclus dans la demande.
`INVALID_FILTER_VALUES`	Renvoyé lorsque les valeurs de filtre ne sont pas valides, dupliquées, vides, dépassent le nombre maximum autorisé ou lorsqu'un filtre de plage de dates spécifie une `BeforeEndTime` valeur qui précède la `AfterEndTime` valeur.
`INVALID_NEXT_TOKEN`	Renvoyé lorsque le jeton de pagination est mal formé, a expiré, ne peut pas être déchiffré ou lorsque les paramètres de la demande ont changé entre les appels paginés.
`DUPLICATE_CHARGES`	Renvoyé lorsque la demande contient des identifiants de facturation dupliqués ou lorsque des valeurs de bon de commande différentes sont fournies pour le même identifiant de facturation.
`UNSUPPORTED_FILTERS`	Renvoyé lorsque la combinaison de filtres fournie n'est pas prise en charge. Les combinaisons de filtres prises en charge varient en fonction du type de groupe. Vérifiez les combinaisons prises en charge dans la documentation publique.
`INVALID_PURCHASE_ORDER_REFERENCE`	Renvoyé lorsque la référence du bon de commande ne répond pas aux exigences de format ou lorsqu'un bon de commande requis n'est pas fourni tel que configuré par l'administrateur du compte.
`INVALID_CHARGE_AMOUNT`	Renvoyé lorsque le montant débité n'est pas valide. Scénarios possibles : Le montant des frais dépasse le montant total maximal pour la durée du contrat. Le format du montant facturé ne correspond pas aux exigences en matière de devises (par exemple, trop de décimales). Aucun montant restant n'est disponible car l'accord a atteint le montant total maximal des frais.
`UNSUPPORTED_ACTION`	Renvoyé lorsque l'opération demandée n'est pas prise en charge pour l'état actuel de la ressource. Les scénarios spécifiques varient en fonction de l'API : `UpdatePurchaseOrders`— La date de facturation est passée et le renouvellement automatique est désactivé, la date de facturation est dans les 3 heures, les frais sont des frais de remboursement, la révision des frais n'est pas la plus récente, les bons de commande ne font pas tous partie du même contrat ou le contrat n'est pas actif. `CreateAgreementRequest`— La modification d'un accord futur n'est pas prise en charge, la combinaison type de ressource et type de terme ne répond pas à l'intention demandée, le remplacement d'un accord actif par un accord futur n'est pas autorisé, la durée de l'accord ne peut pas être modifiée pendant la modification, l'accord ne peut pas être mis à jour pour le moment (par exemple, des droits en attente existent), la proposition d'accord doit faire référence à la même ressource que l'accord source, la proposition d'accord doit être différente du type d'accord source ou de l'accord ne prend pas en charge cette action. `AcceptAgreementRequest`— La combinaison du type de ressource et du type de terme ne permet pas cette action, le type d'accord ne prend pas en charge cette action, un accord actif existe déjà sur la même ressource ou l'accord ne peut pas être mis à jour pour le moment. `CancelAgreement`— L'accord a des droits en suspens, le type d'accord ne permet pas l'annulation, un accord `UsageBasedPricingTerm` ne peut pas être annulé alors qu'un accord avec `ConfigurableUpfrontPricingTerm` ou `PaymentScheduleTerm` est toujours actif sur la même ressource, ou la combinaison type de ressource et type de terme ne permet pas l'annulation. `GetBillingAdjustmentRequest`— L'accord est un type de contrat sans achat, ou l'appelant est l'accepteur du contrat. `SendAgreementCancellationRequest`— Le type d'accord ne prend pas en charge cette action. `AcceptAgreementCancellationRequest`— Le type d'accord ne prend pas en charge cette action. `RejectAgreementCancellationRequest`— Le type d'accord ne prend pas en charge cette action. `CancelAgreementCancellationRequest`— Le type d'accord ne prend pas en charge cette action. `GetAgreementCancellationRequest`— Le contrat est un type de contrat sans achat.

ResourceNotFoundException

Les ResourceNotFoundException resourceType inclusions et les resourceId champs qui identifient la ressource introuvable. Le tableau suivant décrit les scénarios susceptibles de provoquer cette exception pour chaque type de ressource.

Note

Pour des raisons de sécurité, la même erreur est renvoyée, qu'une ressource n'existe pas ou que l'appelant n'y ait pas accès. Cela empêche l'énumération des identificateurs de ressources valides.

Type de ressource	Scénarios possibles
`AgreementProposal`	Aucune proposition d'accord n'a été trouvée pour l'identifiant donné. L'offre ne s'adresse pas à l'accepteur. L'offre n'est pas disponible dans le pays de l'accepteur.
`Agreement`	Aucun accord n'a été trouvé pour l'identifiant indiqué. L'appelant n'est ni l'accepteur ni le proposant de l'accord.
`AgreementRequest`	Aucune demande d'accord n'a été trouvée pour l'identifiant donné. La demande d'accord appartient à un autre appelant. La demande d'accord a expiré. La demande d'accord a été remplacée par une demande acceptée ultérieure concernant le même produit ou la même offre. La proposition d'accord est devenue inactive entre `CreateAgreementRequest` et les `AcceptAgreementRequest` appels en raison de la republication de l'offre ou de l'expiration de l'offre.
`Charge`	Aucun frais n'a été trouvé pour l'identifiant indiqué. Les frais ne font pas partie de l'accord spécifié.
`BillingAdjustmentRequest`	Aucune demande d'ajustement de facturation n'a été trouvée pour l'identifiant donné. L'appelant n'est ni l'accepteur ni le proposant de l'accord associé à l'ajustement.
`AgreementCancellationRequest`	Aucune demande d'annulation d'accord n'a été trouvée pour l'identifiant indiqué. L'appelant n'est ni l'accepteur ni le proposant de l'accord associé à la demande d'annulation.
`PaymentRequest`	Aucune demande de paiement n'a été trouvée pour l'identifiant indiqué. L'appelant n'est ni l'accepteur ni le proposant de l'accord associé à la demande de paiement.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Utilisation de l'API Catalog

Utilisation de l'API de mesure