本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeForecast
描述使用CreateForecast操作创建的预测。
除了列出CreateForecast
请求中提供的属性外,此操作还列出了以下属性:
-
DatasetGroupArn
-提供训练数据的数据集组。 -
CreationTime
-
LastModificationTime
-
Status
-
Message
-如果发生错误,则为有关错误的信息。
请求语法
{
"ForecastArn": "string
"
}
请求参数
请求接受采用 JSON 格式的以下数据。
- ForecastArn
-
预测的 Amazon 资源名称(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
-
创建预测创建任务的时间。
类型:Timestamp
- 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
-当作业完成或失败时。
类型:Timestamp
-
- 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
另请参阅
有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: