La référence d'API AWS Marketplace a été restructurée. Pour plus d'informations sur les opérations d'API prises en charge, consultez le manuel AWS Marketplace API Reference.
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.
Travaillez avec des autorisations de revente à l'aide du AWS Marketplace API
Vous pouvez utiliser le AWS Marketplace Catalog API pour automatiser les tâches liées à l'utilisation des autorisations de revente.
Alors que le produit décrit ce qui est vendu AWS Marketplace, l'autorisation de revente (également connue sous le nom d'opportunité) décrit les termes et règles concernant la manière dont ce produit est autorisé à être revendu. AWS Marketplace Le CPPO est la cible de l'autorisation de revente.
Une autorisation de revente contient un ensemble de termes et de règles à accepter pour un accord de revendeur entre les fabricants et les partenaires de distribution. L'acceptation des termes de l'autorisation de revente permet au revendeur de créer des offres pour le produit conformément aux conditions énoncées dans les termes.
Il existe deux types de règles dans une autorisation de revente :
-
AvailabilityRule— Contrôle le cycle de vie de l'autorisation de revente dans AWS Marketplace.
-
PartnerTargetingRule — Spécifie si l'autorisation de revente doit être accessible à un ensemble spécifique de partenaires de distribution.
Consultez les ressources suivantes :
-
Pour des ateliers de bout en bout avec des exemples de code fonctionnel, voir Atelier : autoriser un revendeur
dans l'AWS Marketplace atelier des vendeurs. -
Pour des exemples de code de requêtes d'API, consultez les exemples Python
et Java dans AWS Samples on GitHub. -
Pour une vidéo sur la création d'autorisations de revente, voir Création d'autorisations de revente à l'aide de l'API du catalogue sur AWS Marketplace
. YouTube
Les rubriques suivantes décrivent comment utiliser l'API du catalogue pour créer et mettre à jour les autorisations de revente :
Conditions préalables à l'autorisation de revente
Pour utiliser l'autorisation de revente, les fournisseurs de logiciels indépendants (ISV) et les partenaires de AWS Marketplace distribution doivent créer un rôle lié à un service qui fournit des autorisations de partage de ressources à. AWS Si les deux groupes ne remplissent pas cette condition préalable, ils ne AWS peuvent pas partager la ressource d'autorisation de l'ISV avec le partenaire de AWS Marketplace distribution. Pour plus d'informations, consultez la section Utilisation des rôles pour l'autorisation de revente AWS Marketplace dans le Guide du AWS Marketplace vendeur.
Créer une nouvelle autorisation de revente
Vous pouvez utiliser l'API du catalogue pour créer une nouvelle autorisation de revente dans AWS Marketplace.
Si votre demande est traitée avec succès, AWS Marketplace Catalog API génère une autorisation de revente en Draft état pour vous. Il s'agit d'une autorisation de revente incomplète qui n'est pas visible pour les partenaires de distribution. AWS Marketplace
Utilisez les types de Update modification pour compléter l'autorisation de revente. Une fois l'autorisation de revente terminée, utilisez le type de ReleaseResaleAuthorization modification pour terminer le processus de création de l'autorisation de revente et libérer l'autorisation de revente, qui validera l'intégralité de l'autorisation de revente et la rendra visible aux partenaires de distribution. AWS Marketplace
Pour créer une autorisation de revente en Draft état, appelez l'opération StartChangeSet API avec le type de CreateResaleAuthorization modification, comme indiqué dans l'exemple suivant.
Syntaxe de la demande
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "CreateResaleAuthorization", "ChangeName": "xyz", "Entity": { "Type": "ResaleAuthorization@1.0" }, "DetailsDocument": { "ProductId": "prod-ad8EXAMPLE51", "Name": "Test ResaleAuthorization", "Description": "Worldwide ResaleAuthorization for Test Product", "ResellerAccountId": "777788889999" } } ] }
Fournissez des informations pour les champs de saisie afin d'ajouter le type de CreateResaleAuthorization modification :
-
Entité (objet) (obligatoire) — Votre autorisation de revente.
-
Type (chaîne) (obligatoire) —
TypeC'est toujours le casResaleAuthorization@1.0.
-
-
DetailsDocument(objet) (obligatoire) — Spécificités de la demande.
-
ProductId(string) (obligatoire) — Identifiant du produit pour lequel créer l'autorisation de revente.
-
Nom (chaîne) (obligatoire) : nom associé au ResaleAuthorization pour une meilleure lisibilité pour vous et vos partenaires de distribution.
-
Description (chaîne) (facultatif) — Champ de texte libre disponible pour ajouter des détails sur le ResaleAuthorization.
-
ResellerAccountId(chaîne) (obligatoire) — Ajoutez des partenaires de distribution ciblés Compte AWS capables de le décrire et de l'utiliser
ResaleAuthorizationpour créer une offre privée.
-
Syntaxe de réponse
Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La demande de modification est ajoutée à une file d'attente et traitée.
Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.
Lorsque la demande est terminée (si Status c'est le casSUCCEEDED), une nouvelle ResaleAuthorization est générée. Bien que le SUCCEEDED statut indique que l'appel de CreateResaleAuthorization changement de type est terminé, le ResaleAuthorization statut est toujours en Draft vigueur.
Ce qui suit montre la réponse de l'opération DescribeChangeSetd'API.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef", "ChangeSetName": "Submitted by 123456789012", "StartTime": "2021-05-27T22:21:26Z", "EndTime": "2021-05-27T22:32:19Z", "Status": "SUCCEEDED", "ChangeSet": [ { "ChangeType": "CreateResaleAuthorization", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "ProductId": "prod-ad8EXAMPLE51", "Name": "Test ResaleAuthorization", "Description": "Worldwide ResaleAuthorization for Test Product", "ResellerAccountId": "777788889999", "BulkRequestId": "84977023-5093-4a66-8b24-ef2c5a2f8b1f" }, "ErrorDetailList": [] } ] }
Validations synchrones
Les validations du schéma sont spécifiques aux CreateResaleAuthorization actions du AWS Marketplace Catalog API. Les validations sont effectuées lorsque vous appelezStartChangeSet. Si la demande ne répond pas aux exigences suivantes, elle échouera avec une réponse HTTP.
| Champ de saisie | Règle de validation | Code HTTP |
|---|---|---|
| ProductId |
Obligatoire Ne doit pas être vide ou nul La longueur doit être comprise entre 1 et 50 caractères |
422 |
| ProductId | L'utilisateur doit être autorisé à créer ResaleAuthorization pour le produit donné | 403 |
| ProductId | Il doit s'agir d'un produit existant dans le catalogue et non dans Draft l'état Le produit doit être pris en charge pour la revente |
404 |
| Nom |
Obligatoire Ne doit pas être vide ou nul La longueur doit être comprise entre 1 et 100 caractères Aucun caractère spécial autorisé |
422 |
| Description |
Facultatif La longueur doit être comprise entre 1 et 255 caractères Aucun caractère spécial autorisé |
422 |
| ResellerAccountId |
Obligatoire Ne doit pas être vide Compte AWS Les identifiants doivent être au format valide (numéro à 12 chiffres) |
422 |
| BulkRequestId |
Facultatif La longueur doit être comprise entre 1 et 50 caractères Doit être au format UUID |
422 |
| Une propriété inconnue | Aucune propriété supplémentaire n'est autorisée | 422 |
Erreurs asynchrones
Les erreurs suivantes sont spécifiques aux CreateResaleAuthorization actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.
| Code d’erreur | Message d’erreur |
|---|---|
| COMPTE_REVENDEUR NON VALIDE | Fournissez un compte revendeur valide. |
Actualiser le ciblage des acheteurs
Vous pouvez utiliser l'API du catalogue pour mettre à jour les acheteurs qui ciblent votre autorisation de revente dans AWS Marketplace.
Toutes les options de ciblage existantes qui ne sont pas incluses dans la dernière demande sont supprimées de l'autorisation de revente. Ce type de modification est facultatif pour la délivrance de l'autorisation de revente.
Pour mettre à jour les acheteurs qui ciblent votre autorisation de revente, appelez l'opération StartChangeSet API avec le type de UpdateBuyerTargetingTerms modification, comme indiqué dans l'exemple suivant.
Syntaxe de la demande
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType":"UpdateBuyerTargetingTerms", "Entity":{ "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "Terms": [ { "Type": "BuyerTargetingTerm", "PositiveTargeting": { "BuyerAccounts": [ "123456789012" ] } } ] } } ] }
Fournissez des informations pour les champs permettant d'ajouter le type de UpdateBuyerTargetingTerms modification :
-
Entité (objet) (obligatoire) — Votre autorisation de revente.
-
Type (chaîne) (obligatoire) —
TypeC'est toujours le casResaleAuthorization@1.0. -
Identifiant (chaîne) (obligatoire) — Votre numéro d'autorisation de revente. Pour de plus amples informations, veuillez consulter Identifiant.
-
-
DetailsDocument(objet) (obligatoire) — Spécificités de la demande.
-
Termes (ensemble de structures) (facultatif) : liste des acheteurs ciblant les termes que vous souhaitez mettre à jour. Si l'intention n'est pas de
ResaleAuthorizationcibler un acheteur en particulier, le champ des termes peut être ignoré. Par défaut,ResaleAuthorizations'adresse à tous les acheteurs. Les termes pris en charge sont les suivants :-
BuyerTargetingTerms(objet) (facultatif) — Définissez un ciblage spécifique à l'acheteur pour votre. ResaleAuthorization
-
Type (chaîne) (obligatoire) — Catégorie du terme mis à jour.
-
PositiveTargeting(objet) (obligatoire) — Définit les critères auxquels le profil de tout acheteur doit répondre pour être autorisé à accéder au
ResaleAuthorization.-
BuyerAccounts(tableau de chaînes) (facultatif) — Liste comme facultative. Vous pouvez ajouter celui de l'acheteur cible Comptes AWS. Si l'intention n'est pas
ResaleAuthorizationde cibler des acheteurs spécifiques, ce champ doit être omis. Par défaut, tous les acheteurs sont ciblés. Les partenaires de distribution ciblés peuvent choisir de créer une offre privée et de cibler un sous-ensemble d'acheteurs, si cela est spécifié.
-
-
-
-
Syntaxe de réponse
Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La demande de modification est ajoutée à une file d'attente et traitée. Cela inclut la validation des informations auprès de l'équipe des opérations des AWS Marketplace vendeurs pour s'assurer qu'elles sont conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.
Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.
Validations synchrones
Les validations du schéma sont spécifiques aux UpdateBuyerTargetingTerms actions du AWS Marketplace Catalog API. Ces validations sont effectuées lorsque vous appelezStartChangeSet. Si la demande ne répond pas aux exigences suivantes, elle échouera avec une réponse HTTP.
| Champ de saisie | Règle de validation |
|---|---|
| Termes |
Facultatif Ne doit pas être vide ou nul Seul « BuyerTargetingTerm » est autorisé dans la liste La taille de la liste doit être de 1 (il n'existe aujourd'hui aucun cas d'utilisation nécessitant plusieurs conditions d'achat) |
| BuyerTargetingTerm.PositiveTargeting |
Obligatoire Ne doit pas être vide |
| BuyerTargetingTerm.PositiveTargeting.BuyerAccounts |
Facultatif Compte AWS Les identifiants doivent être au format valide (numéro à 12 chiffres) Ne doit pas contenir plus de 25 comptes |
| Une propriété inconnue | Aucune propriété supplémentaire n'est autorisée |
Erreurs asynchrones
Les erreurs suivantes sont spécifiques aux UpdateBuyerTargetingTerms actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.
| Code d’erreur | Message d’erreur |
|---|---|
| CIBLAGE_ACHETEUR_ACHETEUR INCOMPATIBLE | Au moins un compte d'acheteur doit être présent pour ResaleAuthorization PreExistingBuyerAgreement. |
Disponibilité des mises à jour
Vous pouvez utiliser l'API du catalogue pour limiter la disponibilité du nombre d'offres privées créées ou jusqu'à quel moment précis une offre privée peut être créée.
Par défaut, la valeur est l'utilisation illimitée de cette autorisation de revente, bien que vous puissiez vérifier la disponibilité dans la liste des règles.
Pour contrôler la disponibilité et l'utilisabilité de votre autorisation de revente, appelez l'opération StartChangeSet API avec le type de UpdateAvailability modification, comme indiqué dans l'exemple suivant.
Syntaxe de la demande
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateAvailability", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "AvailabilityEndDate": "2022-05-31", "OffersMaxQuantity": 1 } } ] }
Fournissez des informations pour les champs permettant d'ajouter le type de UpdateAvailability modification :
-
Entité (objet) (obligatoire) — Votre autorisation de revente.
-
Type (chaîne) (obligatoire) —
TypeC'est toujours le casResaleAuthorization@1.0. -
Identifiant (chaîne) (obligatoire) — Votre numéro d'autorisation de revente. Pour de plus amples informations, veuillez consulter Identifiant.
-
-
DetailsDocument(objet) (obligatoire) — Spécificités de la demande.
-
AvailabilityEndDate(string) (facultatif) — Définissez la date de fin jusqu'à ce que les partenaires de distribution puissent en tirer parti
ResaleAuthorizationpour créer une offre. Les partenaires de distribution peuvent l'utiliserResaleAuthorizationplusieurs fois jusqu'à la date de fin spécifiée. Les dates sont représentées au format ISO_8601. -
OffersMaxQuantity(entier) (facultatif) — Définissez le nombre maximum d'offres privées pouvant être créées à l'aide du ResaleAuthorization. Cela ne définit pas le nombre d'abonnements.
-
Syntaxe de réponse
Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La demande de modification est ajoutée à une file d'attente et traitée. Cela inclut la validation des informations auprès de l'équipe des opérations des AWS Marketplace vendeurs pour s'assurer qu'elles sont conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.
Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.
Validations synchrones
Les validations du schéma sont spécifiques aux UpdateAvailability actions du AWS Marketplace Catalog API. Les validations sont effectuées lorsque vous appelezStartChangeSet. Si la demande ne répond pas aux exigences suivantes, elle échouera avec une réponse HTTP
| Champ de saisie | Règle de validation |
|---|---|
| OffersMaxQuantity |
Facultatif Doit être un entier non négatif Valeur autorisée uniquement « 1 » (actuellement aucun cas d'utilisation pour prendre en charge plusieurs quantités) |
| AvailabilityEndDate |
Facultatif Doit être au format ISO_8601 Doit être daté dans le futur |
| Disponibilité | Fournissez l'un OffersMaxQuantity ou l'autre AvailabilityEndDate. |
| Une propriété inconnue | Aucune propriété supplémentaire n'est autorisée |
Erreurs asynchrones
Les erreurs suivantes sont spécifiques aux UpdateAvailability actions effectuées dans l'API AWS Marketplace Catalog. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.
| Code d’erreur | Message d’erreur |
|---|---|
| DATE DE FIN DE DISPONIBILITÉ NON VALIDE | Fournissez un AvailabilityEndDate qui se trouve avant tout ResalePaymentScheduleTerms. ChargeDate |
| DATE DE FIN DE DISPONIBILITÉ NON VALIDE | Offrez un futur AvailabilityEndDate. |
Mettre à jour la validité d'un futur accord
Vous pouvez utiliser l'API Catalog pour modifier et contrôler une future date de début de service dans AWS Marketplace.
Cet ensemble de modifications n'est pas obligatoire pour délivrer une autorisation de revente.
Pour modifier et contrôler la durée du contrat de produit de votre autorisation de revente, appelez l'opération StartChangeSet API avec le type de UpdateBuyerValidityTerms modification, comme indiqué dans l'exemple suivant.
Note
Future-dated les accords ne sont pris en charge que pour les types de produits SaaS.
Syntaxe de la demande
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateBuyerValidityTerms", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "Terms": [ { "Type": "BuyerValidityTerm", "MaximumAgreementStartDate": "2024-05-31" } ] } } ] }
Fournissez des informations pour les champs de saisie afin d'ajouter le type de UpdateBuyerValidityTerms modification :
-
Entité (objet) (obligatoire) — Votre autorisation de revente.
-
Type (chaîne) (obligatoire) —
TypeC'est toujours le casResaleAuthorization@1.0. -
Identifiant (chaîne) (obligatoire) — Votre numéro d'autorisation de revente. Pour de plus amples informations, veuillez consulter Identifiant.
-
-
DetailsDocument(objet) (obligatoire) — Spécificités de la demande.
-
Termes (ensemble de structures) : liste des termes de validité de l'accord que vous souhaitez mettre à jour. Les termes pris en charge sont les suivants :
-
BuyerValidityTerm(objet) — Définit les disponibilités d'un service pour un produit de votre ResaleAuthorization.
-
Type (chaîne) — Catégorie du terme en cours de mise à jour.
-
MaximumAgreementStartDate(chaîne) (obligatoire) — Définissez la date de début du contrat pour le produit proposé. Les offres à date future ne peuvent pas dépasser cette date de début de service. Les dates sont représentées au format ISO_8601.
-
-
-
Syntaxe de réponse
Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La demande de modification est ajoutée à une file d'attente et traitée. Cela inclut la validation des informations auprès de l'équipe des opérations des AWS Marketplace vendeurs pour s'assurer qu'elles sont conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.
Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.
Validations synchrones
Les validations du schéma sont spécifiques aux UpdateBuyerValidityTerms actions du AWS Marketplace Catalog API. Les validations sont effectuées lorsque vous appelezStartChangeSet. Si la demande ne répond pas aux exigences suivantes, elle échouera avec une réponse HTTP.
| Champ de saisie | Règle de validation |
|---|---|
| Termes |
Obligatoire Ne doit pas être vide ou nul Seul « BuyerValidityTerm » est autorisé dans la liste La taille de la liste doit être de 1 (il n'existe aujourd'hui aucun cas d'utilisation nécessitant plusieurs conditions de disponibilité des services) |
| MaximumAgreementStartDate |
Obligatoire Ne doit pas être vide ou nul Doit être une date future et ne doit pas dépasser plus de 3 ans Doit être au format ISO_8601 |
| Une propriété inconnue | Aucune propriété supplémentaire n'est autorisée |
Erreurs asynchrones
Les erreurs suivantes sont spécifiques aux UpdateBuyerValidityTerms actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.
| Code d’erreur | Message d’erreur |
|---|---|
| PRODUIT_INCOMPATIBLE | BuyerValidityTerm n'est pas pris en charge pour le produit. |
| DATE_DE_DÉBUT_MAXIMALE DE L'ACCORD NON VALIDE | Prévoyez un futur MaximumAgreementStartDate avec une limite autorisée. |
Mettre à jour les ressources juridiques
Vous pouvez utiliser l'API du catalogue pour remplacer complètement les termes juridiques existants dans AWS Marketplace.
Les termes juridiques qui ne sont pas inclus dans la dernière demande seront supprimés de l'autorisation de revente. BuyerLegalTermcontient le CLUF qui sera inclus dans le contrat d'acheteur final et LegalTerm inclut le contrat de revendeur qui sera inclus dans le contrat de revendeur entre le partenaire de distribution et l'ISV.
Pour mettre à jour vos termes juridiquesResaleAuthorization, appelez l'opération StartChangeSet API avec le type de UpdateLegalTerms modification, comme indiqué dans l'exemple suivant.
Syntaxe de la demande
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateLegalTerms", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "Terms": [ { "Type": "BuyerLegalTerm", "Documents": [ { "Type": "CustomEula", "Url": "https://my-public-bucket.s3.amazonaws.com/eula-example12345.txt" } ] }, { "Type": "ResaleLegalTerm", "Documents": [ { "Type": "CustomResellerContract", "Url": "https://my-public-bucket.s3.amazonaws.com/reseller-example12345.txt" } ] } ] } } ] }
Fournissez des informations pour les champs permettant d'ajouter le type de UpdateLegalTerms modification :
-
Entité (objet) (obligatoire) — Votre autorisation de revente.
-
Type (chaîne) (obligatoire) —
TypeC'est toujours le casResaleAuthorization@1.0. -
Identifiant (chaîne) (obligatoire) — Votre numéro d'autorisation de revente. Pour de plus amples informations, veuillez consulter Identifiant.
-
-
DetailsDocument(objet) (obligatoire) — Spécificités de la demande.
-
Termes (ensemble de structures) (obligatoire) — Liste des termes juridiques. Les termes juridiques pris en charge sont les suivants :
-
BuyerLegalTerm(object) (obligatoire) — Définit la liste des accords textuels à proposer aux accepteurs. Par exemple, le contrat de licence utilisateur final (EULA).
-
Type (chaîne) (obligatoire) — Catégorie du terme mis à jour.
-
Documents (ensemble de structures) (obligatoire) — Liste de références aux ressources juridiques à proposer aux acheteurs. Par exemple, le EULA. Chaque référence est composée d'un
Typeet d'unURL:-
Type (chaîne) (obligatoire) — Type de document. Les types de documents disponibles sont les suivants :
-
StandardEula— Contrat standard pour AWS Marketplace. Pour plus d'informations, consultez la section SCMP dans le guide du AWS Marketplace vendeur. Il n'est pas nécessaire de fournir une URL pour ce type car il est géré par AWS Marketplace.
-
EnterpriseEula— Contrat d'entreprise pour AWS Marketplace. Pour plus d'informations, consultez la section DSA dans le Guide du AWS Marketplace vendeur. Il n'est pas nécessaire de fournir une URL pour ce type car il est géré par AWS Marketplace.
-
CustomEula— EULA personnalisé fourni par vous en tant que fabricant. Une URL pour le CLUF stocké dans un compartiment S3 accessible est requise pour ce type de document.
-
-
Url (chaîne) (obligatoire sous condition) — URL du document juridique que les acheteurs peuvent lire. Ceci est obligatoire lorsque le type de catégorie est
CustomEula.
-
-
ResaleLegalTerm(object) (facultatif) — Définit la liste des accords textuels à proposer uniquement aux partenaires de distribution. Ce terme ne sera pas disponible pour les acheteurs.
-
Type (chaîne) (obligatoire) — Catégorie du terme en cours de mise à jour.
-
Documents (ensemble de structures) (obligatoire) — Liste des références aux ressources juridiques des revendeurs à proposer aux partenaires de distribution.
-
Type (chaîne) (obligatoire) — Catégorie du document. Les types de documents disponibles sont les suivants :
-
StandardResellerContract— Contrat de revendeur standard pour AWS Marketplace.
-
CustomResellerContract— Un contrat de revendeur personnalisé conclu par vous en tant que fabricant. L'URL du contrat de revendeur est stockée dans un compartiment S3 accessible et est requise pour ce type de document.
-
-
Url (chaîne) (obligatoire sous condition) : URL du document contractuel du revendeur à lire par les partenaires de distribution. C'est obligatoire lorsque le Type est CustomResellerContract.
-
-
-
-
Syntaxe de réponse
Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La demande de modification est ajoutée à une file d'attente et traitée. Cela inclut la validation des informations pour s'assurer qu'elles sont conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.
Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.
Validations synchrones
Les validations du schéma sont spécifiques aux UpdateLegalTerms actions du AWS Marketplace Catalog API. Les validations sont effectuées lorsque vous appelezStartChangeSet. Si la demande ne répond pas aux exigences suivantes, elle échouera avec une réponse HTTP.
| Champ de saisie | Règle de validation | Code HTTP |
|---|---|---|
| Termes |
Obligatoire Ne doit pas être vide ou nul |
422 |
| Termes []. BuyerLegalTerm |
Obligatoire Ne doit pas être vide ou nul |
422 |
| Termes []. ResaleLegalTerm |
Facultatif Ne doit pas être nul ou vide s'il est présent |
422 |
| Termes []. BuyerLegalTerm.Documents |
Obligatoire Ne doit pas être vide ou nul |
422 |
| Termes []. BuyerLegalTerm.Documents[] .Type |
Obligatoire Ne doit pas être vide ou nul Valeurs autorisées :
|
422 |
| Termes []. BuyerLegalTerm.Documents[] .URL | Obligatoire et doit être une URL valide lorsque « Type » est « CustomEula » Ne doit pas être fourni lorsque « Type » est l'un des [» StandardEula «," EnterpriseEula «] |
422 |
| Termes []. ResaleLegalTerm.Documents |
Obligatoire Ne doit pas être vide ou nul |
422 |
| Termes []. ResaleLegalTerm.Documents[] .Type |
Obligatoire Les valeurs autorisées ne doivent pas être nulles ou vides :
|
422 |
| Termes []. ResaleLegalTerm.Documents[] .URL |
Obligatoire et doit être une URL valide lorsque « Type » est « CustomResellerContract » Ne doit pas être fourni lorsque « Type » est l'un des [» StandardContract «] |
422 |
| Une propriété inconnue | Aucune propriété supplémentaire n'est autorisée | 422 |
Erreurs asynchrones
Les erreurs suivantes sont spécifiques aux UpdateLegalTerms actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelezDescribeChangeSet, après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.
| Code d’erreur | Message d’erreur |
|---|---|
| DOCUMENTS_LEGAL_ACHETEUR_INVALIDES | Fournissez des URL pour les documents juridiques des acheteurs stockés dans des compartiments S3 accessibles. |
| DOCUMENTS_LÉGAUX_REVENTE_NON VALIDES | Fournissez des URL pour la revente de documents juridiques stockés dans des compartiments S3 accessibles. |
| TERMES_OBLIGATOIRES MANQUANTS | Fournissez un BuyerLegalTerm. |
Mettre à jour les prix
Vous pouvez utiliser l'API du catalogue pour remplacer complètement les conditions tarifaires existantes AWS Marketplace.
Les conditions tarifaires qui ne sont pas incluses dans la dernière demande seront supprimées de l'autorisation de revente. Vous pouvez mettre à jour le prix réduit de votre produit via cette API.
Pour mettre à jour les informations tarifaires de vos autorisations de revente, appelez l'opération StartChangeSet API avec le type de UpdatePricingTerms modification, comme indiqué dans l'exemple suivant.
Syntaxe de la demande
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdatePricingTerms", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "PricingModel": "Contract", "Terms": [ { "Type": "ResaleUsageBasedPricingTerm", "CurrencyCode": "USD", "RateCards": [ { "RateCard": [ { "DimensionKey": "m3.large", "Price": "0.10" }, { "DimensionKey": "m4.xlarge", "Price": "0.20" } ] } ] }, { "Type": "ResaleConfigurableUpfrontPricingTerm", "CurrencyCode": "USD", "RateCards": [ { "Selector": { "Type": "Duration", "Value": "P12M" }, "RateCard": [ { "DimensionKey": "m3.large", "Price": "300" }, { "DimensionKey": "m4.xlarge", "Price": "400" } ], "Constraints": { "MultipleDimensionSelection": "Allowed", "QuantityConfiguration": "Allowed" } } ] }, { "Type": "ResaleFixedUpfrontPricingTerm", "CurrencyCode": "USD", "Duration": "P2M", "Price": "200.0", "Grants": [ { "DimensionKey": "Users", "MaxQuantity": 10 } ] } ] } } ] }
Fournissez des informations pour les champs permettant d'ajouter le type de UpdatePricingTerms modification :
-
Entité (objet) (obligatoire) — Votre autorisation de revente.
-
Type (chaîne) (obligatoire) —
TypeC'est toujours le casResaleAuthorization@1.0. -
Identifiant (chaîne) (obligatoire) — Votre numéro d'autorisation de revente. Pour de plus amples informations, veuillez consulter Identifiant.
-
-
DetailsDocument(objet) (obligatoire) — Spécificités de la demande.
-
PricingModel(string) (obligatoire) — Modèle de tarification pour votre offre. Les valeurs possibles pour le modèle de tarification sont les suivantes :
-
Utilisation : modèle de Usage-based tarification dans le cadre duquel les acheteurs seront facturés pour l'utilisation qu'ils ont faite de votre produit.
-
Contrat — Dans le modèle de tarification basé sur le contrat, les acheteurs sont soit facturés à l'avance pour l'utilisation de votre produit, soit un calendrier de paiement flexible est proposé. Les acheteurs peuvent également payer pour une utilisation supplémentaire au-delà de leur contrat. Les partenaires de distribution peuvent ajouter leur majoration à ce calendrier de paiement et à ce prix pour chaque dimension.
-
-
Termes (ensemble de structures) (obligatoire) — Liste des conditions tarifaires que vous souhaitez mettre à jour. Les conditions tarifaires prises en charge sont les suivantes :
-
ResaleUsageBasedPricingTerm(objet) — Définit un modèle de tarification au fur et à mesure (PAYG) dans lequel les clients sont facturés en fonction de l'utilisation du produit.
-
Type (chaîne) (obligatoire) — Catégorie du terme.
-
CurrencyCode(string) — Définit la devise pour les prix mentionnés dans ce terme. Actuellement, seul le dollar américain est pris en charge.
-
RateCards(ensemble de structures) — Liste des cartes tarifaires.
-
RateCard(ensemble de structures) — Une carte tarifaire définit les taux unitaires pour les dimensions du produit.
-
DimensionKey(string) — Dimension à laquelle le droit donné s'applique. Les dimensions représentent les catégories de capacité d'un produit et sont spécifiées lorsque le produit est répertorié dans AWS Marketplace.
-
Prix (chaîne) — Prix unitaire pour la dimension du produit utilisée pour calculer le montant à facturer.
-
-
Contraintes (objet) (facultatif) — Définit les limites de la manière dont le terme peut être configuré par les accepteurs.
-
MultipleDimensionSelection(chaîne) (facultatif) — Détermine si les acheteurs sont autorisés à sélectionner plusieurs dimensions dans la grille tarifaire. Les valeurs possibles sont
AllowedetDisallowed. La valeur par défaut estAllowed. -
QuantityConfiguration(chaîne) (facultatif) — Détermine si les accepteurs sont autorisés à configurer la quantité pour chaque dimension de la fiche tarifaire. Les valeurs possibles sont
AllowedetDisallowed. La valeur par défaut estAllowed.
-
-
-
-
ResaleFixedUpfrontPricingTerm(objet) — Définit un modèle de tarification prépayé dans le cadre duquel un montant initial fixe est facturé aux clients.
-
Type (chaîne) (obligatoire) — Catégorie du terme mis à jour.
-
CurrencyCode(string) — Définit la devise pour les prix mentionnés dans ce terme. Définit la devise pour les prix mentionnés dans ce terme. Les devises USD, AUD, EUR, GBP et JPY sont prises en charge.
-
Prix (chaîne) (obligatoire) — Montant fixe à facturer au client lorsque ce terme est accepté.
-
Durée (chaîne) (obligatoire) — Durée du contrat du ResaleAuthorization. Ce champ prend en charge le format ISO 8601.
-
Subventions (ensemble de structures) (obligatoire) — Droits qui seront accordés à l'accepteur d'un prix initial fixe dans le cadre de l'exécution du contrat.
-
DimensionKey(chaîne) (obligatoire) — Clé de dimension unique définie dans le document du produit. Les dimensions représentent les catégories de capacité d'un produit et sont spécifiées lorsque le produit est répertorié dans AWS Marketplace.
-
MaxQuantity(entier) (obligatoire) — Capacité maximale à laquelle l'acheteur peut avoir droit pour la dimension donnée du produit. Si MaxQuantity ce n'est pas fourni, l'acheteur pourra utiliser une quantité illimitée de la dimension donnée.
-
-
-
-
Syntaxe de réponse
Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La demande de modification est ajoutée à une file d'attente et traitée. Cela inclut la validation des informations pour s'assurer qu'elles sont conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.
Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.
Validations synchrones
Les validations de schéma suivantes sont spécifiques aux UpdatePricingTerms actions de l'API AWS Marketplace Catalog. Les validations sont effectuées lorsque vous appelezStartChangeSet. Si la demande ne répond pas aux exigences suivantes, elle échouera avec une réponse HTTP.
| Champ de saisie | Règle de validation |
|---|---|
| Termes |
Obligatoire Ne doit pas être vide ou nul Chaque terme ne doit présenter qu'une seule fois Termes autorisés :
|
| Termes []. ResaleUsageBasedPricingTerm.CurrencyCode |
Obligatoire Valeurs autorisées : USD |
| Termes []. ResaleUsageBasedPricingTerm.Validity |
Obligatoire Ne doit pas être vide ou nul Format attendu : durée ISO 8601 |
| Termes []. ResaleUsageBasedPricingTerm.RateCards |
Obligatoire Ne doit pas être vide ou nul |
| Termes []. ResaleUsageBasedPricingTerm.RateCards[]. DimensionKey |
Obligatoire Ne doit pas être vide ou nul La longueur doit être comprise entre 1 et 60 |
| Termes []. ResaleUsageBasedPricingTerm.RateCards[] .Prix |
Obligatoire Ne doit pas être vide ou nul Le type de données est « String » Doit être non négatif Support jusqu'à 8 décimales Aucun caractère spécial n'est pris en charge |
| Termes []. ResaleConfigurableUpfrontPricingTerm.CurrencyCode |
Obligatoire Valeurs autorisées : ["USD », « AUD », « EUR », « GBP », « JPN"] |
|
Termes []. ResaleConfigurableUpfrontPricingTerm.RateCards[]. Selector.Type |
Obligatoire Ne doit pas être vide ou nul Valeurs autorisées : Durée |
|
Termes []. ResaleConfigurableUpfrontPricingTerm.RateCards[]. Selector.Value |
Obligatoire Ne doit pas être vide ou nul Format attendu : durée ISO 8601 |
|
Termes []. ResaleConfigurableUpfrontPricingTerm.RateCards[]. RateCard.DimensionKey |
Obligatoire Ne doit pas être vide ou nul La longueur doit être comprise entre 1 et 60 |
|
Termes []. ResaleConfigurableUpfrontPricingTerm.RateCards[]. RateCard.Price |
Obligatoire Ne doit pas être vide ou nul Le type de données est « String » Doit être non négatif Support jusqu'à 6 décimales Aucun caractère spécial n'est pris en charge |
|
Termes []. ResaleConfigurableUpfrontPricingTerm.RateCards[] .Contraintes |
Facultatif |
| Termes []. ResaleFixedUpfrontPricingTerm.CurrencyCode | Obligatoire Valeurs autorisées : ["USD », « AUD », « EUR », « GBP », « JPN"] |
| Termes []. ResaleFixedUpfrontPricingTerm.Price |
Obligatoire Ne doit pas être vide ou nul Le type de données est « String » Doit être non négatif Support jusqu'à 6 décimales Aucun caractère spécial n'est pris en charge Valeurs autorisées : 0.0 |
| Termes []. ResaleFixedUpfrontPricingTerm.Duration |
Obligatoire Ne doit pas être vide ou nul Format attendu : durée ISO 8601 |
| Termes []. ResaleFixedUpfrontPricingTerm.Grants[]. DimensionKey |
Obligatoire Ne doit pas être vide ou nul La longueur doit être comprise entre 1 et 60 |
| Termes []. ResaleFixedUpfrontPricingTerm.Grants[]. MaxQuantty |
Obligatoire Ne doit pas être vide ou nul |
| Une propriété inconnue | Aucune propriété supplémentaire n'est autorisée |
Erreurs asynchrones
Les erreurs suivantes sont spécifiques aux UpdatePricingTerms actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.
| Code d’erreur | Message d’erreur |
|---|---|
| CODE_MONNAIE_NON VALIDE | Fournissez les mêmes informations pour CurrencyCode tous les prix et conditions de paiement. |
| PRODUIT_INCOMPATIBLE | Utilisez les dimensions existantes et disponibles du produit en [x]. |
| CLÉS DE DIMENSION DUPLIQUÉES | Fournir une carte tarifaire avec une liste unique de clés de dimension dans [x] |
| CARTE_TARIFAIRE NON VALIDE | Indiquez les dimensions dont l'unité est la même dans [x] |
| CARTE_TARIFAIRE NON VALIDE | Fournissez une carte tarifaire pour les dimensions mesurées uniquement. ResaleUsageBasedPricingTerm |
| CARTE_TARIFAIRE NON VALIDE | Fournissez des taux basés sur l'utilisation pour toutes les dimensions mesurées disponibles dans ResaleUsageBasedPricingTerm. |
| TROP DE TARIFS | Fournissez RateCards dans les limites autorisées dans ResaleUsageBasedPricingTerm. |
| SÉLECTEURS DUPLIQUÉS | Fournissez une liste unique de sélecteurs dans. ResaleConfigurableUpfrontPricingTerm |
| CARTE_TARIFAIRE NON VALIDE | ConfigurableUpfrontPricingTerm il manque une ou plusieurs clés de dimension pendant la durée [x]. Indiquez les prix pour le même jeu de clés dimensionnelles pour toutes les durées. |
| CARTE_TARIFAIRE NON VALIDE | Indiquez toutes les dimensions mesurées ou toutes les dimensions autorisées en [x]. |
| INCOMPATIBLE_RATE_CARD_CONSTRAINTS | Réglez MultipleDimensionSelection et QuantityConfiguration sur Non autorisé dans ResaleConfigurableUpfrontPricingTerm le PricingModel. |
| TROP DE CARTES TARIFAIRES | Une seule inscription par carte tarifaire ConfigurableUpfrontPricingTerm est autorisée pour le produit. |
| TERMES_INCOMPATIBLES | Les termes suivants ne sont pas compatibles avec PricingModel : [x, y, z]. |
| TROP DE TARIFS | Fournissez RateCards dans les limites autorisées en [x terme]. |
| TROP DE SUBVENTIONS | Fournir jusqu'à [N] subventions au cours de [x trimestre]. |
| VALEUR_DURE_DURE_DE_SÉLECTION NON VALIDE | Indiquez une durée comprise entre [x] et [y] mois en ResaleConfigurableUpfront |
| TROP DE SUBVENTIONS | Indiquez une durée comprise entre [x] et [y] mois. |
| VALEUR_DURE_DURE_DE_SÉLECTION NON VALIDE | Assurez-vous que la granularité de la durée est au niveau du jour pour les dimensions mesurées dans ResaleConfigurableUpfront |
| DURÉE_INVALIDE | Assurez-vous que la granularité de la durée est au niveau du jour pour les dimensions mesurées en. FixedUpfront |
| CARTE_TARIFAIRE NON VALIDE | Indiquez uniquement les dimensions autorisées dans [x]. |
| DURÉE_MANQUANTE | Indiquez une durée dans [x]. |
| CLÉS DE DIMENSION DUPLIQUÉES | Fournissez à Grants une liste unique de clés de dimension dans [x]. |
| PARAMÈTRES_DE PAIEMENT INCOMPATIBLES | Mettez à jour vos paramètres de paiement pour qu'ils soient compatibles avec le CurrencyCode. |
| VÉRIFICATION_VENDEUR INCOMPATIBLE | Effectuez tous les processus de vérification des vendeurs requis. |
| CODE_MONNAIE_NON VALIDE | Fournir un support CurrencyCode. |
| CODE_MONNAIE_NON VALIDE | Fournissez les mêmes informations pour CurrencyCode tous les prix et conditions de paiement. |
| CODE_MONNAIE_INCOMPATIBLE | CurrencyCode ne peut pas être modifiée après la publication de l'offre. |
Mettre à jour le calendrier de paiement
Vous pouvez utiliser l'API du catalogue pour modifier les informations associées au paiement, telles qu'un calendrier de paiement flexible, dans. AWS Marketplace
Pour mettre à jour les informations associées au paiement pour votre autorisation de revente, appelez l'opération StartChangeSet API avec le type de UpdatePaymentScheduleTerms modification, comme indiqué dans l'exemple suivant.
Syntaxe de la demande
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdatePaymentScheduleTerms", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "Terms": [ { "Type": "ResalePaymentScheduleTerm", "CurrencyCode": "USD", "Schedule": [ { "ChargeDate": "2021-12-01", "ChargeAmount": "200.00" }, { "ChargeDate": "2022-03-01", "ChargeAmount": "250.00" } ] } ] } } ] }
Fournissez des informations pour les champs permettant d'ajouter le type de UpdatePaymentScheduleTerms modification :
-
Entité (objet) (obligatoire) — Votre autorisation de revente.
-
Type (chaîne) (obligatoire) —
TypeC'est toujours le casResaleAuthorization@1.0. -
Identifiant (chaîne) (obligatoire) — Votre numéro d'autorisation de revente. Pour de plus amples informations, veuillez consulter Identifiant.
-
-
DetailsDocument(objet) (obligatoire) — Spécificités de la demande.
-
Termes (ensemble de structures) : liste des conditions de paiement que vous souhaitez mettre à jour. Les conditions de paiement prises en charge sont les suivantes :
-
ResalePaymentScheduleTerm(objet) — Définit un modèle de tarification par versements dans le cadre duquel les clients se voient facturer un prix fixe à différentes dates au cours de la période de validité du contrat.
-
Type (chaîne) — Catégorie du terme mis à jour.
-
CurrencyCode(string) (obligatoire) — Définit la devise pour le paiement mentionné dans le calendrier. Les devises USD, AUD, EUR, GBP et JPY sont prises en charge.
-
Calendrier (ensemble de structures) — Liste du calendrier de paiement où chaque élément définit un versement. Il contient les informations nécessaires au calcul du prix à payer et de la date à laquelle le client serait débité.
-
ChargeDate(string) (obligatoire) — Date à laquelle le client paierait le prix défini dans ce délai de paiement. Ce champ prend en charge le format ISO 8601.
-
ChargeAmount(string) (obligatoire) — Le prix que le client paierait à une date planifiée (ChargeDate).
-
-
-
-
Syntaxe de réponse
Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La demande de modification est ajoutée à une file d'attente et traitée. Cela inclut la validation des informations pour s'assurer qu'elles sont conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.
Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.
Validations synchrones
Les validations du schéma sont spécifiques aux UpdatePaymentScheduleTerms actions du AWS Marketplace Catalog API. Les validations sont effectuées lorsque vous appelezStartChangeSet. Si la demande ne répond pas aux exigences suivantes, elle échouera avec une réponse HTTP.
| Champ de saisie | Règle de validation | HTTP |
|---|---|---|
| Terms.Type |
Obligatoire Non pris en charge pour le produit [x] Termes autorisés : ResalePaymentScheduleTerm |
422 |
| Termes []. CurrencyCode |
Obligatoire Valeurs autorisées : USD |
422 |
| Termes []. ResalePaymentScheduleTerm.Schedule |
Obligatoire La longueur doit être comprise entre 1 et 60 |
422 |
| Termes []. ResalePaymentScheduleTerm.Shedule.ChargeDate |
Obligatoire Doit être au format ISO 8601 La date doit être dans le futur |
422 |
| Termes []. ResalePaymentScheduleTerm.Shedule.ChargeAmount |
Obligatoire Doit être non négatif |
422 |
| Une propriété inconnue | Aucune propriété supplémentaire n'est autorisée | 422 |
Erreurs asynchrones
Les erreurs suivantes sont spécifiques aux UpdatePaymentScheduleTerms actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultez. Travailler avec des ensembles de modifications
| Code d’erreur | Message d’erreur |
|---|---|
| TERMES_INCOMPATIBLES | OffersMaxQuantity et AvailabilityEndDate doit être présent avec ResalePaymentScheduleTerm. |
| TROP DE PAIEMENTS PLANIFIÉS | Effectuez jusqu'à 60 paiements planifiés ResalePaymentScheduleTerm. |
| DUPLICATE_CHARGE_DATES | Indiquez des dates de facturation uniques dans ResalePaymentScheduleTerm. |
| DATES_DE_CHARGE NON VALIDES | Offrez un futur ChargeDate. |
| DATES_DE_CHARGE NON VALIDES | Indiquez une date de dernière recharge antérieure à [x]. |
| TERMES_OBLIGATOIRES MANQUANTS | Fournissez un ResaleFixedUpfrontPricingTerm et ResalePaymentScheduleTerm ensemble. |
| CODE_MONNAIE_NON VALIDE | Fournissez les mêmes informations pour CurrencyCode tous les prix et conditions de paiement. |
| PARAMÈTRES_DE PAIEMENT INCOMPATIBLES | Mettez à jour vos paramètres de paiement pour qu'ils soient compatibles avec le CurrencyCode. |
| VÉRIFICATION_VENDEUR INCOMPATIBLE | Effectuez tous les processus de vérification des vendeurs requis. |
| CODE_MONNAIE_NON VALIDE | Fournir un support CurrencyCode. |
| CODE_MONNAIE_NON VALIDE | Fournissez les mêmes informations pour CurrencyCode tous les prix et conditions de paiement. |
| CODE_MONNAIE_INCOMPATIBLE | CurrencyCode ne peut pas être modifiée après la publication de l'offre. |
Mettre à jour les détails de l'autorisation de revente
Vous pouvez utiliser l'API du catalogue pour mettre à jour les détails de l'autorisation de revente dans AWS Marketplace.
Pour mettre à jour les détails de l'autorisation de revente, appelez l'opération StartChangeSet API avec le type de UpdateInformation modification, comme indiqué dans l'exemple suivant.
Note
Le type de UpdateInformation modification met uniquement à jour les sections fournies dans la demande ; toutes les autres informations restent inchangées.
Syntaxe de la demande
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "UpdateInformation", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": { "Name": "TestResaleAuthorization", "Description": "Worldwide ResaleAuthorization for Test Product", "PreExistingBuyerAgreement": { "AcquisitionChannel": "AwsMarketplace", "PricingModel": "Contract" } } } ] }
Fournissez des informations pour les champs permettant d'ajouter le type de UpdateInformation modification :
-
Entité (objet) (obligatoire) — Votre autorisation de revente.
-
Type (chaîne) (obligatoire) —
TypeC'est toujours le casResaleAuthorization@1.0. -
Identifiant (chaîne) (obligatoire) — Votre numéro d'autorisation de revente. Pour de plus amples informations, veuillez consulter Identifiant.
-
-
DetailsDocument(objet) (obligatoire) — Détails de la demande, y compris les informations que vous souhaitez mettre à jour pour l'autorisation de revente.
-
Nom (chaîne) (facultatif) : nom associé au ResaleAuthorization pour une meilleure lisibilité pour vous et vos partenaires de distribution.
-
Description (chaîne) (facultatif) — La description est un texte libre dans lequel vous pouvez ajouter des détails sur le ResaleAuthorization.
-
PreExistingBuyerAgreement(objet) (facultatif) — Détermine si cette offre est le renouvellement d'un contrat existant avec un client existant pour le même produit sous-jacent. L'accord existant peut être interne ou externe AWS Marketplace. AWS peut auditer et vérifier que votre offre est un renouvellement. S'il n' AWS est pas en mesure de vérifier votre offre, vous AWS pouvez révoquer l'offre et les droits de votre client.
-
AcquisitionChannel(chaîne) (obligatoire) — Indique si le contrat d'achat existant a été signé à l'extérieur AWS Marketplace ou à l'intérieur AWS Marketplace.
Valeurs possibles :
External,AwsMarketplace -
PricingModel(chaîne) (obligatoire) — Indique le modèle de tarification utilisé par le contrat existant.
Valeurs possibles :
Contract,Usage,BYOL,Free
-
-
Syntaxe de réponse
Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La demande de modification est ajoutée à une file d'attente et traitée. Cela inclut la validation des informations pour s'assurer qu'elles sont conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.
Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.
Validations synchrones
Les validations de schéma suivantes sont spécifiques aux UpdateInformation actions du AWS Marketplace Catalog API. Ces validations sont effectuées lorsque vous appelezStartChangeSet, et la demande échouera avec une erreur HTTP si l'entrée ne répond pas aux exigences suivantes.
| Champ de saisie | Règle de validation | Code HTTP |
|---|---|---|
| Nom |
Facultatif Ne doit pas être vide ou nul La longueur doit être comprise entre 1 et 100 caractères Motif ^ [A-Za-z0-9] *$ Aucun caractère spécial ou espace blanc autorisé |
422 |
| Description |
Facultatif La longueur doit être comprise entre 1 et 255 caractères Motif ^ [A-Za-z0-9\ \ s] *$ Aucun caractère spécial autorisé |
422 |
| Une propriété inconnue | Aucune propriété supplémentaire n'est autorisée | 422 |
Erreurs asynchrones
Les erreurs suivantes sont spécifiques aux UpdateInformation actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultez. Travailler avec des ensembles de modifications
| Code d’erreur | Message d’erreur |
|---|---|
| CIBLAGE_ACHETEUR_ACHETEUR INCOMPATIBLE | Au moins un compte d'acheteur doit être présent pour ResaleAuthorization PreExistingBuyerAgreement. |
Restreindre une autorisation de revente
Vous pouvez utiliser l'API du catalogue pour définir des règles de restriction relatives à une autorisation de revente dans AWS Marketplace.
Une autorisation de revente restreinte ne peut plus être utilisée par un partenaire de distribution pour créer une offre privée. Une offre privée existante ne sera pas affectée.
Pour restreindre votre autorisation de revente, appelez l'opération StartChangeSet API avec le type de RestrictResaleAuthorization modification, comme indiqué dans l'exemple suivant.
Important
Il s'agit d'une opération irréversible. Une fois que l'autorisation de revente est marquée comme telleRestricted, elle ne peut plus être dans un Active état normal.
Syntaxe de la demande
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "RestrictResaleAuthorization", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": {} } ] }
Fournissez des informations pour les champs permettant d'ajouter le type de RestrictResaleAuthorization modification :
-
Entité (objet) (obligatoire) — Votre autorisation de revente.
-
Type (chaîne) (obligatoire) —
TypeC'est toujours le casResaleAuthorization@1.0. -
Identifiant (chaîne) (obligatoire) — Votre numéro d'autorisation de revente. Pour de plus amples informations, veuillez consulter Identifiant.
-
-
DetailsDocument(objet) (obligatoire) — Spécificités de la demande. Il doit s'agir d'un objet vide pour
RestrictResaleAuthorization.
Syntaxe de réponse
Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La demande de modification est ajoutée à une file d'attente et traitée. Cela inclut la validation des informations pour s'assurer qu'elles sont conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.
Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.
Validations synchrones
Les validations de schéma sont spécifiques aux RestrictResaleAuthorization actions de l'API AWS Marketplace Catalog. Ces validations sont effectuées lorsque vous appelezStartChangeSet. Si la demande ne répond pas aux exigences suivantes, elle échouera avec une réponse HTTP.
| Champ de saisie | Règle de validation | Code HTTP |
|---|---|---|
| DetailsDocument | Doit être vide | 422 |
RestrictResaleAuthorization |
La date d'expiration ne ResaleAuthorization peut pas être marquée comme |
422 |
| Une propriété inconnue | Aucune propriété supplémentaire n'est autorisée | 422 |
Erreurs asynchrones
Les erreurs suivantes sont spécifiques aux RestrictResaleAuthorization actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus d'informations sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultez. Travailler avec des ensembles de modifications
| Code d’erreur | Message d’erreur |
|---|---|
| ÉTAT_INCOMPATIBLE | ResaleAuthorization Les articles expirés ne peuvent pas être marqués comme étant restreints. |
Délivrer une autorisation de revente et la rendre visible à un partenaire de distribution
Vous pouvez utiliser l'API Catalog pour passer ResaleAuthorization à un Active état.
ReleaseResaleAuthorizationactive votre autorisation de revente afin qu'un partenaire de distribution puisse utiliser votre autorisation de revente pour créer des offres privées.
Pour libérer votre autorisation de revente, appelez l'opération StartChangeSet API avec le type de ReleaseResaleAuthorization modification, comme indiqué dans l'exemple suivant.
Syntaxe de la demande
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [ { "ChangeType": "ReleaseResaleAuthorization", "Entity": { "Type": "ResaleAuthorization@1.0", "Identifier": "resaleauthz-123456789" }, "DetailsDocument": {} } ] }
Fournissez des informations pour les champs permettant d'ajouter le type de ReleaseResaleAuthorization modification :
-
Entité (objet) (obligatoire) — Votre autorisation de revente.
-
Type (chaîne) (obligatoire) —
TypeC'est toujours le casResaleAuthorization@1.0. -
Identifiant (chaîne) (obligatoire) — Votre numéro d'autorisation de revente. Pour de plus amples informations, veuillez consulter Identifiant.
-
-
DetailsDocument(objet) (obligatoire) — Spécificités de la demande. Il doit être vide pour
ReleaseResaleAuthorization.
Syntaxe de réponse
Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ChangeSetIdensemble ChangeSetArn de modifications et ressemble à ce qui suit.
{ "ChangeSetId": "example123456789012abcdef", "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef" }
La demande de modification est ajoutée à une file d'attente et traitée. Cela inclut la validation des informations pour s'assurer qu'elles sont conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.
Vous pouvez vérifier l'état de la demande via ou directement via l' Portail de gestion AWS Marketplace API Catalog à l'aide de l'opération DescribeChangeSet API.
Validations synchrones
Les validations du schéma sont spécifiques aux ReleaseResaleAuthorization actions du AWS Marketplace Catalog API. Les validations sont effectuées lorsque vous appelezStartChangeSet. Si la demande ne répond pas aux exigences suivantes, elle échouera avec une réponse HTTP.
| Champ de saisie | Règle de validation | Code HTTP |
|---|---|---|
| Une propriété inconnue | Aucune propriété supplémentaire n'est autorisée | 422 |
Erreurs asynchrones
Les erreurs suivantes sont spécifiques aux ReleaseResaleAuthorization actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet après le traitement d'un ensemble de modifications. Pour plus de détails sur l'utilisation DescribeChangeSet pour obtenir le statut d'une demande de modification, consultezTravailler avec des ensembles de modifications.
| Code d’erreur | Message d’erreur |
|---|---|
| TERMES_OBLIGATOIRES MANQUANTS | Fournissez un BuyerLegalTerm. |
| TERMES_OBLIGATOIRES MANQUANTS | Fournissez un PricingTerm. |
| PRODUIT_INCOMPATIBLE | Utilisez un produit actif dans un état limité ou public. |
| TERME_DE TARIFICATION INCOMPATIBLE | PaymentScheduleTerm et FixedUpfrontPricingTerm doivent être présents ensemble. |
| CIBLAGE_ACHETEUR_ACHETEUR INCOMPATIBLE | Au moins un compte d'acheteur doit être présent pour ResaleAuthorization PreExistingBuyerAgreement. |
| TERMES_OBLIGATOIRES MANQUANTS | Indiquez au moins l'un des [x, y, z]. |
| ÉTAT_INCOMPATIBLE | La demande [x] ne peut pas être exécutée une fois l'autorisation de revente délivrée. |
Décrire une autorisation de revente existante
Pour décrire les détails de l'autorisation de revente, appelez l'opération DescribeEntity API avec le type d'ResaleAuthorization@1.0entité, comme indiqué dans l'exemple suivant.
Syntaxe de la demande
GET /DescribeEntity?catalog=<Catalog>&entityId=<EntityId> HTTP/1.1
Fournissez des informations pour les champs permettant d'ajouter le type de DescribeEntity modification :
-
catalog (chaîne) — Le catalogue associé à la demande. Valeur fixe :
AWSMarketplace. -
EntityId (string) — L'ID unique du
ResaleAuthorizationà décrire.
Syntaxe de réponse
La réponse à cette demande vous donne les détails de l'offre et ressemble à ce qui suit.
{ "EntityType": "ResaleAuthorization@1.0", "EntityIdentifier": "resaleauthz-123456789", "EntityArn": "arn:aws:aws-marketplace:us-east-1:111122223333:AWSMarketplace/ResaleAuthorization/resaleauthz-123456789", "LastModifiedDate": "2021-03-10T21:57:16Z", "DetailsDocument": { "Name": "TestResaleAuthorization", "Description": "ResaleAuthorization for Test Product", "ProductId": "prod-ad8EXAMPLE51", "ProductName": "TestProduct", "Status": "Active", /*Draft, Active, Restricted*/ "PreExistingBuyerAgreement": { "AcquisitionChannel": "Unknown", "PricingModel": "Unknown" }, "CreatedDate": "2023-07-18T16:39:31.335Z", "ManufacturerLegalName": "ChannelCAPI.Inc", "ManufacturerAccountId": "123456789012", "Dimensions": [ { "Name": "Protected Resources", "Description": "Additional 100 protected resources", "Key": "hundredresources", "Unit": "Units", "Types": [ "Entitled" ] } ], "OfferDetails": { "OfferExtendedStatus": "Not Started", /* Not Started, Completed-Used, Completed-Usable*/ "OfferCreatedCount": 0 }, "Terms": [ { "Type": "ResaleUsageBasedPricingTerm", "Id": "term_id_placeholder", "CurrencyCode": "USD", "RateCards": [ { "RateCard": [ { "DimensionKey": "resource_number", "Price": "0.05" }, { "DimensionKey": "scanned_data", "Price": "0.05" } ] } ] }, { "Type": "ResaleConfigurableUpfrontPricingTerm", "Id": "term_id_placeholder", "CurrencyCode": "USD", "RateCards": [ { "Selector": { "Type": "Duration", "Value": "P24M" }, "RateCard": [ { "DimensionKey": "hundredresources", "Price": "0.04" }, { "DimensionKey": "tenTBData", "Price": "0.03" }, { "DimensionKey": "channel_custom", "Price": "0.02" } ], "Constraints": { "MultipleDimensionSelection": "Allowed", "QuantityConfiguration": "Allowed" } } ] }, { "Type": "ResaleFixedUpfrontPricingTerm", "Id": "term-sdh27fb2", "CurrencyCode": "USD", "Duration": "P180D", "Price": "0.0", "Grants": [ { "DimensionKey": "sdf73rbns93nl120d10xm1", "MaxQuantity": 1 } ] }, { "Type": "ResalePaymentScheduleTerm", "Id": "term-sdh27fb2", "CurrencyCode": "USD", "Schedule": [ { "ChargeDate": "2018-07-01T00:00:00.000Z", "ChargeAmount": "200.00" }, { "ChargeDate": "2019-05-01T00:00:00.000Z", "ChargeAmount": "200.00" } ] }, { "Type": "BuyerLegalTerm", "Id": "term_id_placeholder", "Documents": [ { "Type": "StandardEula", "Url": "https://resale-auth-legal-terms-iad-beta.s3.us-east-1.amazonaws.com/09ae57d6-c75a-3a4c-aadf-9b866bae64ab/a85cace8-6d9d-40ca-a053-78fc265479bf?isSigned=yes" } ] }, { "Type": "ResaleLegalTerm", "Id": "term_id_placeholder", "Documents": [ { "Type": "StandardResellerContract", "Url": "https://resale-auth-legal-terms-iad-beta.s3.us-east-1.amazonaws.com/09ae57d6-c75a-3a4c-aadf-9b866bae64ab/bed55b56-7ab4-4c4c-b633-3bf4f6efcb98?isSigned=yes" } ] }, { "Type": "BuyerValidityTerm", "Id": "term_id_placeholder", "MaximumAgreementStartDate": "2023-09-25T23:59:59.000Z" }, { "Type": "BuyerTargetingTerm", "Id": "term_id_placeholder", "PositiveTargeting": { "BuyerAccounts": [ { "AwsAccountId": "444455556666" } ] } } ], "Rules": [ { "Type": "AvailabilityRule", "Id": "availability_rule_id_placeholder", /* If the AvailabilityEndDate and OffersMaxQuantity not present Usage will be Unlimited*/ "Usage": "Limited", "AvailabilityEndDate": "2022-05-31T23:59:59Z", "OffersMaxQuantity": 1 }, { "Type": "PartnerTargetingRule", "Id": "partner_targeting_rule_id_placeholder", "ResellerAccountId": "777777777777", "ResellerLegalName": "ChannelCAPICP.Inc" } ] } }
Vous trouverez ci-dessous des informations sur les champs que vous voyez dans la DescribeEntity réponse.
-
EntityType(string) — Le type nommé de l'entité, qui est ResaleAuthorization @1 .0.
-
EntityIdentifier(chaîne) — L'identifiant de l'entité, au format EntityId @RevisionId.
-
EntityArn(chaîne) — L'ARN associé à l'identifiant unique de l'ensemble de modifications référencé dans cette demande.
-
LastModifiedDate(chaîne) — Date de dernière modification de l'entité, au format ISO 8601 (27/02/2018T13:45:22Z).
-
DetailsDocument(object) (obligatoire) — Cette chaîne JSON inclut les détails de l'entité.
-
Nom (chaîne) : nom associé au ResaleAuthorization pour une meilleure lisibilité pour vous et vos partenaires de distribution. Il est affiché dans le cadre des informations du contrat.
-
Description (chaîne) — La description est un texte libre destiné à être utilisé uniquement par vous et qui ne sera jamais exposé aux acheteurs.
-
ProductId(chaîne) — La description est un texte libre destiné à être utilisé uniquement par vous et qui ne sera jamais exposé aux acheteurs.
-
AgreementToken(string) — Généré à partir du contenu dans ResaleAuthorization. Il contient des informations sur les termes, les règles et le proposant lors de la création d'un accord. Il est utilisé pour les contrôles d'autorisation et les validations lors des achats.
-
Termes (ensemble de structures) — Liste des termes présentés pour acceptation.
-
Règles (ensemble de structures) : liste de règles ou ensemble d'instructions.
-