Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Documentation

data TimeSeriesForecastingSettings

Time series forecast settings for the SageMaker Canvas app.

See: newTimeSeriesForecastingSettings smart constructor.

Constructors

TimeSeriesForecastingSettings'

Fields

• amazonForecastRoleArn :: Maybe Text

  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 AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

• status :: Maybe FeatureStatus

  Describes whether time series forecasting is enabled or disabled in the Canvas app.

Instances

FromJSON TimeSeriesForecastingSettings

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Methods

parseJSON :: Value -> Parser TimeSeriesForecastingSettings

parseJSONList :: Value -> Parser [TimeSeriesForecastingSettings]

ToJSON TimeSeriesForecastingSettings

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Methods

toJSON :: TimeSeriesForecastingSettings -> Value

toEncoding :: TimeSeriesForecastingSettings -> Encoding

toJSONList :: [TimeSeriesForecastingSettings] -> Value

toEncodingList :: [TimeSeriesForecastingSettings] -> Encoding

Generic TimeSeriesForecastingSettings

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Associated Types

type Rep TimeSeriesForecastingSettings :: Type -> Type

Methods

from :: TimeSeriesForecastingSettings -> Rep TimeSeriesForecastingSettings x

to :: Rep TimeSeriesForecastingSettings x -> TimeSeriesForecastingSettings

Read TimeSeriesForecastingSettings

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Methods

readsPrec :: Int -> ReadS TimeSeriesForecastingSettings

readList :: ReadS [TimeSeriesForecastingSettings]

readPrec :: ReadPrec TimeSeriesForecastingSettings

readListPrec :: ReadPrec [TimeSeriesForecastingSettings]

Show TimeSeriesForecastingSettings

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Methods

showsPrec :: Int -> TimeSeriesForecastingSettings -> ShowS

show :: TimeSeriesForecastingSettings -> String

showList :: [TimeSeriesForecastingSettings] -> ShowS

NFData TimeSeriesForecastingSettings

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Methods

rnf :: TimeSeriesForecastingSettings -> ()

Eq TimeSeriesForecastingSettings

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Methods

(==) :: TimeSeriesForecastingSettings -> TimeSeriesForecastingSettings -> Bool

(/=) :: TimeSeriesForecastingSettings -> TimeSeriesForecastingSettings -> Bool

Hashable TimeSeriesForecastingSettings

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Methods

hashWithSalt :: Int -> TimeSeriesForecastingSettings -> Int

hash :: TimeSeriesForecastingSettings -> Int

type Rep TimeSeriesForecastingSettings

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

type Rep TimeSeriesForecastingSettings = D1 ('MetaData "TimeSeriesForecastingSettings" "Amazonka.SageMaker.Types.TimeSeriesForecastingSettings" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "TimeSeriesForecastingSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "amazonForecastRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FeatureStatus))))

newTimeSeriesForecastingSettings :: TimeSeriesForecastingSettings

Create a value of TimeSeriesForecastingSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:amazonForecastRoleArn:TimeSeriesForecastingSettings', 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 AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

$sel:status:TimeSeriesForecastingSettings', timeSeriesForecastingSettings_status - Describes whether time series forecasting is enabled or disabled in the Canvas app.

timeSeriesForecastingSettings_amazonForecastRoleArn :: Lens' TimeSeriesForecastingSettings (Maybe Text)

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 AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

timeSeriesForecastingSettings_status :: Lens' TimeSeriesForecastingSettings (Maybe FeatureStatus)

Describes whether time series forecasting is enabled or disabled in the Canvas app.