Amazonka.Forecast.Types.WhatIfForecastSummary

Documentation

data WhatIfForecastSummary

Provides a summary of the what-if forecast properties used in the ListWhatIfForecasts operation. To get the complete set of properties, call the DescribeWhatIfForecast operation, and provide the WhatIfForecastArn that is listed in the summary.

See: newWhatIfForecastSummary smart constructor.

Constructors

WhatIfForecastSummary'

Fields

• creationTime :: Maybe POSIX

  When the what-if forecast was created.

• lastModificationTime :: Maybe POSIX

  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.
• message :: Maybe Text

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

• status :: Maybe Text

  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 analysis must be ACTIVE before you can access the analysis.

• whatIfAnalysisArn :: Maybe Text

  The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.

• whatIfForecastArn :: Maybe Text

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

• whatIfForecastName :: Maybe Text

  The name of the what-if forecast.

Instances

FromJSON WhatIfForecastSummary

Defined in Amazonka.Forecast.Types.WhatIfForecastSummary

Methods

parseJSON :: Value -> Parser WhatIfForecastSummary

parseJSONList :: Value -> Parser [WhatIfForecastSummary]

Generic WhatIfForecastSummary

Defined in Amazonka.Forecast.Types.WhatIfForecastSummary

Associated Types

type Rep WhatIfForecastSummary :: Type -> Type

Methods

from :: WhatIfForecastSummary -> Rep WhatIfForecastSummary x

to :: Rep WhatIfForecastSummary x -> WhatIfForecastSummary

Read WhatIfForecastSummary

Defined in Amazonka.Forecast.Types.WhatIfForecastSummary

Methods

readsPrec :: Int -> ReadS WhatIfForecastSummary

readList :: ReadS [WhatIfForecastSummary]

readPrec :: ReadPrec WhatIfForecastSummary

readListPrec :: ReadPrec [WhatIfForecastSummary]

Show WhatIfForecastSummary

Defined in Amazonka.Forecast.Types.WhatIfForecastSummary

Methods

showsPrec :: Int -> WhatIfForecastSummary -> ShowS

show :: WhatIfForecastSummary -> String

showList :: [WhatIfForecastSummary] -> ShowS

NFData WhatIfForecastSummary

Defined in Amazonka.Forecast.Types.WhatIfForecastSummary

Methods

rnf :: WhatIfForecastSummary -> ()

Eq WhatIfForecastSummary

Defined in Amazonka.Forecast.Types.WhatIfForecastSummary

Methods

(==) :: WhatIfForecastSummary -> WhatIfForecastSummary -> Bool

(/=) :: WhatIfForecastSummary -> WhatIfForecastSummary -> Bool

Hashable WhatIfForecastSummary

Defined in Amazonka.Forecast.Types.WhatIfForecastSummary

Methods

hashWithSalt :: Int -> WhatIfForecastSummary -> Int

hash :: WhatIfForecastSummary -> Int

type Rep WhatIfForecastSummary

Defined in Amazonka.Forecast.Types.WhatIfForecastSummary

type Rep WhatIfForecastSummary = D1 ('MetaData "WhatIfForecastSummary" "Amazonka.Forecast.Types.WhatIfForecastSummary" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "WhatIfForecastSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "lastModificationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "whatIfAnalysisArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "whatIfForecastArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "whatIfForecastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newWhatIfForecastSummary :: WhatIfForecastSummary

Create a value of WhatIfForecastSummary with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:WhatIfForecastSummary', whatIfForecastSummary_creationTime - When the what-if forecast was created.

$sel:lastModificationTime:WhatIfForecastSummary', whatIfForecastSummary_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.

$sel:message:WhatIfForecastSummary', whatIfForecastSummary_message - If an error occurred, an informational message about the error.

$sel:status:WhatIfForecastSummary', whatIfForecastSummary_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 analysis must be ACTIVE before you can access the analysis.

$sel:whatIfAnalysisArn:WhatIfForecastSummary', whatIfForecastSummary_whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.

$sel:whatIfForecastArn:WhatIfForecastSummary', whatIfForecastSummary_whatIfForecastArn - The Amazon Resource Name (ARN) of the what-if forecast.

$sel:whatIfForecastName:WhatIfForecastSummary', whatIfForecastSummary_whatIfForecastName - The name of the what-if forecast.

whatIfForecastSummary_creationTime :: Lens' WhatIfForecastSummary (Maybe UTCTime)

When the what-if forecast was created.

whatIfForecastSummary_lastModificationTime :: Lens' WhatIfForecastSummary (Maybe UTCTime)

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.

whatIfForecastSummary_message :: Lens' WhatIfForecastSummary (Maybe Text)

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

whatIfForecastSummary_status :: Lens' WhatIfForecastSummary (Maybe Text)

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 analysis must be ACTIVE before you can access the analysis.

whatIfForecastSummary_whatIfAnalysisArn :: Lens' WhatIfForecastSummary (Maybe Text)

The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.

whatIfForecastSummary_whatIfForecastArn :: Lens' WhatIfForecastSummary (Maybe Text)

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

whatIfForecastSummary_whatIfForecastName :: Lens' WhatIfForecastSummary (Maybe Text)

The name of the what-if forecast.