

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

# DescribeJob
<a name="API_DescribeJob"></a>

返回特定 DataBrew 作业的定义。

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

```
GET /jobs/name HTTP/1.1
```

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

请求使用以下 URI 参数。

 ** [name](#API_DescribeJob_RequestSyntax) **   <a name="databrew-DescribeJob-request-uri-Name"></a>
要描述的作业的名称。  
长度限制：最小长度为 1。最大长度为 240。  
是否必需：是

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

该请求没有请求正文。

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

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

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

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

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

 ** [Name](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Name"></a>
 作业的名称。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 240。

 ** [CreateDate](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-CreateDate"></a>
创建作业的日期和时间。  
类型：时间戳

 ** [CreatedBy](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-CreatedBy"></a>
与创建作业关联的用户的标识符（用户名）。  
类型：字符串

 ** [DatabaseOutputs](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-DatabaseOutputs"></a>
表示 JDBC 数据库输出对象的列表，该对象定义了要写入的 DataBrew 配方作业的输出目标。  
类型：[DatabaseOutput](API_DatabaseOutput.md) 对象数组  
数组成员：最少 1 个物品。

 ** [DataCatalogOutputs](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-DataCatalogOutputs"></a>
一个或多个工件，用于表示运行作业的 AWS Glue Data Catalog 输出。  
类型：[DataCatalogOutput](API_DataCatalogOutput.md) 对象数组  
数组成员：最少 1 个物品。

 ** [DatasetName](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-DatasetName"></a>
作业执行操作的数据集。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [EncryptionKeyArn](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-EncryptionKeyArn"></a>
用于保护作业的加密密钥的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。

 ** [EncryptionMode](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-EncryptionMode"></a>
作业的加密模式包括以下几种：  
+  `SSE-KMS`-使用由 AWS KMS管理的密钥进行服务器端加密。
+  `SSE-S3` - 使用 Amazon S3 托管密钥进行服务器端加密。
类型：字符串  
有效值：`SSE-KMS | SSE-S3`

 ** [JobSample](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-JobSample"></a>
仅配置文件作业的样本配置。确定要执行配置文件作业的行数。  
类型：[JobSample](API_JobSample.md) 对象

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

 ** [LastModifiedDate](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-LastModifiedDate"></a>
上次修改作业的日期和时间。  
类型：时间戳

 ** [LogSubscription](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-LogSubscription"></a>
表示此任务是否启用了 Amazon CloudWatch 日志记录。  
类型：字符串  
有效值：`ENABLE | DISABLE`

 ** [MaxCapacity](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-MaxCapacity"></a>
作业处理数据时 DataBrew 可以消耗的最大计算节点数。  
类型：整数

 ** [MaxRetries](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-MaxRetries"></a>
作业运行失败后重试此作业的最大次数。  
类型：整数  
有效范围：最小值为 0。

 ** [Outputs](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Outputs"></a>
代表作业运行时 输出的一个或多个构件。  
类型：[Output](API_Output.md) 对象数组  
数组成员：最少 1 个物品。

 ** [ProfileConfiguration](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-ProfileConfiguration"></a>
配置文件作业的配置。用于选择列、进行评估并覆盖评估的默认参数。配置为 null 时，配置文件作业将使用默认设置运行。  
类型：[ProfileConfiguration](API_ProfileConfiguration.md) 对象

 ** [ProjectName](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-ProjectName"></a>
与此工作相关的 DataBrew 项目。  
类型：字符串  
长度限制：最小长度为 1。最大长度为 255。

 ** [RecipeReference](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-RecipeReference"></a>
表示 DataBrew 食谱的名称和版本。  
类型：[RecipeReference](API_RecipeReference.md) 对象

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

 ** [RoleArn](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-RoleArn"></a>
 DataBrew 运行任务时要扮演的 AWS Identity and Access Management (IAM) 角色的 ARN。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。

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

 ** [Timeout](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Timeout"></a>
作业的超时（以分钟为单位）。如果作业的运行时间超出此超时时间，作业将以 `TIMEOUT` 状态结束。  
类型：整数  
有效范围：最小值为 0。

 ** [Type](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-Type"></a>
作业类型，必须为以下类型之一：  
+  `PROFILE`：作业分析数据集，以确定其大小、数据类型、数据分布等。
+  `RECIPE`：作业将一个或多个转换应用于数据集。
类型：字符串  
有效值：`PROFILE | RECIPE`

 ** [ValidationConfigurations](#API_DescribeJob_ResponseSyntax) **   <a name="databrew-DescribeJob-response-ValidationConfigurations"></a>
应用于配置文件作业的验证配置列表。  
类型：[ValidationConfiguration](API_ValidationConfiguration.md) 对象数组  
数组成员：最少 1 个物品。

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

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

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

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

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

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