ListForecasts - Amazon Forecast
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerWeitere 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 von Prognosen zurück, die mit der CreateForecast Operation erstellt wurden. Für jede Prognose gibt dieser Vorgang eine Zusammenfassung ihrer Eigenschaften zurück, einschließlich ihres Amazon-Ressourcennamens (ARN). Um den vollständigen Satz von Eigenschaften abzurufen, geben Sie den ARN mit der DescribeForecast Operation an. Sie können die Liste mithilfe einer Reihe von Filter Objekten filtern.

Anforderungssyntax

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

Anforderungsparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

Filters

Eine Reihe von Filtern. Für jeden Filter geben Sie eine Bedingung und eine Match-Anweisung an. Die Bedingung lautet entweder IS oder und gibt anIS_NOT, ob die Prognosen, die der Aussage entsprechen, in die Liste aufgenommen oder aus der Liste ausgeschlossen werden sollen. Die Match-Anweisung besteht aus einem Schlüssel und einem Wert.

Eigenschaften filtern

  • Condition- Die anzuwendende Bedingung. Gültige Werte sind IS und IS_NOT. Geben Sie Folgendes an, um die Prognosen einzubeziehen, die der Aussage entsprechenIS. Geben Sie Folgendes an, um übereinstimmende Prognosen auszuschließenIS_NOT.

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

  • Value- Der Wert, der zugeordnet werden soll.

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

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

Typ: Array von Filter-Objekten

Erforderlich: Nein

MaxResults

Die Anzahl der Elemente, die in der Antwort zurückgegeben werden sollen.

Typ: Ganzzahl

Gültiger Bereich: Mindestwert 1. Maximalwert 100.

Erforderlich: Nein

NextToken

Wenn das Ergebnis der vorherigen Anfrage gekürzt wurde, enthält die Antwort einNextToken. Um die nächsten Ergebnisse abzurufen, verwenden Sie das Token in der nächsten Anfrage. Tokens laufen nach 24 Stunden ab.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge von 3000.

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

Eine Reihe von Objekten, die die Eigenschaften der einzelnen Prognosen zusammenfassen.

Typ: Array von ForecastSummary-Objekten

NextToken

Wenn die Antwort gekürzt wird, gibt Amazon Forecast dieses Token zurück. Um die nächsten Ergebnisse abzurufen, verwenden Sie das Token in der nächsten Anfrage.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge von 3000.

Pattern: .+

Fehler

InvalidInputException

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

HTTP Status Code: 400

InvalidNextTokenException

Das Token ist nicht gültig. Tokens laufen nach 24 Stunden ab.

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

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