Skip to content

/AWS1/CL_FCSFORECASTSUMMARY

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_forecastarn TYPE /AWS1/FCSARN /AWS1/FCSARN

The ARN of the forecast.

iv_forecastname TYPE /AWS1/FCSNAME /AWS1/FCSNAME

The name of the forecast.

iv_predictorarn TYPE /AWS1/FCSSTRING /AWS1/FCSSTRING

The ARN of the predictor used to generate the forecast.

iv_createdusingautopredictor TYPE /AWS1/FCSBOOLEAN /AWS1/FCSBOOLEAN

Whether the Forecast was created from an AutoPredictor.

iv_datasetgrouparn TYPE /AWS1/FCSSTRING /AWS1/FCSSTRING

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

iv_status TYPE /AWS1/FCSSTATUS /AWS1/FCSSTATUS

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.

iv_message TYPE /AWS1/FCSERRORMESSAGE /AWS1/FCSERRORMESSAGE

If an error occurred, an informational message about the error.

iv_creationtime TYPE /AWS1/FCSTIMESTAMP /AWS1/FCSTIMESTAMP

When the forecast creation task was created.

iv_lastmodificationtime TYPE /AWS1/FCSTIMESTAMP /AWS1/FCSTIMESTAMP

The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.

  • CREATE_IN_PROGRESS - The current timestamp.

  • CREATE_STOPPING - The current timestamp.

  • CREATE_STOPPED - When the job stopped.

  • ACTIVE or CREATE_FAILED - When the job finished or failed.

Queryable Attributes

ForecastArn

The ARN of the forecast.

Accessible with the following methods

Method Description
GET_FORECASTARN() Getter for FORECASTARN, with configurable default
ASK_FORECASTARN() Getter for FORECASTARN w/ exceptions if field has no value
HAS_FORECASTARN() Determine if FORECASTARN has a value

ForecastName

The name of the forecast.

Accessible with the following methods

Method Description
GET_FORECASTNAME() Getter for FORECASTNAME, with configurable default
ASK_FORECASTNAME() Getter for FORECASTNAME w/ exceptions if field has no value
HAS_FORECASTNAME() Determine if FORECASTNAME has a value

PredictorArn

The ARN of the predictor used to generate the forecast.

Accessible with the following methods

Method Description
GET_PREDICTORARN() Getter for PREDICTORARN, with configurable default
ASK_PREDICTORARN() Getter for PREDICTORARN w/ exceptions if field has no value
HAS_PREDICTORARN() Determine if PREDICTORARN has a value

CreatedUsingAutoPredictor

Whether the Forecast was created from an AutoPredictor.

Accessible with the following methods

Method Description
GET_CREDUSINGAUTOPREDICTOR() Getter for CREATEDUSINGAUTOPREDICTOR, with configurable defa
ASK_CREDUSINGAUTOPREDICTOR() Getter for CREATEDUSINGAUTOPREDICTOR w/ exceptions if field
HAS_CREDUSINGAUTOPREDICTOR() Determine if CREATEDUSINGAUTOPREDICTOR has a value

DatasetGroupArn

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

Accessible with the following methods

Method Description
GET_DATASETGROUPARN() Getter for DATASETGROUPARN, with configurable default
ASK_DATASETGROUPARN() Getter for DATASETGROUPARN w/ exceptions if field has no val
HAS_DATASETGROUPARN() Determine if DATASETGROUPARN has a value

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.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

Message

If an error occurred, an informational message about the error.

Accessible with the following methods

Method Description
GET_MESSAGE() Getter for MESSAGE, with configurable default
ASK_MESSAGE() Getter for MESSAGE w/ exceptions if field has no value
HAS_MESSAGE() Determine if MESSAGE has a value

CreationTime

When the forecast creation task was created.

Accessible with the following methods

Method Description
GET_CREATIONTIME() Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME() Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME() Determine if CREATIONTIME has a value

LastModificationTime

The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.

  • CREATE_IN_PROGRESS - The current timestamp.

  • CREATE_STOPPING - The current timestamp.

  • CREATE_STOPPED - When the job stopped.

  • ACTIVE or CREATE_FAILED - When the job finished or failed.

Accessible with the following methods

Method Description
GET_LASTMODIFICATIONTIME() Getter for LASTMODIFICATIONTIME, with configurable default
ASK_LASTMODIFICATIONTIME() Getter for LASTMODIFICATIONTIME w/ exceptions if field has n
HAS_LASTMODIFICATIONTIME() Determine if LASTMODIFICATIONTIME has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_FORECASTS

TYPES TT_FORECASTS TYPE STANDARD TABLE OF REF TO /AWS1/CL_FCSFORECASTSUMMARY WITH DEFAULT KEY
.