amazonka-sagemaker-2.0: Amazon SageMaker Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Description

 
Synopsis

Documentation

data TimeSeriesForecastingSettings Source #

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

Instances details
FromJSON TimeSeriesForecastingSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

ToJSON TimeSeriesForecastingSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Generic TimeSeriesForecastingSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Associated Types

type Rep TimeSeriesForecastingSettings :: Type -> Type #

Read TimeSeriesForecastingSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Show TimeSeriesForecastingSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

NFData TimeSeriesForecastingSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Eq TimeSeriesForecastingSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

Hashable TimeSeriesForecastingSettings Source # 
Instance details

Defined in Amazonka.SageMaker.Types.TimeSeriesForecastingSettings

type Rep TimeSeriesForecastingSettings Source # 
Instance details

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 Source #

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) Source #

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) Source #

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