Class: Aws::ForecastService::Types::ExplainabilityConfig

Inherits:

Struct

Object
Struct
Aws::ForecastService::Types::ExplainabilityConfig

show all

Defined in:: gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb

Overview

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”.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#time_point_granularity ⇒ String
To create an Explainability for all time points in your forecast horizon, use ALL.
#time_series_granularity ⇒ String
To create an Explainability for all time series in your datasets, use ALL.

Instance Attribute Details

#time_point_granularity ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-forecastservice/lib/aws-sdk-forecastservice/types.rb', line 3937

class ExplainabilityConfig < Struct.new(
  :time_series_granularity,
  :time_point_granularity)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_granularity ⇒ `String`

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.