Skip to content

/AWS1/CL_FCSWHATIFFCEXPUMMARY

Provides a summary of the what-if forecast export properties used in the ListWhatIfForecastExports operation. To get the complete set of properties, call the DescribeWhatIfForecastExport operation, and provide the WhatIfForecastExportArn that is listed in the summary.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_whatifforecastexportarn TYPE /AWS1/FCSLONGARN /AWS1/FCSLONGARN

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

it_whatifforecastarns TYPE /AWS1/CL_FCSWHATIFFCARNLSTFO00=>TT_WHATIFFCARNLISTFOREXPORT TT_WHATIFFCARNLISTFOREXPORT

An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.

iv_whatifforecastexportname TYPE /AWS1/FCSNAME /AWS1/FCSNAME

The what-if forecast export name.

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_status TYPE /AWS1/FCSSTATUS /AWS1/FCSSTATUS

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

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

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

WhatIfForecastArns

An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.

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

WhatIfForecastExportName

The what-if forecast export name.

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

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

Status

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

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 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

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_WHATIFFORECASTEXPORTS

TYPES TT_WHATIFFORECASTEXPORTS TYPE STANDARD TABLE OF REF TO /AWS1/CL_FCSWHATIFFCEXPUMMARY WITH DEFAULT KEY
.