Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pricing.Types.Filter

Description

Synopsis

data Filter = Filter' {
- type' :: FilterType
- field :: Text
- value :: Text
}
newFilter :: FilterType -> Text -> Text -> Filter
filter_type :: Lens' Filter FilterType
filter_field :: Lens' Filter Text
filter_value :: Lens' Filter Text

Documentation

data Filter Source #

The constraints that you want all returned products to match.

See: newFilter smart constructor.

Constructors

Filter'

Fields

type' :: FilterType
The type of filter that you want to use.
Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value.
field :: Text
The product metadata field that you want to filter on. You can filter by just the service code to see all products for a specific service, filter by just the attribute name to see a specific attribute for multiple services, or use both a service code and an attribute name to retrieve only products that match both fields.
Valid values include: ServiceCode, and all attribute names
For example, you can filter by the AmazonEC2 service code and the volumeType attribute name to get the prices for only Amazon EC2 volumes.
value :: Text
The service code or attribute value that you want to filter by. If you are filtering by service code this is the actual service code, such as AmazonEC2. If you are filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume.

Instances

Instances details

Eq Filter Source #
Instance details Defined in Amazonka.Pricing.Types.Filter Methods (==) :: Filter -> Filter -> Bool # (/=) :: Filter -> Filter -> Bool #
Read Filter Source #
Instance details Defined in Amazonka.Pricing.Types.Filter Methods readsPrec :: Int -> ReadS Filter # readList :: ReadS [Filter] # readPrec :: ReadPrec Filter # readListPrec :: ReadPrec [Filter] #
Show Filter Source #
Instance details Defined in Amazonka.Pricing.Types.Filter Methods showsPrec :: Int -> Filter -> ShowS # show :: Filter -> String # showList :: [Filter] -> ShowS #
Generic Filter Source #
Instance details Defined in Amazonka.Pricing.Types.Filter Associated Types type Rep Filter :: Type -> Type # Methods from :: Filter -> Rep Filter x # to :: Rep Filter x -> Filter #
NFData Filter Source #
Instance details Defined in Amazonka.Pricing.Types.Filter Methods rnf :: Filter -> () #
Hashable Filter Source #
Instance details Defined in Amazonka.Pricing.Types.Filter Methods hashWithSalt :: Int -> Filter -> Int # hash :: Filter -> Int #
ToJSON Filter Source #
Instance details Defined in Amazonka.Pricing.Types.Filter Methods toJSON :: Filter -> Value # toEncoding :: Filter -> Encoding # toJSONList :: [Filter] -> Value # toEncodingList :: [Filter] -> Encoding #
type Rep Filter Source #
Instance details Defined in Amazonka.Pricing.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.Pricing.Types.Filter" "libZSservicesZSamazonka-pricingZSamazonka-pricing" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterType) :: (S1 ('MetaSel ('Just "field") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newFilter Source #

Arguments

:: FilterType	`$sel:type':Filter'`
-> Text	`$sel:field:Filter'`
-> Text	`$sel:value:Filter'`
-> Filter

Create a value of Filter 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:type':Filter', filter_type - The type of filter that you want to use.

Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value.

$sel:field:Filter', filter_field - The product metadata field that you want to filter on. You can filter by just the service code to see all products for a specific service, filter by just the attribute name to see a specific attribute for multiple services, or use both a service code and an attribute name to retrieve only products that match both fields.

Valid values include: ServiceCode, and all attribute names

For example, you can filter by the AmazonEC2 service code and the volumeType attribute name to get the prices for only Amazon EC2 volumes.

$sel:value:Filter', filter_value - The service code or attribute value that you want to filter by. If you are filtering by service code this is the actual service code, such as AmazonEC2. If you are filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume.

filter_type :: Lens' Filter FilterType Source #

The type of filter that you want to use.

Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value.

filter_field :: Lens' Filter Text Source #

The product metadata field that you want to filter on. You can filter by just the service code to see all products for a specific service, filter by just the attribute name to see a specific attribute for multiple services, or use both a service code and an attribute name to retrieve only products that match both fields.

Valid values include: ServiceCode, and all attribute names

For example, you can filter by the AmazonEC2 service code and the volumeType attribute name to get the prices for only Amazon EC2 volumes.

filter_value :: Lens' Filter Text Source #

The service code or attribute value that you want to filter by. If you are filtering by service code this is the actual service code, such as AmazonEC2. If you are filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume.