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