DescribeWhatIfForecastExport - Amazon Forecast

Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。了解更多

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

DescribeWhatIfForecastExport

描述使用 CreateWhatIfForecastExport 操作创建的假设分析预测导出。

重要

Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。了解更多

除了列出 CreateWhatIfForecastExport 请求中提供的属性外,该操作还列出了以下属性:

  • CreationTime

  • LastModificationTime

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

  • Status

请求语法

{ "WhatIfForecastExportArn": "string" }

请求参数

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

WhatIfForecastExportArn

您感兴趣的假设预测导出的亚马逊资源名称 (ARN)。

类型:字符串

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

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

必需:是

响应语法

{ "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "EstimatedTimeRemainingInMinutes": number, "Format": "string", "LastModificationTime": number, "Message": "string", "Status": "string", "WhatIfForecastArns": [ "string" ], "WhatIfForecastExportArn": "string", "WhatIfForecastExportName": "string" }

响应元素

如果操作成功,服务将发回 HTTP 200 响应。

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

CreationTime

创建假设分析预测导出的时间。

类型:时间戳

Destination

导出作业的目的地。提供 S3 路径、允许 Amazon Forecast 访问该位置的 AWS Identity and Access Management (IAM) 角色和 AWS Key Management Service (KMS) 密钥(可选)。

类型:DataDestination 对象

EstimatedTimeRemainingInMinutes

完成假设分析预测导出的大致剩余时间(分钟)。

类型:长整型

Format

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

类型:字符串

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

模式:^CSV|PARQUET$

LastModificationTime

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

  • CREATE_PENDING - CreationTime

  • CREATE_IN_PROGRESS - 当前时间戳。

  • CREATE_STOPPING - 当前时间戳。

  • CREATE_STOPPED - 当作业停止时。

  • ACTIVE 或者 CREATE_FAILED - 当作业完成或失败时。

类型:时间戳

Message

如果出现错误,则为错误的信息消息。

类型:字符串

Status

假设分析预测的状态。状态包括:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

注意

假设分析预测导出的 Status 必须为 ACTIVE,然后才能访问预测导出。

类型:字符串

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

WhatIfForecastArns

一组 Amazon 资源名称 (ARNs),代表此资源中导出的所有假设预测。

类型:字符串数组

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

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

WhatIfForecastExportArn

假设预测导出的亚马逊资源名称 (ARN)。

类型:字符串

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

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

WhatIfForecastExportName

假设分析预测导出的名称。

类型:字符串

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

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

错误

InvalidInputException

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

HTTP状态码:400

ResourceNotFoundException

我们找不到带有该 Amazon 资源名称的资源 (ARN)。请检查ARN并重试。

HTTP状态码:400

另请参阅

有关在特定语言API中使用它的更多信息 AWS SDKs,请参阅以下内容: