{-# 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.TimeSeriesForecastingSettings
-- 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.TimeSeriesForecastingSettings 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.FeatureStatus

-- | Time series forecast settings for the SageMaker Canvas app.
--
-- /See:/ 'newTimeSeriesForecastingSettings' smart constructor.
data TimeSeriesForecastingSettings = TimeSeriesForecastingSettings'
  { -- | The IAM role that Canvas passes to Amazon Forecast for time series
    -- forecasting. By default, Canvas uses the execution role specified in the
    -- @UserProfile@ that launches the Canvas app. If an execution role is not
    -- specified in the @UserProfile@, Canvas uses the execution role specified
    -- in the Domain that owns the @UserProfile@. To allow time series
    -- forecasting, this IAM role should have the
    -- <https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-canvas.html#security-iam-awsmanpol-AmazonSageMakerCanvasForecastAccess AmazonSageMakerCanvasForecastAccess>
    -- policy attached and @forecast.amazonaws.com@ added in the trust
    -- relationship as a service principal.
    TimeSeriesForecastingSettings -> Maybe Text
amazonForecastRoleArn :: Prelude.Maybe Prelude.Text,
    -- | Describes whether time series forecasting is enabled or disabled in the
    -- Canvas app.
    TimeSeriesForecastingSettings -> Maybe FeatureStatus
status :: Prelude.Maybe FeatureStatus
  }
  deriving (TimeSeriesForecastingSettings
-> TimeSeriesForecastingSettings -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TimeSeriesForecastingSettings
-> TimeSeriesForecastingSettings -> Bool
$c/= :: TimeSeriesForecastingSettings
-> TimeSeriesForecastingSettings -> Bool
== :: TimeSeriesForecastingSettings
-> TimeSeriesForecastingSettings -> Bool
$c== :: TimeSeriesForecastingSettings
-> TimeSeriesForecastingSettings -> Bool
Prelude.Eq, ReadPrec [TimeSeriesForecastingSettings]
ReadPrec TimeSeriesForecastingSettings
Int -> ReadS TimeSeriesForecastingSettings
ReadS [TimeSeriesForecastingSettings]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TimeSeriesForecastingSettings]
$creadListPrec :: ReadPrec [TimeSeriesForecastingSettings]
readPrec :: ReadPrec TimeSeriesForecastingSettings
$creadPrec :: ReadPrec TimeSeriesForecastingSettings
readList :: ReadS [TimeSeriesForecastingSettings]
$creadList :: ReadS [TimeSeriesForecastingSettings]
readsPrec :: Int -> ReadS TimeSeriesForecastingSettings
$creadsPrec :: Int -> ReadS TimeSeriesForecastingSettings
Prelude.Read, Int -> TimeSeriesForecastingSettings -> ShowS
[TimeSeriesForecastingSettings] -> ShowS
TimeSeriesForecastingSettings -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TimeSeriesForecastingSettings] -> ShowS
$cshowList :: [TimeSeriesForecastingSettings] -> ShowS
show :: TimeSeriesForecastingSettings -> String
$cshow :: TimeSeriesForecastingSettings -> String
showsPrec :: Int -> TimeSeriesForecastingSettings -> ShowS
$cshowsPrec :: Int -> TimeSeriesForecastingSettings -> ShowS
Prelude.Show, forall x.
Rep TimeSeriesForecastingSettings x
-> TimeSeriesForecastingSettings
forall x.
TimeSeriesForecastingSettings
-> Rep TimeSeriesForecastingSettings x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep TimeSeriesForecastingSettings x
-> TimeSeriesForecastingSettings
$cfrom :: forall x.
TimeSeriesForecastingSettings
-> Rep TimeSeriesForecastingSettings x
Prelude.Generic)

-- |
-- Create a value of 'TimeSeriesForecastingSettings' 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:
--
-- 'amazonForecastRoleArn', 'timeSeriesForecastingSettings_amazonForecastRoleArn' - The IAM role that Canvas passes to Amazon Forecast for time series
-- forecasting. By default, Canvas uses the execution role specified in the
-- @UserProfile@ that launches the Canvas app. If an execution role is not
-- specified in the @UserProfile@, Canvas uses the execution role specified
-- in the Domain that owns the @UserProfile@. To allow time series
-- forecasting, this IAM role should have the
-- <https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-canvas.html#security-iam-awsmanpol-AmazonSageMakerCanvasForecastAccess AmazonSageMakerCanvasForecastAccess>
-- policy attached and @forecast.amazonaws.com@ added in the trust
-- relationship as a service principal.
--
-- 'status', 'timeSeriesForecastingSettings_status' - Describes whether time series forecasting is enabled or disabled in the
-- Canvas app.
newTimeSeriesForecastingSettings ::
  TimeSeriesForecastingSettings
newTimeSeriesForecastingSettings :: TimeSeriesForecastingSettings
newTimeSeriesForecastingSettings =
  TimeSeriesForecastingSettings'
    { $sel:amazonForecastRoleArn:TimeSeriesForecastingSettings' :: Maybe Text
amazonForecastRoleArn =
        forall a. Maybe a
Prelude.Nothing,
      $sel:status:TimeSeriesForecastingSettings' :: Maybe FeatureStatus
status = forall a. Maybe a
Prelude.Nothing
    }

-- | The IAM role that Canvas passes to Amazon Forecast for time series
-- forecasting. By default, Canvas uses the execution role specified in the
-- @UserProfile@ that launches the Canvas app. If an execution role is not
-- specified in the @UserProfile@, Canvas uses the execution role specified
-- in the Domain that owns the @UserProfile@. To allow time series
-- forecasting, this IAM role should have the
-- <https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-canvas.html#security-iam-awsmanpol-AmazonSageMakerCanvasForecastAccess AmazonSageMakerCanvasForecastAccess>
-- policy attached and @forecast.amazonaws.com@ added in the trust
-- relationship as a service principal.
timeSeriesForecastingSettings_amazonForecastRoleArn :: Lens.Lens' TimeSeriesForecastingSettings (Prelude.Maybe Prelude.Text)
timeSeriesForecastingSettings_amazonForecastRoleArn :: Lens' TimeSeriesForecastingSettings (Maybe Text)
timeSeriesForecastingSettings_amazonForecastRoleArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeSeriesForecastingSettings' {Maybe Text
amazonForecastRoleArn :: Maybe Text
$sel:amazonForecastRoleArn:TimeSeriesForecastingSettings' :: TimeSeriesForecastingSettings -> Maybe Text
amazonForecastRoleArn} -> Maybe Text
amazonForecastRoleArn) (\s :: TimeSeriesForecastingSettings
s@TimeSeriesForecastingSettings' {} Maybe Text
a -> TimeSeriesForecastingSettings
s {$sel:amazonForecastRoleArn:TimeSeriesForecastingSettings' :: Maybe Text
amazonForecastRoleArn = Maybe Text
a} :: TimeSeriesForecastingSettings)

-- | Describes whether time series forecasting is enabled or disabled in the
-- Canvas app.
timeSeriesForecastingSettings_status :: Lens.Lens' TimeSeriesForecastingSettings (Prelude.Maybe FeatureStatus)
timeSeriesForecastingSettings_status :: Lens' TimeSeriesForecastingSettings (Maybe FeatureStatus)
timeSeriesForecastingSettings_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeSeriesForecastingSettings' {Maybe FeatureStatus
status :: Maybe FeatureStatus
$sel:status:TimeSeriesForecastingSettings' :: TimeSeriesForecastingSettings -> Maybe FeatureStatus
status} -> Maybe FeatureStatus
status) (\s :: TimeSeriesForecastingSettings
s@TimeSeriesForecastingSettings' {} Maybe FeatureStatus
a -> TimeSeriesForecastingSettings
s {$sel:status:TimeSeriesForecastingSettings' :: Maybe FeatureStatus
status = Maybe FeatureStatus
a} :: TimeSeriesForecastingSettings)

instance Data.FromJSON TimeSeriesForecastingSettings where
  parseJSON :: Value -> Parser TimeSeriesForecastingSettings
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"TimeSeriesForecastingSettings"
      ( \Object
x ->
          Maybe Text -> Maybe FeatureStatus -> TimeSeriesForecastingSettings
TimeSeriesForecastingSettings'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"AmazonForecastRoleArn")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Status")
      )

instance
  Prelude.Hashable
    TimeSeriesForecastingSettings
  where
  hashWithSalt :: Int -> TimeSeriesForecastingSettings -> Int
hashWithSalt Int
_salt TimeSeriesForecastingSettings' {Maybe Text
Maybe FeatureStatus
status :: Maybe FeatureStatus
amazonForecastRoleArn :: Maybe Text
$sel:status:TimeSeriesForecastingSettings' :: TimeSeriesForecastingSettings -> Maybe FeatureStatus
$sel:amazonForecastRoleArn:TimeSeriesForecastingSettings' :: TimeSeriesForecastingSettings -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
amazonForecastRoleArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe FeatureStatus
status

instance Prelude.NFData TimeSeriesForecastingSettings where
  rnf :: TimeSeriesForecastingSettings -> ()
rnf TimeSeriesForecastingSettings' {Maybe Text
Maybe FeatureStatus
status :: Maybe FeatureStatus
amazonForecastRoleArn :: Maybe Text
$sel:status:TimeSeriesForecastingSettings' :: TimeSeriesForecastingSettings -> Maybe FeatureStatus
$sel:amazonForecastRoleArn:TimeSeriesForecastingSettings' :: TimeSeriesForecastingSettings -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
amazonForecastRoleArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe FeatureStatus
status

instance Data.ToJSON TimeSeriesForecastingSettings where
  toJSON :: TimeSeriesForecastingSettings -> Value
toJSON TimeSeriesForecastingSettings' {Maybe Text
Maybe FeatureStatus
status :: Maybe FeatureStatus
amazonForecastRoleArn :: Maybe Text
$sel:status:TimeSeriesForecastingSettings' :: TimeSeriesForecastingSettings -> Maybe FeatureStatus
$sel:amazonForecastRoleArn:TimeSeriesForecastingSettings' :: TimeSeriesForecastingSettings -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"AmazonForecastRoleArn" 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
amazonForecastRoleArn,
            (Key
"Status" 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 FeatureStatus
status
          ]
      )