DescribeAutoPredictor

Beschreibt einen Predictor, der mit dem CreateAutoPredictor verwenden.

Anforderungssyntax

{
   "PredictorArn": "string"
}

Anfrageparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

PredictorArn

Der Amazon-Ressourcenname (ARN) des Predictors.

Type: String (Zeichenfolge)

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

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

Erforderlich: Ja

Antwortsyntax

{
   "CreationTime": number,
   "DataConfig": { 
      "AdditionalDatasets": [ 
         { 
            "Configuration": { 
               "string" : [ "string" ]
            },
            "Name": "string"
         }
      ],
      "AttributeConfigs": [ 
         { 
            "AttributeName": "string",
            "Transformations": { 
               "string" : "string" 
            }
         }
      ],
      "DatasetGroupArn": "string"
   },
   "DatasetImportJobArns": [ "string" ],
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "EstimatedTimeRemainingInMinutes": number,
   "ExplainabilityInfo": { 
      "ExplainabilityArn": "string",
      "Status": "string"
   },
   "ForecastDimensions": [ "string" ],
   "ForecastFrequency": "string",
   "ForecastHorizon": number,
   "ForecastTypes": [ "string" ],
   "LastModificationTime": number,
   "Message": "string",
   "MonitorInfo": { 
      "MonitorArn": "string",
      "Status": "string"
   },
   "OptimizationMetric": "string",
   "PredictorArn": "string",
   "PredictorName": "string",
   "ReferencePredictorSummary": { 
      "Arn": "string",
      "State": "string"
   },
   "Status": "string",
   "TimeAlignmentBoundary": { 
      "DayOfMonth": number,
      "DayOfWeek": "string",
      "Hour": number,
      "Month": "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

Der Zeitstempel des CreateAutoPredictor request.

Type: Zeitstempel

DataConfig

Die Datenkonfiguration für Ihre Datensatzgruppe und alle zusätzlichen Datensätze.

Typ: DataConfig Objekt

DatasetImportJobArns

Ein Array der ARNs der Dataset-Importjobs, die zum Importieren von Trainingsdaten für den Prädiktor verwendet werden.

Type: Zeichenfolgen-Array

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

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

EncryptionConfig

Ein AWS Key Management Service (KMS) -Schlüssel und eine AWS Identity and Access Management (IAM) -Rolle, die Amazon Forecast annehmen kann, um auf den Schlüssel zuzugreifen. Sie können dieses optionale Objekt imCreateDatasetundCreatePredictoranfragen.

Typ: EncryptionConfig Objekt

EstimatedTimeRemainingInMinutes

Die geschätzte Zeit, die in Minuten verbleibt, um den Predictor Training zu beenden.

Type: Long

ExplainabilityInfo

Stellt den Status und den ARN der Prädiktorerklärbarkeit bereit.

Typ: ExplainabilityInfo Objekt

ForecastDimensions

Ein Array von Dimensionsnamen (Feld), die die Attribute angeben, die zum Gruppieren Ihrer Zeitreihen verwendet werden.

Type: Zeichenfolgen-Array

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

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

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

ForecastFrequency

Die Häufigkeit von Vorhersagen in einer Prognose.

Gültige Intervalle sind Y (Jahr), M (Monat), W (Woche), D (Tag), H (Stunde), 30 Minuten (30 Minuten), 15 Minuten (15 Minuten), 10 Minuten (10 Minuten), 5 Minuten (5 Minuten) und 1 Minute (1 Minute). Zum Beispiel gibt „Y“ jedes Jahr an und „5min“ zeigt alle fünf Minuten an.

Type: String (Zeichenfolge)

Längenbeschränkungen: Mindestlänge 1. Die maximale Länge beträgt 5.

Pattern: ^Y|M|W|D|H|30min|15min|10min|5min|1min$

ForecastHorizon

Die Anzahl der Zeitschritte, die das Modell prognostiziert. Der Prognosehorizont wird auch als Prognoselänge bezeichnet.

Type: Ganzzahl

ForecastTypes

Die während des Prädiktortrainings verwendeten Prognosetypen. Der Standardwert ist ["0.1", "0.5", "0.9"].

Type: Zeichenfolgen-Array

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

Längenbeschränkungen: Mindestlänge 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

Im Falle eines Fehlers eine Meldung, in der die Ursache des Fehlers aufgeführt wird.

Type: String (Zeichenfolge)

MonitorInfo

EINMonitorInfo-Objekt mit dem Amazon-Ressourcennamen (ARN) und Status der Monitorressource.

Typ: MonitorInfo Objekt

OptimizationMetric

Die zur Optimierung des Prädiktors verwendete Genauigkeitsmetrik.

Type: String (Zeichenfolge)

Zulässige Werte: WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE

PredictorArn

Der Amazon-Ressourcenname (ARN) des Predictors

Type: String (Zeichenfolge)

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

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

PredictorName

Der Name des Predictors.

Type: String (Zeichenfolge)

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

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

ReferencePredictorSummary

Der ARN und der Status des Referenzprädiktors. Dieser Parameter ist nur für umgeschulte oder aktualisierte Predictoren gültig.

Typ: ReferencePredictorSummary Objekt

Status

Der Status des Predictors. Zu den Staaten gehören:

• ACTIVE

• CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

• CREATE_STOPPING, CREATE_STOPPED

• DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Type: String (Zeichenfolge)

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

TimeAlignmentBoundary

Die Zeitgrenze, die Forecast beim Aggregieren von Daten verwendet.

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

• AWS-Befehlszeilenschnittstelle

• AWS-SDK für .NET

• AWS-SDK für C++

• AWS-SDK for Go

• AWS SDK for Java V2

• AWS-SDK für JavaScript

• AWS SDK für PHP V3

• AWS SDK für Python

• AWS SDK für Ruby V3