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

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

-- |
-- Module      : Amazonka.GreengrassV2.ResolveComponentCandidates
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Retrieves a list of components that meet the component, version, and
-- platform requirements of a deployment. Greengrass core devices call this
-- operation when they receive a deployment to identify the components to
-- install.
--
-- This operation identifies components that meet all dependency
-- requirements for a deployment. If the requirements conflict, then this
-- operation returns an error and the deployment fails. For example, this
-- occurs if component @A@ requires version @>2.0.0@ and component @B@
-- requires version @\<2.0.0@ of a component dependency.
--
-- When you specify the component candidates to resolve, IoT Greengrass
-- compares each component\'s digest from the core device with the
-- component\'s digest in the Amazon Web Services Cloud. If the digests
-- don\'t match, then IoT Greengrass specifies to use the version from the
-- Amazon Web Services Cloud.
--
-- To use this operation, you must use the data plane API endpoint and
-- authenticate with an IoT device certificate. For more information, see
-- <https://docs.aws.amazon.com/general/latest/gr/greengrass.html IoT Greengrass endpoints and quotas>.
module Amazonka.GreengrassV2.ResolveComponentCandidates
  ( -- * Creating a Request
    ResolveComponentCandidates (..),
    newResolveComponentCandidates,

    -- * Request Lenses
    resolveComponentCandidates_componentCandidates,
    resolveComponentCandidates_platform,

    -- * Destructuring the Response
    ResolveComponentCandidatesResponse (..),
    newResolveComponentCandidatesResponse,

    -- * Response Lenses
    resolveComponentCandidatesResponse_resolvedComponentVersions,
    resolveComponentCandidatesResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.GreengrassV2.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newResolveComponentCandidates' smart constructor.
data ResolveComponentCandidates = ResolveComponentCandidates'
  { -- | The list of components to resolve.
    ResolveComponentCandidates -> Maybe [ComponentCandidate]
componentCandidates :: Prelude.Maybe [ComponentCandidate],
    -- | The platform to use to resolve compatible components.
    ResolveComponentCandidates -> Maybe ComponentPlatform
platform :: Prelude.Maybe ComponentPlatform
  }
  deriving (ResolveComponentCandidates -> ResolveComponentCandidates -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ResolveComponentCandidates -> ResolveComponentCandidates -> Bool
$c/= :: ResolveComponentCandidates -> ResolveComponentCandidates -> Bool
== :: ResolveComponentCandidates -> ResolveComponentCandidates -> Bool
$c== :: ResolveComponentCandidates -> ResolveComponentCandidates -> Bool
Prelude.Eq, ReadPrec [ResolveComponentCandidates]
ReadPrec ResolveComponentCandidates
Int -> ReadS ResolveComponentCandidates
ReadS [ResolveComponentCandidates]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ResolveComponentCandidates]
$creadListPrec :: ReadPrec [ResolveComponentCandidates]
readPrec :: ReadPrec ResolveComponentCandidates
$creadPrec :: ReadPrec ResolveComponentCandidates
readList :: ReadS [ResolveComponentCandidates]
$creadList :: ReadS [ResolveComponentCandidates]
readsPrec :: Int -> ReadS ResolveComponentCandidates
$creadsPrec :: Int -> ReadS ResolveComponentCandidates
Prelude.Read, Int -> ResolveComponentCandidates -> ShowS
[ResolveComponentCandidates] -> ShowS
ResolveComponentCandidates -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ResolveComponentCandidates] -> ShowS
$cshowList :: [ResolveComponentCandidates] -> ShowS
show :: ResolveComponentCandidates -> String
$cshow :: ResolveComponentCandidates -> String
showsPrec :: Int -> ResolveComponentCandidates -> ShowS
$cshowsPrec :: Int -> ResolveComponentCandidates -> ShowS
Prelude.Show, forall x.
Rep ResolveComponentCandidates x -> ResolveComponentCandidates
forall x.
ResolveComponentCandidates -> Rep ResolveComponentCandidates x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ResolveComponentCandidates x -> ResolveComponentCandidates
$cfrom :: forall x.
ResolveComponentCandidates -> Rep ResolveComponentCandidates x
Prelude.Generic)

-- |
-- Create a value of 'ResolveComponentCandidates' 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:
--
-- 'componentCandidates', 'resolveComponentCandidates_componentCandidates' - The list of components to resolve.
--
-- 'platform', 'resolveComponentCandidates_platform' - The platform to use to resolve compatible components.
newResolveComponentCandidates ::
  ResolveComponentCandidates
newResolveComponentCandidates :: ResolveComponentCandidates
newResolveComponentCandidates =
  ResolveComponentCandidates'
    { $sel:componentCandidates:ResolveComponentCandidates' :: Maybe [ComponentCandidate]
componentCandidates =
        forall a. Maybe a
Prelude.Nothing,
      $sel:platform:ResolveComponentCandidates' :: Maybe ComponentPlatform
platform = forall a. Maybe a
Prelude.Nothing
    }

-- | The list of components to resolve.
resolveComponentCandidates_componentCandidates :: Lens.Lens' ResolveComponentCandidates (Prelude.Maybe [ComponentCandidate])
resolveComponentCandidates_componentCandidates :: Lens' ResolveComponentCandidates (Maybe [ComponentCandidate])
resolveComponentCandidates_componentCandidates = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ResolveComponentCandidates' {Maybe [ComponentCandidate]
componentCandidates :: Maybe [ComponentCandidate]
$sel:componentCandidates:ResolveComponentCandidates' :: ResolveComponentCandidates -> Maybe [ComponentCandidate]
componentCandidates} -> Maybe [ComponentCandidate]
componentCandidates) (\s :: ResolveComponentCandidates
s@ResolveComponentCandidates' {} Maybe [ComponentCandidate]
a -> ResolveComponentCandidates
s {$sel:componentCandidates:ResolveComponentCandidates' :: Maybe [ComponentCandidate]
componentCandidates = Maybe [ComponentCandidate]
a} :: ResolveComponentCandidates) 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

-- | The platform to use to resolve compatible components.
resolveComponentCandidates_platform :: Lens.Lens' ResolveComponentCandidates (Prelude.Maybe ComponentPlatform)
resolveComponentCandidates_platform :: Lens' ResolveComponentCandidates (Maybe ComponentPlatform)
resolveComponentCandidates_platform = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ResolveComponentCandidates' {Maybe ComponentPlatform
platform :: Maybe ComponentPlatform
$sel:platform:ResolveComponentCandidates' :: ResolveComponentCandidates -> Maybe ComponentPlatform
platform} -> Maybe ComponentPlatform
platform) (\s :: ResolveComponentCandidates
s@ResolveComponentCandidates' {} Maybe ComponentPlatform
a -> ResolveComponentCandidates
s {$sel:platform:ResolveComponentCandidates' :: Maybe ComponentPlatform
platform = Maybe ComponentPlatform
a} :: ResolveComponentCandidates)

instance Core.AWSRequest ResolveComponentCandidates where
  type
    AWSResponse ResolveComponentCandidates =
      ResolveComponentCandidatesResponse
  request :: (Service -> Service)
-> ResolveComponentCandidates -> Request ResolveComponentCandidates
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy ResolveComponentCandidates
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse ResolveComponentCandidates)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe [ResolvedComponentVersion]
-> Int -> ResolveComponentCandidatesResponse
ResolveComponentCandidatesResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> ( Object
x
                            forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"resolvedComponentVersions"
                            forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                        )
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable ResolveComponentCandidates where
  hashWithSalt :: Int -> ResolveComponentCandidates -> Int
hashWithSalt Int
_salt ResolveComponentCandidates' {Maybe [ComponentCandidate]
Maybe ComponentPlatform
platform :: Maybe ComponentPlatform
componentCandidates :: Maybe [ComponentCandidate]
$sel:platform:ResolveComponentCandidates' :: ResolveComponentCandidates -> Maybe ComponentPlatform
$sel:componentCandidates:ResolveComponentCandidates' :: ResolveComponentCandidates -> Maybe [ComponentCandidate]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [ComponentCandidate]
componentCandidates
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ComponentPlatform
platform

instance Prelude.NFData ResolveComponentCandidates where
  rnf :: ResolveComponentCandidates -> ()
rnf ResolveComponentCandidates' {Maybe [ComponentCandidate]
Maybe ComponentPlatform
platform :: Maybe ComponentPlatform
componentCandidates :: Maybe [ComponentCandidate]
$sel:platform:ResolveComponentCandidates' :: ResolveComponentCandidates -> Maybe ComponentPlatform
$sel:componentCandidates:ResolveComponentCandidates' :: ResolveComponentCandidates -> Maybe [ComponentCandidate]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [ComponentCandidate]
componentCandidates
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ComponentPlatform
platform

instance Data.ToHeaders ResolveComponentCandidates where
  toHeaders :: ResolveComponentCandidates -> ResponseHeaders
toHeaders = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

instance Data.ToJSON ResolveComponentCandidates where
  toJSON :: ResolveComponentCandidates -> Value
toJSON ResolveComponentCandidates' {Maybe [ComponentCandidate]
Maybe ComponentPlatform
platform :: Maybe ComponentPlatform
componentCandidates :: Maybe [ComponentCandidate]
$sel:platform:ResolveComponentCandidates' :: ResolveComponentCandidates -> Maybe ComponentPlatform
$sel:componentCandidates:ResolveComponentCandidates' :: ResolveComponentCandidates -> Maybe [ComponentCandidate]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"componentCandidates" 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 [ComponentCandidate]
componentCandidates,
            (Key
"platform" 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 ComponentPlatform
platform
          ]
      )

instance Data.ToPath ResolveComponentCandidates where
  toPath :: ResolveComponentCandidates -> ByteString
toPath =
    forall a b. a -> b -> a
Prelude.const
      ByteString
"/greengrass/v2/resolveComponentCandidates"

instance Data.ToQuery ResolveComponentCandidates where
  toQuery :: ResolveComponentCandidates -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newResolveComponentCandidatesResponse' smart constructor.
data ResolveComponentCandidatesResponse = ResolveComponentCandidatesResponse'
  { -- | A list of components that meet the requirements that you specify in the
    -- request. This list includes each component\'s recipe that you can use to
    -- install the component.
    ResolveComponentCandidatesResponse
-> Maybe [ResolvedComponentVersion]
resolvedComponentVersions :: Prelude.Maybe [ResolvedComponentVersion],
    -- | The response's http status code.
    ResolveComponentCandidatesResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ResolveComponentCandidatesResponse
-> ResolveComponentCandidatesResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ResolveComponentCandidatesResponse
-> ResolveComponentCandidatesResponse -> Bool
$c/= :: ResolveComponentCandidatesResponse
-> ResolveComponentCandidatesResponse -> Bool
== :: ResolveComponentCandidatesResponse
-> ResolveComponentCandidatesResponse -> Bool
$c== :: ResolveComponentCandidatesResponse
-> ResolveComponentCandidatesResponse -> Bool
Prelude.Eq, ReadPrec [ResolveComponentCandidatesResponse]
ReadPrec ResolveComponentCandidatesResponse
Int -> ReadS ResolveComponentCandidatesResponse
ReadS [ResolveComponentCandidatesResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ResolveComponentCandidatesResponse]
$creadListPrec :: ReadPrec [ResolveComponentCandidatesResponse]
readPrec :: ReadPrec ResolveComponentCandidatesResponse
$creadPrec :: ReadPrec ResolveComponentCandidatesResponse
readList :: ReadS [ResolveComponentCandidatesResponse]
$creadList :: ReadS [ResolveComponentCandidatesResponse]
readsPrec :: Int -> ReadS ResolveComponentCandidatesResponse
$creadsPrec :: Int -> ReadS ResolveComponentCandidatesResponse
Prelude.Read, Int -> ResolveComponentCandidatesResponse -> ShowS
[ResolveComponentCandidatesResponse] -> ShowS
ResolveComponentCandidatesResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ResolveComponentCandidatesResponse] -> ShowS
$cshowList :: [ResolveComponentCandidatesResponse] -> ShowS
show :: ResolveComponentCandidatesResponse -> String
$cshow :: ResolveComponentCandidatesResponse -> String
showsPrec :: Int -> ResolveComponentCandidatesResponse -> ShowS
$cshowsPrec :: Int -> ResolveComponentCandidatesResponse -> ShowS
Prelude.Show, forall x.
Rep ResolveComponentCandidatesResponse x
-> ResolveComponentCandidatesResponse
forall x.
ResolveComponentCandidatesResponse
-> Rep ResolveComponentCandidatesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ResolveComponentCandidatesResponse x
-> ResolveComponentCandidatesResponse
$cfrom :: forall x.
ResolveComponentCandidatesResponse
-> Rep ResolveComponentCandidatesResponse x
Prelude.Generic)

-- |
-- Create a value of 'ResolveComponentCandidatesResponse' 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:
--
-- 'resolvedComponentVersions', 'resolveComponentCandidatesResponse_resolvedComponentVersions' - A list of components that meet the requirements that you specify in the
-- request. This list includes each component\'s recipe that you can use to
-- install the component.
--
-- 'httpStatus', 'resolveComponentCandidatesResponse_httpStatus' - The response's http status code.
newResolveComponentCandidatesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ResolveComponentCandidatesResponse
newResolveComponentCandidatesResponse :: Int -> ResolveComponentCandidatesResponse
newResolveComponentCandidatesResponse Int
pHttpStatus_ =
  ResolveComponentCandidatesResponse'
    { $sel:resolvedComponentVersions:ResolveComponentCandidatesResponse' :: Maybe [ResolvedComponentVersion]
resolvedComponentVersions =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ResolveComponentCandidatesResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | A list of components that meet the requirements that you specify in the
-- request. This list includes each component\'s recipe that you can use to
-- install the component.
resolveComponentCandidatesResponse_resolvedComponentVersions :: Lens.Lens' ResolveComponentCandidatesResponse (Prelude.Maybe [ResolvedComponentVersion])
resolveComponentCandidatesResponse_resolvedComponentVersions :: Lens'
  ResolveComponentCandidatesResponse
  (Maybe [ResolvedComponentVersion])
resolveComponentCandidatesResponse_resolvedComponentVersions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ResolveComponentCandidatesResponse' {Maybe [ResolvedComponentVersion]
resolvedComponentVersions :: Maybe [ResolvedComponentVersion]
$sel:resolvedComponentVersions:ResolveComponentCandidatesResponse' :: ResolveComponentCandidatesResponse
-> Maybe [ResolvedComponentVersion]
resolvedComponentVersions} -> Maybe [ResolvedComponentVersion]
resolvedComponentVersions) (\s :: ResolveComponentCandidatesResponse
s@ResolveComponentCandidatesResponse' {} Maybe [ResolvedComponentVersion]
a -> ResolveComponentCandidatesResponse
s {$sel:resolvedComponentVersions:ResolveComponentCandidatesResponse' :: Maybe [ResolvedComponentVersion]
resolvedComponentVersions = Maybe [ResolvedComponentVersion]
a} :: ResolveComponentCandidatesResponse) 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

-- | The response's http status code.
resolveComponentCandidatesResponse_httpStatus :: Lens.Lens' ResolveComponentCandidatesResponse Prelude.Int
resolveComponentCandidatesResponse_httpStatus :: Lens' ResolveComponentCandidatesResponse Int
resolveComponentCandidatesResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ResolveComponentCandidatesResponse' {Int
httpStatus :: Int
$sel:httpStatus:ResolveComponentCandidatesResponse' :: ResolveComponentCandidatesResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ResolveComponentCandidatesResponse
s@ResolveComponentCandidatesResponse' {} Int
a -> ResolveComponentCandidatesResponse
s {$sel:httpStatus:ResolveComponentCandidatesResponse' :: Int
httpStatus = Int
a} :: ResolveComponentCandidatesResponse)

instance
  Prelude.NFData
    ResolveComponentCandidatesResponse
  where
  rnf :: ResolveComponentCandidatesResponse -> ()
rnf ResolveComponentCandidatesResponse' {Int
Maybe [ResolvedComponentVersion]
httpStatus :: Int
resolvedComponentVersions :: Maybe [ResolvedComponentVersion]
$sel:httpStatus:ResolveComponentCandidatesResponse' :: ResolveComponentCandidatesResponse -> Int
$sel:resolvedComponentVersions:ResolveComponentCandidatesResponse' :: ResolveComponentCandidatesResponse
-> Maybe [ResolvedComponentVersion]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [ResolvedComponentVersion]
resolvedComponentVersions
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus