Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Forecast.Types.WhatIfForecastExportSummary

Description

Synopsis

Documentation

data WhatIfForecastExportSummary Source #

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.

See: newWhatIfForecastExportSummary smart constructor.

Constructors

WhatIfForecastExportSummary'

Fields

creationTime :: Maybe POSIX
When the what-if forecast export was created.
destination :: Maybe DataDestination
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
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 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.
whatIfForecastArns :: Maybe (NonEmpty Text)
An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
whatIfForecastExportArn :: Maybe Text
The Amazon Resource Name (ARN) of the what-if forecast export.
whatIfForecastExportName :: Maybe Text
The what-if forecast export name.

Instances

Instances details

FromJSON WhatIfForecastExportSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WhatIfForecastExportSummary Methods parseJSON :: Value -> Parser WhatIfForecastExportSummary # parseJSONList :: Value -> Parser [WhatIfForecastExportSummary] #
Generic WhatIfForecastExportSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WhatIfForecastExportSummary Associated Types type Rep WhatIfForecastExportSummary :: Type -> Type # Methods from :: WhatIfForecastExportSummary -> Rep WhatIfForecastExportSummary x # to :: Rep WhatIfForecastExportSummary x -> WhatIfForecastExportSummary #
Read WhatIfForecastExportSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WhatIfForecastExportSummary Methods readsPrec :: Int -> ReadS WhatIfForecastExportSummary # readList :: ReadS [WhatIfForecastExportSummary] # readPrec :: ReadPrec WhatIfForecastExportSummary # readListPrec :: ReadPrec [WhatIfForecastExportSummary] #
Show WhatIfForecastExportSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WhatIfForecastExportSummary Methods showsPrec :: Int -> WhatIfForecastExportSummary -> ShowS # show :: WhatIfForecastExportSummary -> String # showList :: [WhatIfForecastExportSummary] -> ShowS #
NFData WhatIfForecastExportSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WhatIfForecastExportSummary Methods rnf :: WhatIfForecastExportSummary -> () #
Eq WhatIfForecastExportSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WhatIfForecastExportSummary Methods (==) :: WhatIfForecastExportSummary -> WhatIfForecastExportSummary -> Bool # (/=) :: WhatIfForecastExportSummary -> WhatIfForecastExportSummary -> Bool #
Hashable WhatIfForecastExportSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WhatIfForecastExportSummary Methods hashWithSalt :: Int -> WhatIfForecastExportSummary -> Int # hash :: WhatIfForecastExportSummary -> Int #
type Rep WhatIfForecastExportSummary Source #
Instance details Defined in Amazonka.Forecast.Types.WhatIfForecastExportSummary type Rep WhatIfForecastExportSummary = D1 ('MetaData "WhatIfForecastExportSummary" "Amazonka.Forecast.Types.WhatIfForecastExportSummary" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "WhatIfForecastExportSummary'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataDestination))) :: (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 "whatIfForecastArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :: (S1 ('MetaSel ('Just "whatIfForecastExportArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "whatIfForecastExportName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newWhatIfForecastExportSummary :: WhatIfForecastExportSummary Source #

Create a value of WhatIfForecastExportSummary 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:WhatIfForecastExportSummary', whatIfForecastExportSummary_creationTime - When the what-if forecast export was created.

$sel:destination:WhatIfForecastExportSummary', whatIfForecastExportSummary_destination - The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

$sel:lastModificationTime:WhatIfForecastExportSummary', whatIfForecastExportSummary_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:WhatIfForecastExportSummary', whatIfForecastExportSummary_message - If an error occurred, an informational message about the error.

$sel:status:WhatIfForecastExportSummary', whatIfForecastExportSummary_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.

$sel:whatIfForecastArns:WhatIfForecastExportSummary', whatIfForecastExportSummary_whatIfForecastArns - An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.

$sel:whatIfForecastExportArn:WhatIfForecastExportSummary', whatIfForecastExportSummary_whatIfForecastExportArn - The Amazon Resource Name (ARN) of the what-if forecast export.

$sel:whatIfForecastExportName:WhatIfForecastExportSummary', whatIfForecastExportSummary_whatIfForecastExportName - The what-if forecast export name.

whatIfForecastExportSummary_creationTime :: Lens' WhatIfForecastExportSummary (Maybe UTCTime) Source #

When the what-if forecast export was created.

whatIfForecastExportSummary_destination :: Lens' WhatIfForecastExportSummary (Maybe DataDestination) Source #

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

whatIfForecastExportSummary_lastModificationTime :: Lens' WhatIfForecastExportSummary (Maybe UTCTime) Source #

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.

whatIfForecastExportSummary_message :: Lens' WhatIfForecastExportSummary (Maybe Text) Source #

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

whatIfForecastExportSummary_status :: Lens' WhatIfForecastExportSummary (Maybe Text) Source #

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.

whatIfForecastExportSummary_whatIfForecastArns :: Lens' WhatIfForecastExportSummary (Maybe (NonEmpty Text)) Source #

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

whatIfForecastExportSummary_whatIfForecastExportArn :: Lens' WhatIfForecastExportSummary (Maybe Text) Source #

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

whatIfForecastExportSummary_whatIfForecastExportName :: Lens' WhatIfForecastExportSummary (Maybe Text) Source #

The what-if forecast export name.