DescribeForecast - Amazon Forecast
AnforderungssyntaxAnfrageparameterAntwortsyntaxAntwortelementeFehlerWeitere 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.

DescribeForecast

Beschreibt eine Prognose, die mithilfe desCreateForecastverwenden.

Neben der Auflistung der in derCreateForecastrequest, dieser Vorgang listet die folgenden Eigenschaften auf:

  • DatasetGroupArn- Die Datensatzgruppe, die die Trainingsdaten bereitgestellt hat.

  • CreationTime

  • LastModificationTime

  • Status

  • Message- Wenn ein Fehler aufgetreten ist, Informationen über den Fehler.

Anforderungssyntax

{
   "ForecastArn": "string"
}

Anfrageparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ForecastArn

Der Amazon-Ressourcenname (ARN) der Prognose.

Type: String (Zeichenfolge)

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

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Erforderlich: Ja

Antwortsyntax

{
   "CreationTime": number,
   "DatasetGroupArn": "string",
   "EstimatedTimeRemainingInMinutes": number,
   "ForecastArn": "string",
   "ForecastName": "string",
   "ForecastTypes": [ "string" ],
   "LastModificationTime": number,
   "Message": "string",
   "PredictorArn": "string",
   "Status": "string",
   "TimeSeriesSelector": { 
      "TimeSeriesIdentifiers": { 
         "DataSource": { 
            "S3Config": { 
               "KMSKeyArn": "string",
               "Path": "string",
               "RoleArn": "string"
            }
         },
         "Format": "string",
         "Schema": { 
            "Attributes": [ 
               { 
                  "AttributeName": "string",
                  "AttributeType": "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.

CreationTime

Als die Prognoseerstellungsaufgabe erstellt wurde.

Type: Zeitstempel

DatasetGroupArn

Der ARN der Dataset-Gruppe, der die Daten bereitstellte, die zum Schulen des Predictors verwendet wurden.

Type: String (Zeichenfolge)

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

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

EstimatedTimeRemainingInMinutes

Die geschätzte Zeit, die in Minuten verbleibt, bis der Prognoseauftrag abgeschlossen ist.

Type: Long

ForecastArn

Der in der Anforderung angegebene Prognose-ARN.

Type: String (Zeichenfolge)

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

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

ForecastName

Der Name der Prognose.

Type: String (Zeichenfolge)

Längenbeschränkungen: Mindestlänge 1. Maximale Länge beträgt 63 Zeichen.

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*

ForecastTypes

Die Quantile, bei denen probabilistische Prognosen generiert wurden.

Type: Zeichenfolgen-Array

Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 50 Elemente.

Längenbeschränkungen: Minimale Länge von 2. Maximale Länge beträgt 4 Zeichen.

Pattern: (^0?\.\d\d?$|^mean$)

LastModificationTime

Die Uhrzeit, wann die Ressource zuletzt geändert wurde. Der Zeitstempel hängt vom Status des Auftrags ab:

  • CREATE_PENDING- DieCreationTimeaus.

  • CREATE_IN_PROGRESS- Der aktuelle Zeitstempel

  • CREATE_STOPPING- Der aktuelle Zeitstempel

  • CREATE_STOPPED- Als der Job aufhörte.

  • ACTIVEoderCREATE_FAILED- Wenn der Job beendet ist oder fehlgeschlagen ist.

Type: Zeitstempel

Message

Wenn ein Fehler aufgetreten ist, ist dies ein Informationsmeldungstext über den Fehler.

Type: String (Zeichenfolge)

PredictorArn

Der ARN des Prädiktors, der zur Generierung der Prognose verwendet wurde.

Type: String (Zeichenfolge)

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

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

Status

Der Status der Prognose. Zu den Staaten gehören:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Anmerkung

DieStatusder Prognose muss seinACTIVEbevor Sie die Prognose abfragen oder exportieren können.

Type: String (Zeichenfolge)

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

Pattern: ^[a-zA-Z0-9\_]+$

TimeSeriesSelector

Die Zeitreihe, die in die Prognose aufgenommen werden soll.

Typ: TimeSeriesSelector Objekt

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

ResourceNotFoundException

Wir können keine Ressource mit diesem Amazon-Ressourcennamen (ARN) finden. Überprüfen Sie den ARN 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 unter: