Class: Aws::ForecastService::Types::Action

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

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 Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_name ⇒ String

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

Returns:

  • (String) 


46
47
48
49
50
51
52
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 46

class Action < Struct.new(
  :attribute_name,
  :operation,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#operation ⇒ String

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.

Returns:

  • (String) 


46
47
48
49
50
51
52
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 46

class Action < Struct.new(
  :attribute_name,
  :operation,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ Float

The value that is applied for the chosen Operation.

Returns:

  • (Float) 


46
47
48
49
50
51
52
 
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 46

class Action < Struct.new(
  :attribute_name,
  :operation,
  :value)
  SENSITIVE = []
  include Aws::Structure
end