Skip to content

/AWS1/CL_FCSDESCRIBEFCRESPONSE

DescribeForecastResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_forecastarn TYPE /AWS1/FCSARN /AWS1/FCSARN

The forecast ARN as specified in the request.

iv_forecastname TYPE /AWS1/FCSNAME /AWS1/FCSNAME

The name of the forecast.

it_forecasttypes TYPE /AWS1/CL_FCSFORECASTTYPES_W=>TT_FORECASTTYPES TT_FORECASTTYPES

The quantiles at which probabilistic forecasts were generated.

iv_predictorarn TYPE /AWS1/FCSARN /AWS1/FCSARN

The ARN of the predictor used to generate the forecast.

iv_datasetgrouparn TYPE /AWS1/FCSARN /AWS1/FCSARN

The ARN of the dataset group that provided the data used to train the predictor.

iv_estimatedtimeremainingi00 TYPE /AWS1/FCSLONG /AWS1/FCSLONG

The estimated time remaining in minutes for the forecast job to complete.

iv_status TYPE /AWS1/FCSSTRING /AWS1/FCSSTRING

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.

io_timeseriesselector TYPE REF TO /AWS1/CL_FCSTIMESERIESSELECTOR /AWS1/CL_FCSTIMESERIESSELECTOR

The time series to include in the forecast.

Queryable Attributes

ForecastArn

The forecast ARN as specified in the request.

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

ForecastTypes

The quantiles at which probabilistic forecasts were generated.

Accessible with the following methods

Method Description
GET_FORECASTTYPES() Getter for FORECASTTYPES, with configurable default
ASK_FORECASTTYPES() Getter for FORECASTTYPES w/ exceptions if field has no value
HAS_FORECASTTYPES() Determine if FORECASTTYPES 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

DatasetGroupArn

The 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

EstimatedTimeRemainingInMinutes

The estimated time remaining in minutes for the forecast job to complete.

Accessible with the following methods

Method Description
GET_ESTIMATEDTIMEREMAINING00() Getter for ESTIMATEDTIMEREMAININGINMINS, with configurable d
ASK_ESTIMATEDTIMEREMAINING00() Getter for ESTIMATEDTIMEREMAININGINMINS w/ exceptions if fie
HAS_ESTIMATEDTIMEREMAINING00() Determine if ESTIMATEDTIMEREMAININGINMINS 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

TimeSeriesSelector

The time series to include in the forecast.

Accessible with the following methods

Method Description
GET_TIMESERIESSELECTOR() Getter for TIMESERIESSELECTOR