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.

Travailler avec les produits des vendeurs

Vous pouvez utiliser le AWS Marketplace Catalog API pour automatiser les tâches liées à l'utilisation des produits des vendeurs. Cela inclut la possibilité de créer, de mettre à jour, d'afficher, de répertorier et de trier des produits. Cela vous permet d'automatiser la gestion des produits. Par exemple, vous pouvez fournir des fonctionnalités de publication en libre-service sur le Portail de gestion AWS Marketplace.

Un produit est une unité ou une ressource que vous avez l'intention de vendre AWS Marketplace, souvent appelée produit de base. Les acheteurs ne peuvent pas consommer un produit de base tant que vous n'avez pas ajouté les informations sur le produit, les attributs de déploiement et les informations de facturation.

Un produit décrit les informations sur le produit, les attributs de déploiement du logiciel et le mécanisme de facturation de l'offre que vous avez l'intention de vendre. Le produit doit être associé à une offre pour devenir une unité négociable que vous pouvez vendre et que les acheteurs peuvent utiliser. AWS Marketplace

Vous pouvez également utiliser le AWS Marketplace Catalog API pour :

Chaque type de produit possède une entité de produit différente. Une entité peut être un produit ou une offre sur AWS Marketplace. Les types de produits et entités suivants sont pris en charge :

Les rubriques suivantes supposent que vous avez accès à l'API et que vous avez rempli toutes les conditions préalables requises pour les vendeurs, comme décrit dansContrôle d'accès pour AWS Marketplace Catalogue API.

Consultez les ressources suivantes :

Les rubriques suivantes décrivent comment utiliser l'API Catalog pour effectuer des actions sur vos produits à AMI unique, vos produits basés sur des conteneurs ou vos produits SaaS.

Création d'un produit

Vous pouvez utiliser l'API Catalog pour créer une AMI, un conteneur, un document de machine learning ou un document de produit SaaS contenant des identifiants (code produit et ID de produit). AWS Marketplace

Vous créez un produit en Draft état en appelant l'opération StartChangeSet API avec le type de CreateProduct modification.

Si votre demande est traitée avec succès, un produit est AWS Marketplace Catalog API généré en Draft état pour vous. Il s'agit d'un produit incomplet qui n'est pas visible pour les acheteurs AWS Marketplace.

Vous utilisez ensuite les types de Update modification pour terminer le processus de création du produit : UpdateInformationUpdateDimensions, UpdateTargeting, et UpdateVisibility.

Une fois le produit terminé, vous pouvez utiliser le type de ReleaseProductmodification pour terminer le processus de création du produit, puis publier l'offre. Ce processus valide l'ensemble du produit et le fait passer à l'Limitedétat actuel.

Pour créer un produit en Draft état, appelez l'opération StartChangeSet API avec le type de CreateProduct modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

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

{
"Catalog": "AWSMarketplace",
"ChangeSet": [ 
  { 
    "ChangeType":"CreateProduct",
    "Entity":{
      "Type": "SaaSProduct@1.0" // choose from ["AmiProduct@1.0", "ContainerProduct@1.0", "SaaSProduct@1.0", "MachineLearningProduct@1.0"]
     },
     "DetailsDocument": {
        "ProductTitle": "Test product title set in CreateProduct"
     }
  }
]
}

Fournissez des informations pour les champs permettant d'ajouter le type de CreateProduct modification. Ce type de modification peut inclure un ProductTitle attribut, sous réserve des mêmes restrictions que celui envoyé dans le type de UpdateInformation 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.

Lorsque la demande est terminée (si Status c'est le casSUCCEEDED), une nouvelle ProductId est générée.

Validations synchrones

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

Mettre à jour les détails du produit

Si vous avez déjà intégré un produit AWS Marketplace, vous pouvez utiliser l'API Catalog pour mettre à jour les détails du produit pour un AMI, un conteneur, un ML ou un produit SaaS.

Pour mettre à jour les détails du produit, appelez l'opération StartChangeSet API avec le type de UpdateInformation modification et les détails que vous souhaitez modifier, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateInformation",
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "AmiProduct@1.0"
      },
      "DetailsDocument":
      {
        "ProductTitle": "My Product Title",
        "ShortDescription": "My product short description.",
        "LongDescription": "My product longer description.",
        "Sku": "123example456",
        "LogoUrl": "https://awsmp-logos.s3.amazonaws.com/ca60b754fe05a24257176cdbf31c4e0d",
        "VideoUrls":
        [
          "https://example.com/my-video"
        ],
        "Highlights":
        [
          "123example45"
        ],
        "AdditionalResources":
        [
          {
            "Text": "123example456",
            "Url": "https://example.com/some-link"
          }
        ],
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.",
        "Categories":
        [
          "Operating Systems",
          "Network Infrastructure",
          "Application Development"
        ],
        "SearchKeywords":
        [
          "123example456"
        ]
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de UpdateInformation 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.

Pour vérifier l'état de la demande, utilisez Portail de gestion AWS Marketplace ou appelez l'DescribeChangeSetAPI.

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

Ajouter des dimensions de tarification

Vous pouvez utiliser les actions du service AWS Marketplace Catalog pour ajouter des dimensions de tarification facturables qui vous permettent de facturer aux utilisateurs des produits AMI, container ou SaaS.

Une dimension de tarification est une unité de mesure que les vendeurs définissent pour facturer les acheteurs. Les vendeurs doivent configurer ces informations pour facturer aux acheteurs l'utilisation du produit, qu'il s'agisse d'un modèle de tarification basé sur l'utilisation ou sur un contrat. Le type de dimension dépend du modèle de tarification du produit.

Pour plus d'informations sur le prix des produits, consultez les rubriques suivantes du Guide du AWS Marketplace vendeur :

Pour plus d'informations sur l'ajout de dimensions tarifaires à l'aide du Portail de gestion AWS Marketplace, consultez les rubriques suivantes du Guide du AWS Marketplace vendeur :

Pour ajouter des dimensions de tarification, appelez l'StartChangeSetAPI avec le type de AddDimensions modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDimensions",
      "DetailsDocument":
      [
        {
          "Description": "Description of the dimension",
          "Key": "UniqueApiKey",
          "Unit": "HostHrs",
          "Name": "First Dimension",
          "Types":
          [
            "ExternallyMetered"
          ]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Fournissez les champs suivants pour le type de AddDimensions 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 AddDimensions 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 AddDimensions 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 dimensions de tarification

Vous pouvez utiliser l'API Catalog pour mettre à jour les dimensions de tarification existantes d'une AMI, d'un conteneur ou d'un produit SaaS dans AWS Marketplace.

Chaque dimension est identifiée de manière unique par la clé de dimension et les types de dimension pour effectuer la mise à jour. La mise à jour d'une dimension n'affecte aucune offre active ni aucun client créé par la dimension d'origine.

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

Syntaxe de la demande

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types":
          [
            "ExternallyMetered"
          ],
          "Name": "First Dimension",
          "Description": "Description of the dimension"
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Utilisez les champs suivants avec le type de UpdateDimensions 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 comprenait la validation des informations pour s'assurer qu'elles étaient 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 UpdateDimensions 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 UpdateDimensions 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.

Restreindre les dimensions de tarification

Vous pouvez utiliser l'API Catalog pour restreindre les dimensions tarifaires existantes d'un produit AMI ou SaaS dans AWS Marketplace.

Chaque dimension est identifiée de manière unique par la clé de dimension et les types de dimension pour effectuer la mise à jour. La restriction d'une dimension n'affecte aucune offre active ni aucun client créé par la dimension d'origine.

Pour restreindre les dimensions de tarification, appelez l'StartChangeSetAPI indiquant le type de RestrictDimensions modification.

L'exemple suivant montre comment restreindre la Entitled dimension d'un produit SaaS.

Syntaxe de la demande

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDimensions",
      "DetailsDocument":
      [
        {
          "Key": "UniqueApiKey",
          "Types": ["Entitled"]
        }
      ],
      "Entity":
      {
        "Identifier": "prod-example12345",
        "Type": "SaaSProduct@1.0"
      }
    }
  ]
}

Utilisez les champs suivants avec le type de RestrictDimensions 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 comprenait la validation des informations pour s'assurer qu'elles étaient 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 en appelant l'DescribeChangeSetAPI. Portail de gestion AWS Marketplace

Validations synchrones

Les validations de schéma suivantes sont spécifiques aux RestrictDimensions 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 RestrictDimensions actions du AWS Marketplace Catalog API. Ces erreurs sont renvoyées lorsque vous appelez DescribeChangeSet pendant 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 ajouter Compte AWS des identifiants autorisés à consulter l'AMI, le conteneur, le ML ou le produit SaaS AWS Marketplace avant qu'il ne passe à un Public état en appelant le type de UpdateTargeting modification.

Les comptes MCO (Managed Catalog Operations) sont automatiquement ajoutés à la liste des comptes autorisés lorsque de nouveaux produits sont créés. Ces comptes MCO sont visibles par les vendeurs sur le portail de AWS Marketplace gestion (AMMP) lorsqu'ils consultent les comptes autorisés, et dans la Targeting section de réponse de l'DescribeEntityAPI.

Pour ajouter Compte AWS des identifiants autorisés à afficher l'AMI, le conteneur, le ML ou le produit SaaS, appelez l'opération d'StartChangeSetAPI 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": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "PositiveTargeting":
        {
          "BuyerAccounts":
          [
            "1112223334444"
          ]
        }
      }
    }
  ]
}

Utilisez les champs suivants avec 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 comprenait la validation des informations pour s'assurer qu'elles étaient conformes aux AWS Marketplace directives. Le processus de validation peut prendre de quelques minutes à quelques heures.

Pour vérifier l'état de la demande, utilisez Portail de gestion AWS Marketplace ou appelez l'DescribeChangeSetAPI.

Lorsque la demande est terminée (si Status c'est le casSUCCEEDED), une nouvelle ProductId est générée.

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 DescribeChangeSet 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 visibilité des produits

Vous pouvez utiliser l'API Catalog pour mettre à jour la visibilité (également appelée état du cycle de vie) d'un produit AMI, conteneur, ML ou SaaS dans AWS Marketplace.

Les états du cycle de vie cible autorisés sont LimitedPublic, ouRestricted.

Pour mettre à jour la visibilité de votre produit, appelez l'opération StartChangeSet API avec le type de UpdateVisibility modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

Pour quand TargetVisibility est-ce Public ouLimited.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Public"
      }
    }
  ]
}

Pour quand TargetVisibilityRestricted.

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateVisibility",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument":
      {
        "TargetVisibility": "Restricted",
        "ReplacementProductId": "prod-example54321"
      }
    }
  ]
}

Fournissez des informations pour les champs permettant d'ajouter le type de UpdateVisibility modification.

Validations synchrones

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

Après avoir déclenché ce type de modification, son exécution peut prendre jusqu'à 37 jours. Cela inclut le temps dont l'équipe des opérations des AWS Marketplace vendeurs a besoin pour examiner, auditer et approuver. Lorsque vous limitez un produit, vous avez 24 heures pour changer d'avis, en appelantCancelChangeSet, avant que l'équipe chargée des opérations des AWS Marketplace vendeurs ne commence l'audit. Pour de plus amples informations, veuillez consulter CancelChangeSet.

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 comprenait la validation des informations pour s'assurer qu'elles étaient 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.

Lorsque la demande est terminée (si Status c'est le casSUCCEEDED), une nouvelle ProductId est générée.

Erreurs asynchrones

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

Publier un produit

Vous pouvez utiliser l'API Catalog pour publier un produit Draft AMI, conteneur, ML ou SaaS dans Limited state in AWS Marketplace.

Pour publier un produit, appelez l'opération StartChangeSet API avec le type de ReleaseProduct modification, comme indiqué dans l'exemple suivant.

Syntaxe de la demande

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "ReleaseProduct",
      "Entity":
      {
        "Type": "SaaSProduct@1.0",
        "Identifier": "prod-example12345"
      },
      "DetailsDocument": {}
    }
  ]
}

Fournissez des informations pour les champs à ajouter au type de ReleaseProduct modification. Ce type de modification ne prend aucune charge utile de paramètres.

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 comprenait la validation des informations pour s'assurer qu'elles étaient 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.

Lorsque la demande est terminée (si Status c'est le casSUCCEEDED), une nouvelle ProductId est générée.

Erreurs asynchrones

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

Trouvez l'identifiant de votre produit

Vous devez obtenir l'identifiant de votre produit avant de pouvoir le modifier à l'aide de l'API AWS Marketplace Catalog. Il existe deux méthodes pour trouver l'identifiant du produit pour les produits serveur :

Les rubriques suivantes expliquent comment trouver un produit en filtrant par identifiant d'entité, titre du produit, date de dernière modification ou visibilité.

Trouvez un produit en fonction du titre du produit

Demande

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "ProductTitle": {
                "WildCardValue": "XYZ"
            }
        }
    }
}

Réponse

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Trouvez un produit en fonction de la date de dernière modification

Demande

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            }
        }
    }
}

Réponse

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Trouvez un produit en fonction de sa visibilité

Demande

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            }
        }
    }
}

Réponse

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Trouvez un produit en fonction du titre du produit, de la date de dernière modification et de la visibilité du produit

Demande

POST /ListEntities HTTP/1.1
Content-Type: application/json
      
{
    "Catalog": "AWSMarketplace",
    "EntityType": "AmiProduct",
    "MaxResults": 10,
    "EntityTypeFilters": {
        "AmiProductFilters": {
            "LastModifiedDate": {
                "DateRange": {
                    "BeforeValue": "2018-03-27T13:45:22Z",
                    "AfterValue": "2018-01-27T13:45:22Z"
                }
            },
            "Visibility": {
                "ValueList": [
                    "Public"
                ]
            },
            "ProductTitle": {
                "ValueList": [
                    "ABC-XYZ-123"
                ]
            }
        }
    }
}

Réponse

HTTP/1.1 200
Content-type: application/json

{ 
  "EntitySummaryList": [ 
    { 
      "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
      "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
      "EntityType": "AmiProduct",
      "LastModifiedDate": "2018-02-27T13:45:22Z",
       "AmiProductSummary": {
            "ProductTitle": "ABC-XYZ-123",
            "Visibility": "Public"
       }
    } 
  ],
  "NextToken": "" 
}

Obtenir des informations supplémentaires sur un produit

Vous pouvez obtenir des informations supplémentaires sur le produit en utilisant l'identifiant de l'entité associée à l'DescribeEntityaction.

Demande

GET /DescribeEntity?catalog=AWSMarketplace&entityId=example-abcd-1234 HTTP/1.1

Réponse

HTTP/1.1 200
Content-type: application/json

{
   "DetailsDocument": {
        "ProductTitle": "ABC-XYZ-123",
        "ShortDescription": "My product short description.", 
        "LongDescription": "My product longer description.", 
        "Sku": "123example456", 
        "SupportDescription": "Need help? Contact our experts at support@example.com \n\nYour purchase includes 24x7 support.", 
        "Categories": [ 
            "Operating Systems", 
            "Network Infrastructure", 
            "Application Development" 
            ] 
   }
    "EntityArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/AmiProduct/example-abcd-1234",
    "EntityId": "example1-abcd-1234-5ef6-7890abcdef12@1",
    "EntityType": "AmiProduct",
    "LastModifiedDate": "2018-02-27T13:45:22Z",
}

Modifier le statut et les erreurs du set

Pour apporter des modifications aux produits du vendeur dans l'API du AWS Marketplace catalogue, vous devez créer des ensembles de modifications décrivant les modifications que vous souhaitez apporter, puis utiliser l'StartChangeSetaction pour lancer les modifications. Les modifications apportées à la demande peuvent prendre quelques minutes, voire plusieurs heures, voire plus, selon la demande. La réponse à cette demande 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, notamment en scannant les fichiers et les informations pour s'assurer qu'elle est conforme aux AWS Marketplace directives relatives aux produits. Selon les demandes de modification, ce processus peut prendre de quelques minutes à quelques jours. Vous pouvez vérifier l'état de la demande via ou dans l'API du catalogue avec l'DescribeChangeSetaction. Portail de gestion AWS Marketplace Pour plus d’informations sur les jeux de modifications, consultez Travailler avec des ensembles de modifications.

Pour vérifier le statut de votre demande, utilisez l'DescribeChangeSetaction.

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

{
   "Catalog": "AWSMarketplace",
   "ChangeSetID": "example123456789012abcdef"
}

Le résultat de cet appel est le suivant (dans ce cas, pour ajouter une nouvelle version à un produit conteneur).

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "SUCCEEDED",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"Details\": {\"EcrDeliveryOptionDetails\" : {\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"DeploymentResources\": [{\"Name\": \"HelmDeploymentTemplate\",\"Url\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}],\"CompatibleServices\": [\"EKS\"],\"Description\": \"Sample Description\",\"UsageInstructions\":\"helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}}},{\"DeliveryOptionTitle\": \"HelmChartDeliveryOption\",\"Details\": {\"HelmDeliveryOptionDetails\": {\"CompatibleServices\": [\"EKS\", \"EKS-Anywhere\"],\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"HelmChartUri\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1\",\"Description\": \"Helm chart description\",\"UsageInstructions\": \"Usage instructions\",\"MarketplaceServiceAccountName\": \"Service account name\",\"ReleaseName\": \"Optional release name\",\"Namespace\": \"Optional Kubernetes namespace\",\"OverrideParameters\": [{\"Key\": \"HelmKeyName1\",\"DefaultValue\": \"${AWSMP_LICENSE_SECRET}\"},{\"Key\": \"HelmKeyName2\",\"DefaultValue\": \"${AWSMP_SERVICE_ACCOUNT}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "DeploymentResources":
                [
                  {
                    "Name": "HelmDeploymentTemplate",
                    "Url": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
                  }
                ],
                "CompatibleServices":
                [
                  "EKS"
                ],
                "Description": "Sample Description",
                "UsageInstructions": "helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
              }
            }
          },
          {
            "DeliveryOptionTitle": "HelmChartDeliveryOption",
            "Details":
            {
              "HelmDeliveryOptionDetails":
              {
                "CompatibleServices":
                [
                  "EKS",
                  "EKS-Anywhere"
                ],
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1",
                "Description": "Helm chart description",
                "UsageInstructions": "Usage instructions",
                "MarketplaceServiceAccountName": "Service account name",
                "ReleaseName": "Optional release name",
                "Namespace": "Optional Kubernetes namespace",
                "OverrideParameters":
                [
                  {
                    "Key": "HelmKeyName1",
                    "DefaultValue": "${AWSMP_LICENSE_SECRET}"
                  },
                  {
                    "Key": "HelmKeyName2",
                    "DefaultValue": "${AWSMP_SERVICE_ACCOUNT}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      []
    }
  ]
}

Le Status champ indique le statut actuel de la demande, dans ce cas,SUCCEEDED.

En cas d'échec, le résultat peut inclure deux types d'erreurs. Pour la plupart des erreurs, le message d'erreur est inclus directement. Toutefois, les erreurs détectées lors de l'analyse du produit pour détecter des failles de sécurité incluent plutôt une URL vers un fichier répertoriant toutes les erreurs détectées, ErrorMessage sur le terrain. Les erreurs détectées lors de la numérisation portent le ErrorCode signe « SCAN_ERROR ».

{
  "ChangeSetId": "example123456789012abcdef",
  "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef",
  "ChangeSetName": "Submitted by 123456789012",
  "StartTime": "2020-10-27T22:21:26Z",
  "EndTime": "2020-10-27T22:32:19Z",
  "Status": "FAILED",
  "FailureDescription": "Change set preparation has failed. For details see 'ErrorDetailList'.",
  "ChangeSet":
  [
    {
      "ChangeType": "AddDeliveryOptions",
      "Entity":
      {
        "Type": "ContainerProduct@1.0",
        "Identifier": "example-1234-abcd-56ef-abcdef12345678@4"
      },
      "Details": "{\"Version\": {\"VersionTitle\": \"1.1\",\"ReleaseNotes\": \"Minor bug fix\"},\"DeliveryOptions\": [{\"DeliveryOptionTitle\": \"EKSDelivery\",\"Details\": {\"EcrDeliveryOptionDetails\" : {\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"DeploymentResources\": [{\"Name\": \"HelmDeploymentTemplate\",\"Url\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}],\"CompatibleServices\": [\"EKS\"],\"Description\": \"Sample Description\",\"UsageInstructions\":\"helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1\"}}},{\"DeliveryOptionTitle\": \"HelmChartDeliveryOption\",\"Details\": {\"HelmDeliveryOptionDetails\": {\"CompatibleServices\": [\"EKS\", \"EKS-Anywhere\"],\"ContainerImages\": [\"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1\"],\"HelmChartUri\": \"111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1\",\"Description\": \"Helm chart description\",\"UsageInstructions\": \"Usage instructions\",\"MarketplaceServiceAccountName\": \"Service account name\",\"ReleaseName\": \"Optional release name\",\"Namespace\": \"Optional Kubernetes namespace\",\"OverrideParameters\": [{\"Key\": \"HelmKeyName1\",\"DefaultValue\": \"${AWSMP_LICENSE_SECRET}\"},{\"Key\": \"HelmKeyName2\",\"DefaultValue\": \"${AWSMP_SERVICE_ACCOUNT}\"}]}}}]}",
      "DetailsDocument":
      {
        "Version":
        {
          "VersionTitle": "1.1",
          "ReleaseNotes": "Minor bug fix"
        },
        "DeliveryOptions":
        [
          {
            "DeliveryOptionTitle": "EKSDelivery",
            "Details":
            {
              "EcrDeliveryOptionDetails":
              {
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "DeploymentResources":
                [
                  {
                    "Name": "HelmDeploymentTemplate",
                    "Url": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
                  }
                ],
                "CompatibleServices":
                [
                  "EKS"
                ],
                "Description": "Sample Description",
                "UsageInstructions": "helm pull 111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame2:mychart1.1"
              }
            }
          },
          {
            "DeliveryOptionTitle": "HelmChartDeliveryOption",
            "Details":
            {
              "HelmDeliveryOptionDetails":
              {
                "CompatibleServices":
                [
                  "EKS",
                  "EKS-Anywhere"
                ],
                "ContainerImages":
                [
                  "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:1.1"
                ],
                "HelmChartUri": "111122223333.dkr.ecr.us-east-1.amazonaws.com/sellername/reponame1:helmchart1.1",
                "Description": "Helm chart description",
                "UsageInstructions": "Usage instructions",
                "MarketplaceServiceAccountName": "Service account name",
                "ReleaseName": "Optional release name",
                "Namespace": "Optional Kubernetes namespace",
                "OverrideParameters":
                [
                  {
                    "Key": "HelmKeyName1",
                    "DefaultValue": "${AWSMP_LICENSE_SECRET}"
                  },
                  {
                    "Key": "HelmKeyName2",
                    "DefaultValue": "${AWSMP_SERVICE_ACCOUNT}"
                  }
                ]
              }
            }
          }
        ]
      },
      "ErrorDetailList":
      [
        {
          "ErrorCode": "DUPLICATE_VERSION_TITLE",
          "ErrorMessage": "The version title must be different from any other version titles of this product."
        },
        {
          "ErrorCode": "SCAN_ERROR",
          "ErrorMessage": "https://123sample456.cloudfront.net/example-1234-abcd-5678-abcdef12345678/1234abcdef567890"
        }
      ]
    }
  ]
}

Dans cet exemple, une erreur a été directement signalée (DUPLICATE_VERSION_TITLE). L'autre erreur contient un fichier contenant des messages d'erreur (plusieurs erreurs SCAN_ERROR peuvent être détectées dans le fichier lié pour une seule erreur).