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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

A what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each what-if forecast incorporates either a replacement dataset or a set of transformations to the original dataset.

Synopsis

Creating a Request

data CreateWhatIfForecast Source #

See: newCreateWhatIfForecast smart constructor.

Constructors

CreateWhatIfForecast'

Fields

tags :: Maybe [Tag]
A list of tags to apply to the what if forecast.
timeSeriesReplacementsDataSource :: Maybe TimeSeriesReplacementsDataSource
The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast. This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.
This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.
Timestamps and item_ids not included in this dataset are not included in the what-if analysis.
timeSeriesTransformations :: Maybe [TimeSeriesTransformation]
The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.
whatIfForecastName :: Text
The name of the what-if forecast. Names must be unique within each what-if analysis.
whatIfAnalysisArn :: Text
The Amazon Resource Name (ARN) of the what-if analysis.

Instances

Instances details

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

newCreateWhatIfForecast Source #

Arguments

:: Text	`CreateWhatIfForecast`
-> Text	`CreateWhatIfForecast`
-> CreateWhatIfForecast

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

$sel:timeSeriesReplacementsDataSource:CreateWhatIfForecast', createWhatIfForecast_timeSeriesReplacementsDataSource - The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast. This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.

This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.

Timestamps and item_ids not included in this dataset are not included in the what-if analysis.

$sel:timeSeriesTransformations:CreateWhatIfForecast', createWhatIfForecast_timeSeriesTransformations - The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.

CreateWhatIfForecast, createWhatIfForecast_whatIfForecastName - The name of the what-if forecast. Names must be unique within each what-if analysis.

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

Request Lenses

createWhatIfForecast_tags :: Lens' CreateWhatIfForecast (Maybe [Tag]) Source #

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

createWhatIfForecast_timeSeriesReplacementsDataSource :: Lens' CreateWhatIfForecast (Maybe TimeSeriesReplacementsDataSource) Source #

The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast. This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.

This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.

Timestamps and item_ids not included in this dataset are not included in the what-if analysis.

createWhatIfForecast_timeSeriesTransformations :: Lens' CreateWhatIfForecast (Maybe [TimeSeriesTransformation]) Source #

The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.

createWhatIfForecast_whatIfForecastName :: Lens' CreateWhatIfForecast Text Source #

The name of the what-if forecast. Names must be unique within each what-if analysis.

createWhatIfForecast_whatIfAnalysisArn :: Lens' CreateWhatIfForecast Text Source #

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

Destructuring the Response

data CreateWhatIfForecastResponse Source #

See: newCreateWhatIfForecastResponse smart constructor.

Constructors

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

Instances

Instances details

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

newCreateWhatIfForecastResponse Source #

Arguments

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

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

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

$sel:httpStatus:CreateWhatIfForecastResponse', createWhatIfForecastResponse_httpStatus - The response's http status code.

Response Lenses

createWhatIfForecastResponse_whatIfForecastArn :: Lens' CreateWhatIfForecastResponse (Maybe Text) Source #

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

createWhatIfForecastResponse_httpStatus :: Lens' CreateWhatIfForecastResponse Int Source #

The response's http status code.