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 les offres privées des partenaires de distribution à l'aide du AWS Marketplace API

Vous pouvez utiliser le AWS Marketplace Catalog API pour automatiser les tâches liées à l'utilisation des offres privées des partenaires de distribution (CPPO).

Lorsque vous créez ou mettez à jour un CPPO, le projet d'offre contiendra les termes et règles d'une autorisation de revente et sera invisible pour l'acheteur. Il est possible, mais pas obligatoire, d'impliquer plusieurs personnes dans votre organisation pour créer une offre privée.

Par exemple, une personne peut être chargée de mettre à jour les prix tandis qu'une seconde personne peut être chargée de mettre à jour le calendrier de paiement. Ensuite, une tierce personne peut être chargée de mettre à jour les termes juridiques. Vous pouvez autoriser une personne à mettre à jour certaines parties d'une offre. Toutefois, vous ne pouvez accorder des autorisations de lecture qu'aux autorisations de revente.

Comme condition préalable pour appeler des types de changement, vous devez avoir reçu une ou plusieurs autorisations de revente et être habitué à les utiliser. AWS Marketplace Catalog API

Pour plus d'informations, consultez la section Offres privées des partenaires de distribution dans le Guide AWS Marketplace du vendeur.

Les rubriques suivantes décrivent comment utiliser l'API Catalog pour créer et mettre à jour des CPPO :

Prérequis du CPPO

Service-linked la configuration d'un rôle pour ResaleAuthorization (SLR) est une condition préalable obligatoire pour utiliser l'autorisation de revente pour créer un CPPO. 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éation d'un CPPO

Vous utilisez une autorisation de revente qui vous est destinée pour créer une offre privée de partenaire de distribution (CPPO) en vigueur dans Draft l'État. AWS Marketplace

Si votre demande est traitée avec succès, AWS Marketplace Catalog API génère une offre en Draft état pour vous avec les conditions d'autorisation de revente. Vous pouvez consulter DescribeEntity les conditions appliquées au projet d'offre à partir de l'autorisation de revente. Il s'agit d'une offre incomplète qui n'est pas visible pour les acheteurs AWS Marketplace. Vous utilisez ensuite les types de modification associés au CPPO pour compléter l'offre.

Une fois l'offre terminée, vous utilisez le type de ReleaseOffer modification pour terminer le processus de création de l'offre et publier l'offre. Cela permettra de valider l'ensemble de l'offre et de la rendre visible aux acheteurs AWS Marketplace.

Pour créer une offre privée destinée aux partenaires de distribution, appelez l'opération StartChangeSet API avec le type de CreateOfferUsingResaleAuthorization modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "CreateOfferUsingResaleAuthorization",
      "Entity": {
        "Type": "Offer@1.0"
      },
      "DetailsDocument": {
        "ResaleAuthorizationId": "resaleauthz-123456789",
        "Name": "Test Offer",
        "OfferSetId": "offerset-b3f9EXAMPLE27"
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de CreateOfferUsingResaleAuthorization modification :

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.

La réponse à cette demande vous indique le statut de la demande. Si le statut est le casSUCCEEDED, un nouveau OfferId est généré.

{
  "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": "CreateOfferUsingResaleAuthorization",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "ResaleAuthorizationId": "resaleauthz-123456789",
        "Name": "Test Offer"
      },
      "ErrorDetailList": []
    }
  ]
}

Vous pouvez utiliser la GET DescribeEntity demande pour décrire le projet de règles et de termes de l'offre créé ResaleAuthorization à partir de la AWS Marketplace Catalog API référence. Pour de plus amples informations, veuillez consulter DescribeChangeSet.

Termes et règles de ResaleAuthorization

{
  "EntityType": "Offer@1.0",
  "EntityIdentifier": "offer-a5EXAMPLEwzpu@1",
  "EntityArn": "arn:aws:aws-marketplace:us-east-1:444555666777:AWSMarketplace/Offer/offer-a5oEXAMPLEzpu",
  "LastModifiedDate": "2021-03-10T21:57:16Z",
  "DetailsDocument": {
    "Id": "offer-3rb23tu92rn",
    "Name": "Test Offer",
    "Description": "Worldwide private offer for Test Product",
    "ProductId": "prod-0bc848d78b51",
    "ResaleAuthorizationId": "resaleauthz-123456789",
    "Terms": [
      {
        "Type": "LegalTerm",
        "Documents": [
          {
            "Type": "CustomEula",
            "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
          }
        ]
      },
      {
        "Type": "ConfigurableUpfrontPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "Selector": {
              "Type": "Duration",
              "Value": "P12M"
            },
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "300.00"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "400.00"
              }
            ],
            "Constraints": {
              "MultipleDimensionSelection": "Allowed",
              "QuantityConfiguration": "Allowed"
            }
          }
        ]
      },
      {
        "Type": "UsageBasedPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "0.10"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "0.20"
              }
            ]
          }
        ]
      },
      {
        "Type": "PaymentScheduleTerm",
        "CurrencyCode": "USD",
        "Schedule": [
          {
            "ChargeDate": "2020-12-01T00:00:00.000Z",
            "ChargeAmount": "1000.00"
          },
          {
            "ChargeDate": "2021-06-15T00:00:00.000Z",
            "ChargeAmount": "1250.00"
          }
        ]
      }
    ],
    "Rules": [
      {
        "Type": "TargetingRule",
        "PositiveTargeting": {
          "BuyerAccounts": [
            "111222333444"
          ]
        }
      }
    ]
  }
}

Validations synchrones

Les validations de schéma suivantes sont spécifiques aux CreateOfferUsingResaleAuthorization 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.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux CreateOfferUsingResaleAuthorization 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.

Créez une offre de remplacement privée pour les partenaires de distribution

Vous pouvez utiliser l'API du catalogue pour créer une offre de remplacement privée pour les partenaires de distribution dans AWS Marketplace.

Vous utilisez le contrat qui vous est ResaleAuthorization destiné et un accord dont vous êtes l'auteur pour créer une offre de remplacement privée de partenaire de distribution telle qu'Draftelle figure dans l'API du catalogue en appelant StartChangeSet avec le type de CreateReplacementOfferUsingResaleAuthorization modification, comme indiqué dans l'exemple suivant. Les offres de remplacement peuvent être utilisées pour remplacer un contrat d'une offre précédente avant son expiration.

CreateReplacementOfferUsingResaleAuthorizationcréera un projet d'offre avec l'accepteur de l'accord lors du ciblage. Ce ciblage ne peut pas être modifié par la suite. Le projet d'offre contiendra également l'identifiant de l'offre source du contrat.

Pour créer une offre de remplacement privée pour les partenaires de distribution, appelez l'opération StartChangeSet API avec le type de CreateReplacementOfferUsingResaleAuthorization modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "CreateReplacementOfferUsingResaleAuthorization",
      "Entity": {
        "Type": "Offer@1.0"
      },
      "DetailsDocument": {
        "ResaleAuthorizationId": "2bd2c761-3b7f-3771-a9a7-e8ad36517698",
        "Name": "CAPI-saas-abo-contract-fps",
        "AgreementId": "agmt-f2ooEXAMLEamtm7mjj0j59gu"
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de CreateReplacementOfferUsingResaleAuthorization modification :

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.

Validations synchrones

Les validations de schéma suivantes sont spécifiques aux CreateReplacementOfferUsingResaleAuthorization 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.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux CreateReplacementOfferUsingResaleAuthorization 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.

Mettre à jour le balisage

Vous pouvez utiliser l'API du catalogue pour mettre à jour les conditions tarifaires en fonction d'une valeur en pourcentage dans votre offre dans AWS Marketplace.

Cela appliquera le pourcentage de majoration indiqué à toutes les conditions tarifaires et de paiement (pour les futurs calendriers de paiement) définies par le fabricant dans le ResaleAuthorization. Tout balisage existant sera remplacé. Vous pouvez consulter les prix et les conditions de paiement mis à jour à l'aide deDescribeEntity.

Pour mettre à jour le balisage, appelez l'opération StartChangeSet API avec le type de UpdateMarkup modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateMarkup",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Percentage": "5.0"
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de UpdateMarkup modification :

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 de schéma suivantes sont spécifiques aux UpdateMarkup 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.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux UpdateMarkup 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.

Actualiser la configuration de ciblage

Vous pouvez utiliser l'API Catalog pour remplacer complètement la configuration de ciblage existante dans AWS Marketplace.

Toutes les options de ciblage existantes qui ne sont pas incluses dans la dernière demande seront supprimées de l'offre. Les fabricants peuvent mentionner des acheteurs ciblés spécifiques dansResaleAuthorization. Les partenaires de distribution peuvent proposer des offres privées à un sous-ensemble d'acheteurs PositiveTargeting en utilisant le type de UpdateTargeting modification.

Pour mettre à jour les configurations de ciblage de votre offre, appelez l'opération StartChangeSet API avec le type de UpdateTargeting modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateTargeting",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "PositiveTargeting": {
          "CountryCodes": [
            "US",
            "CA"
          ],
          "BuyerAccounts": [
            "111222333444"
          ]
        },
        "NegativeTargeting": {
          "CountryCodes": [
            "XX"
          ]
        }
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de UpdateTargeting modification :

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 UpdateTargeting 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.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux UpdateTargeting 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.

Mettre à jour les ressources juridiques

Vous pouvez utiliser l'API du catalogue pour fusionner les termes juridiques relatifs à l'autorisation de revente et remplacer complètement les termes juridiques existants. AWS Marketplace

Cette modification n'affecte pas les accords existants. Les termes juridiques qui ne sont pas inclus dans la dernière demande seront supprimés de l'offre. Vous pouvez consulter les termes juridiques fusionnés en appelantDescribeEntity.

Pour mettre à jour les termes juridiques de votre offre, 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": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "LegalTerm",
            "Documents": [
              {
                "Type": "CustomEula",
                "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
              }
            ]
          }
        ]
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de UpdateLegalTerms modification :

Un ensemble de modifications est créé pour votre demande. La réponse à cette demande vous donne l'ID de l'ensemble de modifications.

Syntaxe de réponse

{
"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 dans l'API du catalogue avec l'DescribeChangeSetaction. Portail de gestion AWS Marketplace

Validations synchrones

Les validations de schéma suivantes sont spécifiques aux UpdateLegalTerms 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.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux UpdateLegalTerms 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.

Mettre à jour la découvrabilité du CPPO

Vous pouvez utiliser l'API du catalogue pour gérer la découvrabilité de votre offre dans AWS Marketplace. Ce type de modification n'affecte pas les accords existants.

Vous pouvez choisir de fixer une date précise dans le futur afin de limiter la visibilité de votre offre ou de la faire expirer dans le passé.

Pour gérer la découvrabilité de votre offre, 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": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "AvailabilityEndDate": "2024-05-31"
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de UpdateAvailability modification :

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 UpdateAvailability 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.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux UpdateAvailability 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.

Définissez la date d'expiration des accords

Vous pouvez utiliser l'API du catalogue pour définir la date d'expiration des accords créés à l'aide de cette offre dans AWS Marketplace.

Ce changement n'affecte pas les accords existants. Le fabricant pourrait mentionner la date maximale de début du contrat dans une autorisation de revente. Toutefois, les partenaires de distribution ne peuvent pas fournir de date de début d'accord ultérieure à cette date.

Pour définir la date d'expiration des accords, appelez l'opération StartChangeSet API avec le type de UpdateValidityTerms modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "UpdateValidityTerms",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "ValidityTerm",
            "AgreementDuration": "P12M",
            "AgreementStartDate": "2021-08-01",
            "AgreementEndDate": "2022-08-01"
          }
        ]
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de UpdateValidityTerms modification :

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 UpdateValidityTerms 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.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux UpdateValidityTerms 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.

Mettre à jour les prix

Vous pouvez utiliser l'API du catalogue pour remplacer complètement les conditions tarifaires existantes.

Les conditions tarifaires qui ne sont pas incluses dans la dernière demande seront supprimées de l'offre. Les partenaires de distribution ne peuvent utiliser ce type de modification que pour passerFixedUpFrontPricingTerm.

Pour mettre à jour les conditions tarifaires de vos offres, 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": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "Details": {
        "PricingModel": "Contract",
        "Terms": [
          {
            "Type": "FixedUpfrontPricingTerm",
            "CurrencyCode": "USD",
            "Price": "200.00",
            "Duration": "P465D",
            "Grants": [
              {
                "DimensionKey": "Users",
                "MaxQuantity": 10
              }
            ]
          }
        ]
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de UpdatePricingTerms modification :

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 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.

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.

Mettre à jour les détails du calendrier de paiement

Vous pouvez utiliser l'API du catalogue pour modifier les détails du calendrier de paiement, tels que le calendrier de paiement flexible, dans AWS Marketplace.

Si le fabricant a fourni un échéancier de paiement dans l'autorisation de revente, le partenaire de distribution peut soit :

Pour mettre à jour les informations associées au paiement pour votre offre, 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": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {
        "Terms": [
          {
            "Type": "PaymentScheduleTerm",
            "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 :

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 UpdatePaymentScheduleTerms 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.

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, consultezTravailler avec des ensembles de modifications.

Publiez le CPPO

Vous pouvez utiliser l'API du catalogue pour fusionner les informations collectées à partir de tous les types de modifications de mise à jour, puis publier l'offre dans AWS Marketplace.

Les offres restent en Draft l'état jusqu'à ce ReleaseOffer qu'elles soient appelées. Une fois l'offre publiée, elle est consultable dans AWS Marketplace.

Pour publier votre offre, appelez l'opération StartChangeSet API avec le type de ReleaseOffer modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

POST /StartChangeSet HTTP/1.1
Content-type: application/json

{
  "Catalog": "AWSMarketplace",
  "ChangeSet": [
    {
      "ChangeType": "ReleaseOffer",
      "Entity": {
        "Type": "Offer@1.0",
        "Identifier": "offer-123456789"
      },
      "DetailsDocument": {}
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de ReleaseOffer modification :

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 ReleaseOffer 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.

Erreurs asynchrones

Les erreurs suivantes sont spécifiques aux ReleaseOffer 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.

Définir un CPPO existant

Vous pouvez utiliser l'API du catalogue pour définir les détails du CPPO dans AWS Marketplace.

Pour définir un CPPO existant, appelez l'opération DescribeEntity API avec le type d'Offer@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 :

Syntaxe de réponse

La réponse à cette demande vous donne les détails de l'offre et ressemble à ce qui suit.

{
  "EntityType": "Offer@1.0",
  "EntityIdentifier": "offer-a5oEXAMPLEzpu@1",
  "EntityArn": "arn:aws:aws-marketplace:us-east-1:446235747164:AWSMarketplace/Offer/offer-a5oEXAMPLEzpu",
  "LastModifiedDate": "2021-03-10T21:57:16Z",
  "Details": {
    "Id": "offer-3rEXAMPLErn",
    "State": "Released",
    "Name": "Test Offer",
    "Description": "Worldwide private offer for Test Product",
    "PreExistingAgreement": {
      "AcquisitionChannel": "External",
      "PricingModel": "Contract"
    },
    "ProductId": "prod-0bEXAMPLEb51",
    "ResaleAuthorizationId": "resaleauthz-123456789",
    "MarkupPercentage": "5.0",
    "Terms": [
      {
        "Type": "LegalTerm",
        "Documents": [
          {
            "Type": "CustomEula",
            "Url": "https://s3.amazonaws.com/EULA/custom-eula-1234.txt"
          }
        ]
      },
      {
        "Type": "ConfigurableUpfrontPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "Selector": {
              "Type": "Duration",
              "Value": "P12M"
            },
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "300.00"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "400.00"
              }
            ],
            "Constraints": {
              "MultipleDimensionSelection": "Allowed",
              "QuantityConfiguration": "Allowed"
            }
          }
        ]
      },
      {
        "Type": "UsageBasedPricingTerm",
        "CurrencyCode": "USD",
        "RateCards": [
          {
            "RateCard": [
              {
                "DimensionKey": "m3.large",
                "Price": "0.10"
              },
              {
                "DimensionKey": "m4.xlarge",
                "Price": "0.20"
              }
            ]
          }
        ]
      },
      {
        "Type": "PaymentScheduleTerm",
        "CurrencyCode": "USD",
        "Schedule": [
          {
            "ChargeDate": "2020-12-01T00:00:00Z",
            "ChargeAmount": "1000.00"
          },
          {
            "ChargeDate": "2021-06-15T00:00:00Z",
            "ChargeAmount": "1250.00"
          }
        ]
      }
    ],
    "Rules": [
      {
        "Type": "TargetingRule",
        "PositiveTargeting": {
          "CountryCodes": [
            "US",
            "CA"
          ],
          "BuyerAccounts": [
            "118033953248"
          ]
        },
        "NegativeTargeting": {
          "CountryCodes": [
            "XX"
          ]
        }
      },
      {
        "Type": "AvailabilityRule",
        "AvailabilityEndDate": "2050-08-30T01:56:03Z"
      }
    ]
  }
}

Fournissez des informations pour les champs de saisie de la DescribeEntity réponse :