CreateForecast - Amazon Forecast

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

CreateForecast

TARGET_TIME_SERIES 数据集中用于训练预测器的每个项目创建预测。这称作推理。要以低延迟检索单个项目的预测,请使用 QueryForecast 操作。要将完整的预测导出到 Amazon Simple Storage Service(Amazon S3)存储桶中,请使用 CreateForecastExportJob 操作。

预测范围由您在 CreatePredictor 请求中指定的 ForecastHorizon 值决定。查询预测时,您可以请求预测内的特定日期范围。

要获取所有预测的列表,请使用 ListForecasts 操作。

注意

Amazon Forecast 生成的预测与用于创建预测器的数据集处于同一时区。

有关更多信息,请参阅 生成预测

注意

在查询或导出预测之前,预测的 Status 必须为 ACTIVE。使用 DescribeForecast 操作获取此状态。

默认情况下,预测包括数据集组中用于训练预测器的每个项目(item_id)的预测。但是,您可以使用 TimeSeriesSelector 对象生成对时间序列子集的预测。对于您指定的任何不在输入数据集中的时间序列,都将跳过创建预测。预测导出文件将不包含这些时间序列或其预测值。

请求语法

{ "ForecastName": "string", "ForecastTypes": [ "string" ], "PredictorArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TimeSeriesSelector": { "TimeSeriesIdentifiers": { "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] } } } }

请求参数

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

ForecastName

预测的名称。

类型:字符串

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

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

必需:是

ForecastTypes

生成概率预测的分位数。目前,每个预测最多可以指定 5 个分位数。可接受的值包括 0.01 to 0.99(仅以 .01 为增量)和 mean。当分布不对称时(例如,贝塔分布和负二项式分布),预测均值与中值(0.50)不同。

默认分位数是您在创建预测器时指定的分位数。如果您未指定分位数,则默认值为 ["0.1", "0.5", "0.9"]

类型:字符串数组

数组成员:最少 1 项。最多 20 项。

长度限制:最小长度为 2。最大长度为 4。

模式:(^0?\.\d\d?$|^mean$)

必需:否

PredictorArn

用于生成预测的预测器的 Amazon 资源名称(ARN)。

类型:字符串

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

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

必需:是

Tags

您应用于预测以帮助您对其进行分类和组织的可选元数据。每个标签都包含定义的一个密钥和一个可选值。

下面是适用于标签的基本限制:

  • 每个资源的最大标签数 - 50。

  • 对于每个资源,每个标签键都必须是唯一的,每个标签键只能有一个值。

  • 最大键长度 - 128 个 Unicode 字符(采用 UTF-8 格式)。

  • 最大值长度 - 256 个 Unicode 字符(采用 UTF-8 格式)。

  • 如果您的标记模式针对多个服务和资源使用,请记得其它服务可能对允许使用的字符有限制。通常允许使用的字符包括:可用 UTF-8 格式表示的字母、数字和空格,以及以下字符:+ - = . _ : / @。

  • 标签键和值区分大小写。

  • 请勿使用aws:AWS:、或任何大写或小写组合,例如密钥的前缀,因为它是保留供 AWS 使用的。不能编辑或删除带此前缀的标签键。值可以带有该前缀。如果标签值将 aws 作为其前缀,但键没有前缀,则 Forecast 会将其视为用户标签,并将计入 50 个标签的限制。仅具有 aws 的键前缀的标签不计入每个资源的标签数限制。

类型:Tag 对象数组

数组成员:最少 0 个物品。最多 200 项。

必需:否

TimeSeriesSelector

定义用于在 TimeSeriesIdentifiers 对象中创建预测的时间序列集。

TimeSeriesIdentifiers 对象需要具备以下信息:

  • DataSource

  • Format

  • Schema

类型:TimeSeriesSelector 对象

必需:否

响应语法

{ "ForecastArn": "string" }

响应元素

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

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

ForecastArn

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

类型:字符串

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

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

错误

InvalidInputException

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

HTTP 状态代码:400

LimitExceededException

超过了每个账户的资源数量限制。

HTTP 状态代码:400

ResourceAlreadyExistsException

已存在同名资源。请使用不同的名称重试。

HTTP 状态代码:400

ResourceInUseException

指定的资源正在使用中。

HTTP 状态代码:400

ResourceNotFoundException

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

HTTP 状态代码:400

另请参阅

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