View a markdown version of this page

DescribeRecommender - Amazon Personalize

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.

DescribeRecommender

Décrit le recommandateur donné, y compris son statut.

Un recommandateur peut se trouver dans l'un des états suivants :

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -ou- CREATE FAILED

  • ARRÊTER EN ATTENTE > ARRÊTER EN COURS > INACTIF > DÉMARRER EN ATTENTE > DÉMARRER EN COURS > ACTIF

  • DELETE PENDING > DELETE IN_PROGRESS

Lorsque status c'estCREATE FAILED, la réponse inclut la failureReason clé, qui décrit pourquoi.

La modelMetrics clé est nulle lorsque le recommandateur est créé ou supprimé.

Pour plus d'informations sur les recommandateurs, consultez CreateRecommender.

Syntaxe de la requête

{ "recommenderArn": "string" }

Paramètres de demande

Cette demande accepte les données suivantes au format JSON.

recommenderArn

Le nom de ressource Amazon (ARN) du recommandateur à décrire.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

Modèle : arn:([a-z\d-]+):personalize:.*:.*:.+

Obligatoire : oui

Syntaxe de la réponse

{ "recommender": { "creationDateTime": number, "datasetGroupArn": "string", "failureReason": "string", "lastUpdatedDateTime": number, "latestRecommenderUpdate": { "creationDateTime": number, "failureReason": "string", "lastUpdatedDateTime": number, "recommenderConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" }, "minRecommendationRequestsPerSecond": number, "trainingDataConfig": { "excludedDatasetColumns": { "string" : [ "string" ] }, "includedDatasetColumns": { "string" : [ "string" ] } } }, "status": "string" }, "modelMetrics": { "string" : number }, "name": "string", "recipeArn": "string", "recommenderArn": "string", "recommenderConfig": { "enableMetadataWithRecommendations": boolean, "itemExplorationConfig": { "string" : "string" }, "minRecommendationRequestsPerSecond": number, "trainingDataConfig": { "excludedDatasetColumns": { "string" : [ "string" ] }, "includedDatasetColumns": { "string" : [ "string" ] } } }, "status": "string" } }

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

recommender

Les propriétés du recommandeur.

Type : objet Recommender

Erreurs

InvalidInputException

Fournissez une valeur valide pour le champ ou le paramètre.

Code d’état HTTP : 400

ResourceNotFoundException

Impossible de trouver la ressource spécifiée.

Code d’état HTTP : 400

Voir aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS kits SDK spécifiques à une langue, consultez les rubriques suivantes :