DescribePredictorResponse

public struct DescribePredictorResponse : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The Amazon Resource Name (ARN) of the algorithm used for model training.

    Declaration

    Swift

    public let algorithmArn: String?

  • When PerformAutoML is specified, the ARN of the chosen algorithm.

    Declaration

    Swift

    public let autoMLAlgorithmArns: [String]?

  • When the model training task was created.

    Declaration

    Swift

    public let creationTime: TimeStamp?

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

    Declaration

    Swift

    public let datasetImportJobArns: [String]?

  • An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

    Declaration

    Swift

    public let encryptionConfig: EncryptionConfig?

  • Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.

    Declaration

    Swift

    public let evaluationParameters: EvaluationParameters?

  • The featurization configuration.

    Declaration

    Swift

    public let featurizationConfig: FeaturizationConfig?

  • The number of time-steps of the forecast. The forecast horizon is also called the prediction length.

    Declaration

    Swift

    public let forecastHorizon: Int?

  • The hyperparameter override values for the algorithm.

    Declaration

    Swift

    public let hPOConfig: HyperParameterTuningJobConfig?

  • Describes the dataset group that contains the data to use to train the predictor.

    Declaration

    Swift

    public let inputDataConfig: InputDataConfig?

  • Initially, the same as CreationTime (when the status is CREATE_PENDING). This value is updated when training starts (when the status changes to CREATE_IN_PROGRESS), and when training has completed (when the status changes to ACTIVE) or fails (when the status changes to CREATE_FAILED).

    Declaration

    Swift

    public let lastModificationTime: TimeStamp?

  • If an error occurred, an informational message about the error.

    Declaration

    Swift

    public let message: String?

  • Whether the predictor is set to perform AutoML.

    Declaration

    Swift

    public let performAutoML: Bool?

  • Whether the predictor is set to perform hyperparameter optimization (HPO).

    Declaration

    Swift

    public let performHPO: Bool?

  • The ARN of the predictor.

    Declaration

    Swift

    public let predictorArn: String?

  • Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor. You specify the number of backtests to perform when you call the operation.

    Declaration

    Swift

    public let predictorExecutionDetails: PredictorExecutionDetails?

  • The name of the predictor.

    Declaration

    Swift

    public let predictorName: String?

  • The status of the predictor. States include: ACTIVE CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

    Declaration

    Swift

    public let status: String?

  • The default training parameters or overrides selected during model training. If using the AutoML algorithm or if HPO is turned on while using the DeepAR+ algorithms, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.

    Declaration

    Swift

    public let trainingParameters: [String : String]?

  • Undocumented

    Declaration

    Swift

    public init(algorithmArn: String? = nil, autoMLAlgorithmArns: [String]? = nil, creationTime: TimeStamp? = nil, datasetImportJobArns: [String]? = nil, encryptionConfig: EncryptionConfig? = nil, evaluationParameters: EvaluationParameters? = nil, featurizationConfig: FeaturizationConfig? = nil, forecastHorizon: Int? = nil, hPOConfig: HyperParameterTuningJobConfig? = nil, inputDataConfig: InputDataConfig? = nil, lastModificationTime: TimeStamp? = nil, message: String? = nil, performAutoML: Bool? = nil, performHPO: Bool? = nil, predictorArn: String? = nil, predictorExecutionDetails: PredictorExecutionDetails? = nil, predictorName: String? = nil, status: String? = nil, trainingParameters: [String : String]? = nil)