Amazonka.Forecast.Types.WhatIfAnalysisSummary

Documentation

data WhatIfAnalysisSummary

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.

See: newWhatIfAnalysisSummary smart constructor.

Constructors

WhatIfAnalysisSummary'

Fields

• creationTime :: Maybe POSIX

  When the what-if analysis was created.

• forecastArn :: Maybe Text

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

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

• whatIfAnalysisArn :: Maybe Text

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

• whatIfAnalysisName :: Maybe Text

  The name of the what-if analysis.

Instances

FromJSON WhatIfAnalysisSummary

Defined in Amazonka.Forecast.Types.WhatIfAnalysisSummary

Methods

parseJSON :: Value -> Parser WhatIfAnalysisSummary

parseJSONList :: Value -> Parser [WhatIfAnalysisSummary]

Generic WhatIfAnalysisSummary

Defined in Amazonka.Forecast.Types.WhatIfAnalysisSummary

Associated Types

type Rep WhatIfAnalysisSummary :: Type -> Type

Methods

from :: WhatIfAnalysisSummary -> Rep WhatIfAnalysisSummary x

to :: Rep WhatIfAnalysisSummary x -> WhatIfAnalysisSummary

Read WhatIfAnalysisSummary

Defined in Amazonka.Forecast.Types.WhatIfAnalysisSummary

Methods

readsPrec :: Int -> ReadS WhatIfAnalysisSummary

readList :: ReadS [WhatIfAnalysisSummary]

readPrec :: ReadPrec WhatIfAnalysisSummary

readListPrec :: ReadPrec [WhatIfAnalysisSummary]

Show WhatIfAnalysisSummary

Defined in Amazonka.Forecast.Types.WhatIfAnalysisSummary

Methods

showsPrec :: Int -> WhatIfAnalysisSummary -> ShowS

show :: WhatIfAnalysisSummary -> String

showList :: [WhatIfAnalysisSummary] -> ShowS

NFData WhatIfAnalysisSummary

Defined in Amazonka.Forecast.Types.WhatIfAnalysisSummary

Methods

rnf :: WhatIfAnalysisSummary -> ()

Eq WhatIfAnalysisSummary

Defined in Amazonka.Forecast.Types.WhatIfAnalysisSummary

Methods

(==) :: WhatIfAnalysisSummary -> WhatIfAnalysisSummary -> Bool

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

Hashable WhatIfAnalysisSummary

Defined in Amazonka.Forecast.Types.WhatIfAnalysisSummary

Methods

hashWithSalt :: Int -> WhatIfAnalysisSummary -> Int

hash :: WhatIfAnalysisSummary -> Int

type Rep WhatIfAnalysisSummary

Defined in Amazonka.Forecast.Types.WhatIfAnalysisSummary

type Rep WhatIfAnalysisSummary = D1 ('MetaData "WhatIfAnalysisSummary" "Amazonka.Forecast.Types.WhatIfAnalysisSummary" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "WhatIfAnalysisSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "forecastArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: 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 "whatIfAnalysisName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newWhatIfAnalysisSummary :: WhatIfAnalysisSummary

Create a value of WhatIfAnalysisSummary 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:WhatIfAnalysisSummary', whatIfAnalysisSummary_creationTime - When the what-if analysis was created.

$sel:forecastArn:WhatIfAnalysisSummary', whatIfAnalysisSummary_forecastArn - The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis.

$sel:lastModificationTime:WhatIfAnalysisSummary', whatIfAnalysisSummary_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:WhatIfAnalysisSummary', whatIfAnalysisSummary_message - If an error occurred, an informational message about the error.

$sel:status:WhatIfAnalysisSummary', whatIfAnalysisSummary_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.

$sel:whatIfAnalysisArn:WhatIfAnalysisSummary', whatIfAnalysisSummary_whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis.

$sel:whatIfAnalysisName:WhatIfAnalysisSummary', whatIfAnalysisSummary_whatIfAnalysisName - The name of the what-if analysis.

whatIfAnalysisSummary_creationTime :: Lens' WhatIfAnalysisSummary (Maybe UTCTime)

When the what-if analysis was created.

whatIfAnalysisSummary_forecastArn :: Lens' WhatIfAnalysisSummary (Maybe Text)

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

whatIfAnalysisSummary_lastModificationTime :: Lens' WhatIfAnalysisSummary (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.

whatIfAnalysisSummary_message :: Lens' WhatIfAnalysisSummary (Maybe Text)

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

whatIfAnalysisSummary_status :: Lens' WhatIfAnalysisSummary (Maybe Text)

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.

whatIfAnalysisSummary_whatIfAnalysisArn :: Lens' WhatIfAnalysisSummary (Maybe Text)

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

whatIfAnalysisSummary_whatIfAnalysisName :: Lens' WhatIfAnalysisSummary (Maybe Text)

The name of the what-if analysis.