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

ListWhatIfAnalyses

Gibt eine Liste von Was-wäre-wenn-Analysen zurück, die mit der CreateWhatIfAnalysis Operation erstellt wurden. Für jede Was-wäre-wenn-Analyse gibt dieser Vorgang eine Zusammenfassung ihrer Eigenschaften zurück, einschließlich ihres Amazon-Ressourcennamens (ARN). Sie können den vollständigen Satz von Eigenschaften abrufen, indem Sie den Was-wäre-wenn-Analyse-ARN mit dem DescribeWhatIfAnalysis Vorgang verwenden.

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 Übereinstimmungsanweisung an. Die Bedingung lautet entweder IS oder und gibt anIS_NOT, ob die Was-wäre-wenn-Analyseaufträge, die der Anweisung 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 Was-wäre-wenn-Analyseaufträge einzubeziehen, die der Aussage entsprechen. IS Um passende Was-wäre-wenn-Analyseaufträge auszuschließen, geben Sie an. IS_NOT

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

  • Value- Der Wert, der zugeordnet werden soll.

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

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

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

{
   "NextToken": "string",
   "WhatIfAnalyses": [ 
      { 
         "CreationTime": number,
         "ForecastArn": "string",
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string",
         "WhatIfAnalysisArn": "string",
         "WhatIfAnalysisName": "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 die Antwort gekürzt ist, gibt 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. Die maximale Länge beträgt 3000.

Pattern: .+

WhatIfAnalyses

Eine Reihe von WhatIfAnalysisSummary Objekten, die die übereinstimmenden Analysen beschreiben.

Typ: Array von WhatIfAnalysisSummary-Objekten

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 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: