{-# 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.DocumentKeyValuesFilter
-- 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.DocumentKeyValuesFilter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | One or more filters. Use a filter to return a more specific list of
-- documents.
--
-- For keys, you can specify one or more tags that have been applied to a
-- document.
--
-- You can also use Amazon Web Services-provided keys, some of which have
-- specific allowed values. These keys and their associated values are as
-- follows:
--
-- [DocumentType]
--     -   @ApplicationConfiguration@
--
--     -   @ApplicationConfigurationSchema@
--
--     -   @Automation@
--
--     -   @ChangeCalendar@
--
--     -   @Command@
--
--     -   @DeploymentStrategy@
--
--     -   @Package@
--
--     -   @Policy@
--
--     -   @Session@
--
-- [Owner]
--     Note that only one @Owner@ can be specified in a request. For
--     example: @Key=Owner,Values=Self@.
--
--     -   @Amazon@
--
--     -   @Private@
--
--     -   @Public@
--
--     -   @Self@
--
--     -   @ThirdParty@
--
-- [PlatformTypes]
--     -   @Linux@
--
--     -   @Windows@
--
-- @Name@ is another Amazon Web Services-provided key. If you use @Name@ as
-- a key, you can use a name prefix to return a list of documents. For
-- example, in the Amazon Web Services CLI, to return a list of all
-- documents that begin with @Te@, run the following command:
--
-- @aws ssm list-documents --filters Key=Name,Values=Te@
--
-- You can also use the @TargetType@ Amazon Web Services-provided key. For
-- a list of valid resource type values that can be used with this key, see
-- <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html Amazon Web Services resource and property types reference>
-- in the /CloudFormation User Guide/.
--
-- If you specify more than two keys, only documents that are identified by
-- all the tags are returned in the results. If you specify more than two
-- values for a key, documents that are identified by any of the values are
-- returned in the results.
--
-- To specify a custom key-value pair, use the format
-- @Key=tag:tagName,Values=valueName@.
--
-- For example, if you created a key called region and are using the Amazon
-- Web Services CLI to call the @list-documents@ command:
--
-- @aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self@
--
-- /See:/ 'newDocumentKeyValuesFilter' smart constructor.
data DocumentKeyValuesFilter = DocumentKeyValuesFilter'
  { -- | The value for the filter key.
    DocumentKeyValuesFilter -> Maybe [Text]
values :: Prelude.Maybe [Prelude.Text],
    -- | The name of the filter key.
    DocumentKeyValuesFilter -> Maybe Text
key :: Prelude.Maybe Prelude.Text
  }
  deriving (DocumentKeyValuesFilter -> DocumentKeyValuesFilter -> Bool
(DocumentKeyValuesFilter -> DocumentKeyValuesFilter -> Bool)
-> (DocumentKeyValuesFilter -> DocumentKeyValuesFilter -> Bool)
-> Eq DocumentKeyValuesFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DocumentKeyValuesFilter -> DocumentKeyValuesFilter -> Bool
$c/= :: DocumentKeyValuesFilter -> DocumentKeyValuesFilter -> Bool
== :: DocumentKeyValuesFilter -> DocumentKeyValuesFilter -> Bool
$c== :: DocumentKeyValuesFilter -> DocumentKeyValuesFilter -> Bool
Prelude.Eq, ReadPrec [DocumentKeyValuesFilter]
ReadPrec DocumentKeyValuesFilter
Int -> ReadS DocumentKeyValuesFilter
ReadS [DocumentKeyValuesFilter]
(Int -> ReadS DocumentKeyValuesFilter)
-> ReadS [DocumentKeyValuesFilter]
-> ReadPrec DocumentKeyValuesFilter
-> ReadPrec [DocumentKeyValuesFilter]
-> Read DocumentKeyValuesFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DocumentKeyValuesFilter]
$creadListPrec :: ReadPrec [DocumentKeyValuesFilter]
readPrec :: ReadPrec DocumentKeyValuesFilter
$creadPrec :: ReadPrec DocumentKeyValuesFilter
readList :: ReadS [DocumentKeyValuesFilter]
$creadList :: ReadS [DocumentKeyValuesFilter]
readsPrec :: Int -> ReadS DocumentKeyValuesFilter
$creadsPrec :: Int -> ReadS DocumentKeyValuesFilter
Prelude.Read, Int -> DocumentKeyValuesFilter -> ShowS
[DocumentKeyValuesFilter] -> ShowS
DocumentKeyValuesFilter -> String
(Int -> DocumentKeyValuesFilter -> ShowS)
-> (DocumentKeyValuesFilter -> String)
-> ([DocumentKeyValuesFilter] -> ShowS)
-> Show DocumentKeyValuesFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DocumentKeyValuesFilter] -> ShowS
$cshowList :: [DocumentKeyValuesFilter] -> ShowS
show :: DocumentKeyValuesFilter -> String
$cshow :: DocumentKeyValuesFilter -> String
showsPrec :: Int -> DocumentKeyValuesFilter -> ShowS
$cshowsPrec :: Int -> DocumentKeyValuesFilter -> ShowS
Prelude.Show, (forall x.
 DocumentKeyValuesFilter -> Rep DocumentKeyValuesFilter x)
-> (forall x.
    Rep DocumentKeyValuesFilter x -> DocumentKeyValuesFilter)
-> Generic DocumentKeyValuesFilter
forall x. Rep DocumentKeyValuesFilter x -> DocumentKeyValuesFilter
forall x. DocumentKeyValuesFilter -> Rep DocumentKeyValuesFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DocumentKeyValuesFilter x -> DocumentKeyValuesFilter
$cfrom :: forall x. DocumentKeyValuesFilter -> Rep DocumentKeyValuesFilter x
Prelude.Generic)

-- |
-- Create a value of 'DocumentKeyValuesFilter' 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:
--
-- 'values', 'documentKeyValuesFilter_values' - The value for the filter key.
--
-- 'key', 'documentKeyValuesFilter_key' - The name of the filter key.
newDocumentKeyValuesFilter ::
  DocumentKeyValuesFilter
newDocumentKeyValuesFilter :: DocumentKeyValuesFilter
newDocumentKeyValuesFilter =
  DocumentKeyValuesFilter' :: Maybe [Text] -> Maybe Text -> DocumentKeyValuesFilter
DocumentKeyValuesFilter'
    { $sel:values:DocumentKeyValuesFilter' :: Maybe [Text]
values = Maybe [Text]
forall a. Maybe a
Prelude.Nothing,
      $sel:key:DocumentKeyValuesFilter' :: Maybe Text
key = Maybe Text
forall a. Maybe a
Prelude.Nothing
    }

-- | The value for the filter key.
documentKeyValuesFilter_values :: Lens.Lens' DocumentKeyValuesFilter (Prelude.Maybe [Prelude.Text])
documentKeyValuesFilter_values :: (Maybe [Text] -> f (Maybe [Text]))
-> DocumentKeyValuesFilter -> f DocumentKeyValuesFilter
documentKeyValuesFilter_values = (DocumentKeyValuesFilter -> Maybe [Text])
-> (DocumentKeyValuesFilter
    -> Maybe [Text] -> DocumentKeyValuesFilter)
-> Lens
     DocumentKeyValuesFilter
     DocumentKeyValuesFilter
     (Maybe [Text])
     (Maybe [Text])
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentKeyValuesFilter' {Maybe [Text]
values :: Maybe [Text]
$sel:values:DocumentKeyValuesFilter' :: DocumentKeyValuesFilter -> Maybe [Text]
values} -> Maybe [Text]
values) (\s :: DocumentKeyValuesFilter
s@DocumentKeyValuesFilter' {} Maybe [Text]
a -> DocumentKeyValuesFilter
s {$sel:values:DocumentKeyValuesFilter' :: Maybe [Text]
values = Maybe [Text]
a} :: DocumentKeyValuesFilter) ((Maybe [Text] -> f (Maybe [Text]))
 -> DocumentKeyValuesFilter -> f DocumentKeyValuesFilter)
-> ((Maybe [Text] -> f (Maybe [Text]))
    -> Maybe [Text] -> f (Maybe [Text]))
-> (Maybe [Text] -> f (Maybe [Text]))
-> DocumentKeyValuesFilter
-> f DocumentKeyValuesFilter
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso [Text] [Text] [Text] [Text]
-> Iso (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text])
forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping AnIso [Text] [Text] [Text] [Text]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

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

instance Prelude.Hashable DocumentKeyValuesFilter

instance Prelude.NFData DocumentKeyValuesFilter

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