本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
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。此 ID 是每個唯一的AWS 區域For EeachAWS帳戶。
類型:字串
必要:是
- Name
-
資料來源的顯示名稱。
類型:字串
長度限制:長度下限為 1。長度上限為 128。
必要:是
- Type
-
資料來源的類型。若要傳回所有資料來源的清單,請使用
ListDataSources
。使用
AMAZON_ELASTICSEARCH
For Aight OpenSearch Service (服務)。類型:字串
有效值:
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 連接時使用 VPC 連接。
類型:VpcConnectionProperties 物件
必要:否
回應語法
HTTP/1.1 Status
Content-type: application/json
{
"Arn": "string",
"CreationStatus": "string",
"DataSourceId": "string",
"RequestId": "string"
}
回應元素
如果動作成功,則服務傳回下列 HTTP 回應。
- Status
-
請求的 HTTP 狀態。
服務會傳回下列 JSON 格式的資料。
- Arn
-
資料來源的 Amazon Resource Name (ARN)。
類型:字串
- CreationStatus
-
建立資料來源的狀態。
類型:字串
有效值:
CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED
- DataSourceId
-
資料來源的 ID。此 ID 是每個唯一的AWS 區域For EeachAWS帳戶。
類型:字串
- 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 的詳細資訊,請參閱下列說明: