{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.SSM.Types.InventoryFilter
-- 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)
module Amazonka.SSM.Types.InventoryFilter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import Amazonka.SSM.Types.InventoryQueryOperatorType

-- | One or more filters. Use a filter to return a more specific list of
-- results.
--
-- /See:/ 'newInventoryFilter' smart constructor.
data InventoryFilter = InventoryFilter'
  { -- | The type of filter.
    --
    -- The @Exists@ filter must be used with aggregators. For more information,
    -- see
    -- <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-aggregate.html Aggregating inventory data>
    -- in the /Amazon Web Services Systems Manager User Guide/.
    InventoryFilter -> Maybe InventoryQueryOperatorType
type' :: Prelude.Maybe InventoryQueryOperatorType,
    -- | The name of the filter key.
    InventoryFilter -> Text
key :: Prelude.Text,
    -- | Inventory filter values. Example: inventory filter where instance IDs
    -- are specified as values
    -- @Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal@.
    InventoryFilter -> NonEmpty Text
values :: Prelude.NonEmpty Prelude.Text
  }
  deriving (InventoryFilter -> InventoryFilter -> Bool
(InventoryFilter -> InventoryFilter -> Bool)
-> (InventoryFilter -> InventoryFilter -> Bool)
-> Eq InventoryFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: InventoryFilter -> InventoryFilter -> Bool
$c/= :: InventoryFilter -> InventoryFilter -> Bool
== :: InventoryFilter -> InventoryFilter -> Bool
$c== :: InventoryFilter -> InventoryFilter -> Bool
Prelude.Eq, ReadPrec [InventoryFilter]
ReadPrec InventoryFilter
Int -> ReadS InventoryFilter
ReadS [InventoryFilter]
(Int -> ReadS InventoryFilter)
-> ReadS [InventoryFilter]
-> ReadPrec InventoryFilter
-> ReadPrec [InventoryFilter]
-> Read InventoryFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [InventoryFilter]
$creadListPrec :: ReadPrec [InventoryFilter]
readPrec :: ReadPrec InventoryFilter
$creadPrec :: ReadPrec InventoryFilter
readList :: ReadS [InventoryFilter]
$creadList :: ReadS [InventoryFilter]
readsPrec :: Int -> ReadS InventoryFilter
$creadsPrec :: Int -> ReadS InventoryFilter
Prelude.Read, Int -> InventoryFilter -> ShowS
[InventoryFilter] -> ShowS
InventoryFilter -> String
(Int -> InventoryFilter -> ShowS)
-> (InventoryFilter -> String)
-> ([InventoryFilter] -> ShowS)
-> Show InventoryFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [InventoryFilter] -> ShowS
$cshowList :: [InventoryFilter] -> ShowS
show :: InventoryFilter -> String
$cshow :: InventoryFilter -> String
showsPrec :: Int -> InventoryFilter -> ShowS
$cshowsPrec :: Int -> InventoryFilter -> ShowS
Prelude.Show, (forall x. InventoryFilter -> Rep InventoryFilter x)
-> (forall x. Rep InventoryFilter x -> InventoryFilter)
-> Generic InventoryFilter
forall x. Rep InventoryFilter x -> InventoryFilter
forall x. InventoryFilter -> Rep InventoryFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep InventoryFilter x -> InventoryFilter
$cfrom :: forall x. InventoryFilter -> Rep InventoryFilter x
Prelude.Generic)

-- |
-- Create a value of 'InventoryFilter' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'type'', 'inventoryFilter_type' - The type of filter.
--
-- The @Exists@ filter must be used with aggregators. For more information,
-- see
-- <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-aggregate.html Aggregating inventory data>
-- in the /Amazon Web Services Systems Manager User Guide/.
--
-- 'key', 'inventoryFilter_key' - The name of the filter key.
--
-- 'values', 'inventoryFilter_values' - Inventory filter values. Example: inventory filter where instance IDs
-- are specified as values
-- @Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal@.
newInventoryFilter ::
  -- | 'key'
  Prelude.Text ->
  -- | 'values'
  Prelude.NonEmpty Prelude.Text ->
  InventoryFilter
newInventoryFilter :: Text -> NonEmpty Text -> InventoryFilter
newInventoryFilter Text
pKey_ NonEmpty Text
pValues_ =
  InventoryFilter' :: Maybe InventoryQueryOperatorType
-> Text -> NonEmpty Text -> InventoryFilter
InventoryFilter'
    { $sel:type':InventoryFilter' :: Maybe InventoryQueryOperatorType
type' = Maybe InventoryQueryOperatorType
forall a. Maybe a
Prelude.Nothing,
      $sel:key:InventoryFilter' :: Text
key = Text
pKey_,
      $sel:values:InventoryFilter' :: NonEmpty Text
values = Tagged (NonEmpty Text) (Identity (NonEmpty Text))
-> Tagged (NonEmpty Text) (Identity (NonEmpty Text))
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced (Tagged (NonEmpty Text) (Identity (NonEmpty Text))
 -> Tagged (NonEmpty Text) (Identity (NonEmpty Text)))
-> NonEmpty Text -> NonEmpty Text
forall t b. AReview t b -> b -> t
Lens.# NonEmpty Text
pValues_
    }

