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

Syntax

Update-QSDataSource
-DataSourceId <String>
-CredentialPair_AlternateDataSourceParameter <DataSourceParameters[]>
-AwsAccountId <String>
-ManifestFileLocation_Bucket <String>
-PrestoParameters_Catalog <String>
-RedshiftParameters_ClusterId <String>
-Credentials_CopySourceArn <String>
-AuroraParameters_Database <String>
-AuroraPostgreSqlParameters_Database <String>
-MariaDbParameters_Database <String>
-MySqlParameters_Database <String>
-OracleParameters_Database <String>
-PostgreSqlParameters_Database <String>
-RdsParameters_Database <String>
-RedshiftParameters_Database <String>
-SnowflakeParameters_Database <String>
-SqlServerParameters_Database <String>
-TeradataParameters_Database <String>
-AwsIotAnalyticsParameters_DataSetName <String>
-SslProperties_DisableSsl <Boolean>
-AmazonElasticsearchParameters_Domain <String>
-AmazonOpenSearchParameters_Domain <String>
-AuroraParameters_Host <String>
-AuroraPostgreSqlParameters_Host <String>
-DatabricksParameters_Host <String>
-ExasolParameters_Host <String>
-MariaDbParameters_Host <String>
-MySqlParameters_Host <String>
-OracleParameters_Host <String>
-PostgreSqlParameters_Host <String>
-PrestoParameters_Host <String>
-RedshiftParameters_Host <String>
-SnowflakeParameters_Host <String>
-SparkParameters_Host <String>
-SqlServerParameters_Host <String>
-TeradataParameters_Host <String>
-RdsParameters_InstanceId <String>
-ManifestFileLocation_Key <String>
-TwitterParameters_MaxRow <Int32>
-Name <String>
-CredentialPair_Password <String>
-AuroraParameters_Port <Int32>
-AuroraPostgreSqlParameters_Port <Int32>
-DatabricksParameters_Port <Int32>
-ExasolParameters_Port <Int32>
-MariaDbParameters_Port <Int32>
-MySqlParameters_Port <Int32>
-OracleParameters_Port <Int32>
-PostgreSqlParameters_Port <Int32>
-PrestoParameters_Port <Int32>
-RedshiftParameters_Port <Int32>
-SparkParameters_Port <Int32>
-SqlServerParameters_Port <Int32>
-TeradataParameters_Port <Int32>
-TwitterParameters_Query <String>
-AthenaParameters_RoleArn <String>
-S3Parameters_RoleArn <String>
-Credentials_SecretArn <String>
-JiraParameters_SiteBaseUrl <String>
-ServiceNowParameters_SiteBaseUrl <String>
-DatabricksParameters_SqlEndpointPath <String>
-CredentialPair_Username <String>
-VpcConnectionProperties_VpcConnectionArn <String>
-SnowflakeParameters_Warehouse <String>
-AthenaParameters_WorkGroup <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonQuickSightConfig>

Description

Updates a data source.

Parameters

-AmazonElasticsearchParameters_Domain <String>
The OpenSearch domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_AmazonElasticsearchParameters_Domain
-AmazonOpenSearchParameters_Domain <String>
The OpenSearch domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_AmazonOpenSearchParameters_Domain
-AthenaParameters_RoleArn <String>
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_AthenaParameters_RoleArn
-AthenaParameters_WorkGroup <String>
The workgroup that Amazon Athena uses.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_AthenaParameters_WorkGroup
-AuroraParameters_Database <String>
Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_AuroraParameters_Database
-AuroraParameters_Host <String>
Host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_AuroraParameters_Host
-AuroraParameters_Port <Int32>
Port.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_AuroraParameters_Port
-AuroraPostgreSqlParameters_Database <String>
The Amazon Aurora PostgreSQL database to connect to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_AuroraPostgreSqlParameters_Database
-AuroraPostgreSqlParameters_Host <String>
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_AuroraPostgreSqlParameters_Host
-AuroraPostgreSqlParameters_Port <Int32>
The port that Amazon Aurora PostgreSQL is listening on.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_AuroraPostgreSqlParameters_Port
-AwsAccountId <String>
The Amazon Web Services account ID.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsIotAnalyticsParameters_DataSetName <String>
Dataset name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_AwsIotAnalyticsParameters_DataSetName
-ClientConfig <AmazonQuickSightConfig>
Amazon.PowerShell.Cmdlets.QS.AmazonQuickSightClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CredentialPair_AlternateDataSourceParameter <DataSourceParameters[]>
A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCredentials_CredentialPair_AlternateDataSourceParameters
-CredentialPair_Password <String>
Password.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCredentials_CredentialPair_Password
-CredentialPair_Username <String>
User name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCredentials_CredentialPair_Username
-Credentials_CopySourceArn <String>
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Credentials_SecretArn <String>
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DatabricksParameters_Host <String>
The host name of the Databricks data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_DatabricksParameters_Host
-DatabricksParameters_Port <Int32>
The port for the Databricks data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_DatabricksParameters_Port
-DatabricksParameters_SqlEndpointPath <String>
The HTTP path of the Databricks data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_DatabricksParameters_SqlEndpointPath
-DataSourceId <String>
The ID of the data source. 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)
-ExasolParameters_Host <String>
The hostname or IP address of the Exasol data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_ExasolParameters_Host
-ExasolParameters_Port <Int32>
The port for the Exasol data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_ExasolParameters_Port
-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)
-JiraParameters_SiteBaseUrl <String>
The base URL of the Jira site.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_JiraParameters_SiteBaseUrl
-ManifestFileLocation_Bucket <String>
Amazon S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_S3Parameters_ManifestFileLocation_Bucket
-ManifestFileLocation_Key <String>
Amazon S3 key that identifies an object.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_S3Parameters_ManifestFileLocation_Key
-MariaDbParameters_Database <String>
Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_MariaDbParameters_Database
-MariaDbParameters_Host <String>
Host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_MariaDbParameters_Host
-MariaDbParameters_Port <Int32>
Port.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_MariaDbParameters_Port
-MySqlParameters_Database <String>
Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_MySqlParameters_Database
-MySqlParameters_Host <String>
Host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_MySqlParameters_Host
-MySqlParameters_Port <Int32>
Port.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_MySqlParameters_Port
-Name <String>
A display name for the data source.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OracleParameters_Database <String>
The database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_OracleParameters_Database
-OracleParameters_Host <String>
An Oracle host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_OracleParameters_Host
-OracleParameters_Port <Int32>
The port.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_OracleParameters_Port
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the DataSourceId parameter. The -PassThru parameter is deprecated, use -Select '^DataSourceId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PostgreSqlParameters_Database <String>
Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_PostgreSqlParameters_Database
-PostgreSqlParameters_Host <String>
Host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_PostgreSqlParameters_Host
-PostgreSqlParameters_Port <Int32>
Port.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_PostgreSqlParameters_Port
-PrestoParameters_Catalog <String>
Catalog.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_PrestoParameters_Catalog
-PrestoParameters_Host <String>
Host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_PrestoParameters_Host
-PrestoParameters_Port <Int32>
Port.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_PrestoParameters_Port
-RdsParameters_Database <String>
Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_RdsParameters_Database
-RdsParameters_InstanceId <String>
Instance ID.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_RdsParameters_InstanceId
-RedshiftParameters_ClusterId <String>
Cluster ID. This field can be blank if the Host and Port are provided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_RedshiftParameters_ClusterId
-RedshiftParameters_Database <String>
Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_RedshiftParameters_Database
-RedshiftParameters_Host <String>
Host. This field can be blank if ClusterId is provided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_RedshiftParameters_Host
-RedshiftParameters_Port <Int32>
Port. This field can be blank if the ClusterId is provided.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_RedshiftParameters_Port
-S3Parameters_RoleArn <String>
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_S3Parameters_RoleArn
-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.UpdateDataSourceResponse). Specifying the name of a property of type Amazon.QuickSight.Model.UpdateDataSourceResponse 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)
-ServiceNowParameters_SiteBaseUrl <String>
URL of the base site.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_ServiceNowParameters_SiteBaseUrl
-SnowflakeParameters_Database <String>
Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_SnowflakeParameters_Database
-SnowflakeParameters_Host <String>
Host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_SnowflakeParameters_Host
-SnowflakeParameters_Warehouse <String>
Warehouse.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_SnowflakeParameters_Warehouse
-SparkParameters_Host <String>
Host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_SparkParameters_Host
-SparkParameters_Port <Int32>
Port.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_SparkParameters_Port
-SqlServerParameters_Database <String>
Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_SqlServerParameters_Database
-SqlServerParameters_Host <String>
Host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_SqlServerParameters_Host
-SqlServerParameters_Port <Int32>
Port.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_SqlServerParameters_Port
-SslProperties_DisableSsl <Boolean>
A Boolean option to control whether SSL should be disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TeradataParameters_Database <String>
Database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_TeradataParameters_Database
-TeradataParameters_Host <String>
Host.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_TeradataParameters_Host
-TeradataParameters_Port <Int32>
Port.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_TeradataParameters_Port
-TwitterParameters_MaxRow <Int32>
Maximum number of rows to query Twitter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_TwitterParameters_MaxRows
-TwitterParameters_Query <String>
Twitter query string.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataSourceParameters_TwitterParameters_Query
-VpcConnectionProperties_VpcConnectionArn <String>
The Amazon Resource Name (ARN) for the VPC connection.
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.UpdateDataSourceResponse
This cmdlet returns an Amazon.QuickSight.Model.UpdateDataSourceResponse 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