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.
Ajouter une nouvelle version
Vous pouvez utiliser l'API du catalogue ou le portail AWS Marketplace de gestion pour ajouter une nouvelle version à un produit de machine learning. Pour plus d'informations sur l'utilisation du portail, consultez la section Ajouter une nouvelle version dans le guide du vendeur d'AWS Marketplace.
Note
Pour les produits ML, une version consiste en une seule option de livraison, qui représente le produit que vous mettez à disposition. Dans l'API du catalogue, l'utilisation des options de livraison pour les produits ML modifie efficacement les versions de votre produit.
Lorsque vous ajoutez de nouveaux types d'instances, incluez un type de UpdatePricingTerms modification dans votre ensemble de modifications afin de définir le prix des nouveaux types d'instances. Pour les nouveaux produits, tous les types d'instances pris en charge UpdatePricingTerms doivent être couverts. UpdatePricingDimensionsn'est ni obligatoire ni pris en charge pour les produits ML, car les dimensions sont automatiquement générées pour tous les types d'instances pris en charge. Pour plus d’informations, consultez Mettre à jour les dimensions de tarification.
Utilisation StartChangeSetpour ajouter une version
Pour ajouter une nouvelle version, appelez l'StartChangeSetopération avec le type de AddDeliveryOptions modification :
-
Pour valider votre appel d'API sans créer de version, définissez
IntentsurVALIDATE. -
Pour la création de version réelle, définissez
IntentsurAPPLY.
Syntaxe de demande
POST /StartChangeSet HTTP/1.1 Content-type: application/json { "Catalog": "AWSMarketplace", "ChangeSet": [{ "ChangeType": "AddDeliveryOptions", "Entity": { "Identifier": "example1-abcd-1234-5ef6-7890abcdef12@1", "Type": "MachineLearningProduct@1.0" }, "DetailsDocument": { "Version": { "VersionTitle": "version 1.1", "ReleaseNotes": "Patch update for small bugfix in version 1.0" }, "DeliveryOptions": [{ "Details": { "SageMakerAlgorithmDeliveryOptionDetails": { "SageMakerAlgorithmArn": "arn:aws:sagemaker:us-east-2:605142612156:algorithm/scikit-decision-trees-1552343220", "AccessRoleArn": "arn:aws:iam::12345678901:role/AwsMarketplaceSageMakerIngestion", "UsageInstructions":"This is how you use your algorithm", "SampleNotebookUrl": "https://www.amazon.com", "RepositoryUrl": "https://www,amazon.com", "InputProperties": { "Description": "Input should have all columns in the train/test file except for 'is_fraud' column.", "Limitations": "Can predict on 1 input in the CSV only at a time", "SampleInput": { "RealtimeInferenceText": "{\"prompt\":\"Write summary\", \"maxTokens\": 1 }", "BatchTransformUrl": "https://www.sampleData.com", }, "Parameters": [{ "Name": "prompt", "Description": "Represents the instruct-style prompt for the model. DataType is String", "Constraints": "Minimum length should be 1", "Required": true }, { "Name": "maxTokens", "Description": "Denotes the number of tokens to predict per generation. See BPE Tokens for more details.", "Constraints": "Minvalue: 1, MaxValue: 30" } ], "SageMakerCustomAttributes": [{ "Name": "threshold", "Description": "Threshold of the confidence score of the detected object", "Constraints": "Should be an Integer" }] }, "OutputProperties": { "Description": "The output is a JSON object that has the generated text along with likelihoods of tokens, if requested. See example json.", "SampleOutput": { "RealtimeInferenceUrl": "https://www.sampledata.com", "BatchTransformUrl": "https://www.sampleData.com", }, "Parameters": [{ "Name": "id", "Description": "An identifier for response" "AlwaysReturned": true }, { "Name": "generations", "Description": "The generated text along with the likelihoods for tokens requested.", } ], }, "RecommendedInstanceTypes": { "BatchTransform": "ml.m4.large", "RealtimeInference": "ml.m4.large", "Training": "ml.m4.large" } } }] } }], "Intent": "APPLY" }
Champs obligatoires
-
Entity(objet) —obligatoireContient des informations sur votre produit ML.
-
Identifier(chaîne) : obligatoireL'identifiant de votre produit. Pour plus d'informations, consultez la section Identifiant.
-
Type(chaîne) : obligatoireSpécifie le mode de livraison (type de produit). Ça doit l'être
MachineLearningProduct@1.0.
-
-
DetailsDocument(objet) —obligatoireContient tous les détails concernant la nouvelle version de votre produit.
-
Version(objet) —obligatoireInformations sur la version ajoutée.
-
VersionTitle(chaîne) : obligatoireLe titre de la version, tel que « Version 1.1 » ou « 1.1 ». Les acheteurs sélectionnent les versions de ces titres.
-
ReleaseNotes(chaîne) : obligatoireRemarques détaillées sur cette version. Doit contenir moins de 30 000 caractères.
-
-
DeliveryOptions(tableau) : obligatoireGamme de méthodes de livraison pour la version de votre produit. Limité à une option de livraison par version.
-
Details(objet) —obligatoire-
SagemakerModelPackageDeliveryOptionDetailsouSageMakerAlgorithmDeliveryOptionDetails(objet)-
SageMakerModelPackageArnouSageMakerAlgorithmArn(chaîne) : obligatoireAmazon Resource Name (ARN) de votre modèle, de votre package ou de votre algorithme.
-
AccessRoleArn(chaîne) : obligatoireARN du rôle IAM pour AWS Marketplace permettant d'accéder à la SageMaker ressource.
-
SampleNotebookUrl(chaîne) : obligatoireLien vers un exemple de bloc-notes Jupyter avec le code d'utilisation. Pour plus d'informations, consultez un exemple de modèle de bloc-notes
sur GitHub. -
RepositoryUrl(chaîne) : obligatoireURL du référentiel Git pour l'accès au bloc-notes et aux exemples de données. Pour plus d'informations, consultez un exemple de dépôt Git
sur GitHub. -
UsageInstructions(chaîne) : obligatoireInformations de formation pour les algorithmes ou détails d'utilisation pour les modèles.
-
InputProperties(objet) —obligatoire-
Description(chaîne) : obligatoireDescription des model/algorithm entrées
-
Limitations(chaîne)Limites d'entrée
-
SampleInput(objet) —obligatoireRealtimeInferenceUrl (chaîne) | RealtimeInferenceText (chaîne) | BatchTransformUrl (chaîne) | BatchTransformText (chaîne)
-
Parameters(Réseau<Object>)Nom (chaîne) —obligatoire | Description (chaîne) —Obligatoire | Contraintes (chaîne) | Obligatoire (booléen)
-
SageMakerCustomAttributes(Réseau<Object>)Décrit toutes les CustomAttributesoptions prises en charge par votre modèle.
Name(chaîne) —obligatoire |Description(chaîne) —Obligatoire |Constraints(chaîne) |Required(booléen)
-
-
OutputProperties(objet) —obligatoire-
Description(chaîne) : obligatoire -
SampleOutput(Array<Object>) : obligatoireRealtimeInferenceUrl (chaîne) | RealtimeInferenceText (chaîne) | BatchTransformUrl (chaîne) | BatchTransformText (chaîne)
-
Parameters(Réseau)Nom (chaîne) —obligatoire | Description (chaîne) —obligatoire | AlwaysReturned (booléen)
-
-
RecommendedInstanceTypes(objet) —obligatoire-
BatchTransform(chaîne) —Obligatoire -
RealtimeInference(chaîne) —Obligatoire -
Training(string) : obligatoire pour les SageMaker algorithmes uniquement
-
-
-
-
-
Syntaxe de réponse
Lorsque vous soumettez la demande, un ensemble de modifications est créé et l'API 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 de traitement, où elle passe par plusieurs étapes :
-
Validation : le système vérifie que 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.
-
-
Surveillance de l'état : vous pouvez vérifier l'état de la demande de deux manières.
-
Via le portail de gestion AWS Marketplace
-
Utilisation de l’opération
DescribeChangeSet
-
-
Achèvement : une fois approuvée, la nouvelle version est ajoutée.
Erreurs
Erreurs asynchrones
Les erreurs suivantes sont spécifiques aux AddDeliveryOptions actions de l'API AWS Marketplace Catalog. Ces erreurs apparaissent lorsque vous appelez DescribeChangeSet alors qu'un ensemble de modifications est en cours de traitement. Pour plus d'informations sur l'utilisation DescribeChangeSet pour vérifier le statut d'une demande de modification, consultez la section Utilisation d'ensembles de modifications.
| Code d’erreur | Message d’erreur |
|---|---|
| ÉTAT_DU PRODUIT INCOMPATIBLE | Nous n'avons pas pu localiser le produit fourni. Fournissez un produit valide. |
| TITRE_DE_VERSION DUPLIQUÉ | Le titre de version fourni est déjà utilisé. Créez un titre de version unique. |
| TYPE_D'INSTANCE_RECOMMANDÉ NON VALIDE | Vous n'avez pas fourni de type d'instance valide pour [x]. Entrez un type d'instance valide et réessayez. Les types valides sont les suivants : [valids] |
| OPTIONS DE LIVRAISON INCOMPATIBLES | L'option de livraison que vous avez indiquée ne correspond pas à votre sélection précédente : [sélection précédente]. Mettez à jour votre option de livraison et réessayez. |
| AR_ACTIF NON VALIDE | Vous n'avez pas fourni d'ARN valide pour SageMakerAlgorithmDeliveryOption. Entrez un ARN valide et réessayez. |
| ACTIF_DUPLIQUÉ | Vous n'avez pas fourni d'ARN unique pour ce produit. Entrez un ARN unique et réessayez. |
| ACTIF NON TROUVÉ | Nous n'avons pas pu trouver l'ARN que vous avez fourni. Vérifiez que l'ARN est correct et qu'il dispose des autorisations requises. |
| EXCEPTION DE VALIDATION D'ACTIFS | Impossible d'ingérer SagemakerModelArn/SagemakerAlgorithmArn [x] dans le compte AWS Sagemaker |
| RÔLE_D'ACCÈS NON VALIDE | Nous n'avons pas pu trouver l'ARN du rôle IAM que vous avez fourni. Vérifiez que l'ARN est correct et réessayez. |
| MISE À JOUR DES PRIX_REQUISE | UpdatePricingTerms est obligatoire. |