Skip to content

/AWS1/CL_FCSPREDICTORSUMMARY

Provides a summary of the predictor properties that are used in the ListPredictors operation. To get the complete set of properties, call the DescribePredictor operation, and provide the listed PredictorArn.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_predictorarn TYPE /AWS1/FCSARN /AWS1/FCSARN

The ARN of the predictor.

iv_predictorname TYPE /AWS1/FCSNAME /AWS1/FCSNAME

The name of the predictor.

iv_datasetgrouparn TYPE /AWS1/FCSARN /AWS1/FCSARN

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

iv_isautopredictor TYPE /AWS1/FCSBOOLEAN /AWS1/FCSBOOLEAN

Whether AutoPredictor was used to create the predictor.

io_referencepredictorsummary TYPE REF TO /AWS1/CL_FCSREFERENCEPREDICT00 /AWS1/CL_FCSREFERENCEPREDICT00

A summary of the reference predictor used if the predictor was retrained or upgraded.

iv_status TYPE /AWS1/FCSSTATUS /AWS1/FCSSTATUS

The status of the predictor. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a 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 model training 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

PredictorArn

The ARN of the predictor.

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

PredictorName

The name of the predictor.

Accessible with the following methods

Method Description
GET_PREDICTORNAME() Getter for PREDICTORNAME, with configurable default
ASK_PREDICTORNAME() Getter for PREDICTORNAME w/ exceptions if field has no value
HAS_PREDICTORNAME() Determine if PREDICTORNAME has a value

DatasetGroupArn

The Amazon Resource Name (ARN) of the dataset group that contains 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

IsAutoPredictor

Whether AutoPredictor was used to create the predictor.

Accessible with the following methods

Method Description
GET_ISAUTOPREDICTOR() Getter for ISAUTOPREDICTOR, with configurable default
ASK_ISAUTOPREDICTOR() Getter for ISAUTOPREDICTOR w/ exceptions if field has no val
HAS_ISAUTOPREDICTOR() Determine if ISAUTOPREDICTOR has a value

ReferencePredictorSummary

A summary of the reference predictor used if the predictor was retrained or upgraded.

Accessible with the following methods

Method Description
GET_REFERENCEPREDICTORSUMM() Getter for REFERENCEPREDICTORSUMMARY

Status

The status of the predictor. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

The Status of the predictor must be ACTIVE before you can use the predictor to create a 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 model training 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_PREDICTORS

TYPES TT_PREDICTORS TYPE STANDARD TABLE OF REF TO /AWS1/CL_FCSPREDICTORSUMMARY WITH DEFAULT KEY
.