Amazon Forecast is no longer available to new customers. Existing customers of
Amazon Forecast can continue to use the service as normal.
Learn more"
WhatIfAnalysisSummary
Provides a summary of the what-if analysis properties used in the ListWhatIfAnalyses operation. To get the complete set of properties, call the DescribeWhatIfAnalysis operation, and provide the WhatIfAnalysisArn that is listed in the summary.
Contents
- CreationTime
-
When the what-if analysis was created.
Type: Timestamp
Required: No
- ForecastArn
-
The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+Required: No
- 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. -
ACTIVEorCREATE_FAILED- When the job finished or failed.
Type: Timestamp
Required: No
-
- Message
-
If an error occurred, an informational message about the error.
Type: String
Required: No
- Status
-
The status of the what-if analysis. States include:
-
ACTIVE -
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILED -
CREATE_STOPPING,CREATE_STOPPED -
DELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
Note
The
Statusof the what-if analysis must beACTIVEbefore you can access the analysis.Type: String
Length Constraints: Maximum length of 256.
Required: No
-
- WhatIfAnalysisArn
-
The Amazon Resource Name (ARN) of the what-if analysis.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+Required: No
- WhatIfAnalysisName
-
The name of the what-if analysis.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z][a-zA-Z0-9_]*Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
