翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# DescribeDataSet
データセットの説明を表示します。この操作は、アップロードされたファイルをソースとして含むデータセットをサポートしていません。
## リクエストの構文
```
GET /accounts/AwsAccountId/data-sets/DataSetId HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [AwsAccountId](#API_DescribeDataSet_RequestSyntax) **
AWS アカウント ID。
長さの制約: 固定長は 12 です。
パターン: `^[0-9]{12}$`
: 必須: はい
** [DataSetId](#API_DescribeDataSet_RequestSyntax) **
作成するデータセットの ID。この ID は、各 AWS アカウントの AWS リージョン ごとに一意です。
: 必須: はい
## リクエスト本文
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 Status
Content-type: application/json
{
"DataSet": {
"Arn": "string",
"ColumnGroups": [
{
"GeoSpatialColumnGroup": {
"Columns": [ "string" ],
"CountryCode": "string",
"Name": "string"
}
}
],
"ColumnLevelPermissionRules": [
{
"ColumnNames": [ "string" ],
"Principals": [ "string" ]
}
],
"ConsumedSpiceCapacityInBytes": number,
"CreatedTime": number,
"DataSetId": "string",
"DataSetUsageConfiguration": {
"DisableUseAsDirectQuerySource": boolean,
"DisableUseAsImportedSource": boolean
},
"FieldFolders": {
"string" : {
"columns": [ "string" ],
"description": "string"
}
},
"ImportMode": "string",
"LastUpdatedTime": number,
"LogicalTableMap": {
"string" : {
"Alias": "string",
"DataTransforms": [
{
"CastColumnTypeOperation": {
"ColumnName": "string",
"Format": "string",
"NewColumnType": "string"
},
"CreateColumnsOperation": {
"Columns": [
{
"ColumnId": "string",
"ColumnName": "string",
"Expression": "string"
}
]
},
"FilterOperation": {
"ConditionExpression": "string"
},
"ProjectOperation": {
"ProjectedColumns": [ "string" ]
},
"RenameColumnOperation": {
"ColumnName": "string",
"NewColumnName": "string"
},
"TagColumnOperation": {
"ColumnName": "string",
"Tags": [
{
"ColumnDescription": {
"Text": "string"
},
"ColumnGeographicRole": "string"
}
]
},
"UntagColumnOperation": {
"ColumnName": "string",
"TagNames": [ "string" ]
}
}
],
"Source": {
"DataSetArn": "string",
"JoinInstruction": {
"LeftJoinKeyProperties": {
"UniqueKey": boolean
},
"LeftOperand": "string",
"OnClause": "string",
"RightJoinKeyProperties": {
"UniqueKey": boolean
},
"RightOperand": "string",
"Type": "string"
},
"PhysicalTableId": "string"
}
}
},
"Name": "string",
"OutputColumns": [
{
"Description": "string",
"Name": "string",
"Type": "string"
}
],
"PhysicalTableMap": {
"string" : {
"CustomSql": {
"Columns": [
{
"Name": "string",
"Type": "string"
}
],
"DataSourceArn": "string",
"Name": "string",
"SqlQuery": "string"
},
"RelationalTable": {
"Catalog": "string",
"DataSourceArn": "string",
"InputColumns": [
{
"Name": "string",
"Type": "string"
}
],
"Name": "string",
"Schema": "string"
},
"S3Source": {
"DataSourceArn": "string",
"InputColumns": [
{
"Name": "string",
"Type": "string"
}
],
"UploadSettings": {
"ContainsHeader": boolean,
"Delimiter": "string",
"Format": "string",
"StartFromRow": number,
"TextQualifier": "string"
}
}
}
},
"RowLevelPermissionDataSet": {
"Arn": "string",
"FormatVersion": "string",
"Namespace": "string",
"PermissionPolicy": "string",
"Status": "string"
},
"RowLevelPermissionTagConfiguration": {
"Status": "string",
"TagRules": [
{
"ColumnName": "string",
"MatchAllValue": "string",
"TagKey": "string",
"TagMultiValueDelimiter": "string"
}
]
}
},
"RequestId": "string"
}
```
## レスポンス要素
アクションが成功すると、以下の HTTP レスポンスが返されます。
** [Status](#API_DescribeDataSet_ResponseSyntax) **
リクエストの HTTP ステータス。
サービスから以下のデータが JSON 形式で返されます。
** [DataSet](#API_DescribeDataSet_ResponseSyntax) **
データセットに関する情報。
型: [DataSet](API_DataSet.md) オブジェクト
** [RequestId](#API_DescribeDataSet_ResponseSyntax) **
-AWSこの処理のリクエスト ID。
Type: 文字列
## エラー
すべてのアクションに共通のエラーについては、「[共通エラー](CommonErrors.md)」を参照してください。
** AccessDeniedException **
このアイテムにはアクセスできません。提供された認証情報を検証できませんでした。リクエストを実行する権限がない可能性があります。あなたのアカウントがAmazonの使用を許可されていることを確認してください QuickSight サービスの利用を許可されていること、ポリシーに正しいアクセス許可があること、正しいアクセスキーを使っていることを確認してください。
HTTP ステータスコード: 401
** InternalFailureException **
内部エラーが発生しました。
HTTP ステータスコード: 500
** InvalidParameterValueException **
1 つ以上のパラメータに無効な値があります。
HTTP ステータスコード: 400
** ResourceNotFoundException **
1 つ以上のリソースが見つかりません。
HTTP ステータスコード: 404
** ThrottlingException **
アクセスが調整済みです。
HTTP ステータスコード: 429
## 例
### 例
この例で示すのは、 DescribeDataSet。
#### リクエスト例
```
GET /accounts/{AwsAccountId}/data-sets/{DataSetId} HTTP/1.1
Content-type: application/json
```
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/DescribeDataSet)
+ [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/DescribeDataSet)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/DescribeDataSet)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/DescribeDataSet)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/DescribeDataSet)
+ [AWS向け SDK JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/DescribeDataSet)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/DescribeDataSet)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/DescribeDataSet)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/DescribeDataSet)