View a markdown version of this page

Informations de version de mise à jour - AWS Marketplace
Syntaxe de demandeChamps obligatoiresSyntaxe de réponseErreurs

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.

Informations de version de mise à jour

Vous pouvez utiliser l'API Catalog pour mettre à jour les détails d'une version existante de votre produit de machine learning dans AWS Marketplace.

Important

Vous ne pouvez pas mettre à jour l'ARN d'une version. Si vous devez modifier l'ARN, vous devez plutôt créer une nouvelle version.

Utilisation StartChangeSetpour ajouter une version :

  • Pour mettre à jour les informations de version, appelez l'StartChangeSetopération avec le type de UpdateDeliveryOptions modification.

Syntaxe de demande

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

{
  "Catalog": "AWSMarketplace",
  "ChangeSet":
  [
    {
      "ChangeType": "UpdateDeliveryOptions",
      "Entity":
      {
        "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1",
        "Type": "MachineLearningProduct@1.0"
      },
      "DetailsDocument":
      {
        "Version":
        {
          "ReleaseNotes": "Adding support for new parameters"
        },
        "DeliveryOptions":
        [
          {
            "Id": "example1-2222-cccc-2222-cccccccccccc",
            "Details":
            {
              "SagemakerModelPackageDeliveryOptionDetails":
              {
                "SampleNotebookUrl": "https://www.amazon.com",
                "RepositoryUrl":"https://www,amazon.com",
                "InputProperties": 
                { 
                    "SampleInput": {
                        "RealtimeInferenceUrl": "https://www.sampleData.com",
                        "BatchTranformUrl": "https://www.sampleData.com",
                     },
                 },
                 "RecommendedInstanceTypes": {
                        "BatchTransform": "ml.m4.large",
                        "RealtimeInference": "ml.m4.large"
                  }
            }
          }
        ]
      }
    }
  ]
}

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.

    • Type(chaîne) : obligatoire

      Spécifie le mode de livraison (type de produit). Ça doit l'êtreMachineLearningProduct@1.0.

  • DetailsDocument(objet) —obligatoire

    Contient les informations de version mises à jour.

    • Version(objet) —obligatoire

      Définit les informations spécifiques à la version.

      • VersionTitle(chaîne) : obligatoire

        L'identifiant de version affiché aux acheteurs, tel que « Version 1.1 » ou « 1.1 ». Les acheteurs utilisent ce titre pour sélectionner les versions à déployer.

      • ReleaseNotes(chaîne) : obligatoire

        Notes détaillées sur cette version, limitée à 30 000 caractères.

    • DeliveryOptions(tableau) : obligatoire

      Spécifie les méthodes de livraison pour la version de votre produit. Limité à une option de livraison par version.

      • Id(chaîne) : obligatoire

        Identifiant unique pour DeliveryOption. Récupérez-le à l'aide de l' DescribeEntity action sur votre produit.

      • Details(objet) —obligatoire

        Contient les spécifications des options de livraison.

        • SageMakerModelPackageSubscriptionDetailsou SageMakerAlgorithmSubscriptionDetails (objet) : obligatoire

          Détails de l'option de livraison

          • SampleNotebookUrl(chaîne) : obligatoire

            Exemple de lien vers un bloc-notes Jupyter fournissant un code à l'usage de l'acheteur.

          • RepositoryUrl(chaîne) : obligatoire

            URL du référentiel Git pour le clonage du bloc-notes et des exemples de données.

          • UsageInstructions(chaîne) : obligatoire

            Pour les algorithmes : informations d'entraînement. Pour les modèles : informations d'utilisation supplémentaires.

          • InputProperties(objet) —obligatoire

            Détails des exigences model/algorithm d'entrée.

            • Description(chaîne) : obligatoire

              Description des entrées requises.

            • Limitations (chaîne)

              Toutes les limites de saisie.

            • SampleInput(objet) —obligatoire

              Exemples de données d'entrée pour différentes opérations.

              • RealtimeInferenceUrl (chaîne)

                Exemple d'URL d'entrée pour une inférence en temps réel.

              • RealtimeInferenceText (chaîne)

                Exemple de texte de saisie pour une inférence en temps réel.

              • BatchTransformUrl (chaîne)

                Exemple d'URL d'entrée pour les tâches de transformation par lots.

              • BatchTransformText (chaîne)

                Exemple de texte d'entrée pour les tâches de transformation par lots.

            • Parameters(Réseau<Object>)

              Détails de chaque paramètre d'entrée.

              • Name(chaîne) : obligatoire

                Nom du paramètre d'entrée.

              • Description(chaîne) : obligatoire

                Description du paramètre d'entrée.

              • Constraints (chaîne)

                Contraintes de paramètres (MinValue MaxValue, AllowedValues, MinLength, MaxLength,, Pattern, etc.).

              • Required(booléen)

                Indique si le paramètre est obligatoire. La valeur par défaut est false.

            • SageMakerCustomAttributes(Réseau<Object>)

              Informations sur le support CustomAttributes.

              • Name(chaîne) : obligatoire

                Nom de l'attribut personnalisé.

              • Description(chaîne) : obligatoire

                Description de l'attribut personnalisé.

              • Constraints (chaîne)

                Contraintes d'attributs (MinValue MaxValue, AllowedValues, MinLength, MaxLength,, Pattern, etc.).

              • Required(booléen)

                Indique si l'attribut est obligatoire. La valeur par défaut est false.

          • OutputProperties(objet) —obligatoire

            Détails de model/algorithm la sortie.

            • Description(chaîne) : obligatoire

              Description des model/algorithm sorties

            • SampleOutput(Array<Object>) : obligatoire

              Exemples de données de sortie pour différentes opérations.

              • RealtimeInferenceUrl (chaîne)

                Exemple d'URL de sortie pour une inférence en temps réel.

              • RealtimeInferenceText (chaîne)

                Exemple de texte de sortie pour une inférence en temps réel.

              • BatchTransformUrl (chaîne)

                Exemple d'URL de sortie pour les tâches de transformation par lots.

              • BatchTransformText (chaîne)

                Exemple de texte de sortie pour les tâches de transformation par lots.

            • Parameters(Réseau)

              Détails de chaque paramètre de sortie.

              • Name(chaîne) : obligatoire

                Nom du paramètre de sortie.

              • Description(chaîne) : obligatoire

                Description du paramètre de sortie.

              • AlwaysReturned(booléen)

                Indique si le paramètre est toujours renvoyé. La valeur par défaut est false.

          • RecommendedInstanceTypes(objet) —obligatoire

            Types d'instances recommandés pour des performances optimales.

            • BatchTransform(chaîne) : obligatoire

              Type d'instance recommandé pour les opérations de transformation par lots.

            • RealtimeInference(chaîne) : obligatoire

              Type d'instance recommandé pour les opérations d'inférence en temps réel.

            • Training(chaîne) : obligatoire

              Type d'instance recommandé pour les opérations d'entraînement des algorithmes. Requis uniquement pour les SageMaker algorithmes.

Syntaxe de réponse

Une demande réussie renvoie :

{
    "ChangeSetId": "example123456789012abcdef",
    "ChangeSetArn": "arn:aws:aws-marketplace:us-east-1:123456789012:AWSMarketplace/ChangeSet/example123456789012abcdef"
}
Traitement des ensembles de modifications

La demande de modification entre dans une file d'attente de traitement, où elle passe par plusieurs étapes :

  1. Validation : le système vérifie si toutes les informations sont conformes aux AWS Marketplace directives.

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

  3. Achèvement : Une fois approuvée, la nouvelle version est mise à jour.

Erreurs

Erreurs asynchrones

Les erreurs spécifiques relatives aux UpdateDeliveryOptions actions peuvent être récupérées à l'aide de l'DescribeChangeSetopération une fois que le traitement de l'ensemble de modifications a commencé. Pour plus de détails sur les erreurs et la résolution des problèmes, voir Modifier le statut du set et les erreurs.

Code d’erreur Message d’erreur
ÉTAT_DU PRODUIT INCOMPATIBLE Utilisez un produit limité ou public existant.
IDENTIFIANT_OPTION_DE LIVRAISON NON VALIDE Fournissez les identifiants des options de livraison qui se trouvent dans le produit. Identifiants introuvables : [x]
ÉTAT DE L'OPTION_DE LIVRAISON INCOMPATIBLE L'option de livraison ne peut pas être mise à jour car son statut est restreint. Essayez plutôt d'ajouter une nouvelle version.
OPTIONS DE LIVRAISON INCOMPATIBLES Le produit utilisait auparavant [X] comme option de livraison ; par conséquent, toutes les options de livraison à venir devraient être du type [X]
TYPE_D'INSTANCE_RECOMMANDÉ NON VALIDE Fournir un type d'instance existant et disponible pour [X] (X peut être Batch Transform, Realtime Inference ou Algorithm Training)
TITRE_DE_VERSION DUPLIQUÉ Le titre de la version doit être différent de celui des autres titres de version de ce produit.
LE CHAMP N'EST PAS AUTORISÉ À CHANGER Le champ X n'est pas autorisé à être modifié.