View a markdown version of this page

GetJob - Amazon Location Service

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

GetJob

GetJob操作检索有关特定任务的信息,包括其当前状态、配置、时间戳和任何错误信息。使用此操作可以监视作业进度并验证配置详细信息。对于已完成的作业,在访问结果之前,您可以使用此信息来验证是否成功处理。

欲了解更多信息,请参阅GetJob亚马逊定位服务 API 参考》。

有关此 API 的请求、响应和 CLI 命令示例,请参阅如何监控任务进度

使用案例

  • 作业状态和进度监控:通过待处理、运行和完成状态跟踪作业生命周期进度,以确定何时完成处理以及何时可以下载结果。监控工作状态以进行工作流管理和报告。

  • 错误诊断:在作业失败时检索详细的错误信息,包括用于解决处理问题的特定错误消息和失败原因。

  • 配置验证:在开始处理之前,请确认作业配置的详细信息,包括 input/output 位置、执行角色和请求的功能。

了解请求

GetJob请求只需要一个参数即可检索有关特定任务的全面信息。这种简单的请求结构便于监控任务状态和检索详细的配置和处理信息。

该请求包含以下参数:

Job 识别

指定要检索有关哪个作业信息的必填参数。

  • JobId:要检索的任务的唯一标识符。必须是 1-100 个字符匹配的模式[-._\w]+。这与创建任务时StartJob操作返回的标识符相同。

了解响应

GetJob响应提供有关指定任务的信息,包括其当前状态、完整配置、处理时间戳和任何错误信息。您可以使用此响应来监控作业状态并对可能出现的任何错误进行故障排除。

响应包括以下字段:

Job 识别

唯一标识符和基本工作信息。

  • JobId:用于监控和管理操作的唯一作业标识符。

  • JobArn: ARN,用于唯一标识其中的作业。 AWS

  • Name: 人类可读的作业名称(如果在创建作业时指定)。

Job 状态和生命周期

当前作业状态和处理时间表信息。

  • Status:表示处理状态的当前作业状态(待处理、正在运行、已完成、失败、取消或已取消)。

  • CreatedAt: ISO 8601 格式的 Job 创建时间戳。

  • UpdatedAt:上次状态更新时间戳采用 ISO 8601 格式。

  • EndedAt: 采用 ISO 8601 格式的 Job 完成时间戳。仅适用于处于终端状态的作业。

作业配置

按照创建过程中指定的方式完成任务配置。

  • Action:正在执行的操作类型(目前ValidateAddress仅支持)。

  • ExecutionRoleArn:在任务执行期间用于访问 Amazon S3 存储桶的 IAM 角色 ARN。

  • InputOptions:输入配置,包括 Amazon S3 的位置和数据格式。

  • OutputOptions:输出配置,包括 Amazon S3 目标和结果格式。

  • ActionOptions:为该任务请求的可选附加功能,例如PositionCountrySpecificAttributes

错误信息

当任务失败时,响应中会包含错误详细信息,以帮助您诊断和解决问题。

  • Error:一个包含故障详细信息的JobError对象。此对象包括以下字段:

    • Code:用于标识故障类型的错误代码。

    • Messages:人类可读的消息列表,这些消息为故障排除提供了更多背景信息。