Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。了解更多
本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeForecast
描述使用 CreateForecast 操作创建的预测。
重要
Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。了解更多
除了列出 CreateForecast
请求中提供的属性外,该操作还列出了以下属性:
-
DatasetGroupArn
- 提供训练数据的数据集组。 -
CreationTime
-
LastModificationTime
-
Status
-
Message
- 如果出现错误,则为错误相关的信息。
请求语法
{
"ForecastArn": "string
"
}
请求参数
该请求接受以下JSON格式的数据。
- ForecastArn
-
预测的亚马逊资源名称 (ARN)。
类型:字符串
长度约束:最大长度为 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
必需:是
响应语法
{
"CreationTime": number,
"DatasetGroupArn": "string",
"EstimatedTimeRemainingInMinutes": number,
"ForecastArn": "string",
"ForecastName": "string",
"ForecastTypes": [ "string" ],
"LastModificationTime": number,
"Message": "string",
"PredictorArn": "string",
"Status": "string",
"TimeSeriesSelector": {
"TimeSeriesIdentifiers": {
"DataSource": {
"S3Config": {
"KMSKeyArn": "string",
"Path": "string",
"RoleArn": "string"
}
},
"Format": "string",
"Schema": {
"Attributes": [
{
"AttributeName": "string",
"AttributeType": "string"
}
]
}
}
}
}
响应元素
如果操作成功,服务将发回 HTTP 200 响应。
以下数据由服务以JSON格式返回。
- CreationTime
-
预测创建任务的创建时间。
类型:时间戳
- DatasetGroupArn
-
提供用于训练预测变量的数据的数据集组中的。ARN
类型:字符串
长度约束:最大长度为 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
- EstimatedTimeRemainingInMinutes
-
完成预测作业的估计剩余时间(分钟)。
类型:长整型
- ForecastArn
-
请求ARN中指定的预测。
类型:字符串
长度约束:最大长度为 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
- ForecastName
-
预测的名称。
类型:字符串
长度限制:最小长度为 1。最大长度为 63。
模式:
^[a-zA-Z][a-zA-Z0-9_]*
- ForecastTypes
-
生成概率预测的分位数。
类型:字符串数组
数组成员:最少 1 项。最多 20 项。
长度限制:最小长度为 2。最大长度为 4。
模式:
(^0?\.\d\d?$|^mean$)
- LastModificationTime
-
上次修改资源的时间。时间戳取决于作业的状态:
-
CREATE_PENDING
-CreationTime
。 -
CREATE_IN_PROGRESS
- 当前时间戳。 -
CREATE_STOPPING
- 当前时间戳。 -
CREATE_STOPPED
- 当作业停止时。 -
ACTIVE
或者CREATE_FAILED
- 当作业完成或失败时。
类型:时间戳
-
- Message
-
如果出现错误,则为错误的信息消息。
类型:字符串
- PredictorArn
-
用于生成预测ARN的预测变量。
类型:字符串
长度约束:最大长度为 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
- Status
-
预测的状态。状态包括:
-
ACTIVE
-
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
-
CREATE_STOPPING
,CREATE_STOPPED
-
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
注意
在查询或导出预测之前,预测的
Status
必须为ACTIVE
。类型:字符串
长度约束:最大长度为 256。
模式:
^[a-zA-Z0-9\_]+$
-
- TimeSeriesSelector
-
要包含在预测中的时间序列。
类型:TimeSeriesSelector 对象
错误
- InvalidInputException
-
我们无法处理该请求,因为其包含无效值或超出有效范围的值。
HTTP状态码:400
- ResourceNotFoundException
-
我们找不到带有该 Amazon 资源名称的资源 (ARN)。请检查ARN并重试。
HTTP状态码:400
另请参阅
有关API在一种特定语言中使用此功能的更多信息 AWS SDKs,请参阅以下内容: