UpdateDataSource - Amazon QuickSight

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

UpdateDataSource

删除数据源。

请求语法

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": { "WorkGroup": "string" }, "AuroraParameters": { "Database": "string", "Host": "string", "Port": number }, "AuroraPostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "AwsIotAnalyticsParameters": { "DataSetName": "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", "Port": number }, "S3Parameters": { "ManifestFileLocation": { "Bucket": "string", "Key": "string" } }, "ServiceNowParameters": { "SiteBaseUrl": "string" }, "SnowflakeParameters": { "Database": "string", "Host": "string", "Warehouse": "string" }, "SparkParameters": { "Host": "string", "Port": number }, "SqlServerParameters": { "Database": "string", "Host": "string", "Port": number }, "TeradataParameters": { "Database": "string", "Host": "string", "Port": number }, "TwitterParameters": { "MaxRows": number, "Query": "string" } } ], "Password": "string", "Username": "string" } }, "DataSourceParameters": { "AmazonElasticsearchParameters": { "Domain": "string" }, "AmazonOpenSearchParameters": { "Domain": "string" }, "AthenaParameters": { "WorkGroup": "string" }, "AuroraParameters": { "Database": "string", "Host": "string", "Port": number }, "AuroraPostgreSqlParameters": { "Database": "string", "Host": "string", "Port": number }, "AwsIotAnalyticsParameters": { "DataSetName": "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", "Port": number }, "S3Parameters": { "ManifestFileLocation": { "Bucket": "string", "Key": "string" } }, "ServiceNowParameters": { "SiteBaseUrl": "string" }, "SnowflakeParameters": { "Database": "string", "Host": "string", "Warehouse": "string" }, "SparkParameters": { "Host": "string", "Port": number }, "SqlServerParameters": { "Database": "string", "Host": "string", "Port": number }, "TeradataParameters": { "Database": "string", "Host": "string", "Port": number }, "TwitterParameters": { "MaxRows": number, "Query": "string" } }, "Name": "string", "SslProperties": { "DisableSsl": boolean }, "VpcConnectionProperties": { "VpcConnectionArn": "string" } }

URI 请求参数

请求使用以下 URI 参数。

AwsAccountId

AWS 账户 ID。

长度限制: 固定长度为 12。

模式:^[0-9]{12}$

必需: 是

DataSourceId

数据源的 ID。对于每个 AWS 账户,此 ID 在每个 AWS 区域 中都是唯一的。

必需: 是

请求正文

请求接受采用 JSON 格式的以下数据。

Name

数据源的显示名称。

类型: 字符串

长度限制: 最小长度为 1。长度上限为 128。

必需: 是

Credentials

亚马逊的凭证 QuickSight 用于连接到您的底层数据源的内容。目前,仅支持基于用户名和密码的凭证。

类型:DataSourceCredentials 对象

必需: 否

DataSourceParameters

亚马逊的参数 QuickSight 用于连接到您的底层数据源。

类型:DataSourceParameters 对象

必需: 否

SslProperties

Amazon 应用的安全套接字层 (SSL) 属性 QuickSight 连接到您的底层来源。

类型:SslProperties 对象

必需: 否

VpcConnectionProperties

仅当您想要Amazon 时,才需要使用此参数 QuickSight 连接到基础数据源时使用 VPC 连接。

类型:VpcConnectionProperties 对象

必需: 否

响应语法

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

响应元素

如果此操作成功,则该服务将会发送回 HTTP 响应。

Status

请求的 HTTP 状态。

服务以 JSON 格式返回的以下数据。

Arn

数据源的 Amazon 资源名称 (ARN)。

类型: 字符串

DataSourceId

数据源的 ID。对于每个 AWS 账户,此 ID 在每个 AWS 区域 中都是唯一的。

类型: 字符串

RequestId

这些区域有:AWS用于此操作的请求 ID。

类型: 字符串

UpdateStatus

数据源上次更新的更新状态。

类型: 字符串

有效值: CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED

错误

有关所有操作常见错误的信息,请参阅常见错误.

AccessDeniedException

您无权访问此项目。无法验证提供的凭证。您可能无权执行请求。确保您的账户获得使用亚马逊的授权 QuickSight 服务,您的策略具有正确的权限,并且您使用的是正确的访问密钥。

HTTP 状态代码:401

ConflictException

更新或删除资源可能会导致状态不一致。

HTTP 状态代码:409

InternalFailureException

出现内部故障。

HTTP 状态代码:500

InvalidParameterValueException

一个或多个参数的值无效。

HTTP 状态代码:400

ResourceNotFoundException

无法找到一个或多个资源。

HTTP 状态代码:404

ThrottlingException

访问受限。

HTTP 状态代码:429

示例

示例

此示例说明了一种用法 UpdateDataSource.

示例请求

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

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: