翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
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 アカウントの AWS リージョン ごとに一意です。
Type: 文字列
必須: はい
- Name
-
データソースの表示名。
Type: 文字列
長さの制約: 最小長は 1 です｡ 最大長は 128 です。
必須: はい
- Type
-
データソースのタイプ。すべてのデータソースのリストを返すには、
ListDataSourcesを使用します。を使用する
AMAZON_ELASTICSEARCHアマゾンのため OpenSearch サービス。Type: 文字列
有効な値:
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
-
Amazonが使用するパラメータ QuickSight 基になるソースに接続するために使用。
型: DataSourceParameters オブジェクト
必須: いいえ
- Permissions
-
データソースに対するリソースのアクセス許可のリスト。
Type: 配列ResourcePermissionオブジェクト
配列メンバー: 最小数は 1 項目です。最大数は 64 項目です。
必須: いいえ
- SslProperties
-
Amazon が使用する場合に適用される Secure Layer (SSL) プロパティ QuickSight 基盤となるソースに接続します。
型: SslProperties オブジェクト
必須: いいえ
- Tags
-
データソースに割り当てられたリソースタグのキーと値のペアのマップが含まれます。
Type: 配列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)。
Type: 文字列
- CreationStatus
-
データソースの作成ステータス。
Type: 文字列
有効な値:
CREATION_IN_PROGRESS | CREATION_SUCCESSFUL | CREATION_FAILED | UPDATE_IN_PROGRESS | UPDATE_SUCCESSFUL | UPDATE_FAILED | DELETED - DataSourceId
-
データソースの ID。この ID は、各 AWS アカウントの AWS リージョン ごとに一意です。
Type: 文字列
- RequestId
-
-AWSこの処理のリクエスト ID。
Type: 文字列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
この項目へのアクセス権限がありません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。あなたのアカウントがAmazonの使用を許可されていることを確認してください QuickSight ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。
HTTP ステータスコード: 401
- ConflictException
-
リソースを更新または削除すると、一貫性のない状態が発生する可能性があります。
HTTP ステータスコード: 409
- InternalFailureException
-
内部エラーが発生しました。
HTTP ステータスコード: 500
- InvalidParameterValueException
-
1 つ以上のパラメータに無効な値があります。
HTTP ステータスコード: 400
- LimitExceededException
-
制限を超過しています。
HTTP ステータスコード: 409
- ResourceExistsException
-
指定されたリソースは既に存在します。
HTTP ステータスコード: 409
- ResourceNotFoundException
-
1 つ以上のリソースが見つかりません。
HTTP ステータスコード: 404
- ThrottlingException
-
アクセスが調整済みです。
HTTP ステータスコード: 429
例
例
この例で示すのは、 CreateDataSource。
リクエスト例
POST /accounts/{AwsAccountId}/data-sources HTTP/1.1 Content-type: application/json
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
