View a markdown version of this page

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

ListWhatIfForecasts

Gibt eine Liste von Was-wäre-wenn-Prognosen zurück, die mithilfe der CreateWhatIfForecast Operation erstellt wurden. Für jede Was-wäre-wenn-Prognose gibt diese Operation eine Zusammenfassung ihrer Eigenschaften zurück, einschließlich des Amazon-Ressourcennamens (ARN). Sie können den vollständigen Satz von Eigenschaften abrufen, indem Sie bei der Operation den ARN der Was-wäre-wenn-Prognose verwenden. DescribeWhatIfForecast

Wichtig

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“

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. Sie gibt anIS_NOT, ob die Exportaufträge für Was-wäre-wenn-Prognosen, die der Aussage entsprechen, in die Liste aufgenommen bzw. 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 prognostizierten Exportaufträge einzubeziehen, die der Aussage entsprechenIS. Um übereinstimmende Prognose-Exportaufträge auszuschließen, geben Sie Folgendes anIS_NOT.

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

  • Value- Der Wert, der übereinstimmen soll.

Um beispielsweise alle Jobs aufzulisten, die eine Prognose mit dem Namen Elektrizität exportieren WhatIfForecast, geben Sie den folgenden Filter an:

"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast" } ]

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 eineNextToken. Um den nächsten Satz von Ergebnissen abzurufen, verwenden Sie das Token im 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

{
   "NextToken": "string",
   "WhatIfForecasts": [ 
      { 
         "CreationTime": number,
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string",
         "WhatIfAnalysisArn": "string",
         "WhatIfForecastArn": "string",
         "WhatIfForecastName": "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.

NextToken

Wenn das Ergebnis der vorherigen Anfrage gekürzt wurde, enthält die Antwort eineNextToken. Um den nächsten Satz von Ergebnissen abzurufen, verwenden Sie das Token im 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: .+

WhatIfForecasts

Eine Reihe von WhatIfForecasts Objekten, die die übereinstimmenden Prognosen beschreiben.

Typ: Array von WhatIfForecastSummary-Objekten

Fehler

InvalidInputException

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

HTTP-Statuscode: 400

InvalidNextTokenException

Das Token ist nicht gültig. Die 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 im Folgenden: