View a markdown version of this page

QueryForecast - Amazon Forecast
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerWeitere Informationen finden Sie unter:

Amazon Forecast ist für Neukunden nicht mehr verfügbar. Bestehende Kunden von Amazon Forecast können den Service weiterhin wie gewohnt nutzen. Erfahren Sie mehr“

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.

QueryForecast

Ruft eine Prognose für einen einzelnen Artikel ab, gefiltert nach den angegebenen Kriterien.

Das Kriterium ist ein Schlüssel-Wert-Paar. Der Schlüssel stammt entweder item_id (oder das entsprechende Feld ohne Zeitstempel, kein Zielfeld) aus dem TARGET_TIME_SERIES Datensatz oder aus einer der als Teil des Objekts angegebenen Prognosedimensionen. FeaturizationConfig

QueryForecastGibt standardmäßig den vollständigen Datumsbereich für die gefilterte Prognose zurück. Sie können einen bestimmten Datumsbereich anfordern.

Verwenden Sie die CreateForecastExportJob Operation, um die vollständige Prognose zu erhalten.

Anmerkung

Die von Amazon Forecast generierten Prognosen befinden sich in derselben Zeitzone wie der Datensatz, der zur Erstellung des Prädiktors verwendet wurde.

Anforderungssyntax

{
   "EndDate": "string",
   "Filters": { 
      "string" : "string" 
   },
   "ForecastArn": "string",
   "NextToken": "string",
   "StartDate": "string"
}

Anforderungsparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

EndDate

Das Enddatum für die Prognose. Geben Sie das Datum in diesem Format an: yyyy- MM-dd 'T' HH:mm:ss (ISO 8601-Format). Zum Beispiel 2015-01-01. T20:00:00

Typ: Zeichenfolge

Erforderlich: Nein

Filters

Die Filterkriterien, die beim Abrufen der Prognose angewendet werden sollen. Geben Sie beispielsweise Folgendes an, um die Prognose für den Stromverbrauch client_21 im Datensatz „Stromverbrauch“ abzurufen:

{"item_id" : "client_21"}

Verwenden Sie die CreateForecastExportJob Operation, um die vollständige Prognose zu erhalten.

Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge

Karteneinträge: Maximale Anzahl von 50 Elementen.

Einschränkungen der Schlüssellänge: Die maximale Länge beträgt 256.

Schlüssel-Muster: ^[a-zA-Z0-9\_\-]+$

Beschränkungen der Wertelänge: Die maximale Länge beträgt 256.

Erforderlich: Ja

ForecastArn

Der Amazon-Ressourcenname (ARN) der abzufragenden Prognose.

Typ: Zeichenfolge

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

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

Erforderlich: Ja

NextToken

Wenn das Ergebnis der vorherigen Anfrage gekürzt wurde, enthält die Antwort eineNextToken. Verwenden Sie das Token in der nächsten Anfrage, um die nächsten Ergebnisse abzurufen. Die Token laufen nach 24 Stunden ab.

Typ: Zeichenfolge

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

Erforderlich: Nein

StartDate

Das Startdatum für die Prognose. Geben Sie das Datum in diesem Format an: yyyy- MM-dd 'T' HH:mm:ss (ISO 8601-Format). Zum Beispiel 2015-01-01. T08:00:00

Typ: Zeichenfolge

Erforderlich: Nein

Antwortsyntax

{
   "Forecast": { 
      "Predictions": { 
         "string" : [ 
            { 
               "Timestamp": "string",
               "Value": number
            }
         ]
      }
   }
}

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.

Forecast

Die Prognose.

Typ: Forecast Objekt

Fehler

InvalidInputException

Der Wert ist ungültig oder zu lang.

HTTP-Statuscode: 400

InvalidNextTokenException

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

HTTP-Statuscode: 400

LimitExceededException

Das Limit für die Anzahl der Anfragen pro Sekunde wurde überschritten.

HTTP-Statuscode: 400

ResourceInUseException

Die angegebene Ressource wird verwendet.

HTTP-Statuscode: 400

ResourceNotFoundException

Wir können diese Ressource nicht finden. Überprüfen Sie die von Ihnen angegebenen Informationen und versuchen Sie es erneut.

HTTP-Statuscode: 400

Weitere Informationen finden Sie unter:

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