You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ForecastService::Types::Filter

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

Overview

Note:

When making an API call, you may pass Filter data as a hash:

{
  key: "String", # required
  value: "Arn", # required
  condition: "IS", # required, accepts IS, IS_NOT
}

Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude, respectively, the objects that match the statement. The match statement consists of a key and a value.

Instance Attribute Summary collapse

Instance Attribute Details

#conditionString

The condition to apply.

Returns:

  • (String)


1806
1807
1808
1809
1810
1811
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1806

class Filter < Struct.new(
  :key,
  :value,
  :condition)
  include Aws::Structure
end

#keyString

The name of the parameter to filter on.

Returns:

  • (String)


1806
1807
1808
1809
1810
1811
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1806

class Filter < Struct.new(
  :key,
  :value,
  :condition)
  include Aws::Structure
end

#valueString

A valid value for Key.

Returns:

  • (String)


1806
1807
1808
1809
1810
1811
# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 1806

class Filter < Struct.new(
  :key,
  :value,
  :condition)
  include Aws::Structure
end