翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
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 は、各 AWS アカウントの AWS リージョン ごとに一意です。
Type: 文字列
必須: はい
- ImportMode
-
データを SPICE にインポートするかどうかを示す。
Type: 文字列
有効な値:
SPICE | DIRECT_QUERY
必須: はい
- Name
-
データセットの表示名。
Type: 文字列
長さの制約: 最小長は 1 です。 最大長は 128 です。
必須: はい
- PhysicalTableMap
-
基になるデータソースで使用可能な物理テーブルを宣言します。
Type: 文字列PhysicalTableオブジェクトマップ
マップエントリ: 最小項目数は 0 です。最大数は 32 項目です。
キーの長さの制約: 最小長は 1 です。 最大長は 64 文字です。
キーパターン:
[0-9a-zA-Z-]*
必須: はい
- ColumnGroups
-
特定の Amazon で連携して機能する列のグループ QuickSight します。。。現在、地理空間階層のみがサポートされています。
Type: 配列ColumnGroupオブジェクト
配列メンバー: 最小数は 1 項目です。最大数は 8 項目です。
必須: いいえ
- ColumnLevelPermissionRules
-
ColumnLevelPermissionRule
の 1 つ以上の定義セット。Type: 配列ColumnLevelPermissionRuleオブジェクト
配列メンバー: 最小数は 1 項目です。
必須: いいえ
- DataSetUsageConfiguration
-
このデータセットをソースとして参照する子データセットに適用する使用構成。
型: DataSetUsageConfiguration オブジェクト
必須: いいえ
- FieldFolders
-
データセットのフィールドとネストされたサブフォルダを含むフォルダ。
Type: 文字列FieldFolderオブジェクトマップ
キーの長さの制約: 最小長は 1 です。 最大長は 1,000 です。
必須: いいえ
- LogicalTableMap
-
物理テーブルからのデータの組み合わせと変換を設定します。
Type: 文字列LogicalTableオブジェクトマップ
マップエントリ: 最大数は 64 項目です。
キーの長さの制約: 最小長は 1 です。 最大長は 64 文字です。
キーパターン:
[0-9a-zA-Z-]*
必須: いいえ
- Permissions
-
データセットに対するリソースのアクセス許可のリスト。
Type: 配列ResourcePermissionオブジェクト
配列メンバー: 最小数は 1 項目です。最大数は 64 項目です。
必須: いいえ
- RowLevelPermissionDataSet
-
作成するデータに対する行レベルのセキュリティ設定。
型: RowLevelPermissionDataSet オブジェクト
必須: いいえ
- RowLevelPermissionTagConfiguration
-
行レベルのセキュリティを設定するためのデータセット上のタグの構成。行レベルのセキュリティタグは、現在、匿名埋め込みでのみサポートされています。
型: RowLevelPermissionTagConfiguration オブジェクト
必須: いいえ
- Tags
-
データセットに割り当てられたリソースタグのキーと値のペアのマップが含まれます。
Type: 配列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)。
Type: 文字列
- DataSetId
-
作成するデータセットの ID。この ID は、各 AWS アカウントの AWS リージョン ごとに一意です。
Type: 文字列
- IngestionArn
-
インポートモードが SPICE の場合、データセット作成の結果としてトリガーされる取り込みの ARN。
Type: 文字列
- IngestionId
-
インポートモードが SPICE の場合、データセット作成の結果としてトリガーされる取り込みの ID。
Type: 文字列
- RequestId
-
-AWSこの処理のリクエストID。
Type: 文字列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
この項目にはアクセスできません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。アカウントがAmazonの使用を許可されていることを確認してください QuickSight ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。
HTTP ステータスコード: 401
- ConflictException
-
リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。
HTTP ステータスコード: 409
- InternalFailureException
-
内部エラーが発生しました。
HTTP ステータスコード: 500
- InvalidParameterValueException
-
1 つ以上のパラメータに無効な値があります。
HTTP ステータスコード: 400
- LimitExceededException
-
制限を超過しています。
HTTP ステータスコード: 409
- ResourceExistsException
-
指定されたリソースは既に存在します。
HTTP ステータスコード: 409
- ResourceNotFoundException
-
1 つ以上のリソースが見つかりません。
HTTP ステータスコード: 404
- ThrottlingException
-
アクセスが調整済みです。
HTTP ステータスコード: 429
- UnsupportedUserEditionException
-
このエラーは、Amazonでオペレーションを呼び出していることを示します。 QuickSightエディションにその操作のサポートが含まれていないサブスクリプション。アマゾンアマゾン QuickSight 現在、Standard Edition があります。すべてのオペレーションと機能がすべてのエディションで利用できるわけではありません。
HTTP ステータスコード: 403
例
例
この例で示すのは、以下の機能の使用方法の CreateDataSet。
リクエスト例
POST /accounts/{AwsAccountId}/data-sets HTTP/1.1
Content-type: application/json
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。