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

DescribeWhatIfAnalysis

Beschreibt die Was-wäre-wenn-Analyse, die mit der CreateWhatIfAnalysis Operation erstellt wurde.

Dieser Vorgang listet nicht nur die in der CreateWhatIfAnalysis Anforderung angegebenen Eigenschaften auf, sondern listet auch die folgenden Eigenschaften auf:

  • CreationTime

  • LastModificationTime

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

  • Status

Anforderungssyntax

{
   "WhatIfAnalysisArn": "string"
}

Anforderungsparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

WhatIfAnalysisArn

Der Amazon-Ressourcenname (ARN) der Was-wäre-wenn-Analyse, an der Sie interessiert sind.

Typ: Zeichenfolge

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

Pattern: arn:([a-z\d-]+):forecast:.*:.*:.+

Erforderlich: Ja

Antwortsyntax

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

CreationTime

Wann die Was-wäre-wenn-Analyse erstellt wurde.

Typ: Zeitstempel

EstimatedTimeRemainingInMinutes

Die ungefähre Zeit, die bis zum Abschluss der Was-wäre-wenn-Analyse noch verbleibt, in Minuten.

Type: Long

ForecastArn

Der Amazon-Ressourcenname (ARN) der Was-wäre-wenn-Prognose.

Typ: Zeichenfolge

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

Pattern: arn:([a-z\d-]+):forecast:.*:.*:.+

LastModificationTime

Das letzte Mal, als die Ressource geändert wurde. Der Zeitstempel hängt vom Status des Jobs ab:

  • CREATE_PENDING- DasCreationTime.

  • CREATE_IN_PROGRESS- Der aktuelle Zeitstempel.

  • CREATE_STOPPING- Der aktuelle Zeitstempel.

  • CREATE_STOPPED- Als der Job beendet wurde.

  • ACTIVEoder CREATE_FAILED — Wenn der Job abgeschlossen wurde oder fehlgeschlagen ist.

Typ: Zeitstempel

Message

Wenn ein Fehler aufgetreten ist, eine Informationsmeldung über den Fehler.

Typ: Zeichenfolge

Status

Der Status der Was-wäre-wenn-Analyse. 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

Die Status Was-wäre-wenn-Analyse muss vorliegen, ACTIVE bevor Sie auf die Analyse zugreifen können.

Typ: Zeichenfolge

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

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

TimeSeriesSelector

Definiert den Satz von Zeitreihen, die zur Erstellung der Prognosen in einem TimeSeriesIdentifiers Objekt verwendet werden.

Das TimeSeriesIdentifiers Objekt benötigt die folgenden Informationen:

  • DataSource

  • Format

  • Schema

Typ: TimeSeriesSelector Objekt

WhatIfAnalysisArn

Der Amazon-Ressourcenname (ARN) der Was-wäre-wenn-Analyse.

Typ: Zeichenfolge

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

Pattern: arn:([a-z\d-]+):forecast:.*:.*:.+

WhatIfAnalysisName

Der Name der Was-wäre-wenn-Analyse.

Typ: Zeichenfolge

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

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

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

ResourceNotFoundException

Wir können keine Ressource mit diesem Amazon-Ressourcennamen (ARN) finden. Überprüfen Sie den ARN und versuchen Sie es erneut.

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: