Skip to content

/AWS1/CL_FCSDESCRFCEXPJOBRSP

DescribeForecastExportJobResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_forecastexportjobarn TYPE /AWS1/FCSARN /AWS1/FCSARN

The ARN of the forecast export job.

iv_forecastexportjobname TYPE /AWS1/FCSNAME /AWS1/FCSNAME

The name of the forecast export job.

iv_forecastarn TYPE /AWS1/FCSARN /AWS1/FCSARN

The Amazon Resource Name (ARN) of the exported forecast.

io_destination TYPE REF TO /AWS1/CL_FCSDATADESTINATION /AWS1/CL_FCSDATADESTINATION

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

iv_message TYPE /AWS1/FCSMESSAGE /AWS1/FCSMESSAGE

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

iv_status TYPE /AWS1/FCSSTATUS /AWS1/FCSSTATUS

The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.

iv_creationtime TYPE /AWS1/FCSTIMESTAMP /AWS1/FCSTIMESTAMP

When the forecast export job 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.

iv_format TYPE /AWS1/FCSFORMAT /AWS1/FCSFORMAT

The format of the exported data, CSV or PARQUET.

Queryable Attributes

ForecastExportJobArn

The ARN of the forecast export job.

Accessible with the following methods

Method Description
GET_FORECASTEXPORTJOBARN() Getter for FORECASTEXPORTJOBARN, with configurable default
ASK_FORECASTEXPORTJOBARN() Getter for FORECASTEXPORTJOBARN w/ exceptions if field has n
HAS_FORECASTEXPORTJOBARN() Determine if FORECASTEXPORTJOBARN has a value

ForecastExportJobName

The name of the forecast export job.

Accessible with the following methods

Method Description
GET_FORECASTEXPORTJOBNAME() Getter for FORECASTEXPORTJOBNAME, with configurable default
ASK_FORECASTEXPORTJOBNAME() Getter for FORECASTEXPORTJOBNAME w/ exceptions if field has
HAS_FORECASTEXPORTJOBNAME() Determine if FORECASTEXPORTJOBNAME has a value

ForecastArn

The Amazon Resource Name (ARN) of the exported 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

Destination

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

Accessible with the following methods

Method Description
GET_DESTINATION() Getter for DESTINATION

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

Status

The status of the forecast export job. 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 export job must be ACTIVE before you can access the forecast in your S3 bucket.

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

CreationTime

When the forecast export job 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

Format

The format of the exported data, CSV or PARQUET.

Accessible with the following methods

Method Description
GET_FORMAT() Getter for FORMAT, with configurable default
ASK_FORMAT() Getter for FORMAT w/ exceptions if field has no value
HAS_FORMAT() Determine if FORMAT has a value