DescribeJob - Amazon Glue DataBrew
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

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

DescribeJob

返回特定数据库作业的定义。

请求语法

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", "Key": "string" } }, "DatabaseOutputMode": "string", "GlueConnectionName": "string" } ], "DataCatalogOutputs": [ { "CatalogId": "string", "DatabaseName": "string", "DatabaseOptions": { "TableName": "string", "TempDirectory": { "Bucket": "string", "Key": "string" } }, "Overwrite": boolean, "S3Options": { "Location": { "Bucket": "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", "Key": "string" }, "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" } ] }, "ProfileColumns": [ { "Name": "string", "Regex": "string" } ] }, "ProjectName": "string", "RecipeReference": { "Name": "string", "RecipeVersion": "string" }, "ResourceArn": "string", "RoleArn": "string", "Tags": { "string" : "string" }, "Timeout": number, "Type": "string" }

响应元素

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

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

Name

作业的名称。

类型: 字符串

长度约束:最小长度为 1。长度上限为 240。

CreateDate

创建人物的日期和时间。

类型: 时间戳

CreatedBy

与创建作业关联的用户的标识符(用户名)。

类型: 字符串

DatabaseOutputs

表示 JDBC 数据库输出对象的列表,它定义要写入的 Databrew 配方作业的输出目标。

类型: 数组 DatabaseOutput objects

数组成员:最少 1 项。

DataCatalogOutputs

代表Amazon Glue Data Catalog输出。

类型: 数组 DataCatalogOutput objects

数组成员:最少 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 objects

数组成员:最少 1 项。

ProfileConfiguration

配置文件作业的配置。用于选择列、执行评估和覆盖评估的默认参数。当配置为空时,配置文件作业将以默认设置运行。

类型: ProfileConfiguration 对象

ProjectName

与此作业关联的数据集项目。

类型: 字符串

长度约束:最小长度为 1。长度上限为 255。

RecipeReference

表示数据库配方的名称和版本。

类型: RecipeReference 对象

ResourceArn

作业的 Amazon 资源名称 (ARN)。

类型: 字符串

长度约束:最小长度为 20。长度上限为 2048。

RoleArn

的 ARNAmazon Identity and Access Management(IAM) 角色来代入 DataBrew 运行任务。

类型: 字符串

长度约束:最小长度为 20。长度上限为 2048。

Tags

与此作业关联的元数据标签。

类型: 字符串到字符串映射

映射条目:最多 200 项。

密钥长度约束:最小长度为 1。长度上限为 128。

值长度 长度上限为 256。

Timeout

作业的超时(以分钟为单位)。如果作业的运行时间超出此超时时间,作业将以 TIMEOUT 状态结束。

类型: 整数

有效范围: 最小值为 0。

Type

作业类型必须是以下类型之一:

  • PROFILE-作业分析数据集以确定其大小、数据类型、数据分布等。

  • RECIPE-作业将一个或多个转换应用于数据集。

类型: 字符串

有效值: PROFILE | RECIPE

Errors

有关所有操作常见错误的信息,请参阅常见错误.

ResourceNotFoundException

无法找到一个或多个资源。

HTTP 状态代码:2 404

ValidationException

此请求的输入参数未通过验证。

HTTP 状态代码:2 400

另请参阅

有关在特定语言的Amazon开发工具包,请参阅以下开发工具包