Anforderungssyntax Anforderungsparameter Antwortsyntax Antwortelemente Fehler Weitere Informationen finden Sie unter:

DescribeExplainability

Beschreibt eine Erklärbarkeitsressource, die mithilfe der CreateExplainability Operation erstellt wurde.

Wichtig

Amazon Forecast ist für Neukunden nicht mehr verfügbar. Bestehende Kunden von Amazon Forecast können den Service weiterhin wie gewohnt nutzen. Erfahren Sie mehr“

Anforderungssyntax


{
   "ExplainabilityArn": "string"
}

Anforderungsparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ExplainabilityArn

Der Amazon-Ressourcenname (ARN) der zu beschreibenden Erklärbarkeit.

Typ: Zeichenfolge

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

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

Erforderlich: Ja

Antwortsyntax


{
   "CreationTime": number,
   "DataSource": { 
      "S3Config": { 
         "KMSKeyArn": "string",
         "Path": "string",
         "RoleArn": "string"
      }
   },
   "EnableVisualization": boolean,
   "EndDateTime": "string",
   "EstimatedTimeRemainingInMinutes": number,
   "ExplainabilityArn": "string",
   "ExplainabilityConfig": { 
      "TimePointGranularity": "string",
      "TimeSeriesGranularity": "string"
   },
   "ExplainabilityName": "string",
   "LastModificationTime": number,
   "Message": "string",
   "ResourceArn": "string",
   "Schema": { 
      "Attributes": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "string"
         }
      ]
   },
   "StartDateTime": "string",
   "Status": "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 Explainability-Ressource erstellt wurde.

Typ: Zeitstempel

DataSource

Die Quelle Ihrer Daten, eine AWS Identity and Access Management (IAM) -Rolle, die Amazon Forecast den Zugriff auf die Daten ermöglicht, und optional ein AWS Key Management Service (KMS-) Schlüssel.

Typ: DataSource Objekt

EnableVisualization

Ob die Visualisierung für die Explainability-Ressource aktiviert wurde.

Typ: Boolescher Wert

EndDateTime

Wenn aufSPECIFIC, der letzte Zeitpunkt in der Erklärbarkeit gesetzt TimePointGranularity ist.

Typ: Zeichenfolge

Längenbeschränkungen: Maximale Länge von 19.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$

EstimatedTimeRemainingInMinutes

Die geschätzte Zeit in Minuten, die bis zum Abschluss des CreateExplainability Jobs noch verbleibt.

Type: Long

ExplainabilityArn

Der Amazon-Ressourcenname (ARN) der Erklärbarkeit.

Typ: Zeichenfolge

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

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

ExplainabilityConfig

Die Konfigurationseinstellungen, die die Granularität von Zeitreihen und Zeitpunkten für die Erklärbarkeit definieren.

Typ: ExplainabilityConfig Objekt

ExplainabilityName

Der Name der Erklärbarkeit.

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_]*

LastModificationTime

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

CREATE_PENDING- DerCreationTime.
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.