本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeDataset
返回特定 DataBrew 数据集的定义。
请求语法
GET /datasets/name
HTTP/1.1
URI 请求参数
请求使用以下 URI 参数。
- name
-
要描述的数据集的名称。
长度约束:最小长度为 1。最大长度为 255。
必需:是
请求体
该请求没有请求正文。
响应语法
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"
}
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- Input
-
表示有关 DataBrew 如何在 Amazon S3 AWS Glue Data Catalog 或 Amazon S3 中查找数据的信息。
类型:Input 对象
- Name
-
数据集的名称。
类型:字符串
长度限制:长度下限为 1。最大长度为 255。
- CreateDate
-
数据集的创建日期和时间。
类型:时间戳
- CreatedBy
-
创建数据集的用户的标识符(用户名)。
类型:字符串
- Format
-
从 Amazon S3 文件或文件夹创建的数据集的文件格式。
类型:字符串
有效值:
CSV | JSON | PARQUET | EXCEL | ORC
- FormatOptions
-
表示一组选项,这些选项用于定义逗号分隔值 (CSV)、Excel 或 JSON 输入的结构。
类型:FormatOptions 对象
- LastModifiedBy
-
上次修改数据集的用户的标识符(用户名)。
类型:字符串
- LastModifiedDate
-
上次修改数据集的日期和时间。
类型:时间戳
- PathOptions
-
一组选项,用于定义如何 DataBrew 解释数据集的 Amazon S3 路径。
类型:PathOptions 对象
- ResourceArn
-
数据集的 Amazon 资源名称(ARN)。
类型:字符串
长度约束:最小长度为 20。最大长度为 2048。
- Source
-
此数据集的数据位置,Amazon S3 或 AWS Glue Data Catalog。
类型:字符串
有效值:
S3 | DATA-CATALOG | DATABASE
- Tags
-
与此数据集关联的元数据标签。
类型:字符串到字符串映射
地图条目:最大数量为 200 个项目。
密钥长度限制:最小长度为 1。长度上限为 128。
值长度限制:最大长度为 256。
错误
有关所有操作的常见错误信息,请参阅常见错误。
- ResourceNotFoundException
-
找不到一个或多个资源。
HTTP 状态代码:404
- ValidationException
-
此请求的输入参数未通过验证。
HTTP 状态代码:400
另请参阅
有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: