{-# 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.SageMaker.Types.RecommendationJobOutputConfig
-- 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.SageMaker.Types.RecommendationJobOutputConfig 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
import Amazonka.SageMaker.Types.RecommendationJobCompiledOutputConfig

-- | Provides information about the output configuration for the compiled
-- model.
--
-- /See:/ 'newRecommendationJobOutputConfig' smart constructor.
data RecommendationJobOutputConfig = RecommendationJobOutputConfig'
  { -- | Provides information about the output configuration for the compiled
    -- model.
    RecommendationJobOutputConfig
-> Maybe RecommendationJobCompiledOutputConfig
compiledOutputConfig :: Prelude.Maybe RecommendationJobCompiledOutputConfig,
    -- | The Amazon Resource Name (ARN) of a Amazon Web Services Key Management
    -- Service (Amazon Web Services KMS) key that Amazon SageMaker uses to
    -- encrypt your output artifacts with Amazon S3 server-side encryption. The
    -- SageMaker execution role must have @kms:GenerateDataKey@ permission.
    --
    -- The @KmsKeyId@ can be any of the following formats:
    --
    -- -   \/\/ KMS Key ID
    --
    --     @\"1234abcd-12ab-34cd-56ef-1234567890ab\"@
    --
    -- -   \/\/ Amazon Resource Name (ARN) of a KMS Key
    --
    --     @\"arn:aws:kms:\<region>:\<account>:key\/\<key-id-12ab-34cd-56ef-1234567890ab>\"@
    --
    -- -   \/\/ KMS Key Alias
    --
    --     @\"alias\/ExampleAlias\"@
    --
    -- -   \/\/ Amazon Resource Name (ARN) of a KMS Key Alias
    --
    --     @\"arn:aws:kms:\<region>:\<account>:alias\/\<ExampleAlias>\"@
    --
    -- For more information about key identifiers, see
    -- <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id Key identifiers (KeyID)>
    -- in the Amazon Web Services Key Management Service (Amazon Web Services
    -- KMS) documentation.
    RecommendationJobOutputConfig -> Maybe Text
kmsKeyId :: Prelude.Maybe Prelude.Text
  }
  deriving (RecommendationJobOutputConfig
-> RecommendationJobOutputConfig -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: RecommendationJobOutputConfig
-> RecommendationJobOutputConfig -> Bool
$c/= :: RecommendationJobOutputConfig
-> RecommendationJobOutputConfig -> Bool
== :: RecommendationJobOutputConfig
-> RecommendationJobOutputConfig -> Bool
$c== :: RecommendationJobOutputConfig
-> RecommendationJobOutputConfig -> Bool
Prelude.Eq, ReadPrec [RecommendationJobOutputConfig]
ReadPrec RecommendationJobOutputConfig
Int -> ReadS RecommendationJobOutputConfig
ReadS [RecommendationJobOutputConfig]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [RecommendationJobOutputConfig]
$creadListPrec :: ReadPrec [RecommendationJobOutputConfig]
readPrec :: ReadPrec RecommendationJobOutputConfig
$creadPrec :: ReadPrec RecommendationJobOutputConfig
readList :: ReadS [RecommendationJobOutputConfig]
$creadList :: ReadS [RecommendationJobOutputConfig]
readsPrec :: Int -> ReadS RecommendationJobOutputConfig
$creadsPrec :: Int -> ReadS RecommendationJobOutputConfig
Prelude.Read, Int -> RecommendationJobOutputConfig -> ShowS
[RecommendationJobOutputConfig] -> ShowS
RecommendationJobOutputConfig -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [RecommendationJobOutputConfig] -> ShowS
$cshowList :: [RecommendationJobOutputConfig] -> ShowS
show :: RecommendationJobOutputConfig -> String
$cshow :: RecommendationJobOutputConfig -> String
showsPrec :: Int -> RecommendationJobOutputConfig -> ShowS
$cshowsPrec :: Int -> RecommendationJobOutputConfig -> ShowS
Prelude.Show, forall x.
Rep RecommendationJobOutputConfig x
-> RecommendationJobOutputConfig
forall x.
RecommendationJobOutputConfig
-> Rep RecommendationJobOutputConfig x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep RecommendationJobOutputConfig x
-> RecommendationJobOutputConfig
$cfrom :: forall x.
RecommendationJobOutputConfig
-> Rep RecommendationJobOutputConfig x
Prelude.Generic)

-- |
-- Create a value of 'RecommendationJobOutputConfig' 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:
--
-- 'compiledOutputConfig', 'recommendationJobOutputConfig_compiledOutputConfig' - Provides information about the output configuration for the compiled
-- model.
--
-- 'kmsKeyId', 'recommendationJobOutputConfig_kmsKeyId' - The Amazon Resource Name (ARN) of a Amazon Web Services Key Management
-- Service (Amazon Web Services KMS) key that Amazon SageMaker uses to
-- encrypt your output artifacts with Amazon S3 server-side encryption. The
-- SageMaker execution role must have @kms:GenerateDataKey@ permission.
--
-- The @KmsKeyId@ can be any of the following formats:
--
-- -   \/\/ KMS Key ID
--
--     @\"1234abcd-12ab-34cd-56ef-1234567890ab\"@
--
-- -   \/\/ Amazon Resource Name (ARN) of a KMS Key
--
--     @\"arn:aws:kms:\<region>:\<account>:key\/\<key-id-12ab-34cd-56ef-1234567890ab>\"@
--
-- -   \/\/ KMS Key Alias
--
--     @\"alias\/ExampleAlias\"@
--
-- -   \/\/ Amazon Resource Name (ARN) of a KMS Key Alias
--
--     @\"arn:aws:kms:\<region>:\<account>:alias\/\<ExampleAlias>\"@
--
-- For more information about key identifiers, see
-- <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id Key identifiers (KeyID)>
-- in the Amazon Web Services Key Management Service (Amazon Web Services
-- KMS) documentation.
newRecommendationJobOutputConfig ::
  RecommendationJobOutputConfig
newRecommendationJobOutputConfig :: RecommendationJobOutputConfig
newRecommendationJobOutputConfig =
  RecommendationJobOutputConfig'
    { $sel:compiledOutputConfig:RecommendationJobOutputConfig' :: Maybe RecommendationJobCompiledOutputConfig
compiledOutputConfig =
        forall a. Maybe a
Prelude.Nothing,
      $sel:kmsKeyId:RecommendationJobOutputConfig' :: Maybe Text
kmsKeyId = forall a. Maybe a
Prelude.Nothing
    }

-- | Provides information about the output configuration for the compiled
-- model.
recommendationJobOutputConfig_compiledOutputConfig :: Lens.Lens' RecommendationJobOutputConfig (Prelude.Maybe RecommendationJobCompiledOutputConfig)
recommendationJobOutputConfig_compiledOutputConfig :: Lens'
  RecommendationJobOutputConfig
  (Maybe RecommendationJobCompiledOutputConfig)
recommendationJobOutputConfig_compiledOutputConfig = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecommendationJobOutputConfig' {Maybe RecommendationJobCompiledOutputConfig
compiledOutputConfig :: Maybe RecommendationJobCompiledOutputConfig
$sel:compiledOutputConfig:RecommendationJobOutputConfig' :: RecommendationJobOutputConfig
-> Maybe RecommendationJobCompiledOutputConfig
compiledOutputConfig} -> Maybe RecommendationJobCompiledOutputConfig
compiledOutputConfig) (\s :: RecommendationJobOutputConfig
s@RecommendationJobOutputConfig' {} Maybe RecommendationJobCompiledOutputConfig
a -> RecommendationJobOutputConfig
s {$sel:compiledOutputConfig:RecommendationJobOutputConfig' :: Maybe RecommendationJobCompiledOutputConfig
compiledOutputConfig = Maybe RecommendationJobCompiledOutputConfig
a} :: RecommendationJobOutputConfig)

-- | The Amazon Resource Name (ARN) of a Amazon Web Services Key Management
-- Service (Amazon Web Services KMS) key that Amazon SageMaker uses to
-- encrypt your output artifacts with Amazon S3 server-side encryption. The
-- SageMaker execution role must have @kms:GenerateDataKey@ permission.
--
-- The @KmsKeyId@ can be any of the following formats:
--
-- -   \/\/ KMS Key ID
--
--     @\"1234abcd-12ab-34cd-56ef-1234567890ab\"@
--
-- -   \/\/ Amazon Resource Name (ARN) of a KMS Key
--
--     @\"arn:aws:kms:\<region>:\<account>:key\/\<key-id-12ab-34cd-56ef-1234567890ab>\"@
--
-- -   \/\/ KMS Key Alias
--
--     @\"alias\/ExampleAlias\"@
--
-- -   \/\/ Amazon Resource Name (ARN) of a KMS Key Alias
--
--     @\"arn:aws:kms:\<region>:\<account>:alias\/\<ExampleAlias>\"@
--
-- For more information about key identifiers, see
-- <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id Key identifiers (KeyID)>
-- in the Amazon Web Services Key Management Service (Amazon Web Services
-- KMS) documentation.
recommendationJobOutputConfig_kmsKeyId :: Lens.Lens' RecommendationJobOutputConfig (Prelude.Maybe Prelude.Text)
recommendationJobOutputConfig_kmsKeyId :: Lens' RecommendationJobOutputConfig (Maybe Text)
recommendationJobOutputConfig_kmsKeyId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RecommendationJobOutputConfig' {Maybe Text
kmsKeyId :: Maybe Text
$sel:kmsKeyId:RecommendationJobOutputConfig' :: RecommendationJobOutputConfig -> Maybe Text
kmsKeyId} -> Maybe Text
kmsKeyId) (\s :: RecommendationJobOutputConfig
s@RecommendationJobOutputConfig' {} Maybe Text
a -> RecommendationJobOutputConfig
s {$sel:kmsKeyId:RecommendationJobOutputConfig' :: Maybe Text
kmsKeyId = Maybe Text
a} :: RecommendationJobOutputConfig)

instance
  Prelude.Hashable
    RecommendationJobOutputConfig
  where
  hashWithSalt :: Int -> RecommendationJobOutputConfig -> Int
hashWithSalt Int
_salt RecommendationJobOutputConfig' {Maybe Text
Maybe RecommendationJobCompiledOutputConfig
kmsKeyId :: Maybe Text
compiledOutputConfig :: Maybe RecommendationJobCompiledOutputConfig
$sel:kmsKeyId:RecommendationJobOutputConfig' :: RecommendationJobOutputConfig -> Maybe Text
$sel:compiledOutputConfig:RecommendationJobOutputConfig' :: RecommendationJobOutputConfig
-> Maybe RecommendationJobCompiledOutputConfig
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe RecommendationJobCompiledOutputConfig
compiledOutputConfig
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
kmsKeyId

instance Prelude.NFData RecommendationJobOutputConfig where
  rnf :: RecommendationJobOutputConfig -> ()
rnf RecommendationJobOutputConfig' {Maybe Text
Maybe RecommendationJobCompiledOutputConfig
kmsKeyId :: Maybe Text
compiledOutputConfig :: Maybe RecommendationJobCompiledOutputConfig
$sel:kmsKeyId:RecommendationJobOutputConfig' :: RecommendationJobOutputConfig -> Maybe Text
$sel:compiledOutputConfig:RecommendationJobOutputConfig' :: RecommendationJobOutputConfig
-> Maybe RecommendationJobCompiledOutputConfig
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe RecommendationJobCompiledOutputConfig
compiledOutputConfig
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
kmsKeyId

instance Data.ToJSON RecommendationJobOutputConfig where
  toJSON :: RecommendationJobOutputConfig -> Value
toJSON RecommendationJobOutputConfig' {Maybe Text
Maybe RecommendationJobCompiledOutputConfig
kmsKeyId :: Maybe Text
compiledOutputConfig :: Maybe RecommendationJobCompiledOutputConfig
$sel:kmsKeyId:RecommendationJobOutputConfig' :: RecommendationJobOutputConfig -> Maybe Text
$sel:compiledOutputConfig:RecommendationJobOutputConfig' :: RecommendationJobOutputConfig
-> Maybe RecommendationJobCompiledOutputConfig
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"CompiledOutputConfig" 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 RecommendationJobCompiledOutputConfig
compiledOutputConfig,
            (Key
"KmsKeyId" 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 Text
kmsKeyId
          ]
      )