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

DescribeDataset

Beschreibt ein Amazon Forecast-Dataset, das mit derCreateDatasetverwenden.

Zusätzlich zur Auflistung der in derCreateDatasetrequest enthält dieser Vorgang die folgenden Datensatzeigenschaften:

  • CreationTime

  • LastModificationTime

  • Status

Anforderungssyntax

{
   "DatasetArn": "string"
}

Anfrageparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

DatasetArn

Der Amazon-Ressourcenname (ARN) des Datensatzes.

Type: String (Zeichenfolge)

Einschränkungen der Länge: Maximale Länge beträgt 256 Zeichen.

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

Erforderlich: Ja

Antwortsyntax

{
   "CreationTime": number,
   "DataFrequency": "string",
   "DatasetArn": "string",
   "DatasetName": "string",
   "DatasetType": "string",
   "Domain": "string",
   "EncryptionConfig": { 
      "KMSKeyArn": "string",
      "RoleArn": "string"
   },
   "LastModificationTime": number,
   "Schema": { 
      "Attributes": [ 
         { 
            "AttributeName": "string",
            "AttributeType": "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

Als der Datensatz erstellt wurde.

Type: Zeitstempel

DataFrequency

Die Häufigkeit der Datenerhebung.

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 „M“ jeden Monat an und „30min“ zeigt alle 30 Minuten an.

Type: String (Zeichenfolge)

Einschränkungen der Länge: Mindestlänge 1. Maximale Länge beträgt 5.

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

DatasetArn

Der Amazon-Ressourcenname (ARN) des Datensatzes.

Type: String (Zeichenfolge)

Einschränkungen der Länge: Maximale Länge beträgt 256 Zeichen.

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

DatasetName

Der Name des Datensatzes.

Type: String (Zeichenfolge)

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

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

DatasetType

Der Datensatztyp.

Type: String (Zeichenfolge)

Zulässige Werte: TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA

Domain

Die mit dem Datensatz verknüpfte Domäne.

Type: String (Zeichenfolge)

Zulässige Werte: RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS

EncryptionConfig

Der AWS Key Management Service (KMS) -Schlüssel und die AWS Identity and Access Management (IAM) -Rolle, die Amazon Forecast übernehmen kann, um auf den Schlüssel zuzugreifen.

Typ: EncryptionConfig Objekt

LastModificationTime

Wenn Sie einen Datensatz erstellen,LastModificationTimeist identisch zuCreationTimeaus. Während Daten in den Datensatz importiert werden,LastModificationTimeist die aktuelle Zeit desDescribeDatasetAufrufen von. Nach einemCreateDatasetImportJobBetrieb ist beendet,LastModificationTimeist, wenn der Importauftrag abgeschlossen oder fehlgeschlagen ist.

Type: Zeitstempel

Schema

Ein Array vonSchemaAttribute-Objekte, die die Dataset-Felder angeben. EACHSchemaAttributegibt den Namen und den Datentyp eines Feldes an.

Typ: Schema Objekt

Status

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

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

DieUPDATEZustände gelten, während Daten aus einem Aufruf desCreateDatasetImportJob-Betrieb und spiegeln Sie den Status des Dataset-Importauftrags wider. Zum Beispiel, wenn der Importauftragsstatus lautetCREATE_IN_PROGRESSist der Status des DatensatzesUPDATE_IN_PROGRESSaus.

Anmerkung

DieStatusdes Datensatzes muss seinACTIVEbevor Sie Schulungsdaten importieren können.

Type: String (Zeichenfolge)

Einschränkungen der Länge: Maximale Länge beträgt 256 Zeichen.

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-Ressourcenname (ARN) finden. Überprüfen Sie das 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: