Skip to content

/AWS1/CL_FCSDSCWHATIFFCEXPRSP

DescribeWhatIfForecastExportResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_whatifforecastexportarn TYPE /AWS1/FCSLONGARN /AWS1/FCSLONGARN

The Amazon Resource Name (ARN) of the what-if forecast export.

iv_whatifforecastexportname TYPE /AWS1/FCSNAME /AWS1/FCSNAME

The name of the what-if forecast export.

it_whatifforecastarns TYPE /AWS1/CL_FCSLONGARNLIST_W=>TT_LONGARNLIST TT_LONGARNLIST

An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.

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

The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).

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 what-if 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 what-if forecast export must be ACTIVE before you can access the forecast export.

iv_creationtime TYPE /AWS1/FCSTIMESTAMP /AWS1/FCSTIMESTAMP

When the what-if forecast export was created.

iv_estimatedtimeremainingi00 TYPE /AWS1/FCSLONG /AWS1/FCSLONG

The approximate time remaining to complete the what-if forecast export, in minutes.

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

WhatIfForecastExportArn

The Amazon Resource Name (ARN) of the what-if forecast export.

Accessible with the following methods

Method Description
GET_WHATIFFORECASTEXPORTARN() Getter for WHATIFFORECASTEXPORTARN, with configurable defaul
ASK_WHATIFFORECASTEXPORTARN() Getter for WHATIFFORECASTEXPORTARN w/ exceptions if field ha
HAS_WHATIFFORECASTEXPORTARN() Determine if WHATIFFORECASTEXPORTARN has a value

WhatIfForecastExportName

The name of the what-if forecast export.

Accessible with the following methods

Method Description
GET_WHATIFFORECASTEXPORTNAME() Getter for WHATIFFORECASTEXPORTNAME, with configurable defau
ASK_WHATIFFORECASTEXPORTNAME() Getter for WHATIFFORECASTEXPORTNAME w/ exceptions if field h
HAS_WHATIFFORECASTEXPORTNAME() Determine if WHATIFFORECASTEXPORTNAME has a value

WhatIfForecastArns

An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.

Accessible with the following methods

Method Description
GET_WHATIFFORECASTARNS() Getter for WHATIFFORECASTARNS, with configurable default
ASK_WHATIFFORECASTARNS() Getter for WHATIFFORECASTARNS w/ exceptions if field has no
HAS_WHATIFFORECASTARNS() Determine if WHATIFFORECASTARNS has a value

Destination

The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).

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 what-if 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 what-if forecast export must be ACTIVE before you can access the forecast export.

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 what-if forecast export 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

EstimatedTimeRemainingInMinutes

The approximate time remaining to complete the what-if forecast export, in minutes.

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

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