本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
DescribeAutoPredictor
描述使用CreateAutoPredictor操作创建的预测变量。
请求语法
{
"PredictorArn": "string
"
}
请求参数
请求接受采用 JSON 格式的以下数据。
- PredictorArn
-
预测变量的Amazon 资源名称 (ARN)。
类型:字符串
长度限制:最大长度为 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
必需:是
响应语法
{
"CreationTime": number,
"DataConfig": {
"AdditionalDatasets": [
{
"Configuration": {
"string" : [ "string" ]
},
"Name": "string"
}
],
"AttributeConfigs": [
{
"AttributeName": "string",
"Transformations": {
"string" : "string"
}
}
],
"DatasetGroupArn": "string"
},
"DatasetImportJobArns": [ "string" ],
"EncryptionConfig": {
"KMSKeyArn": "string",
"RoleArn": "string"
},
"EstimatedTimeRemainingInMinutes": number,
"ExplainabilityInfo": {
"ExplainabilityArn": "string",
"Status": "string"
},
"ForecastDimensions": [ "string" ],
"ForecastFrequency": "string",
"ForecastHorizon": number,
"ForecastTypes": [ "string" ],
"LastModificationTime": number,
"Message": "string",
"MonitorInfo": {
"MonitorArn": "string",
"Status": "string"
},
"OptimizationMetric": "string",
"PredictorArn": "string",
"PredictorName": "string",
"ReferencePredictorSummary": {
"Arn": "string",
"State": "string"
},
"Status": "string",
"TimeAlignmentBoundary": {
"DayOfMonth": number,
"DayOfWeek": "string",
"Hour": number,
"Month": "string"
}
}
响应元素
如果此操作成功,则该服务将会发送回 HTTP 200 响应。
服务以 JSON 格式返回的以下数据。
- CreationTime
-
CreateAutoPredictor请求的时间戳。
类型:时间戳
- DataConfig
-
您的数据集组和任何其他数据集的数据配置。
类型:DataConfig 对象
- DatasetImportJobArns
-
数据集导入作业的 ARN 数组,用于为预测变量导入训练数据。
类型:字符串数组
长度限制:最大长度为 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
- EncryptionConfig
-
AWS Key Management Service(KMS)密钥和 Amazon Forecast 可以代入以访问密钥的 AWS Identity and Access Management IAM 角色。您可以在CreateDataset和CreatePredictor请求中指定这个可选对象。
类型:EncryptionConfig 对象
- EstimatedTimeRemainingInMinutes
-
完成预测器训练作业的估计剩余时间(以分钟为单位)。
类型:长整型
- ExplainabilityInfo
-
提供预测变量可解释性的状态和 ARN。
类型:ExplainabilityInfo 对象
- ForecastDimensions
-
维度(字段)名称数组,用于指定用于对时间序列进行分组的属性。
类型:字符串数组
数组成员:最少 1 项。最多 10 项。
长度限制:最小长度为 1。最大长度为 63。
模式:
^[a-zA-Z][a-zA-Z0-9_]*
- ForecastFrequency
-
预测中预测的频率。
有效间隔为 Y(年)、M(月)、W(周)、D(日)、H(小时)、30min(30 分钟)、15min(15 分钟)、10min(10 分钟)、5min(5 分钟)和 1min(1 分钟)。例如,“Y” 表示每年,“5min” 表示每 5 分钟。
类型:字符串
长度限制:最小长度为 1。长度上限为 5。
模式:
^Y|M|W|D|H|30min|15min|10min|5min|1min$
- ForecastHorizon
-
模型预测的时间步长。预测范围也称为预测长度。
类型:整数
- ForecastTypes
-
预测器训练期间使用的预测类型。默认值为 ["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
-
发生错误时,一条详细说明错误原因的消息。
类型:字符串
- MonitorInfo
-
具有 Amazon 资源名称 (ARN) 和监控资源状态的MonitorInfo对象。
类型:MonitorInfo 对象
- OptimizationMetric
-
用于优化预测变量的精度指标。
类型:字符串
有效值:
WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE
- PredictorArn
-
预测变量的Amazon 资源名称 (ARN)
类型:字符串
长度限制:最大长度为 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
- PredictorName
-
预测变量的名称。
类型:字符串
长度限制:最小长度为 1。最大长度为 63。
模式:
^[a-zA-Z][a-zA-Z0-9_]*
- ReferencePredictorSummary
-
参考预测变量的 ARN 和状态。此参数仅对再训练或升级的预测变量有效。
- Status
-
预测变量的状态。州包括:
-
ACTIVE
-
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
-
CREATE_STOPPING
,CREATE_STOPPED
-
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
类型:字符串
长度限制:最大长度为 256。
-
- TimeAlignmentBoundary
-
Forecast 在聚合数据时使用的时间边界。
类型:TimeAlignmentBoundary 对象
错误
- InvalidInputException
-
我们无法处理请求,因为它包含无效值或超出有效范围的值。
HTTP 状态代码:400
- ResourceNotFoundException
-
我们找不到具有该Amazon 资源名称 (ARN) 的资源。检查 ARN 并重试。
HTTP 状态代码:400
另请参阅
有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: