

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](https://docs.aws.amazon.com/marketplace/latest/APIReference/Welcome.html).

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.

# Restreindre une version
<a name="ml-restrict-version"></a>

 Vous pouvez utiliser l'API Catalog pour restreindre une version de votre produit de machine learning dans AWS Marketplace. En cas de restriction, les nouveaux acheteurs ne peuvent pas accéder à cette version. Les abonnés existants conservent l'accès aux versions restreintes. AWS Marketplace les directives exigent une assistance continue pour les acheteurs existants pendant 90 jours après la restriction. 

**Important**  
 Au moins une version illimitée doit rester disponible. Vous ne pouvez pas restreindre la dernière version accessible au public d'un produit. 

**Pour restreindre une version, procédez comme suit :**
+  Pour restreindre une version, appelez l'`StartChangeSet`opération avec le type de `RestrictDeliveryOptions` modification. 

## Syntaxe de demande
<a name="ml-restrict-version-request-syntax"></a>

```
POST /StartChangeSet HTTP/1.1
Content-type: application/json
{
"Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "RestrictDeliveryOptions",
      "Entity":
      {
        "Identifier": "{{example1-abcd-1234-5ef6-7890abcdef12@1}}",
        "Type": "MachineLearningProduct@1.0"
      },
      "DetailsDocument":
      {
        "DeliveryOptionIds":
        [
          "{{example1-2222-cccc-2222-cccccccccccc}}"
        ]
      }
    }
  ]
}
```

## Champs obligatoires
<a name="ml-restrict-version-required-fields"></a>

**Champs obligatoires**
+  `Entity`(objet) —obligatoire 

  Contient des informations sur votre produit ML.
  +  `Identifier`(chaîne) : obligatoire 

    L'identifiant de votre produit. Pour plus d'informations, consultez la section [Identifiant](https://docs.aws.amazon.com/marketplace/latest/APIReference/catalog-apis.html#identifier).
  +  `Type`(chaîne) : obligatoire 

    Spécifie le mode de livraison (type de produit). Ça doit l'être`MachineLearningProduct@1.0`.
+  `DetailsDocument`(objet) —obligatoire 

   Contient les informations de version mises à jour. 
  + `DeliveryOptionIds`(ensemble d'objets) —obligatoire

    Liste des DeliveryOption identifiants des versions que vous souhaitez restreindre. Récupérez l'identifiant unique de chacun DeliveryOption en appelant l' DescribeEntity action sur la version que vous limitez.

## Syntaxe de réponse
<a name="ml-restrict-version-response-syntax"></a>

Une demande réussie renvoie :

```
{
    "ChangeSetId": "example123456789012abcdef",
    "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
```

1. Validation : le système vérifie si toutes les informations sont conformes aux AWS Marketplace directives.
   +  Temps de traitement : quelques minutes à plusieurs heures 
   +  Pour les erreurs de validation, voir [Modifier le statut et les erreurs du set](https://docs.aws.amazon.com/marketplace/latest/APIReference/work-with-seller-products.html#seller-product-change-set-errors). 

1.  Surveillance de l'état : vous pouvez vérifier le statut de la demande de deux manières. 
   + Via le portail AWS Marketplace de gestion
   + Utilisation de l’opération `DescribeChangeSet`

1.  Achèvement : une fois approuvée, la nouvelle version est restreinte. 

## Erreurs
<a name="ml-restrict-version-errors"></a>

**Erreurs asynchrones**  
Les erreurs suivantes peuvent se produire lors du traitement de l'ensemble de modifications et peuvent être récupérées à l'aide de cette `DescribeChangeSet` opération :


| Code d’erreur | Message d’erreur | 
| --- | --- | 
| ÉTAT\_DU PRODUIT INCOMPATIBLE | Utiliser un produit public ou limité existant | 
| IDENTIFIANT\_OPTION\_DE\_LIVRAISON MANQUANTS | Fournissez une option de livraison à partir de la liste d'identifiants existante. | 
| IDENTIFIANT\_OPTION\_DE\_LIVRAISON NON VALIDES | Fournissez les identifiants des options de livraison qui se trouvent dans le produit. Identifiants introuvables : [x] | 
| ÉTAT\_DE L'OPTION\_DE LIVRAISON NON VALIDE | Les identifiants de l'option de livraison [invalid\_ids] ne sont pas valides. Fournir des options de livraison dans l'État public. | 
| TOUTES LES OPTIONS DE LIVRAISON SONT RESTREINTES | Offrez moins d'options de livraison à restreindre, car au moins l'une d'entre elles doit rester dans l'État public. | 