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

ListWhatIfForecastExports

Gibt eine Liste von Was-wäre-wenn-Prognoseexporten zurück, die mit der CreateWhatIfForecastExport Operation erstellt wurden. Für jeden Was-wäre-wenn-Prognoseexport gibt dieser Vorgang eine Zusammenfassung seiner Eigenschaften zurück, einschließlich seines Amazon-Ressourcennamens (ARN). Sie können den vollständigen Satz von Eigenschaften abrufen, indem Sie den Was-wäre-wenn-Prognose-Export-ARN mit dem DescribeWhatIfForecastExport 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 Match-Anweisung an. Die Bedingung lautet entweder IS oder und gibt anIS_NOT, ob die Was-wäre-wenn-Prognose-Exportaufträge, die der Aussage entsprechen, jeweils aus der Liste aufgenommen oder 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 Prognose-Exportaufträge einzubeziehen, die der Aussage entsprechenIS. Geben Sie Folgendes an, um passende Forecast-Exportaufträge auszuschließenIS_NOT.

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

  • Value- Der Wert, der zugeordnet werden soll.

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

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

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",
   "WhatIfForecastExports": [ 
      { 
         "CreationTime": number,
         "Destination": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string",
         "WhatIfForecastArns": [ "string" ],
         "WhatIfForecastExportArn": "string",
         "WhatIfForecastExportName": "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. Maximale Länge von 3000.

Pattern: .+

WhatIfForecastExports

Eine Reihe von WhatIfForecastExports Objekten, die die übereinstimmenden Prognoseexporte beschreiben.

Typ: Array von WhatIfForecastExportSummary-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: