Amazonka.Forecast.Types.Action

Documentation

data Action

Defines the modifications that you are making to an attribute for a what-if forecast. For example, you can use this operation to create a what-if forecast that investigates a 10% off sale on all shoes. To do this, you specify "AttributeName": "shoes", "Operation": "MULTIPLY", and "Value": "0.90". Pair this operation with the TimeSeriesCondition operation within the CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define a subset of attribute items that are modified.

See: newAction smart constructor.

Constructors

Action'

Fields

• attributeName :: Text

  The related time series that you are modifying. This value is case insensitive.

• operation :: Operation

  The operation that is applied to the provided attribute. Operations include:

  • ADD - adds Value to all rows of AttributeName.
  • SUBTRACT - subtracts Value from all rows of AttributeName.
  • MULTIPLY - multiplies all rows of AttributeName by Value.
  • DIVIDE - divides all rows of AttributeName by Value.
• value :: Double

  The value that is applied for the chosen Operation.

Instances

FromJSON Action

Defined in Amazonka.Forecast.Types.Action

Methods

parseJSON :: Value -> Parser Action

parseJSONList :: Value -> Parser [Action]

ToJSON Action

Defined in Amazonka.Forecast.Types.Action

Methods

toJSON :: Action -> Value

toEncoding :: Action -> Encoding

toJSONList :: [Action] -> Value

toEncodingList :: [Action] -> Encoding

Generic Action

Defined in Amazonka.Forecast.Types.Action

Associated Types

type Rep Action :: Type -> Type

Methods

from :: Action -> Rep Action x

to :: Rep Action x -> Action

Read Action

Defined in Amazonka.Forecast.Types.Action

Methods

readsPrec :: Int -> ReadS Action

readList :: ReadS [Action]

readPrec :: ReadPrec Action

readListPrec :: ReadPrec [Action]

Show Action

Defined in Amazonka.Forecast.Types.Action

Methods

showsPrec :: Int -> Action -> ShowS

show :: Action -> String

showList :: [Action] -> ShowS

NFData Action

Defined in Amazonka.Forecast.Types.Action

Methods

rnf :: Action -> ()

Eq Action

Defined in Amazonka.Forecast.Types.Action

Methods

(==) :: Action -> Action -> Bool

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

Hashable Action

Defined in Amazonka.Forecast.Types.Action

Methods

hashWithSalt :: Int -> Action -> Int

hash :: Action -> Int

type Rep Action

Defined in Amazonka.Forecast.Types.Action

type Rep Action = D1 ('MetaData "Action" "Amazonka.Forecast.Types.Action" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "Action'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Operation) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double))))

newAction

Arguments

:: Text

$sel:attributeName:Action'

-> Operation

$sel:operation:Action'

-> Double

$sel:value:Action'

-> Action

Create a value of Action 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:attributeName:Action', action_attributeName - The related time series that you are modifying. This value is case insensitive.

$sel:operation:Action', action_operation - The operation that is applied to the provided attribute. Operations include:

• ADD - adds Value to all rows of AttributeName.
• SUBTRACT - subtracts Value from all rows of AttributeName.
• MULTIPLY - multiplies all rows of AttributeName by Value.
• DIVIDE - divides all rows of AttributeName by Value.

$sel:value:Action', action_value - The value that is applied for the chosen Operation.

action_attributeName :: Lens' Action Text

The related time series that you are modifying. This value is case insensitive.

action_operation :: Lens' Action Operation

The operation that is applied to the provided attribute. Operations include:

• ADD - adds Value to all rows of AttributeName.
• SUBTRACT - subtracts Value from all rows of AttributeName.
• MULTIPLY - multiplies all rows of AttributeName by Value.
• DIVIDE - divides all rows of AttributeName by Value.

action_value :: Lens' Action Double

The value that is applied for the chosen Operation.