{-# 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.AWSHealth.Types.EntityFilter
-- 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.AWSHealth.Types.EntityFilter where

import Amazonka.AWSHealth.Types.DateTimeRange
import Amazonka.AWSHealth.Types.EntityStatusCode
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

-- | The values to use to filter results from the
-- <https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html DescribeAffectedEntities>
-- operation.
--
-- /See:/ 'newEntityFilter' smart constructor.
data EntityFilter = EntityFilter'
  { -- | A list of entity ARNs (unique identifiers).
    EntityFilter -> Maybe (NonEmpty Text)
entityArns :: Prelude.Maybe (Prelude.NonEmpty Prelude.Text),
    -- | A list of IDs for affected entities.
    EntityFilter -> Maybe (NonEmpty Text)
entityValues :: Prelude.Maybe (Prelude.NonEmpty Prelude.Text),
    -- | A list of the most recent dates and times that the entity was updated.
    EntityFilter -> Maybe (NonEmpty DateTimeRange)
lastUpdatedTimes :: Prelude.Maybe (Prelude.NonEmpty DateTimeRange),
    -- | A list of entity status codes (@IMPAIRED@, @UNIMPAIRED@, or @UNKNOWN@).
    EntityFilter -> Maybe (NonEmpty EntityStatusCode)
statusCodes :: Prelude.Maybe (Prelude.NonEmpty EntityStatusCode),
    -- | A map of entity tags attached to the affected entity.
    --
    -- Currently, the @tags@ property isn\'t supported.
    EntityFilter -> Maybe [HashMap Text Text]
tags :: Prelude.Maybe [Prelude.HashMap Prelude.Text Prelude.Text],
    -- | A list of event ARNs (unique identifiers). For example:
    -- @\"arn:aws:health:us-east-1::event\/EC2\/EC2_INSTANCE_RETIREMENT_SCHEDULED\/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456\", \"arn:aws:health:us-west-1::event\/EBS\/AWS_EBS_LOST_VOLUME\/AWS_EBS_LOST_VOLUME_CHI789_JKL101\"@
    EntityFilter -> NonEmpty Text
eventArns :: Prelude.NonEmpty Prelude.Text
  }
  deriving (EntityFilter -> EntityFilter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: EntityFilter -> EntityFilter -> Bool
$c/= :: EntityFilter -> EntityFilter -> Bool
== :: EntityFilter -> EntityFilter -> Bool
$c== :: EntityFilter -> EntityFilter -> Bool
Prelude.Eq, ReadPrec [EntityFilter]
ReadPrec EntityFilter
Int -> ReadS EntityFilter
ReadS [EntityFilter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [EntityFilter]
$creadListPrec :: ReadPrec [EntityFilter]
readPrec :: ReadPrec EntityFilter
$creadPrec :: ReadPrec EntityFilter
readList :: ReadS [EntityFilter]
$creadList :: ReadS [EntityFilter]
readsPrec :: Int -> ReadS EntityFilter
$creadsPrec :: Int -> ReadS EntityFilter
Prelude.Read, Int -> EntityFilter -> ShowS
[EntityFilter] -> ShowS
EntityFilter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [EntityFilter] -> ShowS
$cshowList :: [EntityFilter] -> ShowS
show :: EntityFilter -> String
$cshow :: EntityFilter -> String
showsPrec :: Int -> EntityFilter -> ShowS
$cshowsPrec :: Int -> EntityFilter -> ShowS
Prelude.Show, forall x. Rep EntityFilter x -> EntityFilter
forall x. EntityFilter -> Rep EntityFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep EntityFilter x -> EntityFilter
$cfrom :: forall x. EntityFilter -> Rep EntityFilter x
Prelude.Generic)

-- |
-- Create a value of 'EntityFilter' 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:
--
-- 'entityArns', 'entityFilter_entityArns' - A list of entity ARNs (unique identifiers).
--
-- 'entityValues', 'entityFilter_entityValues' - A list of IDs for affected entities.
--
-- 'lastUpdatedTimes', 'entityFilter_lastUpdatedTimes' - A list of the most recent dates and times that the entity was updated.
--
-- 'statusCodes', 'entityFilter_statusCodes' - A list of entity status codes (@IMPAIRED@, @UNIMPAIRED@, or @UNKNOWN@).
--
-- 'tags', 'entityFilter_tags' - A map of entity tags attached to the affected entity.
--
-- Currently, the @tags@ property isn\'t supported.
--
-- 'eventArns', 'entityFilter_eventArns' - A list of event ARNs (unique identifiers). For example:
-- @\"arn:aws:health:us-east-1::event\/EC2\/EC2_INSTANCE_RETIREMENT_SCHEDULED\/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456\", \"arn:aws:health:us-west-1::event\/EBS\/AWS_EBS_LOST_VOLUME\/AWS_EBS_LOST_VOLUME_CHI789_JKL101\"@
newEntityFilter ::
  -- | 'eventArns'
  Prelude.NonEmpty Prelude.Text ->
  EntityFilter
newEntityFilter :: NonEmpty Text -> EntityFilter
newEntityFilter NonEmpty Text
pEventArns_ =
  EntityFilter'
    { $sel:entityArns:EntityFilter' :: Maybe (NonEmpty Text)
entityArns = forall a. Maybe a
Prelude.Nothing,
      $sel:entityValues:EntityFilter' :: Maybe (NonEmpty Text)
entityValues = forall a. Maybe a
Prelude.Nothing,
      $sel:lastUpdatedTimes:EntityFilter' :: Maybe (NonEmpty DateTimeRange)
lastUpdatedTimes = forall a. Maybe a
Prelude.Nothing,
      $sel:statusCodes:EntityFilter' :: Maybe (NonEmpty EntityStatusCode)
statusCodes = forall a. Maybe a
Prelude.Nothing,
      $sel:tags:EntityFilter' :: Maybe [HashMap Text Text]
tags = forall a. Maybe a
Prelude.Nothing,
      $sel:eventArns:EntityFilter' :: NonEmpty Text
eventArns = forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced forall t b. AReview t b -> b -> t
Lens.# NonEmpty Text
pEventArns_
    }

-- | A list of entity ARNs (unique identifiers).
entityFilter_entityArns :: Lens.Lens' EntityFilter (Prelude.Maybe (Prelude.NonEmpty Prelude.Text))
entityFilter_entityArns :: Lens' EntityFilter (Maybe (NonEmpty Text))
entityFilter_entityArns = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityFilter' {Maybe (NonEmpty Text)
entityArns :: Maybe (NonEmpty Text)
$sel:entityArns:EntityFilter' :: EntityFilter -> Maybe (NonEmpty Text)
entityArns} -> Maybe (NonEmpty Text)
entityArns) (\s :: EntityFilter
s@EntityFilter' {} Maybe (NonEmpty Text)
a -> EntityFilter
s {$sel:entityArns:EntityFilter' :: Maybe (NonEmpty Text)
entityArns = Maybe (NonEmpty Text)
a} :: EntityFilter) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A list of IDs for affected entities.
entityFilter_entityValues :: Lens.Lens' EntityFilter (Prelude.Maybe (Prelude.NonEmpty Prelude.Text))
entityFilter_entityValues :: Lens' EntityFilter (Maybe (NonEmpty Text))
entityFilter_entityValues = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityFilter' {Maybe (NonEmpty Text)
entityValues :: Maybe (NonEmpty Text)
$sel:entityValues:EntityFilter' :: EntityFilter -> Maybe (NonEmpty Text)
entityValues} -> Maybe (NonEmpty Text)
entityValues) (\s :: EntityFilter
s@EntityFilter' {} Maybe (NonEmpty Text)
a -> EntityFilter
s {$sel:entityValues:EntityFilter' :: Maybe (NonEmpty Text)
entityValues = Maybe (NonEmpty Text)
a} :: EntityFilter) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A list of the most recent dates and times that the entity was updated.
entityFilter_lastUpdatedTimes :: Lens.Lens' EntityFilter (Prelude.Maybe (Prelude.NonEmpty DateTimeRange))
entityFilter_lastUpdatedTimes :: Lens' EntityFilter (Maybe (NonEmpty DateTimeRange))
entityFilter_lastUpdatedTimes = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityFilter' {Maybe (NonEmpty DateTimeRange)
lastUpdatedTimes :: Maybe (NonEmpty DateTimeRange)
$sel:lastUpdatedTimes:EntityFilter' :: EntityFilter -> Maybe (NonEmpty DateTimeRange)
lastUpdatedTimes} -> Maybe (NonEmpty DateTimeRange)
lastUpdatedTimes) (\s :: EntityFilter
s@EntityFilter' {} Maybe (NonEmpty DateTimeRange)
a -> EntityFilter
s {$sel:lastUpdatedTimes:EntityFilter' :: Maybe (NonEmpty DateTimeRange)
lastUpdatedTimes = Maybe (NonEmpty DateTimeRange)
a} :: EntityFilter) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A list of entity status codes (@IMPAIRED@, @UNIMPAIRED@, or @UNKNOWN@).
entityFilter_statusCodes :: Lens.Lens' EntityFilter (Prelude.Maybe (Prelude.NonEmpty EntityStatusCode))
entityFilter_statusCodes :: Lens' EntityFilter (Maybe (NonEmpty EntityStatusCode))
entityFilter_statusCodes = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityFilter' {Maybe (NonEmpty EntityStatusCode)
statusCodes :: Maybe (NonEmpty EntityStatusCode)
$sel:statusCodes:EntityFilter' :: EntityFilter -> Maybe (NonEmpty EntityStatusCode)
statusCodes} -> Maybe (NonEmpty EntityStatusCode)
statusCodes) (\s :: EntityFilter
s@EntityFilter' {} Maybe (NonEmpty EntityStatusCode)
a -> EntityFilter
s {$sel:statusCodes:EntityFilter' :: Maybe (NonEmpty EntityStatusCode)
statusCodes = Maybe (NonEmpty EntityStatusCode)
a} :: EntityFilter) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A map of entity tags attached to the affected entity.
--
-- Currently, the @tags@ property isn\'t supported.
entityFilter_tags :: Lens.Lens' EntityFilter (Prelude.Maybe [Prelude.HashMap Prelude.Text Prelude.Text])
entityFilter_tags :: Lens' EntityFilter (Maybe [HashMap Text Text])
entityFilter_tags = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityFilter' {Maybe [HashMap Text Text]
tags :: Maybe [HashMap Text Text]
$sel:tags:EntityFilter' :: EntityFilter -> Maybe [HashMap Text Text]
tags} -> Maybe [HashMap Text Text]
tags) (\s :: EntityFilter
s@EntityFilter' {} Maybe [HashMap Text Text]
a -> EntityFilter
s {$sel:tags:EntityFilter' :: Maybe [HashMap Text Text]
tags = Maybe [HashMap Text Text]
a} :: EntityFilter) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | A list of event ARNs (unique identifiers). For example:
-- @\"arn:aws:health:us-east-1::event\/EC2\/EC2_INSTANCE_RETIREMENT_SCHEDULED\/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456\", \"arn:aws:health:us-west-1::event\/EBS\/AWS_EBS_LOST_VOLUME\/AWS_EBS_LOST_VOLUME_CHI789_JKL101\"@
entityFilter_eventArns :: Lens.Lens' EntityFilter (Prelude.NonEmpty Prelude.Text)
entityFilter_eventArns :: Lens' EntityFilter (NonEmpty Text)
entityFilter_eventArns = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityFilter' {NonEmpty Text
eventArns :: NonEmpty Text
$sel:eventArns:EntityFilter' :: EntityFilter -> NonEmpty Text
eventArns} -> NonEmpty Text
eventArns) (\s :: EntityFilter
s@EntityFilter' {} NonEmpty Text
a -> EntityFilter
s {$sel:eventArns:EntityFilter' :: NonEmpty Text
eventArns = NonEmpty Text
a} :: EntityFilter) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Prelude.Hashable EntityFilter where
  hashWithSalt :: Int -> EntityFilter -> Int
hashWithSalt Int
_salt EntityFilter' {Maybe [HashMap Text Text]
Maybe (NonEmpty Text)
Maybe (NonEmpty DateTimeRange)
Maybe (NonEmpty EntityStatusCode)
NonEmpty Text
eventArns :: NonEmpty Text
tags :: Maybe [HashMap Text Text]
statusCodes :: Maybe (NonEmpty EntityStatusCode)
lastUpdatedTimes :: Maybe (NonEmpty DateTimeRange)
entityValues :: Maybe (NonEmpty Text)
entityArns :: Maybe (NonEmpty Text)
$sel:eventArns:EntityFilter' :: EntityFilter -> NonEmpty Text
$sel:tags:EntityFilter' :: EntityFilter -> Maybe [HashMap Text Text]
$sel:statusCodes:EntityFilter' :: EntityFilter -> Maybe (NonEmpty EntityStatusCode)
$sel:lastUpdatedTimes:EntityFilter' :: EntityFilter -> Maybe (NonEmpty DateTimeRange)
$sel:entityValues:EntityFilter' :: EntityFilter -> Maybe (NonEmpty Text)
$sel:entityArns:EntityFilter' :: EntityFilter -> Maybe (NonEmpty Text)
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty Text)
entityArns
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty Text)
entityValues
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty DateTimeRange)
lastUpdatedTimes
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty EntityStatusCode)
statusCodes
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [HashMap Text Text]
tags
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` NonEmpty Text
eventArns

instance Prelude.NFData EntityFilter where
  rnf :: EntityFilter -> ()
rnf EntityFilter' {Maybe [HashMap Text Text]
Maybe (NonEmpty Text)
Maybe (NonEmpty DateTimeRange)
Maybe (NonEmpty EntityStatusCode)
NonEmpty Text
eventArns :: NonEmpty Text
tags :: Maybe [HashMap Text Text]
statusCodes :: Maybe (NonEmpty EntityStatusCode)
lastUpdatedTimes :: Maybe (NonEmpty DateTimeRange)
entityValues :: Maybe (NonEmpty Text)
entityArns :: Maybe (NonEmpty Text)
$sel:eventArns:EntityFilter' :: EntityFilter -> NonEmpty Text
$sel:tags:EntityFilter' :: EntityFilter -> Maybe [HashMap Text Text]
$sel:statusCodes:EntityFilter' :: EntityFilter -> Maybe (NonEmpty EntityStatusCode)
$sel:lastUpdatedTimes:EntityFilter' :: EntityFilter -> Maybe (NonEmpty DateTimeRange)
$sel:entityValues:EntityFilter' :: EntityFilter -> Maybe (NonEmpty Text)
$sel:entityArns:EntityFilter' :: EntityFilter -> Maybe (NonEmpty Text)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty Text)
entityArns
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty Text)
entityValues
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty DateTimeRange)
lastUpdatedTimes
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty EntityStatusCode)
statusCodes
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [HashMap Text Text]
tags
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf NonEmpty Text
eventArns

instance Data.ToJSON EntityFilter where
  toJSON :: EntityFilter -> Value
toJSON EntityFilter' {Maybe [HashMap Text Text]
Maybe (NonEmpty Text)
Maybe (NonEmpty DateTimeRange)
Maybe (NonEmpty EntityStatusCode)
NonEmpty Text
eventArns :: NonEmpty Text
tags :: Maybe [HashMap Text Text]
statusCodes :: Maybe (NonEmpty EntityStatusCode)
lastUpdatedTimes :: Maybe (NonEmpty DateTimeRange)
entityValues :: Maybe (NonEmpty Text)
entityArns :: Maybe (NonEmpty Text)
$sel:eventArns:EntityFilter' :: EntityFilter -> NonEmpty Text
$sel:tags:EntityFilter' :: EntityFilter -> Maybe [HashMap Text Text]
$sel:statusCodes:EntityFilter' :: EntityFilter -> Maybe (NonEmpty EntityStatusCode)
$sel:lastUpdatedTimes:EntityFilter' :: EntityFilter -> Maybe (NonEmpty DateTimeRange)
$sel:entityValues:EntityFilter' :: EntityFilter -> Maybe (NonEmpty Text)
$sel:entityArns:EntityFilter' :: EntityFilter -> Maybe (NonEmpty Text)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"entityArns" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (NonEmpty Text)
entityArns,
            (Key
"entityValues" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (NonEmpty Text)
entityValues,
            (Key
"lastUpdatedTimes" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (NonEmpty DateTimeRange)
lastUpdatedTimes,
            (Key
"statusCodes" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (NonEmpty EntityStatusCode)
statusCodes,
            (Key
"tags" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [HashMap Text Text]
tags,
            forall a. a -> Maybe a
Prelude.Just (Key
"eventArns" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= NonEmpty Text
eventArns)
          ]
      )