本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# DescribeDataset
<a name="API_DescribeDataset"></a>

返回特定 DataBrew 数据集的定义。

## 请求语法
<a name="API_DescribeDataset_RequestSyntax"></a>

```
GET /datasets/name HTTP/1.1
```

## URI 请求参数
<a name="API_DescribeDataset_RequestParameters"></a>

请求使用以下 URI 参数。

 ** [name](#API_DescribeDataset_RequestSyntax) **   <a name="databrew-DescribeDataset-request-uri-Name"></a>
要描述的数据集的名称。  
长度约束：最小长度为 1。最大长度为 255。  
是否必需：是

## 请求体
<a name="API_DescribeDataset_RequestBody"></a>

该请求没有请求正文。

## 响应语法
<a name="API_DescribeDataset_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "CreateDate": number,
   "CreatedBy": "string",
   "Format": "string",
   "FormatOptions": { 
      "Csv": { 
         "Delimiter": "string",
         "HeaderRow": boolean
      },
      "Excel": { 
         "HeaderRow": boolean,
         "SheetIndexes": [ number ],
         "SheetNames": [ "string" ]
      },
      "Json": { 
         "MultiLine": boolean
      }
   },
   "Input": { 
      "DatabaseInputDefinition": { 
         "DatabaseTableName": "string",
         "GlueConnectionName": "string",
         "QueryString": "string",
         "TempDirectory": { 
            "Bucket": "string",
            "BucketOwner": "string",
            "Key": "string"
         }
      },
      "DataCatalogInputDefinition": { 
         "CatalogId": "string",
         "DatabaseName": "string",
         "TableName": "string",
         "TempDirectory": { 
            "Bucket": "string",
            "BucketOwner": "string",
            "Key": "string"
         }
      },
      "Metadata": { 
         "SourceArn": "string"
      },
      "S3InputDefinition": { 
         "Bucket": "string",
         "BucketOwner": "string",
         "Key": "string"
      }
   },
   "LastModifiedBy": "string",
   "LastModifiedDate": number,
   "Name": "string",
   "PathOptions": { 
      "FilesLimit": { 
         "MaxFiles": number,
         "Order": "string",
         "OrderedBy": "string"
      },
      "LastModifiedDateCondition": { 
         "Expression": "string",
         "ValuesMap": { 
            "string" : "string" 
         }
      },
      "Parameters": { 
         "string" : { 
            "CreateColumn": boolean,
            "DatetimeOptions": { 
               "Format": "string",
               "LocaleCode": "string",
               "TimezoneOffset": "string"
            },
            "Filter": { 
               "Expression": "string",
               "ValuesMap": { 
                  "string" : "string" 
               }
            },
            "Name": "string",
            "Type": "string"
         }
      }
   },
   "ResourceArn": "string",
   "Source": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## 响应元素
<a name="API_DescribeDataset_ResponseElements"></a>

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

 ** [Input](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-Input"></a>
表示有关 DataBrew 如何在 Amazon S3 AWS Glue Data Catalog 或 Amazon S3 中查找数据的信息。  
类型：[Input](API_Input.md) 对象

 ** [Name](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-Name"></a>
数据集的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [CreateDate](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-CreateDate"></a>
数据集的创建日期和时间。  
类型：时间戳

 ** [CreatedBy](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-CreatedBy"></a>
创建数据集的用户的标识符（用户名）。  
类型：字符串

 ** [Format](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-Format"></a>
从 Amazon S3 文件或文件夹创建的数据集的文件格式。  
类型：字符串  
有效值：`CSV | JSON | PARQUET | EXCEL | ORC`

 ** [FormatOptions](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-FormatOptions"></a>
表示一组选项，这些选项用于定义逗号分隔值（CSV）、Excel 或 JSON 输入的结构。  
类型：[FormatOptions](API_FormatOptions.md) 对象

 ** [LastModifiedBy](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-LastModifiedBy"></a>
上次修改数据集的用户的标识符（用户名）。  
类型：字符串

 ** [LastModifiedDate](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-LastModifiedDate"></a>
上次修改数据集的日期和时间。  
类型：时间戳

 ** [PathOptions](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-PathOptions"></a>
一组选项，用于定义如何 DataBrew 解释数据集的 Amazon S3 路径。  
类型：[PathOptions](API_PathOptions.md) 对象

 ** [ResourceArn](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-ResourceArn"></a>
数据集的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。

 ** [Source](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-Source"></a>
此数据集的数据位置：Amazon S3 或 AWS Glue Data Catalog。  
类型：字符串  
有效值：`S3 | DATA-CATALOG | DATABASE`

 ** [Tags](#API_DescribeDataset_ResponseSyntax) **   <a name="databrew-DescribeDataset-response-Tags"></a>
与此数据集关联的元数据标签。  
类型：字符串到字符串映射  
地图条目：最大数量为 200 个项目。  
密钥长度限制：最小长度为 1。最大长度为 128。  
值长度限制：最大长度为 256。

## 错误
<a name="API_DescribeDataset_Errors"></a>

有关所有操作的常见错误的信息，请参阅[常见错误](CommonErrors.md)。

 ** ResourceNotFoundException **   
无法找到一个或多个资源。  
HTTP 状态代码：404

 ** ValidationException **   
此请求的输入参数验证失败。  
HTTP 状态代码：400

## 另请参阅
<a name="API_DescribeDataset_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/databrew-2017-07-25/DescribeDataset) 
+  [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/databrew-2017-07-25/DescribeDataset) 
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/databrew-2017-07-25/DescribeDataset) 
+  [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/databrew-2017-07-25/DescribeDataset) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/databrew-2017-07-25/DescribeDataset) 
+  [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/databrew-2017-07-25/DescribeDataset) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/databrew-2017-07-25/DescribeDataset) 
+  [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/databrew-2017-07-25/DescribeDataset) 
+  [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/databrew-2017-07-25/DescribeDataset) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/databrew-2017-07-25/DescribeDataset)