Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

UpdateDataSet

Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.

Request Syntax


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" ]
      }
   ],
   "DatasetParameters": [ 
      { 
         "DateTimeDatasetParameter": { 
            "DefaultValues": { 
               "StaticValues": [ number ]
            },
            "Id": "string",
            "Name": "string",
            "TimeGranularity": "string",
            "ValueType": "string"
         },
         "DecimalDatasetParameter": { 
            "DefaultValues": { 
               "StaticValues": [ number ]
            },
            "Id": "string",
            "Name": "string",
            "ValueType": "string"
         },
         "IntegerDatasetParameter": { 
            "DefaultValues": { 
               "StaticValues": [ number ]
            },
            "Id": "string",
            "Name": "string",
            "ValueType": "string"
         },
         "StringDatasetParameter": { 
            "DefaultValues": { 
               "StaticValues": [ "string" ]
            },
            "Id": "string",
            "Name": "string",
            "ValueType": "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",
                  "SubType": "string"
               },
               "CreateColumnsOperation": { 
                  "Columns": [ 
                     { 
                        "ColumnId": "string",
                        "ColumnName": "string",
                        "Expression": "string"
                     }
                  ]
               },
               "FilterOperation": { 
                  "ConditionExpression": "string"
               },
               "OverrideDatasetParameterOperation": { 
                  "NewDefaultValues": { 
                     "DateTimeStaticValues": [ number ],
                     "DecimalStaticValues": [ number ],
                     "IntegerStaticValues": [ number ],
                     "StringStaticValues": [ "string" ]
                  },
                  "NewParameterName": "string",
                  "ParameterName": "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",
                  "SubType": "string",
                  "Type": "string"
               }
            ],
            "DataSourceArn": "string",
            "Name": "string",
            "SqlQuery": "string"
         },
         "RelationalTable": { 
            "Catalog": "string",
            "DataSourceArn": "string",
            "InputColumns": [ 
               { 
                  "Name": "string",
                  "SubType": "string",
                  "Type": "string"
               }
            ],
            "Name": "string",
            "Schema": "string"
         },
         "S3Source": { 
            "DataSourceArn": "string",
            "InputColumns": [ 
               { 
                  "Name": "string",
                  "SubType": "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",
      "TagRuleConfigurations": [ 
         [ "string" ]
      ],
      "TagRules": [ 
         { 
            "ColumnName": "string",
            "MatchAllValue": "string",
            "TagKey": "string",
            "TagMultiValueDelimiter": "string"
         }
      ]
   }
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The AWS account ID.

Length Constraints: Fixed length of 12.

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

Required: Yes

DataSetId

The ID for the dataset that you want to update. This ID is unique per AWS Region for each AWS account.

Required: Yes

Request Body

The request accepts the following data in JSON format.

ImportMode

Indicates whether you want to import the data into SPICE.

Type: String

Valid Values: SPICE | DIRECT_QUERY

Required: Yes

Name

The display name for the dataset.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

PhysicalTableMap

Declares the physical tables that are available in the underlying data sources.

Type: String to PhysicalTable object map

Map Entries: Minimum number of 0 items. Maximum number of 32 items.

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: [0-9a-zA-Z-]*

Required: Yes

ColumnGroups

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

Type: Array of ColumnGroup objects

Array Members: Minimum number of 1 item. Maximum number of 8 items.

Required: No

ColumnLevelPermissionRules

A set of one or more definitions of a ColumnLevelPermissionRule.

Type: Array of ColumnLevelPermissionRule objects

Array Members: Minimum number of 1 item.

Required: No

DatasetParameters

The parameter declarations of the dataset.

Type: Array of DatasetParameter objects

Array Members: Minimum number of 1 item. Maximum number of 32 items.

Required: No

DataSetUsageConfiguration

The usage configuration to apply to child datasets that reference this dataset as a source.

Type: DataSetUsageConfiguration object

Required: No

FieldFolders

The folder that contains fields and nested subfolders for your dataset.

Type: String to FieldFolder object map

Key Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: No

LogicalTableMap

Configures the combination and transformation of the data from the physical tables.

Type: String to LogicalTable object map

Map Entries: Maximum number of 64 items.

Key Length Constraints: Minimum length of 1. Maximum length of 64.

Key Pattern: [0-9a-zA-Z-]*

Required: No

RowLevelPermissionDataSet

The row-level security configuration for the data you want to create.

Type: RowLevelPermissionDataSet object

Required: No

RowLevelPermissionTagConfiguration

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

Type: RowLevelPermissionTagConfiguration object

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

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

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of the request.

The following data is returned in JSON format by the service.

Arn

The Amazon Resource Name (ARN) of the dataset.

Type: String

DataSetId

The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.

Type: String

IngestionArn

The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

Type: String

IngestionId

The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.

Type: String

RequestId

The AWS request ID for this operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

UnsupportedUserEditionException

This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

HTTP Status Code: 403

Examples

Example

This example illustrates one usage of UpdateDataSet.

Sample Request


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