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 CreateDashboard API operation.

Syntax

New-QSDashboard
-DashboardId <String>
-SourceTemplate_Arn <String>
-AdHocFilteringOption_AvailabilityStatus <DashboardBehavior>
-DataPointDrillUpDownOption_AvailabilityStatus <DashboardBehavior>
-DataPointMenuLabelOption_AvailabilityStatus <DashboardBehavior>
-DataPointTooltipOption_AvailabilityStatus <DashboardBehavior>
-ExportToCSVOption_AvailabilityStatus <DashboardBehavior>
-ExportWithHiddenFieldsOption_AvailabilityStatus <DashboardBehavior>
-SheetLayoutElementMaximizationOption_AvailabilityStatus <DashboardBehavior>
-VisualAxisSortOption_AvailabilityStatus <DashboardBehavior>
-VisualMenuOption_AvailabilityStatus <DashboardBehavior>
-ExportHiddenFieldsOption_AvailabilityStatus <DashboardBehavior>
-AwsAccountId <String>
-PaperMargin_Bottom <String>
-Definition_CalculatedField <CalculatedField[]>
-Definition_ColumnConfiguration <ColumnConfiguration[]>
-Definition_DataSetIdentifierDeclaration <DataSetIdentifierDeclaration[]>
-SourceTemplate_DataSetReference <DataSetReference[]>
-Parameters_DateTimeParameter <DateTimeParameter[]>
-Parameters_DecimalParameter <DecimalParameter[]>
-Definition_FilterGroup <FilterGroup[]>
-FolderArn <String[]>
-Parameters_IntegerParameter <IntegerParameter[]>
-PaperMargin_Left <String>
-LinkEntity <String[]>
-ValidationStrategy_Mode <ValidationStrategyMode>
-Name <String>
-Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_FreeForm_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth <String>
-Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_Grid_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth <String>
-PaperCanvasSizeOptions_PaperOrientation <PaperOrientation>
-PaperCanvasSizeOptions_PaperSize <PaperSize>
-Definition_ParameterDeclaration <ParameterDeclaration[]>
-LinkSharingConfiguration_Permission <ResourcePermission[]>
-Permission <ResourcePermission[]>
-ScreenCanvasSizeOptions_ResizeOption <ResizeOption>
-PaperMargin_Right <String>
-DefaultNewSheetConfiguration_SheetContentType <SheetContentType>
-Definition_Sheet <SheetDefinition[]>
-Parameters_StringParameter <StringParameter[]>
-Tag <Tag[]>
-ThemeArn <String>
-Options_Timezone <String>
-PaperMargin_Top <String>
-VersionDescription <String>
-SheetControlsOption_VisibilityState <DashboardUIState>
-Options_WeekStart <DayOfTheWeek>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonQuickSightConfig>

Description

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.

Parameters

-AdHocFilteringOption_AvailabilityStatus <DashboardBehavior>
Availability status.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDashboardPublishOptions_AdHocFilteringOption_AvailabilityStatus
-AwsAccountId <String>
The ID of the Amazon Web Services account where you want to create the dashboard.
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)
-DashboardId <String>
The ID for the dashboard, also added to the IAM policy.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-DataPointDrillUpDownOption_AvailabilityStatus <DashboardBehavior>
The status of the drill down options of data points.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDashboardPublishOptions_DataPointDrillUpDownOption_AvailabilityStatus
-DataPointMenuLabelOption_AvailabilityStatus <DashboardBehavior>
The status of the data point menu options.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDashboardPublishOptions_DataPointMenuLabelOption_AvailabilityStatus
-DataPointTooltipOption_AvailabilityStatus <DashboardBehavior>
The status of the data point tool tip options.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDashboardPublishOptions_DataPointTooltipOption_AvailabilityStatus
-DefaultNewSheetConfiguration_SheetContentType <SheetContentType>
The option that determines the sheet content type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_AnalysisDefaults_DefaultNewSheetConfiguration_SheetContentType
-Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_FreeForm_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth <String>
The width that the view port will be optimized for when the layout renders.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesScreenCanvasSizeOptions_OptimizedViewPortWidth
-Definition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_Grid_CanvasSizeOptions_ScreenCanvasSizeOptions_OptimizedViewPortWidth <String>
The width that the view port will be optimized for when the layout renders.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Definition_CalculatedField <CalculatedField[]>
An array of calculated field definitions for the dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_CalculatedFields
-Definition_ColumnConfiguration <ColumnConfiguration[]>
An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_ColumnConfigurations
-Definition_DataSetIdentifierDeclaration <DataSetIdentifierDeclaration[]>
An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_DataSetIdentifierDeclarations
-Definition_FilterGroup <FilterGroup[]>
The filter definitions for a dashboard.For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_FilterGroups
-Definition_ParameterDeclaration <ParameterDeclaration[]>
The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_ParameterDeclarations
-Definition_Sheet <SheetDefinition[]>
An array of sheet definitions for a dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_Sheets
-ExportHiddenFieldsOption_AvailabilityStatus <DashboardBehavior>
The status of the export hidden fields options of a dashbaord.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDashboardPublishOptions_VisualPublishOptions_ExportHiddenFieldsOption_AvailabilityStatus
-ExportToCSVOption_AvailabilityStatus <DashboardBehavior>
Availability status.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDashboardPublishOptions_ExportToCSVOption_AvailabilityStatus
-ExportWithHiddenFieldsOption_AvailabilityStatus <DashboardBehavior>
The status of the export with hidden fields options.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDashboardPublishOptions_ExportWithHiddenFieldsOption_AvailabilityStatus
-FolderArn <String[]>
When you create the dashboard, Amazon QuickSight adds the dashboard 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)
-LinkEntity <String[]>
A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLinkEntities
-LinkSharingConfiguration_Permission <ResourcePermission[]>
A structure that contains the permissions of a shareable link.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLinkSharingConfiguration_Permissions
-Name <String>
The display name of the dashboard.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_Timezone <String>
Determines the timezone for the analysis.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_Options_Timezone
-Options_WeekStart <DayOfTheWeek>
Determines the week start day for an analysis.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_Options_WeekStart
-PaperCanvasSizeOptions_PaperOrientation <PaperOrientation>
The paper orientation that is used to define canvas dimensions. Choose one of the following options:
  • PORTRAIT
  • LANDSCAPE
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_AnalysisDefaults_DefaultNewSheetConfiguration_PaginatedLayoutConfiguration_SectionBased_CanvasSizeOptions_PaperCanvasSizeOptions_PaperOrientation
-PaperCanvasSizeOptions_PaperSize <PaperSize>
The paper size that is used to define canvas dimensions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_AnalysisDefaults_DefaultNewSheetConfiguration_PaginatedLayoutConfiguration_SectionBased_CanvasSizeOptions_PaperCanvasSizeOptions_PaperSize
-PaperMargin_Bottom <String>
Define the bottom spacing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_AnalysisDefaults_DefaultNewSheetConfiguration_PaginatedLayoutConfiguration_SectionBased_CanvasSizeOptions_PaperCanvasSizeOptions_PaperMargin_Bottom
-PaperMargin_Left <String>
Define the left spacing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_AnalysisDefaults_DefaultNewSheetConfiguration_PaginatedLayoutConfiguration_SectionBased_CanvasSizeOptions_PaperCanvasSizeOptions_PaperMargin_Left
-PaperMargin_Right <String>
Define the right spacing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_AnalysisDefaults_DefaultNewSheetConfiguration_PaginatedLayoutConfiguration_SectionBased_CanvasSizeOptions_PaperCanvasSizeOptions_PaperMargin_Right
-PaperMargin_Top <String>
Define the top spacing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_AnalysisDefaults_DefaultNewSheetConfiguration_PaginatedLayoutConfiguration_SectionBased_CanvasSizeOptions_PaperCanvasSizeOptions_PaperMargin_Top
-Parameters_DateTimeParameter <DateTimeParameter[]>
The parameters that have a data type of date-time.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_DateTimeParameters
-Parameters_DecimalParameter <DecimalParameter[]>
The parameters that have a data type of decimal.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_DecimalParameters
-Parameters_IntegerParameter <IntegerParameter[]>
The parameters that have a data type of integer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_IntegerParameters
-Parameters_StringParameter <StringParameter[]>
The parameters that have a data type of string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_StringParameters
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DashboardId parameter. The -PassThru parameter is deprecated, use -Select '^DashboardId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Permission <ResourcePermission[]>
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN. To specify no permissions, omit the permissions list.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPermissions
-ScreenCanvasSizeOptions_ResizeOption <ResizeOption>
This value determines the layout behavior when the viewport is resized.
  • FIXED: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called Classic.
  • RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called Tiled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_AnalysisDefaults_DefaultNewSheetConfiguration_InteractiveLayoutConfiguration_Grid_CanvasSizeOptions_ScreenCanvasSizeOptions_ResizeOption
-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.CreateDashboardResponse). Specifying the name of a property of type Amazon.QuickSight.Model.CreateDashboardResponse 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)
-SheetControlsOption_VisibilityState <DashboardUIState>
Visibility state.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDashboardPublishOptions_SheetControlsOption_VisibilityState
-SheetLayoutElementMaximizationOption_AvailabilityStatus <DashboardBehavior>
The status of the sheet layout maximization options of a dashbaord.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDashboardPublishOptions_SheetLayoutElementMaximizationOption_AvailabilityStatus
-SourceTemplate_Arn <String>
The Amazon Resource Name (ARN) of the resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceEntity_SourceTemplate_Arn
-SourceTemplate_DataSetReference <DataSetReference[]>
Dataset references.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceEntity_SourceTemplate_DataSetReferences
-Tag <Tag[]>
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-ThemeArn <String>
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ValidationStrategy_Mode <ValidationStrategyMode>
The mode of validation for the asset to be created or updated. When you set this value to STRICT, strict validation for every error is enforced. When you set this value to LENIENT, validation is skipped for specific UI errors.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VersionDescription <String>
A description for the first version of the dashboard being created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-VisualAxisSortOption_AvailabilityStatus <DashboardBehavior>
The availaiblity status of a visual's axis sort options.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDashboardPublishOptions_VisualAxisSortOption_AvailabilityStatus
-VisualMenuOption_AvailabilityStatus <DashboardBehavior>
The availaiblity status of a visual's menu options.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDashboardPublishOptions_VisualMenuOption_AvailabilityStatus

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.CreateDashboardResponse
This cmdlet returns an Amazon.QuickSight.Model.CreateDashboardResponse 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