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

Syntax

Update-QSAnalysis
-AnalysisId <String>
-SourceTemplate_Arn <String>
-AwsAccountId <String>
-PaperMargin_Bottom <String>
-Definition_CalculatedField <CalculatedField[]>
-Definition_ColumnConfiguration <ColumnConfiguration[]>
-Definition_DataSetIdentifierDeclaration <DataSetIdentifierDeclaration[]>
-SourceTemplate_DataSetReference <DataSetReference[]>
-Parameters_DateTimeParameter <DateTimeParameter[]>
-Parameters_DecimalParameter <DecimalParameter[]>
-Options_ExcludedDataSetArn <String[]>
-Definition_FilterGroup <FilterGroup[]>
-Parameters_IntegerParameter <IntegerParameter[]>
-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[]>
-Options_QBusinessInsightsStatus <QBusinessInsightsStatus>
-QueryExecutionOptions_QueryExecutionMode <QueryExecutionMode>
-ScreenCanvasSizeOptions_ResizeOption <ResizeOption>
-PaperMargin_Right <String>
-DefaultNewSheetConfiguration_SheetContentType <SheetContentType>
-Definition_Sheet <SheetDefinition[]>
-Definition_StaticFile <StaticFile[]>
-Parameters_StringParameter <StringParameter[]>
-ThemeArn <String>
-Options_Timezone <String>
-PaperMargin_Top <String>
-HighlightOperation_Trigger <VisualHighlightTrigger>
-Options_WeekStart <DayOfTheWeek>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonQuickSightConfig>

Description

Updates an analysis in Amazon Quick Sight

Parameters

-AnalysisId <String>
The ID for the analysis that you're updating. This ID displays in the URL of the analysis.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-AwsAccountId <String>
The ID of the Amazon Web Services account that contains the analysis 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 analysis. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_CalculatedFields
-Definition_ColumnConfiguration <ColumnConfiguration[]>
An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_ColumnConfigurations
-Definition_DataSetIdentifierDeclaration <DataSetIdentifierDeclaration[]>
An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_DataSetIdentifierDeclarations
-Definition_FilterGroup <FilterGroup[]>
Filter definitions for an analysis.For more information, see Filtering Data in Amazon Quick Sight in the Amazon Quick Suite User Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_FilterGroups
-Definition_ParameterDeclaration <ParameterDeclaration[]>
An array of parameter declarations for an analysis.Parameters are named variables that can transfer a value for use by an action or an object.For more information, see Parameters in Amazon Quick Sight in the Amazon Quick Suite User Guide. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_ParameterDeclarations
-Definition_Sheet <SheetDefinition[]>
An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_Sheets
-Definition_StaticFile <StaticFile[]>
The static files for the definition. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_StaticFiles
-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)
-HighlightOperation_Trigger <VisualHighlightTrigger>
Specifies whether a highlight operation is initiated by a click or hover, or whether it's disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_Options_CustomActionDefaults_HighlightOperation_Trigger
-Name <String>
A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon Quick Sight console.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Options_ExcludedDataSetArn <String[]>
A list of dataset ARNS to exclude from Dashboard Q&A. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_Options_ExcludedDataSetArns
-Options_QBusinessInsightsStatus <QBusinessInsightsStatus>
Determines whether insight summaries from Amazon Q Business are allowed in Dashboard Q&A.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_Options_QBusinessInsightsStatus
-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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_DateTimeParameters
-Parameters_DecimalParameter <DecimalParameter[]>
The parameters that have a data type of decimal. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_DecimalParameters
-Parameters_IntegerParameter <IntegerParameter[]>
The parameters that have a data type of integer. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_IntegerParameters
-Parameters_StringParameter <StringParameter[]>
The parameters that have a data type of string. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters_StringParameters
-QueryExecutionOptions_QueryExecutionMode <QueryExecutionMode>
A structure that describes the query execution mode.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDefinition_QueryExecutionOptions_QueryExecutionMode
-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 Quick Sight console, this option is called Classic.
  • RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the Quick Sight 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.UpdateAnalysisResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateAnalysisResponse 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)
-SourceTemplate_Arn <String>
The Amazon Resource Name (ARN) of the source template of an analysis.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceEntity_SourceTemplate_Arn
-SourceTemplate_DataSetReference <DataSetReference[]>
The dataset references of the source template of an analysis. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSourceEntity_SourceTemplate_DataSetReferences
-ThemeArn <String>
The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon Quick Sight console, make sure that you have access to it.
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)

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.UpdateAnalysisResponse
This cmdlet returns an Amazon.QuickSight.Model.UpdateAnalysisResponse object containing multiple properties.
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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