本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeJobRun
代表一次DataBrew作业的运行。
请求语法
GET /jobs/name
/jobRun/runId
HTTP/1.1
URI 请求参数
请求使用以下 URI 参数。
请求正文
该请求没有请求体。
响应语法
HTTP/1.1 200
Content-type: application/json
{
"Attempt": number,
"CompletedOn": number,
"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",
"ErrorMessage": "string",
"ExecutionTime": number,
"JobName": "string",
"JobSample": {
"Mode": "string",
"Size": number
},
"LogGroupName": "string",
"LogSubscription": "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"
}
]
},
"RecipeReference": {
"Name": "string",
"RecipeVersion": "string"
},
"RunId": "string",
"StartedBy": "string",
"StartedOn": number,
"State": "string",
"ValidationConfigurations": [
{
"RulesetArn": "string",
"ValidationMode": "string"
}
]
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回的以下数据。
- JobName
-
此运行期间正在处理的任务的名称。
类型:字符串
长度限制:最小长度为 1。最大长度为 240。
- Attempt
-
尝试运行DataBrew的次数。
类型:整数
- CompletedOn
-
任务完成处理的日期和时间。
类型:时间戳
- DatabaseOutputs
-
表示一个 JDBC 数据库输出对象列表,它定义了DataBrew食谱作业的输出目标。
类型:DatabaseOutput 对象数组
数组成员:最少 1 项。
- DataCatalogOutputs
-
代表作业运行时 Amazon Glue Data Catalog 输出的一个或多个构件。
类型:DataCatalogOutput 对象数组
数组成员:最少 1 项。
- DatasetName
-
要处理的任务的数据集的名称。
类型:字符串
长度限制:最小长度为 1。最大长度为 255。
- ErrorMessage
-
一条消息,表示作业运行时遇到错误(如果有)。
类型:字符串
- ExecutionTime
-
任务运行使用资源的时间长度(以秒为单位)。
类型:整数
- JobSample
-
仅适用于配置文件作业的示例配置。确定要执行配置文件作业的行数。如果未提供JobSample值,则使用默认值。模式参数的默认值为 CUSTOM_ROWS,大小参数的默认值为 20000。
类型:JobSample 对象
- LogGroupName
-
Amazon CloudWatch 日志组的名称,作业运行时在其中写入诊断消息。
类型:字符串
长度限制:最小长度为 1。最大长度为 512。
- LogSubscription
-
任务运行的 Amazon CloudWatch 日志记录的当前状态。
类型:字符串
有效值:
ENABLE | DISABLE
- Outputs
-
任务运行中的一个或多个输出工件。
类型:Output 对象数组
数组成员:最少 1 项。
- ProfileConfiguration
-
配置文件作业的配置。用于选择列、进行评估并覆盖评估的默认参数。当 null 时,配置文件作业将使用默认设置运行。
类型:ProfileConfiguration 对象
- RecipeReference
-
代表DataBrew配方的名称和版本。
类型:RecipeReference 对象
- RunId
-
任务运行的唯一标识符。
类型:字符串
长度限制:最小长度为 1。最大长度为 255。
- StartedBy
-
启动任务运行的用户的 Amazon 资源名称(ARN)。
类型:字符串
- StartedOn
-
任务运行的开始日期和时间。
类型:时间戳
- State
-
任务运行实体本身的当前状态。
类型:字符串
有效值:
STARTING | RUNNING | STOPPING | STOPPED | SUCCEEDED | FAILED | TIMEOUT
- ValidationConfigurations
-
应用于配置文件作业的验证配置列表。
类型:ValidationConfiguration 对象数组
数组成员:最少 1 项。
错误
有关所有操作常见错误的信息,请参阅常见错误。
- ResourceNotFoundException
-
找不到一个或多个资源。
HTTP 状态代码:404
- ValidationException
-
此请求的输入参数未通过验证。
HTTP 状态代码:400
另请参阅
有关在特定语言的 Amazon 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: