本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeWhatIfForecast
描述使用 CreateWhatIfForecast 操作创建的假设分析预测。
除了列出 CreateWhatIfForecast
请求中提供的属性外,该操作还列出了以下属性:
-
CreationTime
-
LastModificationTime
-
Message
- 如果出现错误,则为错误的相关信息。 -
Status
请求语法
{
"WhatIfForecastArn": "string
"
}
请求参数
请求接受采用 JSON 格式的以下数据。
- WhatIfForecastArn
-
您感兴趣的假设分析预测的 Amazon 资源名称(ARN)。
类型:字符串
长度限制:最大长度为 300。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
必需:是
响应语法
{
"CreationTime": number,
"EstimatedTimeRemainingInMinutes": number,
"ForecastTypes": [ "string" ],
"LastModificationTime": number,
"Message": "string",
"Status": "string",
"TimeSeriesReplacementsDataSource": {
"Format": "string",
"S3Config": {
"KMSKeyArn": "string",
"Path": "string",
"RoleArn": "string"
},
"Schema": {
"Attributes": [
{
"AttributeName": "string",
"AttributeType": "string"
}
]
},
"TimestampFormat": "string"
},
"TimeSeriesTransformations": [
{
"Action": {
"AttributeName": "string",
"Operation": "string",
"Value": number
},
"TimeSeriesConditions": [
{
"AttributeName": "string",
"AttributeValue": "string",
"Condition": "string"
}
]
}
],
"WhatIfAnalysisArn": "string",
"WhatIfForecastArn": "string",
"WhatIfForecastName": "string"
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回以下数据。
- CreationTime
-
假设分析预测的创建时间。
类型:时间戳
- EstimatedTimeRemainingInMinutes
-
完成假设分析预测的大致剩余时间(分钟)。
类型:长整型
- ForecastTypes
-
生成概率预测的分位数。在 CreateWhatIfForecast 操作中,您最多可以为每个假设分析预测指定五个分位数。如果您未指定分位数,则默认值为
["0.1", "0.5", "0.9"]
。类型:字符串数组
数组成员:最少 1 项。最多 20 项。
长度限制:最小长度为 2。最大长度为 4。
模式:
(^0?\.\d\d?$|^mean$)
- 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。
模式:
^[a-zA-Z0-9\_]+$
-
- TimeSeriesReplacementsDataSource
-
描述替换时间序列的
S3Config
、Schema
和Format
元素的数组。 - TimeSeriesTransformations
-
Action
和TimeSeriesConditions
元素的数组,用于描述对哪些时间序列进行了转换。类型:TimeSeriesTransformation 对象数组
数组成员:最少 0 个物品。最多 30 项。
- WhatIfAnalysisArn
-
包含该预测的假设分析的 Amazon 资源名称(ARN)。
类型:字符串
长度限制:最大长度为 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
- WhatIfForecastArn
-
假设分析预测的 Amazon 资源名称(ARN)。
类型:字符串
长度限制:最大长度为 300。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
- WhatIfForecastName
-
假设分析预测的名称。
类型:字符串
长度限制:最小长度为 1。最大长度为 63。
模式:
^[a-zA-Z][a-zA-Z0-9_]*
错误
- InvalidInputException
-
我们无法处理该请求,因为其包含无效值或超出有效范围的值。
HTTP 状态代码:400
- ResourceNotFoundException
-
我们找不到具有该 Amazon 资源名称(ARN)的资源。检查 ARN,然后重试。
HTTP 状态代码:400
另请参阅
有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: