本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeJob
返回特定 DataBrew 作业的定义。
请求语法
GET /jobs/name
HTTP/1.1
URI 请求参数
请求使用以下 URI 参数。
- name
-
要描述的任务的名称。
长度限制:长度下限为 1。最大长度为 240。
必需:是
请求体
该请求没有请求正文。
响应语法
HTTP/1.1 200
Content-type: application/json
{
"CreateDate": number,
"CreatedBy": "string",
"DatabaseOutputs": [
{
"DatabaseOptions": {
"TableName": "string",
"TempDirectory": {
"Bucket": "string",
"BucketOwner": "string",
"Key": "string"
}
},
"DatabaseOutputMode": "string",
"GlueConnectionName": "string"
}
],
"DataCatalogOutputs": [
{
"CatalogId": "string",
"DatabaseName": "string",
"DatabaseOptions": {
"TableName": "string",
"TempDirectory": {
"Bucket": "string",
"BucketOwner": "string",
"Key": "string"
}
},
"Overwrite": boolean,
"S3Options": {
"Location": {
"Bucket": "string",
"BucketOwner": "string",
"Key": "string"
}
},
"TableName": "string"
}
],
"DatasetName": "string",
"EncryptionKeyArn": "string",
"EncryptionMode": "string",
"JobSample": {
"Mode": "string",
"Size": number
},
"LastModifiedBy": "string",
"LastModifiedDate": number,
"LogSubscription": "string",
"MaxCapacity": number,
"MaxRetries": number,
"Name": "string",
"Outputs": [
{
"CompressionFormat": "string",
"Format": "string",
"FormatOptions": {
"Csv": {
"Delimiter": "string"
}
},
"Location": {
"Bucket": "string",
"BucketOwner": "string",
"Key": "string"
},
"MaxOutputFiles": number,
"Overwrite": boolean,
"PartitionColumns": [ "string" ]
}
],
"ProfileConfiguration": {
"ColumnStatisticsConfigurations": [
{
"Selectors": [
{
"Name": "string",
"Regex": "string"
}
],
"Statistics": {
"IncludedStatistics": [ "string" ],
"Overrides": [
{
"Parameters": {
"string" : "string"
},
"Statistic": "string"
}
]
}
}
],
"DatasetStatisticsConfiguration": {
"IncludedStatistics": [ "string" ],
"Overrides": [
{
"Parameters": {
"string" : "string"
},
"Statistic": "string"
}
]
},
"EntityDetectorConfiguration": {
"AllowedStatistics": [
{
"Statistics": [ "string" ]
}
],
"EntityTypes": [ "string" ]
},
"ProfileColumns": [
{
"Name": "string",
"Regex": "string"
}
]
},
"ProjectName": "string",
"RecipeReference": {
"Name": "string",
"RecipeVersion": "string"
},
"ResourceArn": "string",
"RoleArn": "string",
"Tags": {
"string" : "string"
},
"Timeout": number,
"Type": "string",
"ValidationConfigurations": [
{
"RulesetArn": "string",
"ValidationMode": "string"
}
]
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- Name
-
作业的名称。
类型:字符串
长度限制:长度下限为 1。最大长度为 240。
- CreateDate
-
创建作业的日期和时间。
类型:时间戳
- CreatedBy
-
与创建任务相关的用户的标识符(用户名)。
类型:字符串
- DatabaseOutputs
-
表示 JDBC 数据库输出对象的列表,该对象定义了要写入的 DataBrew 配方作业的输出目标。
类型:DatabaseOutput 对象数组
数组成员:最少 1 个物品。
- DataCatalogOutputs
-
一个或多个工件,用于表示运行作业的 Amazon Glue Data Catalog 输出。
类型:DataCatalogOutput 对象数组
数组成员:最少 1 个物品。
- DatasetName
-
作业所依据的数据集。
类型:字符串
长度限制:长度下限为 1。最大长度为 255。
- EncryptionKeyArn
-
用于保护任务的加密密钥的 Amazon 资源名称 (ARN)。
类型:字符串
长度约束:最小长度为 20。最大长度为 2048。
- EncryptionMode
-
作业的加密模式包括以下几种:
-
SSE-KMS
-使用由 Amazon KMS管理的密钥进行服务器端加密。 -
SSE-S3
- 使用 Amazon S3 托管密钥进行服务器端加密。
类型:字符串
有效值:
SSE-KMS | SSE-S3
-
- JobSample
-
仅适用于配置文件作业的示例配置。确定要执行分析作业的行数。
类型:JobSample 对象
- LastModifiedBy
-
上次修改作业的用户的标识符(用户名)。
类型:字符串
- LastModifiedDate
-
上次修改作业的日期和时间。
类型:时间戳
- LogSubscription
-
表示此任务是否启用了 Amazon CloudWatch 日志记录。
类型:字符串
有效值:
ENABLE | DISABLE
- MaxCapacity
-
作业处理数据时 DataBrew 可以消耗的最大计算节点数。
类型:整数
- MaxRetries
-
作业运行失败后重试此作业的最大次数。
类型:整数
有效范围:最小值为 0。
- Outputs
-
代表作业运行时 输出的一个或多个构件。
类型:Output 对象数组
数组成员:最少 1 个物品。
- ProfileConfiguration
-
配置文件作业的配置。用于选择列、进行评估和覆盖评估的默认参数。当配置为空时,分析作业将使用默认设置运行。
类型:ProfileConfiguration 对象
- ProjectName
-
与此工作相关的 DataBrew 项目。
类型:字符串
长度限制:长度下限为 1。最大长度为 255。
- RecipeReference
-
表示 DataBrew 配方的名称和版本。
类型:RecipeReference 对象
- ResourceArn
-
任务的亚马逊资源名称 (ARN)。
类型:字符串
长度约束:最小长度为 20。最大长度为 2048。
- RoleArn
-
DataBrew 运行任务时要扮演的 Amazon Identity and Access Management (IAM) 角色的 ARN。
类型:字符串
长度约束:最小长度为 20。最大长度为 2048。
- Tags
-
与此任务关联的元数据标签。
类型:字符串到字符串映射
地图条目:最大数量为 200 个项目。
密钥长度限制:最小长度为 1。长度上限为 128。
值长度限制:最大长度为 256。
- Timeout
-
作业的超时(以分钟为单位)。如果作业的运行时间超出此超时时间,作业将以
TIMEOUT
状态结束。类型:整数
有效范围:最小值为 0。
- Type
-
作业类型,必须是以下类型之一:
-
PROFILE
-该作业分析数据集以确定其大小、数据类型、数据分布等。 -
RECIPE
-该作业对数据集应用一个或多个转换。
类型:字符串
有效值:
PROFILE | RECIPE
-
- ValidationConfigurations
-
应用于配置文件作业的验证配置列表。
类型:ValidationConfiguration 对象数组
数组成员:最少 1 个物品。
错误
有关所有操作的常见错误信息,请参阅常见错误。
- ResourceNotFoundException
-
找不到一个或多个资源。
HTTP 状态代码:404
- ValidationException
-
此请求的输入参数未通过验证。
HTTP 状态代码:400
另请参阅
有关在特定语言的 Amazon SDK 中使用此 API 的更多信息,请参阅以下内容: