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

Syntax

Update-QSTemplate
-TemplateId <String>
-SourceAnalysis_Arn <String>
-SourceTemplate_Arn <String>
-AwsAccountId <String>
-PaperMargin_Bottom <String>
-Definition_CalculatedField <CalculatedField[]>
-Definition_ColumnConfiguration <ColumnConfiguration[]>
-Definition_DataSetConfiguration <DataSetConfiguration[]>
-SourceAnalysis_DataSetReference <DataSetReference[]>
-Definition_FilterGroup <FilterGroup[]>
-PaperMargin_Left <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[]>
-ScreenCanvasSizeOptions_ResizeOption <ResizeOption>
-PaperMargin_Right <String>
-DefaultNewSheetConfiguration_SheetContentType <SheetContentType>
-Definition_Sheet <SheetDefinition[]>
-Options_Timezone <String>
-PaperMargin_Top <String>
-VersionDescription <String>
-Options_WeekStart <DayOfTheWeek>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonQuickSightConfig>

Description

Updates a template from an existing Amazon QuickSight analysis or another template.

Parameters

-AwsAccountId <String>
The ID of the Amazon Web Services account that contains the template that you're updating.
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)
-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 template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_CalculatedFields
-Definition_ColumnConfiguration <ColumnConfiguration[]>
An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_ColumnConfigurations
-Definition_DataSetConfiguration <DataSetConfiguration[]>
An array of dataset configurations. These configurations define the required columns for each dataset used within a template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_DataSetConfigurations
-Definition_FilterGroup <FilterGroup[]>
Filter definitions for a template.For more information, see Filtering Data in the Amazon QuickSight User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_FilterGroups
-Definition_ParameterDeclaration <ParameterDeclaration[]>
An array of parameter declarations for a template.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 template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_Sheets
-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)
-Name <String>
The name for the template.
Required?False
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
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the TemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TemplateId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.UpdateTemplateResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateTemplateResponse 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)
-SourceAnalysis_Arn <String>
The Amazon Resource Name (ARN) of the resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceEntity_SourceAnalysis_Arn
-SourceAnalysis_DataSetReference <DataSetReference[]>
A structure containing information about the dataset references used as placeholders in the template.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceEntity_SourceAnalysis_DataSetReferences
-SourceTemplate_Arn <String>
The Amazon Resource Name (ARN) of the resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceEntity_SourceTemplate_Arn
-TemplateId <String>
The ID for the template.
Required?True
Position?1
Accept pipeline input?True (ByValue, 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 of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

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