View a markdown version of this page

DescribeRecommender - Amazon Personalize

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

DescribeRecommender

Beschreibt den angegebenen Empfehlungsgeber, einschließlich seines Status.

Ein Empfehlungsgeber kann sich in einem der folgenden Zustände befinden:

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

  • AUSSTEHEND BEENDEN > IN_PROGRESS BEENDEN > INAKTIV > AUSSTEHEND STARTEN > IN_PROGRESS STARTEN > AKTIV

  • DELETE PENDING > DELETE IN_PROGRESS

Wenn jaCREATE FAILED, enthält die Antwort den failureReason Schlüssel, der den Grund beschreibt. status

Der modelMetrics Schlüssel ist Null, wenn der Empfehlungsempfehler erstellt oder gelöscht wird.

Weitere Informationen zu Empfehlern finden Sie unter. CreateRecommender

Anforderungssyntax

{ "recommenderArn": "string" }

Anforderungsparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

recommenderArn

Der Amazon-Ressourcenname (ARN) des Empfehlenden, der beschrieben werden soll.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge beträgt 256 Zeichen.

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Erforderlich: Ja

Antwortsyntax

{ "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" } }

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

recommender

Die Eigenschaften des Empfehlenden.

Typ: Recommender Objekt

Fehler

InvalidInputException

Geben Sie einen gültigen Wert für das Feld oder den Parameter an.

HTTP-Statuscode: 400

ResourceNotFoundException

Die angegebene Ressource konnte nicht gefunden werden.

HTTP-Statuscode: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: