{-# 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-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.SSM.Types.DocumentKeyValuesFilter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
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@
--
--     -   @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 name of the filter key.
    key :: Prelude.Maybe Prelude.Text,
    -- | The value for the filter key.
    values :: Prelude.Maybe [Prelude.Text]
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, 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:
--
-- 'key', 'documentKeyValuesFilter_key' - The name of the filter key.
--
-- 'values', 'documentKeyValuesFilter_values' - The value for the filter key.
newDocumentKeyValuesFilter ::
  DocumentKeyValuesFilter
newDocumentKeyValuesFilter =
  DocumentKeyValuesFilter'
    { key = Prelude.Nothing,
      values = Prelude.Nothing
    }

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

-- | The value for the filter key.
documentKeyValuesFilter_values :: Lens.Lens' DocumentKeyValuesFilter (Prelude.Maybe [Prelude.Text])
documentKeyValuesFilter_values = Lens.lens (\DocumentKeyValuesFilter' {values} -> values) (\s@DocumentKeyValuesFilter' {} a -> s {values = a} :: DocumentKeyValuesFilter) Prelude.. Lens.mapping Lens.coerced

instance Prelude.Hashable DocumentKeyValuesFilter where
  hashWithSalt _salt DocumentKeyValuesFilter' {..} =
    _salt
      `Prelude.hashWithSalt` key
      `Prelude.hashWithSalt` values

instance Prelude.NFData DocumentKeyValuesFilter where
  rnf DocumentKeyValuesFilter' {..} =
    Prelude.rnf key `Prelude.seq` Prelude.rnf values

instance Data.ToJSON DocumentKeyValuesFilter where
  toJSON DocumentKeyValuesFilter' {..} =
    Data.object
      ( Prelude.catMaybes
          [ ("Key" Data..=) Prelude.<$> key,
            ("Values" Data..=) Prelude.<$> values
          ]
      )