CreateDataSet - Amazon QuickSight
AnforderungssyntaxURI-AnfrageparameterAnforderungstextAntwortsyntaxAntwortelementeFehlerBeispieleWeitere 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.

CreateDataSet

Erstellt ein Dataset Dieser Vorgang unterstützt keine Datensätze, die hochgeladene Dateien als Quelle enthalten.

Anforderungssyntax

POST /accounts/AwsAccountId/data-sets HTTP/1.1
Content-type: application/json

{
   "ColumnGroups": [ 
      { 
         "GeoSpatialColumnGroup": { 
            "Columns": [ "string" ],
            "CountryCode": "string",
            "Name": "string"
         }
      }
   ],
   "ColumnLevelPermissionRules": [ 
      { 
         "ColumnNames": [ "string" ],
         "Principals": [ "string" ]
      }
   ],
   "DataSetId": "string",
   "DataSetUsageConfiguration": { 
      "DisableUseAsDirectQuerySource": boolean,
      "DisableUseAsImportedSource": boolean
   },
   "FieldFolders": { 
      "string" : { 
         "columns": [ "string" ],
         "description": "string"
      }
   },
   "ImportMode": "string",
   "LogicalTableMap": { 
      "string" : { 
         "Alias": "string",
         "DataTransforms": [ 
            { 
               "CastColumnTypeOperation": { 
                  "ColumnName": "string",
                  "Format": "string",
                  "NewColumnType": "string"
               },
               "CreateColumnsOperation": { 
                  "Columns": [ 
                     { 
                        "ColumnId": "string",
                        "ColumnName": "string",
                        "Expression": "string"
                     }
                  ]
               },
               "FilterOperation": { 
                  "ConditionExpression": "string"
               },
               "ProjectOperation": { 
                  "ProjectedColumns": [ "string" ]
               },
               "RenameColumnOperation": { 
                  "ColumnName": "string",
                  "NewColumnName": "string"
               },
               "TagColumnOperation": { 
                  "ColumnName": "string",
                  "Tags": [ 
                     { 
                        "ColumnDescription": { 
                           "Text": "string"
                        },
                        "ColumnGeographicRole": "string"
                     }
                  ]
               },
               "UntagColumnOperation": { 
                  "ColumnName": "string",
                  "TagNames": [ "string" ]
               }
            }
         ],
         "Source": { 
            "DataSetArn": "string",
            "JoinInstruction": { 
               "LeftJoinKeyProperties": { 
                  "UniqueKey": boolean
               },
               "LeftOperand": "string",
               "OnClause": "string",
               "RightJoinKeyProperties": { 
                  "UniqueKey": boolean
               },
               "RightOperand": "string",
               "Type": "string"
            },
            "PhysicalTableId": "string"
         }
      }
   },
   "Name": "string",
   "Permissions": [ 
      { 
         "Actions": [ "string" ],
         "Principal": "string"
      }
   ],
   "PhysicalTableMap": { 
      "string" : { 
         "CustomSql": { 
            "Columns": [ 
               { 
                  "Name": "string",
                  "Type": "string"
               }
            ],
            "DataSourceArn": "string",
            "Name": "string",
            "SqlQuery": "string"
         },
         "RelationalTable": { 
            "Catalog": "string",
            "DataSourceArn": "string",
            "InputColumns": [ 
               { 
                  "Name": "string",
                  "Type": "string"
               }
            ],
            "Name": "string",
            "Schema": "string"
         },
         "S3Source": { 
            "DataSourceArn": "string",
            "InputColumns": [ 
               { 
                  "Name": "string",
                  "Type": "string"
               }
            ],
            "UploadSettings": { 
               "ContainsHeader": boolean,
               "Delimiter": "string",
               "Format": "string",
               "StartFromRow": number,
               "TextQualifier": "string"
            }
         }
      }
   },
   "RowLevelPermissionDataSet": { 
      "Arn": "string",
      "FormatVersion": "string",
      "Namespace": "string",
      "PermissionPolicy": "string",
      "Status": "string"
   },
   "RowLevelPermissionTagConfiguration": { 
      "Status": "string",
      "TagRules": [ 
         { 
            "ColumnName": "string",
            "MatchAllValue": "string",
            "TagKey": "string",
            "TagMultiValueDelimiter": "string"
         }
      ]
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

AwsAccountId

Die AWS-Konto-ID.

Längenbeschränkungen: Feste Länge von 12.

Pattern: ^[0-9]{12}$

Erforderlich: Ja

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

DataSetId

Eine ID für das Dataset, das Sie erstellen möchten. Diese ID ist eindeutigAWS-Regionfür jedenAWSKonto.

Type: String

Erforderlich: Ja

ImportMode

Zeigt an, ob Sie die Daten in SPICE importieren möchten.

Type: String

Zulässige Werte: SPICE | DIRECT_QUERY

Erforderlich: Ja

Name

Der Anzeigename für das Dataset.

Type: String

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

Erforderlich: Ja

PhysicalTableMap

Deklariert die physischen Tabellen, die in den zugrunde liegenden Datenquellen verfügbar sind.

Type: Zeichenfolge fürPhysicalTableObjekt-Map

Karten-Einträge: Minimale Anzahl der Elemente: 0. Die maximale Anzahl beträgt 32 Elemente.

Wichtige Längenbeschränkungen: Mindestlänge 1. Höchstlänge = 64 Zeichen.

Schlüssel-Muster: [0-9a-zA-Z-]*

Erforderlich: Ja

ColumnGroups

Gruppierungen von Spalten, die in bestimmten Amazon-Umgebungen zusammenarbeiten QuickSight -Funktionen Derzeit wird nur die räumliche Hierarchie unterstützt.

Type: ArrayColumnGroupObjekte

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

Erforderlich: Nein

ColumnLevelPermissionRules

Ein Satz von einer oder mehreren Definitionen eines ColumnLevelPermissionRule .

Type: ArrayColumnLevelPermissionRuleObjekte

Array-Mitglieder: Die Mindestanzahl beträgt 1 Element.

Erforderlich: Nein

DataSetUsageConfiguration

Die Verwendungskonfiguration, die auf untergeordnete Datasets angewendet werden soll, die auf diese Datenmenge als Quelle verweisen.

Typ: DataSetUsageConfiguration Objekt

Erforderlich: Nein

FieldFolders

Der Ordner, der Felder und verschachtelte Unterordner für Ihr Dataset enthält.

Type: Zeichenfolge fürFieldFolderObjekt-Map

Wichtige Längenbeschränkungen: Mindestlänge 1. Höchstlänge = 1000 Zeichen.

Erforderlich: Nein

LogicalTableMap

Konfiguriert die Kombination und Transformation der Daten aus den physischen Tabellen.

Type: Zeichenfolge fürLogicalTableObjekt-Map

Karten-Einträge: Die maximale Anzahl beträgt 64 Elemente.

Wichtige Längenbeschränkungen: Mindestlänge 1. Höchstlänge = 64 Zeichen.

Schlüssel-Muster: [0-9a-zA-Z-]*

Erforderlich: Nein

Permissions

Eine Liste der Ressourcenberechtigungen für den Datensatz.

Type: ArrayResourcePermissionObjekte

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

Erforderlich: Nein

RowLevelPermissionDataSet

Die Sicherheitskonfiguration auf Zeilenebene für die Daten, die Sie erstellen möchten.

Typ: RowLevelPermissionDataSet Objekt

Erforderlich: Nein

RowLevelPermissionTagConfiguration

Die Konfiguration von Tags in einem Dataset, um die Sicherheit auf Zeilenebene festzulegen. Sicherheits-Tags auf Zeilenebene werden derzeit nur für die anonyme Einbettung unterstützt.

Typ: RowLevelPermissionTagConfiguration Objekt

Erforderlich: Nein

Tags

Enthält eine Zuordnung der Schlüssel-Wert-Paare für das oder die Ressourcen-Tags, die dem Dataset zugewiesen sind.

Type: ArrayTagObjekte

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

Erforderlich: Nein

Antwortsyntax

HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "DataSetId": "string",
   "IngestionArn": "string",
   "IngestionId": "string",
   "RequestId": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Dienst die folgende HTTP-Antwort zurück.

Status

Der HTTP-Status der Anforderung.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

Arn

Der Amazon-Ressourcenname (ARN) des Datenschlüssels.

Type: String

DataSetId

Die ID des Datenschlüssels, das Sie erstellen möchten. Diese ID ist eindeutigAWS-Regionfür jedenAWSKonto.

Type: String

IngestionArn

Der ARN für die Aufnahme, der als Ergebnis der Datensatzerstellung ausgelöst wird, wenn der Importmodus SPICE ist.

Type: String

IngestionId

Die ID der Aufnahme, die als Ergebnis der Datensatzerstellung ausgelöst wird, wenn der Importmodus SPICE ist.

Type: String

RequestId

DieAWSAnforderungs-ID für diese Operation.

Type: String

Fehler

Hinweise zu den Fehlern, die bei allen Aktionen auftreten, finden Sie unterHäufige Fehler.

AccessDeniedException

Sie haben keinen Zugriff auf dieses Element. Die bereitgestellten Anmeldeinformationen konnten nicht überprüft werden. Sie sind möglicherweise nicht berechtigt, die Anforderung auszuführen. Stellen Sie sicher, dass Ihr Konto für die Nutzung von Amazon autorisiert ist QuickSight --Service, dass Ihre Richtlinien die richtigen Berechtigungen besitzen und dass Sie die richtigen Zugriffsschlüssel verwenden.

HTTP Status Code: 401

ConflictException

Das Aktualisieren oder Löschen einer Ressource kann zu einem inkonsistenten Zustand führen.

HTTP Status Code: 409

InternalFailureException

Es ist ein interner Fehler aufgetreten.

HTTP Status Code: 500

InvalidParameterValueException

Ein oder mehrere Parameter haben einen Wert, der nicht gültig ist.

HTTP Status Code: 400

LimitExceededException

Ein Limit wurde überschritten.

HTTP Status Code: 409

ResourceExistsException

Die angegebene Ressource ist bereits vorhanden.

HTTP Status Code: 409

ResourceNotFoundException

Mindestens eine Ressource kann nicht gefunden werden.

HTTP Status Code: 404

ThrottlingException

Der Zugriff wird gedrosselt

HTTP Status Code: 429

UnsupportedUserEditionException

Dieser Fehler zeigt an, dass Sie eine Operation bei Amazon durchführen. QuickSightAbonnement, bei dem die Edition keine Unterstützung für diesen Vorgang enthält. Amazon QuickSight verfügt derzeit über eine Standard Edition und eine Enterprise Edition. Nicht jede Operation und Funktion ist in jeder Version verfügbar ist.

HTTP Status Code: 403

Beispiele

Beispiel

Dieses Beispiel zeigt eine Verwendung von CreateDataSet.

Beispielanforderung

POST /accounts/{AwsAccountId}/data-sets HTTP/1.1
Content-type: application/json

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS-SDKs finden Sie unter: