Skip to content

/AWS1/CL_FCSWHATIFALYSUMMARY

Provides a summary of the what-if analysis properties used in the ListWhatIfAnalyses operation. To get the complete set of properties, call the DescribeWhatIfAnalysis operation, and provide the WhatIfAnalysisArn that is listed in the summary.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_whatifanalysisarn TYPE /AWS1/FCSARN /AWS1/FCSARN

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

iv_whatifanalysisname TYPE /AWS1/FCSNAME /AWS1/FCSNAME

The name of the what-if analysis.

iv_forecastarn TYPE /AWS1/FCSARN /AWS1/FCSARN

The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis.

iv_status TYPE /AWS1/FCSSTATUS /AWS1/FCSSTATUS

The status of the what-if analysis. 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 analysis 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

WhatIfAnalysisArn

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

Accessible with the following methods

Method Description
GET_WHATIFANALYSISARN() Getter for WHATIFANALYSISARN, with configurable default
ASK_WHATIFANALYSISARN() Getter for WHATIFANALYSISARN w/ exceptions if field has no v
HAS_WHATIFANALYSISARN() Determine if WHATIFANALYSISARN has a value

WhatIfAnalysisName

The name of the what-if analysis.

Accessible with the following methods

Method Description
GET_WHATIFANALYSISNAME() Getter for WHATIFANALYSISNAME, with configurable default
ASK_WHATIFANALYSISNAME() Getter for WHATIFANALYSISNAME w/ exceptions if field has no
HAS_WHATIFANALYSISNAME() Determine if WHATIFANALYSISNAME has a value

ForecastArn

The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis.

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

Status

The status of the what-if analysis. 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 analysis 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_WHATIFANALYSES

TYPES TT_WHATIFANALYSES TYPE STANDARD TABLE OF REF TO /AWS1/CL_FCSWHATIFALYSUMMARY WITH DEFAULT KEY
.