UpdateDataSource - Amazon QuickSight

UpdateDataSource

Updates a data source.

Request Syntax

PUT /accounts/AwsAccountId/data-sources/DataSourceId HTTP/1.1 Content-type: application/json { "Credentials": { "CopySourceArn": "string", "CredentialPair": { "AlternateDataSourceParameters": [ { "AmazonElasticsearchParameters": { "Domain": "string" }, "AmazonOpenSearchParameters": { "Domain": "string" }, "AthenaParameters": { "RoleArn": "string", "WorkGroup": "string" }, "AuroraParameters": { "Database": "string", "Host": "string", "Port": number }, "AuroraPostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "AwsIotAnalyticsParameters": { "DataSetName": "string" }, "BigQueryParameters": { "DataSetRegion": "string", "ProjectId": "string" }, "DatabricksParameters": { "Host": "string", "Port": number, "SqlEndpointPath": "string" }, "ExasolParameters": { "Host": "string", "Port": number }, "JiraParameters": { "SiteBaseUrl": "string" }, "MariaDbParameters": { "Database": "string", "Host": "string", "Port": number }, "MySqlParameters": { "Database": "string", "Host": "string", "Port": number }, "OracleParameters": { "Database": "string", "Host": "string", "Port": number }, "PostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "PrestoParameters": { "Catalog": "string", "Host": "string", "Port": number }, "RdsParameters": { "Database": "string", "InstanceId": "string" }, "RedshiftParameters": { "ClusterId": "string", "Database": "string", "Host": "string", "IAMParameters": { "AutoCreateDatabaseUser": boolean, "DatabaseGroups": [ "string" ], "DatabaseUser": "string", "RoleArn": "string" }, "IdentityCenterConfiguration": { "EnableIdentityPropagation": boolean }, "Port": number }, "S3Parameters": { "ManifestFileLocation": { "Bucket": "string", "Key": "string" }, "RoleArn": "string" }, "ServiceNowParameters": { "SiteBaseUrl": "string" }, "SnowflakeParameters": { "Database": "string", "Host": "string", "Warehouse": "string" }, "SparkParameters": { "Host": "string", "Port": number }, "SqlServerParameters": { "Database": "string", "Host": "string", "Port": number }, "StarburstParameters": { "Catalog": "string", "Host": "string", "Port": number, "ProductType": "string" }, "TeradataParameters": { "Database": "string", "Host": "string", "Port": number }, "TrinoParameters": { "Catalog": "string", "Host": "string", "Port": number }, "TwitterParameters": { "MaxRows": number, "Query": "string" } } ], "Password": "string", "Username": "string" }, "SecretArn": "string" }, "DataSourceParameters": { "AmazonElasticsearchParameters": { "Domain": "string" }, "AmazonOpenSearchParameters": { "Domain": "string" }, "AthenaParameters": { "RoleArn": "string", "WorkGroup": "string" }, "AuroraParameters": { "Database": "string", "Host": "string", "Port": number }, "AuroraPostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "AwsIotAnalyticsParameters": { "DataSetName": "string" }, "BigQueryParameters": { "DataSetRegion": "string", "ProjectId": "string" }, "DatabricksParameters": { "Host": "string", "Port": number, "SqlEndpointPath": "string" }, "ExasolParameters": { "Host": "string", "Port": number }, "JiraParameters": { "SiteBaseUrl": "string" }, "MariaDbParameters": { "Database": "string", "Host": "string", "Port": number }, "MySqlParameters": { "Database": "string", "Host": "string", "Port": number }, "OracleParameters": { "Database": "string", "Host": "string", "Port": number }, "PostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "PrestoParameters": { "Catalog": "string", "Host": "string", "Port": number }, "RdsParameters": { "Database": "string", "InstanceId": "string" }, "RedshiftParameters": { "ClusterId": "string", "Database": "string", "Host": "string", "IAMParameters": { "AutoCreateDatabaseUser": boolean, "DatabaseGroups": [ "string" ], "DatabaseUser": "string", "RoleArn": "string" }, "IdentityCenterConfiguration": { "EnableIdentityPropagation": boolean }, "Port": number }, "S3Parameters": { "ManifestFileLocation": { "Bucket": "string", "Key": "string" }, "RoleArn": "string" }, "ServiceNowParameters": { "SiteBaseUrl": "string" }, "SnowflakeParameters": { "Database": "string", "Host": "string", "Warehouse": "string" }, "SparkParameters": { "Host": "string", "Port": number }, "SqlServerParameters": { "Database": "string", "Host": "string", "Port": number }, "StarburstParameters": { "Catalog": "string", "Host": "string", "Port": number, "ProductType": "string" }, "TeradataParameters": { "Database": "string", "Host": "string", "Port": number }, "TrinoParameters": { "Catalog": "string", "Host": "string", "Port": number }, "TwitterParameters": { "MaxRows": number, "Query": "string" } }, "Name": "string", "SslProperties": { "DisableSsl": boolean }, "VpcConnectionProperties": { "VpcConnectionArn": "string" } }

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The AWS account ID.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

DataSourceId

The ID of the data source. This ID is unique per AWS Region for each AWS account.

Required: Yes

Request Body

The request accepts the following data in JSON format.

Name

A display name for the data source.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Credentials

The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

Type: DataSourceCredentials object

Required: No

DataSourceParameters

The parameters that Amazon QuickSight uses to connect to your underlying source.

Type: DataSourceParameters object

Required: No

SslProperties

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

Type: SslProperties object

Required: No

VpcConnectionProperties

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

Type: VpcConnectionProperties object

Required: No

Response Syntax

HTTP/1.1 Status Content-type: application/json { "Arn": "string", "DataSourceId": "string", "RequestId": "string", "UpdateStatus": "string" }

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status

The HTTP status of the request.

The following data is returned in JSON format by the service.

Arn

The Amazon Resource Name (ARN) of the data source.

Type: String

DataSourceId

The ID of the data source. This ID is unique per AWS Region for each AWS account.

Type: String

RequestId

The AWS request ID for this operation.

Type: String

UpdateStatus

The update status of the data source's last update.

Type: String

Valid Values: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

CustomerManagedKeyUnavailableException

The customer managed key that is registered to your Amazon QuickSight account is unavailable.

HTTP Status Code: 400

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

HTTP Status Code: 429

Examples

Example

This example illustrates one usage of UpdateDataSource.

Sample Request

PUT /accounts/{AwsAccountId}/data-sources/{DataSourceId} HTTP/1.1 Content-type: application/json

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: