AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon QuickSight CreateDataSet API operation.

Syntax

New-QSDataSet
-DataSetId <String>
-RowLevelPermissionDataSet_Arn <String>
-AwsAccountId <String>
-ColumnGroup <ColumnGroup[]>
-ColumnLevelPermissionRule <ColumnLevelPermissionRule[]>
-DatasetParameter <DatasetParameter[]>
-DataSetUsageConfiguration_DisableUseAsDirectQuerySource <Boolean>
-DataSetUsageConfiguration_DisableUseAsImportedSource <Boolean>
-FieldFolder <Hashtable>
-FolderArn <String[]>
-RowLevelPermissionDataSet_FormatVersion <RowLevelPermissionFormatVersion>
-ImportMode <DataSetImportMode>
-LogicalTableMap <Hashtable>
-Name <String>
-RowLevelPermissionDataSet_Namespace <String>
-RowLevelPermissionDataSet_PermissionPolicy <RowLevelPermissionPolicy>
-Permission <ResourcePermission[]>
-PhysicalTableMap <Hashtable>
-RowLevelPermissionDataSet_Status <Status>
-RowLevelPermissionTagConfiguration_Status <Status>
-RowLevelPermissionTagConfiguration_TagRuleConfiguration <String[][]>
-RowLevelPermissionTagConfiguration_TagRule <RowLevelPermissionTagRule[]>
-Tag <Tag[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonQuickSightConfig>

Description

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

Parameters

-AwsAccountId <String>
The Amazon Web Services account ID.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonQuickSightConfig>
Amazon.PowerShell.Cmdlets.QS.AmazonQuickSightClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ColumnGroup <ColumnGroup[]>
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesColumnGroups
-ColumnLevelPermissionRule <ColumnLevelPermissionRule[]>
A set of one or more definitions of a ColumnLevelPermissionRule.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesColumnLevelPermissionRules
-DataSetId <String>
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.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DatasetParameter <DatasetParameter[]>
The parameter declarations of the dataset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDatasetParameters
-DataSetUsageConfiguration_DisableUseAsDirectQuerySource <Boolean>
An option that controls whether a child dataset of a direct query can use this dataset as a source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSetUsageConfiguration_DisableUseAsImportedSource <Boolean>
An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FieldFolder <Hashtable>
The folder that contains fields and nested subfolders for your dataset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFieldFolders
-FolderArn <String[]>
When you create the dataset, Amazon QuickSight adds the dataset to these folders.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFolderArns
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ImportMode <DataSetImportMode>
Indicates whether you want to import the data into SPICE.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogicalTableMap <Hashtable>
Configures the combination and transformation of the data from the physical tables.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The display name for the dataset.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DataSetId parameter. The -PassThru parameter is deprecated, use -Select '^DataSetId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Permission <ResourcePermission[]>
A list of resource permissions on the dataset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPermissions
-PhysicalTableMap <Hashtable>
Declares the physical tables that are available in the underlying data sources.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RowLevelPermissionDataSet_Arn <String>
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RowLevelPermissionDataSet_FormatVersion <RowLevelPermissionFormatVersion>
The user or group rules associated with the dataset that contains permissions for RLS.By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RowLevelPermissionDataSet_Namespace <String>
The namespace associated with the dataset that contains permissions for RLS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RowLevelPermissionDataSet_PermissionPolicy <RowLevelPermissionPolicy>
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RowLevelPermissionDataSet_Status <Status>
The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RowLevelPermissionTagConfiguration_Status <Status>
The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RowLevelPermissionTagConfiguration_TagRule <RowLevelPermissionTagRule[]>
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRowLevelPermissionTagConfiguration_TagRules
-RowLevelPermissionTagConfiguration_TagRuleConfiguration <String[][]>
A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRowLevelPermissionTagConfiguration_TagRuleConfigurations
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.QuickSight.Model.CreateDataSetResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateDataSetResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.QuickSight.Model.CreateDataSetResponse
This cmdlet returns an Amazon.QuickSight.Model.CreateDataSetResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z