CreateDataSet - Amazon QuickSight

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

CreateDataSet

建立資料集。這項作業不支援包含上傳檔案做為來源的資料集。

請求語法

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 請求參數

請求會使用下列 URI 參數。

AwsAccountId

AWS 帳戶 ID。

長度限制:固定長度上限為 12。

模式:^[0-9]{12}$

必要:是

請求主體

請求接受採用 JSON 格式的下列資料。

DataSetId

資料集的 ID,您要建立之資料集的 ID,您要建立資料集的 ID 此 ID 是唯一的AWS 區域的必要項目AWS帳戶。

類型:字串

必要:是

ImportMode

表示是否要將資料匯入 SPICE。

類型:字串

有效值: SPICE | DIRECT_QUERY

必要:是

Name

資料集的顯示名稱。

類型:字串

長度限制:長度下限為 1。長度上限為 128。

必要:是

PhysicalTableMap

聲明在底層資料來源中可用的實體表。

類型:字串PhysicalTable物件地圖

地圖項目:項目數下限為 0。項目數上限為 32。

索引鍵長度限制:長度下限為 1。長度上限為 64。

金鑰模式:[0-9a-zA-Z-]*

必要:是

ColumnGroups

在某些 Amazon Amazon 中共同運作的欄分組 QuickSight 功能如下:目前僅支援空間階層。

類型:的陣列ColumnGroup對象

陣列成員:項目數下限為 1。項目數上限為 8。

必要:否

ColumnLevelPermissionRules

ColumnLevelPermissionRule 的一組一個或多個定義。

類型:的陣列ColumnLevelPermissionRule對象

陣列成員:項目數下限為 1。

必要:否

DataSetUsageConfiguration

要套用至參照此資料集做為來源之子資料集的使用方式設定。

類型:DataSetUsageConfiguration 物件

必要:否

FieldFolders

包含資料集的欄位和巢狀子資料夾的資料夾。

類型:字串FieldFolder物件地圖

索引鍵長度限制:長度下限為 1。長度上限為 1000。

必要:否

LogicalTableMap

設定實體表中資料的組合和轉換。

類型:字串LogicalTable物件地圖

地圖項目:項目數上限為 64。

索引鍵長度限制:長度下限為 1。長度上限為 64。

金鑰模式:[0-9a-zA-Z-]*

必要:否

Permissions

資料集的資源權限清單。

類型:的陣列ResourcePermission對象

陣列成員:項目數下限為 1。項目數上限為 64。

必要:否

RowLevelPermissionDataSet

您要建立之資料的資料列層級安全組態。

類型:RowLevelPermissionDataSet 物件

必要:否

RowLevelPermissionTagConfiguration

資料集上的標籤設定,以設定資料列層級的安全性。列層級安全性標籤目前僅支援匿名內嵌。

類型:RowLevelPermissionTagConfiguration 物件

必要:否

Tags

包含資源標籤或指派給資料集之標籤的鍵值組對映。

類型:的陣列Tag對象

陣列成員:項目數下限為 1。項目數上限為 200。

必要:否

回應語法

HTTP/1.1 Status Content-type: application/json { "Arn": "string", "DataSetId": "string", "IngestionArn": "string", "IngestionId": "string", "RequestId": "string" }

回應元素

如果動作成功,則服務傳回下列 HTTP 回應。

Status

請求的 HTTP 狀態。

服務會傳回下列 JSON 格式的資料。

Arn

資料集的 Amazon Resource Name (ARN)。

類型:字串

DataSetId

您要建立資料集的 ID,您要建立資料集的 ID,您要建立即要 此 ID 是每個唯一的AWS 區域的必要項目AWS帳戶。

類型:字串

IngestionArn

擷取的 ARN,如果匯入模式為 SPICE,則會因建立資料集而觸發。

類型:字串

IngestionId

擷取的識別碼,如果匯入模式為 SPICE,則會因建立資料集而觸發。

類型:字串

RequestId

所以此AWS此操作的請求 ID。

類型:字串

錯誤

如需所有動作常見的錯誤相關資訊,請參閱常見錯誤

AccessDeniedException

您無法存取此項目。提供的登入資料無法驗證。您可能無法取得授權以執行請求。確保您的帳戶被授權使用亞馬遜 QuickSight 服務,您的政策有正確許可,以及您使用正確的存取金鑰。

HTTP 狀態碼:401

ConflictException

更新或刪除資源可能會導致不一致的狀態。

HTTP 狀態碼:409

InternalFailureException

發生內部故障。

HTTP 狀態碼:500

InvalidParameterValueException

一或多個參數的值無效。

HTTP 狀態碼:400

LimitExceededException

已超過上限。

HTTP 狀態碼:409

ResourceExistsException

指定的資源已存在。

HTTP 狀態碼:409

ResourceNotFoundException

無法找到一個或多個資源。

HTTP 狀態碼:404

ThrottlingException

存取已調節。

HTTP 狀態碼:429

UnsupportedUserEditionException

此錯誤表示您正在呼叫 Amazon 上的操作 QuickSight訂閱版本不包括對該操作的支持。Amazon QuickSight 目前包含標準版和 Enterprise Edition (標準版)。不是每個版本都會提供所有操作和功能。

HTTP 狀態碼:403

範例

範例

這個例子說明了一個用法 CreateDataSet。

請求範例

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

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: