POST

/accounts/{AwsAccountId}/data-sets

http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/data-sets

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

Access Token Required: API Key

Path Parameters

AwsAccountIdstringrequired

The Amazon Web Services account ID.

Body Params

Namestringrequired

The display name for the dataset.

Tagsarray

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

DataSetIdstringrequired

An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

ImportModestringrequired

Indicates whether you want to import the data into SPICE.

Permissionsarray

A list of resource permissions on the dataset.

ColumnGroupsarray

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

FieldFoldersobject

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

LogicalTableMapobject

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

PhysicalTableMapobjectrequired

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

DataSetUsageConfigurationobject

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

RowLevelPermissionDataSetobject

Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the Amazon QuickSight User Guide. The option to deny permissions by setting <code>PermissionPolicy</code> to <code>DENY_ACCESS</code> is not supported for new RLS datasets.

ColumnLevelPermissionRulesarray

A set of one or more definitions of a <code> <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html">ColumnLevelPermissionRule</a> </code>.

RowLevelPermissionTagConfigurationobject

The configuration of tags on a dataset to set row-level security.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://quicksight.{region}.amazonaws.com/accounts/{AwsAccountId}/data-sets' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}