本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
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。对于每个 AWS 账户,此 ID 在每个 AWS 区域 中都是唯一的。
类型: 字符串
必需: 是
- ImportMode
-
指示是否要将数据导入 SPICE。
类型: 字符串
有效值:
SPICE | DIRECT_QUERY
必需: 是
- Name
-
数据集的显示名称。
类型: 字符串
长度限制:最小长度为 1。长度上限为 128。
必需: 是
- PhysicalTableMap
-
声明基础数据源中可用的物理表。
类型: 字符串PhysicalTable物体映射
地图条目:最少 0 项。最多 32 项。
密钥长度限制:最小长度为 1。最大长度为 64。
密钥模式:
[0-9a-zA-Z-]*
必需: 是
- ColumnGroups
-
在某些 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 资源名称(ARN)。
类型: 字符串
- DataSetId
-
要创建数据集的 ID。对于每个 AWS 账户,此 ID 在每个 AWS 区域 中都是唯一的。
类型: 字符串
- IngestionArn
-
摄取的 ARN,如果导入模式为 SPICE,则在创建数据集时触发。
类型: 字符串
- IngestionId
-
摄取的 ID,如果导入模式为 SPICE,则在创建数据集时触发。
类型: 字符串
- RequestId
-
这些区域有:AWS对于此操作的请求编号。
类型: 字符串
错误
有关所有操作常见错误的信息,请参阅常见错误.
- 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 当前具有标准版和企业版。每个版本中并未提供所有操作和功能。
HTTP 状态代码:403
示例
示例
此示例说明了一种用法 CreateDataSet.
示例请求
POST /accounts/{AwsAccountId}/data-sets HTTP/1.1
Content-type: application/json
另请参阅
有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: