ListForecasts - Amazon Forecast
AnforderungssyntaxAnfrageparameterAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

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.

ListForecasts

Gibt eine Liste der Prognosen zurück, die mit derCreateForecastverwenden. Für jede Prognose gibt dieser Vorgang eine Zusammenfassung seiner Eigenschaften zurück, einschließlich dessen Amazon-Ressourcenname (ARN). Um den vollständigen Eigenschaftssatz abzurufen, geben Sie den ARN mit demDescribeForecastverwenden. Sie können die Liste mit einem Array von filternFilter-Objekte.

Anforderungssyntax

{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

Anfrageparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

Filters

Ein Array von Filtern. Für jeden Filter geben Sie eine Bedingung und eine Vergleichsanweisung an. Die Bedingung ist entwederISoderIS_NOT, der angibt, ob die Prognosen, die mit der Anweisung übereinstimmen, in die Liste aufgenommen oder ausgeschlossen werden sollen. Die Match-Anweisung besteht aus einem Schlüssel und einem Wert.

Eigenschaften filtern

  • Condition- Die zutreffende Bedingung. Gültige Werte sind IS und IS_NOT. Um die Prognosen einzubeziehen, die mit der Anweisung übereinstimmen, geben Sie anISaus. Um übereinstimmende Prognosen auszuschließen, geben Sie anIS_NOTaus.

  • Key- Der Name des Parameters, nach dem gefiltert werden soll. Gültige Werte sind DatasetGroupArn, PredictorArn, und Status.

  • Value- Der zu übereinstimmende Wert.

Um beispielsweise alle Prognosen aufzulisten, deren Status nicht AKTIV ist, würden Sie Folgendes angeben:

"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]

Type: Array vonFilterObjekte

: Erforderlich Nein

MaxResults

Die Anzahl der Elemente, die in der Antwort zurückgegeben werden können.

Type: Ganzzahl

Gültiger Bereich: Der Mindestwert ist 1. Maximalwert 100.

: Erforderlich Nein

NextToken

Wenn das Ergebnis der vorherigen Anfrage abgeschnitten wurde, enthält die Antwort eineNextTokenaus. Um den nächsten Ergebnissatz abzurufen, verwenden Sie das Token in der nächsten Anforderung. Token laufen nach 24 Stunden ab.

Type: String (Zeichenfolge)

Längen-Beschränkungen: Mindestlänge 1. Maximale Länge beträgt 3000 Zeichen.

Pattern: .+

: Erforderlich Nein

Antwortsyntax

{
   "Forecasts": [ 
      { 
         "CreatedUsingAutoPredictor": boolean,
         "CreationTime": number,
         "DatasetGroupArn": "string",
         "ForecastArn": "string",
         "ForecastName": "string",
         "LastModificationTime": number,
         "Message": "string",
         "PredictorArn": "string",
         "Status": "string"
      }
   ],
   "NextToken": "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.

Forecasts

Ein Array von Objekten, die die Eigenschaften jeder Prognose zusammenfassen.

Type: Array vonForecastSummaryObjekte

NextToken

Wenn die Antwort abgeschnitten wird, gibt Amazon Forecast dieses Token zurück. Um den nächsten Ergebnissatz abzurufen, verwenden Sie das Token in der nächsten Anforderung.

Type: String (Zeichenfolge)

Längen-Beschränkungen: Mindestlänge 1. Maximale Länge beträgt 3000 Zeichen.

Pattern: .+

Fehler

InvalidInputException

Wir können die Anfrage nicht bearbeiten, da sie einen ungültigen Wert oder einen Wert enthält, der den gültigen Bereich überschreitet.

HTTP-Statuscode: 400

InvalidNextTokenException

Das Token ist ungültig. Token laufen nach 24 Stunden ab.

HTTP-Statuscode: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter: