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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to remember that the purpose of a what-if analysis is to understand how a forecast can change given different modifications to the baseline time series.

For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales tactics might affect your goals. You could create a scenario where everything is given a 25% markdown and another where everything is given a fixed dollar markdown. You can create a scenario where the sale lasts for 1 week and another where the sale lasts for 1 month. Your what-if analysis enables you to compare many different scenarios against each other.

Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.

The TimeSeriesSelector object defines the items that you want in the what-if analysis.

Synopsis

Creating a Request

data CreateWhatIfAnalysis Source #

See: newCreateWhatIfAnalysis smart constructor.

Constructors

CreateWhatIfAnalysis'

Fields

tags :: Maybe [Tag]
A list of tags to apply to the what if forecast.
timeSeriesSelector :: Maybe TimeSeriesSelector
Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.
The TimeSeriesIdentifiers object needs the following information:
- ```
DataSource
```
- ```
Format
```
- ```
Schema
```
whatIfAnalysisName :: Text
The name of the what-if analysis. Each name must be unique.
forecastArn :: Text
The Amazon Resource Name (ARN) of the baseline forecast.

Instances

Instances details

ToJSON CreateWhatIfAnalysis Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Methods toJSON :: CreateWhatIfAnalysis -> Value # toEncoding :: CreateWhatIfAnalysis -> Encoding # toJSONList :: [CreateWhatIfAnalysis] -> Value # toEncodingList :: [CreateWhatIfAnalysis] -> Encoding #
ToHeaders CreateWhatIfAnalysis Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Methods toHeaders :: CreateWhatIfAnalysis -> [Header] #
ToPath CreateWhatIfAnalysis Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Methods toPath :: CreateWhatIfAnalysis -> ByteString #
ToQuery CreateWhatIfAnalysis Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Methods toQuery :: CreateWhatIfAnalysis -> QueryString #
AWSRequest CreateWhatIfAnalysis Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Associated Types type AWSResponse CreateWhatIfAnalysis # Methods request :: (Service -> Service) -> CreateWhatIfAnalysis -> Request CreateWhatIfAnalysis # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateWhatIfAnalysis -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateWhatIfAnalysis))) #
Generic CreateWhatIfAnalysis Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Associated Types type Rep CreateWhatIfAnalysis :: Type -> Type # Methods from :: CreateWhatIfAnalysis -> Rep CreateWhatIfAnalysis x # to :: Rep CreateWhatIfAnalysis x -> CreateWhatIfAnalysis #
Show CreateWhatIfAnalysis Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Methods showsPrec :: Int -> CreateWhatIfAnalysis -> ShowS # show :: CreateWhatIfAnalysis -> String # showList :: [CreateWhatIfAnalysis] -> ShowS #
NFData CreateWhatIfAnalysis Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Methods rnf :: CreateWhatIfAnalysis -> () #
Eq CreateWhatIfAnalysis Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Methods (==) :: CreateWhatIfAnalysis -> CreateWhatIfAnalysis -> Bool # (/=) :: CreateWhatIfAnalysis -> CreateWhatIfAnalysis -> Bool #
Hashable CreateWhatIfAnalysis Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Methods hashWithSalt :: Int -> CreateWhatIfAnalysis -> Int # hash :: CreateWhatIfAnalysis -> Int #
type AWSResponse CreateWhatIfAnalysis Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis type AWSResponse CreateWhatIfAnalysis = CreateWhatIfAnalysisResponse
type Rep CreateWhatIfAnalysis Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis type Rep CreateWhatIfAnalysis = D1 ('MetaData "CreateWhatIfAnalysis" "Amazonka.Forecast.CreateWhatIfAnalysis" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "CreateWhatIfAnalysis'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "timeSeriesSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeSeriesSelector))) :: (S1 ('MetaSel ('Just "whatIfAnalysisName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "forecastArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateWhatIfAnalysis Source #

Arguments

:: Text	`CreateWhatIfAnalysis`
-> Text	`CreateWhatIfAnalysis`
-> CreateWhatIfAnalysis

Create a value of CreateWhatIfAnalysis 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:tags:CreateWhatIfAnalysis', createWhatIfAnalysis_tags - A list of tags to apply to the what if forecast.

$sel:timeSeriesSelector:CreateWhatIfAnalysis', createWhatIfAnalysis_timeSeriesSelector - Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.

The TimeSeriesIdentifiers object needs the following information:

```
DataSource
```
```
Format
```
```
Schema
```

CreateWhatIfAnalysis, createWhatIfAnalysis_whatIfAnalysisName - The name of the what-if analysis. Each name must be unique.

CreateWhatIfAnalysis, createWhatIfAnalysis_forecastArn - The Amazon Resource Name (ARN) of the baseline forecast.

Request Lenses

createWhatIfAnalysis_tags :: Lens' CreateWhatIfAnalysis (Maybe [Tag]) Source #

A list of tags to apply to the what if forecast.

createWhatIfAnalysis_timeSeriesSelector :: Lens' CreateWhatIfAnalysis (Maybe TimeSeriesSelector) Source #

Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.

The TimeSeriesIdentifiers object needs the following information:

```
DataSource
```
```
Format
```
```
Schema
```

createWhatIfAnalysis_whatIfAnalysisName :: Lens' CreateWhatIfAnalysis Text Source #

The name of the what-if analysis. Each name must be unique.

createWhatIfAnalysis_forecastArn :: Lens' CreateWhatIfAnalysis Text Source #

The Amazon Resource Name (ARN) of the baseline forecast.

Destructuring the Response

data CreateWhatIfAnalysisResponse Source #

See: newCreateWhatIfAnalysisResponse smart constructor.

Constructors

CreateWhatIfAnalysisResponse'
Fields whatIfAnalysisArn :: Maybe Text The Amazon Resource Name (ARN) of the what-if analysis. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateWhatIfAnalysisResponse Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Associated Types type Rep CreateWhatIfAnalysisResponse :: Type -> Type # Methods from :: CreateWhatIfAnalysisResponse -> Rep CreateWhatIfAnalysisResponse x # to :: Rep CreateWhatIfAnalysisResponse x -> CreateWhatIfAnalysisResponse #
Read CreateWhatIfAnalysisResponse Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Methods readsPrec :: Int -> ReadS CreateWhatIfAnalysisResponse # readList :: ReadS [CreateWhatIfAnalysisResponse] # readPrec :: ReadPrec CreateWhatIfAnalysisResponse # readListPrec :: ReadPrec [CreateWhatIfAnalysisResponse] #
Show CreateWhatIfAnalysisResponse Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Methods showsPrec :: Int -> CreateWhatIfAnalysisResponse -> ShowS # show :: CreateWhatIfAnalysisResponse -> String # showList :: [CreateWhatIfAnalysisResponse] -> ShowS #
NFData CreateWhatIfAnalysisResponse Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Methods rnf :: CreateWhatIfAnalysisResponse -> () #
Eq CreateWhatIfAnalysisResponse Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis Methods (==) :: CreateWhatIfAnalysisResponse -> CreateWhatIfAnalysisResponse -> Bool # (/=) :: CreateWhatIfAnalysisResponse -> CreateWhatIfAnalysisResponse -> Bool #
type Rep CreateWhatIfAnalysisResponse Source #
Instance details Defined in Amazonka.Forecast.CreateWhatIfAnalysis type Rep CreateWhatIfAnalysisResponse = D1 ('MetaData "CreateWhatIfAnalysisResponse" "Amazonka.Forecast.CreateWhatIfAnalysis" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "CreateWhatIfAnalysisResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "whatIfAnalysisArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateWhatIfAnalysisResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateWhatIfAnalysisResponse'`
-> CreateWhatIfAnalysisResponse

Create a value of CreateWhatIfAnalysisResponse 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:

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

$sel:httpStatus:CreateWhatIfAnalysisResponse', createWhatIfAnalysisResponse_httpStatus - The response's http status code.

Response Lenses

createWhatIfAnalysisResponse_whatIfAnalysisArn :: Lens' CreateWhatIfAnalysisResponse (Maybe Text) Source #

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

createWhatIfAnalysisResponse_httpStatus :: Lens' CreateWhatIfAnalysisResponse Int Source #

The response's http status code.