Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Forecast.Types.ExplainabilityConfig

Description

Synopsis

Documentation

data ExplainabilityConfig Source #

The ExplainabilityConfig data type defines the number of time series and time points included in CreateExplainability.

If you provide a predictor ARN for ResourceArn, you must set both TimePointGranularity and TimeSeriesGranularity to “ALL”. When creating Predictor Explainability, Amazon Forecast considers all time series and time points.

If you provide a forecast ARN for ResourceArn, you can set TimePointGranularity and TimeSeriesGranularity to either “ALL” or “Specific”.

See: newExplainabilityConfig smart constructor.

Constructors

ExplainabilityConfig'

Fields

timeSeriesGranularity :: TimeSeriesGranularity
To create an Explainability for all time series in your datasets, use ALL. To create an Explainability for specific time series in your datasets, use SPECIFIC.
Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.
timePointGranularity :: TimePointGranularity
To create an Explainability for all time points in your forecast horizon, use ALL. To create an Explainability for specific time points in your forecast horizon, use SPECIFIC.
Specify time points with the StartDateTime and EndDateTime parameters within the CreateExplainability operation.

Instances

Instances details

FromJSON ExplainabilityConfig Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilityConfig Methods parseJSON :: Value -> Parser ExplainabilityConfig # parseJSONList :: Value -> Parser [ExplainabilityConfig] #
ToJSON ExplainabilityConfig Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilityConfig Methods toJSON :: ExplainabilityConfig -> Value # toEncoding :: ExplainabilityConfig -> Encoding # toJSONList :: [ExplainabilityConfig] -> Value # toEncodingList :: [ExplainabilityConfig] -> Encoding #
Generic ExplainabilityConfig Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilityConfig Associated Types type Rep ExplainabilityConfig :: Type -> Type # Methods from :: ExplainabilityConfig -> Rep ExplainabilityConfig x # to :: Rep ExplainabilityConfig x -> ExplainabilityConfig #
Read ExplainabilityConfig Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilityConfig Methods readsPrec :: Int -> ReadS ExplainabilityConfig # readList :: ReadS [ExplainabilityConfig] # readPrec :: ReadPrec ExplainabilityConfig # readListPrec :: ReadPrec [ExplainabilityConfig] #
Show ExplainabilityConfig Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilityConfig Methods showsPrec :: Int -> ExplainabilityConfig -> ShowS # show :: ExplainabilityConfig -> String # showList :: [ExplainabilityConfig] -> ShowS #
NFData ExplainabilityConfig Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilityConfig Methods rnf :: ExplainabilityConfig -> () #
Eq ExplainabilityConfig Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilityConfig Methods (==) :: ExplainabilityConfig -> ExplainabilityConfig -> Bool # (/=) :: ExplainabilityConfig -> ExplainabilityConfig -> Bool #
Hashable ExplainabilityConfig Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilityConfig Methods hashWithSalt :: Int -> ExplainabilityConfig -> Int # hash :: ExplainabilityConfig -> Int #
type Rep ExplainabilityConfig Source #
Instance details Defined in Amazonka.Forecast.Types.ExplainabilityConfig type Rep ExplainabilityConfig = D1 ('MetaData "ExplainabilityConfig" "Amazonka.Forecast.Types.ExplainabilityConfig" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "ExplainabilityConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "timeSeriesGranularity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TimeSeriesGranularity) :*: S1 ('MetaSel ('Just "timePointGranularity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TimePointGranularity)))

newExplainabilityConfig Source #

Arguments

:: TimeSeriesGranularity	`$sel:timeSeriesGranularity:ExplainabilityConfig'`
-> TimePointGranularity	`$sel:timePointGranularity:ExplainabilityConfig'`
-> ExplainabilityConfig

Create a value of ExplainabilityConfig 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:timeSeriesGranularity:ExplainabilityConfig', explainabilityConfig_timeSeriesGranularity - To create an Explainability for all time series in your datasets, use ALL. To create an Explainability for specific time series in your datasets, use SPECIFIC.

Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.

$sel:timePointGranularity:ExplainabilityConfig', explainabilityConfig_timePointGranularity - To create an Explainability for all time points in your forecast horizon, use ALL. To create an Explainability for specific time points in your forecast horizon, use SPECIFIC.

Specify time points with the StartDateTime and EndDateTime parameters within the CreateExplainability operation.

explainabilityConfig_timeSeriesGranularity :: Lens' ExplainabilityConfig TimeSeriesGranularity Source #

To create an Explainability for all time series in your datasets, use ALL. To create an Explainability for specific time series in your datasets, use SPECIFIC.

Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.

explainabilityConfig_timePointGranularity :: Lens' ExplainabilityConfig TimePointGranularity Source #

To create an Explainability for all time points in your forecast horizon, use ALL. To create an Explainability for specific time points in your forecast horizon, use SPECIFIC.

Specify time points with the StartDateTime and EndDateTime parameters within the CreateExplainability operation.