

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# DescribeDataSet
<a name="API_DescribeDataSet"></a>

說明資料集。這項作業不支援包含上傳檔案做為來源的資料集。

## 請求語法
<a name="API_DescribeDataSet_RequestSyntax"></a>

```
GET /accounts/AwsAccountId/data-sets/DataSetId HTTP/1.1
```

## URI 請求參數
<a name="API_DescribeDataSet_RequestParameters"></a>

請求會使用下列 URI 參數。

 ** [AwsAccountId](#API_DescribeDataSet_RequestSyntax) **   <a name="QS-DescribeDataSet-request-AwsAccountId"></a>
AWS 帳戶 ID。  
長度限制：12 的固定長度。  
模式：`^[0-9]{12}$`  
的必要項目：是

 ** [DataSetId](#API_DescribeDataSet_RequestSyntax) **   <a name="QS-DescribeDataSet-request-DataSetId"></a>
您要建立之資料集的 ID。此 ID 是每個唯一的AWS 區域For EeachAWS帳戶。  
的必要項目：是

## 請求主體
<a name="API_DescribeDataSet_RequestBody"></a>

請求沒有請求主體。

## 回應語法
<a name="API_DescribeDataSet_ResponseSyntax"></a>

```
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"
}
```

## 回應元素
<a name="API_DescribeDataSet_ResponseElements"></a>

如果動作成功，則服務傳回下列 HTTP 回應。

 ** [Status](#API_DescribeDataSet_ResponseSyntax) **   <a name="QS-DescribeDataSet-response-Status"></a>
請求的 HTTP 狀態。

服務會傳回下列 JSON 格式的資料。

 ** [DataSet](#API_DescribeDataSet_ResponseSyntax) **   <a name="QS-DescribeDataSet-response-DataSet"></a>
有關數據集的信息。  
類型：[DataSet](API_DataSet.md) 物件

 ** [RequestId](#API_DescribeDataSet_ResponseSyntax) **   <a name="QS-DescribeDataSet-response-RequestId"></a>
所以此AWS此操作的請求 ID。  
類型：字串

## 錯誤
<a name="API_DescribeDataSet_Errors"></a>

如需所有動作常見的錯誤相關資訊，請參閱[常見錯誤](CommonErrors.md)。

 ** AccessDeniedException **   
您無法存取。提供的登入資料無法驗證。您可能無法取得授權以執行請求。確保您的帳戶已獲授權使用亞馬遜 QuickSight 服務，您的政策有正確許可，以及您使用正確的存取金鑰。  
HTTP 狀態碼：401

 ** InternalFailureException **   
發生內部故障。  
HTTP 狀態碼：500

 ** InvalidParameterValueException **   
一或多個參數的值無效。  
HTTP 狀態碼：400

 ** ResourceNotFoundException **   
無法找到一個或多個資源。  
HTTP 狀態碼：404

 ** ThrottlingException **   
存取已調節。  
HTTP 狀態碼：429

## 範例
<a name="API_DescribeDataSet_Examples"></a>

### 範例
<a name="API_DescribeDataSet_Example_1"></a>

這個例子說明了一個用法 DescribeDataSet。

#### 請求範例
<a name="API_DescribeDataSet_Example_1_Request"></a>

```
GET /accounts/{AwsAccountId}/data-sets/{DataSetId} HTTP/1.1
Content-type: application/json
```

## 另請參閱
<a name="API_DescribeDataSet_SeeAlso"></a>

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊，請參閱下列說明：
+  [AWS 命令列界面](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/DescribeDataSet) 
+  [適用於 .NET 的 AWS 開發套件](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/DescribeDataSet) 
+  [適用於 C\$1\$1 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/DescribeDataSet) 
+  [適用於 Go 的 AWS 開發套件](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/DescribeDataSet) 
+  [適用於 Java 的 AWS 開發套件第 2 版](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/DescribeDataSet) 
+  [AWS適用於的開發 JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/DescribeDataSet) 
+  [適用於 PHP V3 的 AWS SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/DescribeDataSet) 
+  [適用於 Python 的 AWS SDK](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/DescribeDataSet) 
+  [適用於 Ruby 的 AWS 開發套件第 3 版](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/DescribeDataSet) 