DescribeForecastExportJob - Amazon Forecast

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

DescribeForecastExportJob

描述使用该CreateForecastExportJob操作创建的预测导出任务。

除了列出用户在CreateForecastExportJob请求中提供的属性外,此操作还列出了以下属性:

  • CreationTime

  • LastModificationTime

  • Status

  • Message-如果发生错误,则为错误的相关信息。

请求语法

{ "ForecastExportJobArn": "string" }

请求参数

请求接受采用 JSON 格式的以下数据。

ForecastExportJobArn

预测导出任务的 Amazon 资源名称(ARN)。

类型:字符串

长度限制:最大长度为 256。

模式:arn:([a-z\d-]+):forecast:.*:.*:.+

必需:是

响应语法

{ "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "ForecastArn": "string", "ForecastExportJobArn": "string", "ForecastExportJobName": "string", "Format": "string", "LastModificationTime": number, "Message": "string", "Status": "string" }

响应元素

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

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

CreationTime

预测导出任务的创建时间。

类型:Timestamp

Destination

导出预测的 Amazon Simple Storage Service (Amazon S3) 桶的路径。

类型:DataDestination 对象

ForecastArn

导出的预测的 Amazon 资源名称(ARN)。

类型:字符串

长度限制:最大长度为 256。

模式:arn:([a-z\d-]+):forecast:.*:.*:.+

ForecastExportJobArn

预测导出任务的 ARN。

类型:字符串

长度限制:最大长度为 256。

模式:arn:([a-z\d-]+):forecast:.*:.*:.+

ForecastExportJobName

预测导出任务的名称。

类型:字符串

长度限制:最小长度为 1。最大长度为 63。

模式:^[a-zA-Z][a-zA-Z0-9_]*

Format

导出数据的格式,CSV 或 PARQUET。

类型:字符串

长度约束:最大长度为 7。

模式:^CSV|PARQUET$

LastModificationTime

上次修改资源的时间。时间戳取决于任务的状态:

  • CREATE_PENDING-那个CreationTime

  • CREATE_IN_PROGRESS-当前时间戳。

  • CREATE_STOPPING-当前时间戳。

  • CREATE_STOPPED-作业停止时。

  • ACTIVECREATE_FAILED-作业完成或失败时。

类型:Timestamp

Message

如果发生错误,则为有关错误的信息性消息。

类型:字符串

Status

预测导出任务的状态。州包括:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

注意

必须先Status执行预测导出任务,ACTIVE然后才能访问 S3 存储桶中的预测。

类型:字符串

长度限制:最大长度为 256。

错误

InvalidInputException

我们无法处理该请求,因为它包含无效值或超出有效范围的值。

HTTP 状态代码:400

ResourceNotFoundException

我们找不到具有 Amazon 资源名称(ARN)的资源。检查 ARN,然后重试。

HTTP 状态代码:400

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: