DescribeWhatIfForecast
Describes the what-if forecast created using the CreateWhatIfForecast operation.
In addition to listing the properties provided in the CreateWhatIfForecast
request, this operation lists the following properties:
-
CreationTime
-
LastModificationTime
-
Message
- If an error occurred, information about the error. -
Status
Request Syntax
{
"WhatIfForecastArn": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
- WhatIfForecastArn
-
The Amazon Resource Name (ARN) of the what-if forecast that you are interested in.
Type: String
Length Constraints: Maximum length of 300.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+
Required: Yes
Response Syntax
{
"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"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CreationTime
-
When the what-if forecast was created.
Type: Timestamp
- EstimatedTimeRemainingInMinutes
-
The approximate time remaining to complete the what-if forecast, in minutes.
Type: Long
- ForecastTypes
-
The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are
["0.1", "0.5", "0.9"]
.Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Length Constraints: Minimum length of 2. Maximum length of 4.
Pattern:
(^0?\.\d\d?$|^mean$)
- LastModificationTime
-
The last time the resource was modified. The timestamp depends on the status of the job:
-
CREATE_PENDING
- TheCreationTime
. -
CREATE_IN_PROGRESS
- The current timestamp. -
CREATE_STOPPING
- The current timestamp. -
CREATE_STOPPED
- When the job stopped. -
ACTIVE
orCREATE_FAILED
- When the job finished or failed.
Type: Timestamp
-
- Message
-
If an error occurred, an informational message about the error.
Type: String
- Status
-
The status of the what-if forecast. States include:
-
ACTIVE
-
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
-
CREATE_STOPPING
,CREATE_STOPPED
-
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
Note
The
Status
of the what-if forecast must beACTIVE
before you can access the forecast.Type: String
Length Constraints: Maximum length of 256.
Pattern:
^[a-zA-Z0-9\_]+$
-
- TimeSeriesReplacementsDataSource
-
An array of
S3Config
,Schema
, andFormat
elements that describe the replacement time series.Type: TimeSeriesReplacementsDataSource object
- TimeSeriesTransformations
-
An array of
Action
andTimeSeriesConditions
elements that describe what transformations were applied to which time series.Type: Array of TimeSeriesTransformation objects
Array Members: Minimum number of 0 items. Maximum number of 30 items.
- WhatIfAnalysisArn
-
The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+
- WhatIfForecastArn
-
The Amazon Resource Name (ARN) of the what-if forecast.
Type: String
Length Constraints: Maximum length of 300.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+
- WhatIfForecastName
-
The name of the what-if forecast.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z][a-zA-Z0-9_]*
Errors
- InvalidInputException
-
We can't process the request because it includes an invalid value or a value that exceeds the valid range.
HTTP Status Code: 400
- ResourceNotFoundException
-
We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: