forecast/aws.sdk.kotlin.services.forecast.model/DescribeAutoPredictorResponse/Builder

Builder

class Builder

Properties

creationTime

var creationTime: Instant?

The timestamp of the CreateAutoPredictor request.

dataConfig

var dataConfig: DataConfig?

The data configuration for your dataset group and any additional datasets.

datasetImportJobArns

var datasetImportJobArns: List<String>?

An array of the ARNs of the dataset import jobs used to import training data for the predictor.

encryptionConfig

var encryptionConfig: EncryptionConfig?

An Key Management Service (KMS) key and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.

estimatedTimeRemainingInMinutes

var estimatedTimeRemainingInMinutes: Long?

The estimated time remaining in minutes for the predictor training job to complete.

explainabilityInfo

var explainabilityInfo: ExplainabilityInfo?

Provides the status and ARN of the Predictor Explainability.

forecastDimensions

var forecastDimensions: List<String>?

An array of dimension (field) names that specify the attributes used to group your time series.

forecastFrequency

var forecastFrequency: String?

The frequency of predictions in a forecast.

forecastHorizon

var forecastHorizon: Int?

The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.

forecastTypes

var forecastTypes: List<String>?

The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].

lastModificationTime

var lastModificationTime: Instant?

The last time the resource was modified. The timestamp depends on the status of the job:

message

var message: String?

In the event of an error, a message detailing the cause of the error.

monitorInfo

var monitorInfo: MonitorInfo?

A object with the Amazon Resource Name (ARN) and status of the monitor resource.

optimizationMetric

var optimizationMetric: OptimizationMetric?

The accuracy metric used to optimize the predictor.

predictorArn

var predictorArn: String?

The Amazon Resource Name (ARN) of the predictor

predictorName

var predictorName: String?

The name of the predictor.

referencePredictorSummary

var referencePredictorSummary: ReferencePredictorSummary?

The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.

status

var status: String?

The status of the predictor. States include:

timeAlignmentBoundary

var timeAlignmentBoundary: TimeAlignmentBoundary?

The time boundary Forecast uses when aggregating data.

Functions

dataConfig

fun dataConfig(block: DataConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.forecast.model.DataConfig inside the given block

encryptionConfig

fun encryptionConfig(block: EncryptionConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.forecast.model.EncryptionConfig inside the given block

explainabilityInfo

fun explainabilityInfo(block: ExplainabilityInfo.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.forecast.model.ExplainabilityInfo inside the given block

monitorInfo

fun monitorInfo(block: MonitorInfo.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.forecast.model.MonitorInfo inside the given block

referencePredictorSummary

fun referencePredictorSummary(block: ReferencePredictorSummary.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.forecast.model.ReferencePredictorSummary inside the given block

timeAlignmentBoundary

fun timeAlignmentBoundary(block: TimeAlignmentBoundary.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.forecast.model.TimeAlignmentBoundary inside the given block