Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data ForecastSummary = ForecastSummary' {}
- newForecastSummary :: ForecastSummary
- forecastSummary_createdUsingAutoPredictor :: Lens' ForecastSummary (Maybe Bool)
- forecastSummary_creationTime :: Lens' ForecastSummary (Maybe UTCTime)
- forecastSummary_datasetGroupArn :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_forecastArn :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_forecastName :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_lastModificationTime :: Lens' ForecastSummary (Maybe UTCTime)
- forecastSummary_message :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_predictorArn :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_status :: Lens' ForecastSummary (Maybe Text)
Documentation
data ForecastSummary Source #
Provides a summary of the forecast properties used in the ListForecasts
operation. To get the complete set of properties, call the
DescribeForecast operation, and provide the ForecastArn
that is listed
in the summary.
See: newForecastSummary
smart constructor.
ForecastSummary' | |
|
Instances
newForecastSummary :: ForecastSummary Source #
Create a value of ForecastSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdUsingAutoPredictor:ForecastSummary'
, forecastSummary_createdUsingAutoPredictor
- Whether the Forecast was created from an AutoPredictor.
$sel:creationTime:ForecastSummary'
, forecastSummary_creationTime
- When the forecast creation task was created.
$sel:datasetGroupArn:ForecastSummary'
, forecastSummary_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group that provided the
data used to train the predictor.
$sel:forecastArn:ForecastSummary'
, forecastSummary_forecastArn
- The ARN of the forecast.
$sel:forecastName:ForecastSummary'
, forecastSummary_forecastName
- The name of the forecast.
$sel:lastModificationTime:ForecastSummary'
, forecastSummary_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.
$sel:message:ForecastSummary'
, forecastSummary_message
- If an error occurred, an informational message about the error.
$sel:predictorArn:ForecastSummary'
, forecastSummary_predictorArn
- The ARN of the predictor used to generate the forecast.
$sel:status:ForecastSummary'
, forecastSummary_status
- The status of the forecast. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast must be ACTIVE
before you can query or
export the forecast.
forecastSummary_createdUsingAutoPredictor :: Lens' ForecastSummary (Maybe Bool) Source #
Whether the Forecast was created from an AutoPredictor.
forecastSummary_creationTime :: Lens' ForecastSummary (Maybe UTCTime) Source #
When the forecast creation task was created.
forecastSummary_datasetGroupArn :: Lens' ForecastSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
forecastSummary_forecastArn :: Lens' ForecastSummary (Maybe Text) Source #
The ARN of the forecast.
forecastSummary_forecastName :: Lens' ForecastSummary (Maybe Text) Source #
The name of the forecast.
forecastSummary_lastModificationTime :: Lens' ForecastSummary (Maybe UTCTime) Source #
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.
forecastSummary_message :: Lens' ForecastSummary (Maybe Text) Source #
If an error occurred, an informational message about the error.
forecastSummary_predictorArn :: Lens' ForecastSummary (Maybe Text) Source #
The ARN of the predictor used to generate the forecast.
forecastSummary_status :: Lens' ForecastSummary (Maybe Text) Source #
The status of the forecast. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast must be ACTIVE
before you can query or
export the forecast.