本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
CreateDataSource
创建数据源。
请求语法
POST /accounts/AwsAccountId
/data-sources 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
"
}
},
"DataSourceId": "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
",
"Permissions": [
{
"Actions": [ "string
" ],
"Principal": "string
"
}
],
"SslProperties": {
"DisableSsl": boolean
},
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
],
"Type": "string
",
"VpcConnectionProperties": {
"VpcConnectionArn": "string
"
}
}
URI 请求参数
请求使用以下 URI 参数。
- AwsAccountId
-
AWS 账户 ID。
长度约束:固定长度为 12。
模式:
^[0-9]{12}$
必需:是
请求正文
请求接受采用 JSON 格式的以下数据。
- DataSourceId
-
数据来源的 ID。对于每个 AWS 账户,此 ID 在每个 AWS 区域 中都是唯一的。
类型: 字符串
必需:是
- Name
-
数据源的显示名称。
类型: 字符串
长度约束:最小长度为 1。长度上限为 128。
必需:是
- Type
-
数据源的类型。要返回所有数据来源的列表,请使用
ListDataSources
。使用
AMAZON_ELASTICSEARCH
适用于Amazon OpenSearch 服务 。类型: 字符串
有效值:
ADOBE_ANALYTICS | AMAZON_ELASTICSEARCH | ATHENA | AURORA | AURORA_POSTGRESQL | AWS_IOT_ANALYTICS | GITHUB | JIRA | MARIADB | MYSQL | ORACLE | POSTGRESQL | PRESTO | REDSHIFT | S3 | SALESFORCE | SERVICENOW | SNOWFLAKE | SPARK | SQLSERVER | TERADATA | TWITTER | TIMESTREAM | AMAZON_OPENSEARCH | EXASOL
必需:是
- Credentials
-
亚马逊的凭证 QuickSight 用于连接到您的底层数据源的代码。目前,仅支持基于用户名和密码的凭证。
类型:DataSourceCredentials 对象
必需:否
- DataSourceParameters
-
亚马逊的参数 QuickSight 用于连接到您的底层数据源代码。
类型:DataSourceParameters 对象
必需:否
- Permissions
-
数据来源上的资源权限列表。
类型: 数组ResourcePermission对象
数组成员:最少 1 项。最多 64 项。
必需:否
- SslProperties
-
Amazon 应用的安全套接层 (SSL) 属性 QuickSight 连接到您的底层来源。
类型:SslProperties 对象
必需:否
- Tags
-
包含分配给数据来源的一个或多个资源标签的键值对映射。
类型: 数组Tag对象
数组成员:最少 1 项。最多 200 项。
必需:否
- VpcConnectionProperties
-
仅当您想要Amazon QuickSight ,以便在连接到您的底层数据源时使用 VPC 连接。
类型:VpcConnectionProperties 对象
必需:否
响应语法
HTTP/1.1 Status
Content-type: application/json
{
"Arn": "string",
"CreationStatus": "string",
"DataSourceId": "string",
"RequestId": "string"
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 响应。
- Status
-
请求的 HTTP 状态。
服务以 JSON 格式返回的以下数据。
- Arn
-
数据源的 Amazon 资源名称 (ARN)。
类型: 字符串
- CreationStatus
-
创建数据源的状态。
类型: 字符串
有效值:
CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED
- DataSourceId
-
数据源的 ID。对于每个 AWS 账户,此 ID 在每个 AWS 区域 中都是唯一的。
类型: 字符串
- RequestId
-
这些区域有:AWS用于此操作的请求 ID。
类型: 字符串
错误
有关所有操作共有的错误的信息,请参阅常见错误.
- AccessDeniedException
-
您无权访问此项目。无法验证提供的凭证。您可能无权执行请求。确保您的账户已获得使用亚马逊的授权 QuickSight 服务,您的策略具有正确的权限,并且您使用的是正确的访问密钥。
HTTP 状态代码:401
- ConflictException
-
更新或删除资源可能会导致状态不一致。
HTTP 状态代码:409
- InternalFailureException
-
出现内部故障。
HTTP 状态代码:500
- InvalidParameterValueException
-
一个或多个参数的值无效。
HTTP 状态代码:400
- LimitExceededException
-
超出限制。
HTTP 状态代码:409
- ResourceExistsException
-
已存在指定的资源。
HTTP 状态代码:409
- ResourceNotFoundException
-
无法找到一个或多个资源。
HTTP 状态代码:404
- ThrottlingException
-
访问受限。
HTTP 状态代码:429
示例
示例
此示例说明了一种用法 CreateDataSource.
示例请求
POST /accounts/{AwsAccountId}/data-sources HTTP/1.1 Content-type: application/json
另请参阅
有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: