Skip to content

TimeSeriesForecastingSettings

Source code in docs_src/capo_sagemaker/types/time_series_forecasting_settings.py
class TimeSeriesForecastingSettings(TypedDict, closed=True):
    status: NotRequired["capo_sagemaker.types.feature_status.FeatureStatus"]
    """<p>Describes whether time series forecasting is enabled or disabled in the Canvas application.</p>"""
    amazon_forecast_role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the <code>UserProfile</code> that launches the Canvas application. If an execution role is not specified in the <code>UserProfile</code>, Canvas uses the execution role specified in the Domain that owns the <code>UserProfile</code>. To allow time series forecasting, this IAM role should have the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/security-iam-awsmanpol-canvas.html#security-iam-awsmanpol-AmazonSageMakerCanvasForecastAccess"> AmazonSageMakerCanvasForecastAccess</a> policy attached and <code>forecast.amazonaws.com</code> added in the trust relationship as a service principal.</p>"""

amazon_forecast_role_arn instance-attribute

amazon_forecast_role_arn: NotRequired[RoleArn]

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 application. 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 instance-attribute

status: NotRequired[FeatureStatus]

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