-- | The type of filter.
--
-- The @Exists@ filter must be used with aggregators. For more information,
-- see
-- <https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-aggregate.html Aggregating inventory data>
-- in the /Amazon Web Services Systems Manager User Guide/.
inventoryFilter_type :: Lens.Lens' InventoryFilter (Prelude.Maybe InventoryQueryOperatorType)
inventoryFilter_type :: (Maybe InventoryQueryOperatorType
 -> f (Maybe InventoryQueryOperatorType))
-> InventoryFilter -> f InventoryFilter
inventoryFilter_type = (InventoryFilter -> Maybe InventoryQueryOperatorType)
-> (InventoryFilter
    -> Maybe InventoryQueryOperatorType -> InventoryFilter)
-> Lens
     InventoryFilter
     InventoryFilter
     (Maybe InventoryQueryOperatorType)
     (Maybe InventoryQueryOperatorType)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InventoryFilter' {Maybe InventoryQueryOperatorType
type' :: Maybe InventoryQueryOperatorType
$sel:type':InventoryFilter' :: InventoryFilter -> Maybe InventoryQueryOperatorType
type'} -> Maybe InventoryQueryOperatorType
type') (\s :: InventoryFilter
s@InventoryFilter' {} Maybe InventoryQueryOperatorType
a -> InventoryFilter
s {$sel:type':InventoryFilter' :: Maybe InventoryQueryOperatorType
type' = Maybe InventoryQueryOperatorType
a} :: InventoryFilter)

-- | The name of the filter key.
inventoryFilter_key :: Lens.Lens' InventoryFilter Prelude.Text
inventoryFilter_key :: (Text -> f Text) -> InventoryFilter -> f InventoryFilter
inventoryFilter_key = (InventoryFilter -> Text)
-> (InventoryFilter -> Text -> InventoryFilter)
-> Lens InventoryFilter InventoryFilter Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InventoryFilter' {Text
key :: Text
$sel:key:InventoryFilter' :: InventoryFilter -> Text
key} -> Text
key) (\s :: InventoryFilter
s@InventoryFilter' {} Text
a -> InventoryFilter
s {$sel:key:InventoryFilter' :: Text
key = Text
a} :: InventoryFilter)

-- | Inventory filter values. Example: inventory filter where instance IDs
-- are specified as values
-- @Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal@.
inventoryFilter_values :: Lens.Lens' InventoryFilter (Prelude.NonEmpty Prelude.Text)
inventoryFilter_values :: (NonEmpty Text -> f (NonEmpty Text))
-> InventoryFilter -> f InventoryFilter
inventoryFilter_values = (InventoryFilter -> NonEmpty Text)
-> (InventoryFilter -> NonEmpty Text -> InventoryFilter)
-> Lens
     InventoryFilter InventoryFilter (NonEmpty Text) (NonEmpty Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InventoryFilter' {NonEmpty Text
values :: NonEmpty Text
$sel:values:InventoryFilter' :: InventoryFilter -> NonEmpty Text
values} -> NonEmpty Text
values) (\s :: InventoryFilter
s@InventoryFilter' {} NonEmpty Text
a -> InventoryFilter
s {$sel:values:InventoryFilter' :: NonEmpty Text
values = NonEmpty Text
a} :: InventoryFilter) ((NonEmpty Text -> f (NonEmpty Text))
 -> InventoryFilter -> f InventoryFilter)
-> ((NonEmpty Text -> f (NonEmpty Text))
    -> NonEmpty Text -> f (NonEmpty Text))
-> (NonEmpty Text -> f (NonEmpty Text))
-> InventoryFilter
-> f InventoryFilter
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. (NonEmpty Text -> f (NonEmpty Text))
-> NonEmpty Text -> f (NonEmpty Text)
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Prelude.Hashable InventoryFilter

instance Prelude.NFData InventoryFilter

instance Core.ToJSON InventoryFilter where
  toJSON :: InventoryFilter -> Value
toJSON InventoryFilter' {Maybe InventoryQueryOperatorType
NonEmpty Text
Text
values :: NonEmpty Text
key :: Text
type' :: Maybe InventoryQueryOperatorType
$sel:values:InventoryFilter' :: InventoryFilter -> NonEmpty Text
$sel:key:InventoryFilter' :: InventoryFilter -> Text
$sel:type':InventoryFilter' :: InventoryFilter -> Maybe InventoryQueryOperatorType
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"Type" Text -> InventoryQueryOperatorType -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (InventoryQueryOperatorType -> Pair)
-> Maybe InventoryQueryOperatorType -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe InventoryQueryOperatorType
type',
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Key" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
key),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Values" Text -> NonEmpty Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= NonEmpty Text
values)
          ]
      )