View a markdown version of this page

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

ListRecommenders

Renvoie une liste de recommandations dans un groupe de jeux de données de domaine donné. Lorsqu'aucun groupe de jeux de données de domaine n'est spécifié, tous les recommandateurs associés au compte sont répertoriés. La réponse fournit les propriétés de chaque recommandateur, y compris l'Amazon Resource Name (ARN). Pour plus d'informations sur les recommandateurs, consultez CreateRecommender.

Syntaxe de la requête

{ "datasetGroupArn": "string", "maxResults": number, "nextToken": "string" }

Paramètres de demande

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

datasetGroupArn

Le nom de ressource Amazon (ARN) du groupe de jeux de données de domaine pour lequel répertorier les personnes recommandées. Lorsqu'aucun groupe de jeux de données de domaine n'est spécifié, tous les recommandateurs associés au compte sont répertoriés.

Type : Chaîne

Contraintes de longueur : longueur maximale de 256.

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

Obligatoire : non

maxResults

Le nombre maximum de recommandateurs à renvoyer.

Type : entier

Plage valide : valeur minimum de 1. Valeur maximale fixée à 100.

Obligatoire : non

nextToken

Un jeton renvoyé lors de l'appel précédent à ListRecommenders pour obtenir le prochain ensemble de recommandations (s'ils existent).

Type : Chaîne

Contraintes de longueur : longueur maximale de 1500.

Modèle : \p{ASCII}{0,1500}

Obligatoire : non

Syntaxe de la réponse

{ "nextToken": "string", "recommenders": [ { "creationDateTime": number, "datasetGroupArn": "string", "lastUpdatedDateTime": 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.

nextToken

Un jeton permettant d'obtenir le prochain groupe de recommandations (s'ils existent).

Type : Chaîne

Contraintes de longueur : longueur maximale de 1500.

Modèle : \p{ASCII}{0,1500}

recommenders

Une liste des recommandataires.

Type : tableau d’objets RecommenderSummary

Membres du tableau : nombre maximum de 100 éléments.

Erreurs

InvalidInputException

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

Code d’état HTTP : 400

InvalidNextTokenException

Le jeton n'est pas valide.

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 :