You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ForecastService::Types::PredictorSummary

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Provides a summary of the predictor properties used in the ListPredictors operation. To get the complete set of properties, call the DescribePredictor operation, and provide the listed PredictorArn.

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timeTime

When the model training task was created.

Returns:

  • (Time)

    When the model training task was created.

#dataset_group_arnString

The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.

#last_modification_timeTime

Initially, the same as CreationTime (status is CREATE_PENDING). Updated when training starts (status changed to CREATE_IN_PROGRESS), and when training is complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).

Returns:

  • (Time)

    Initially, the same as CreationTime (status is CREATE_PENDING).

#messageString

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

Returns:

  • (String)

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

#predictor_arnString

The ARN of the predictor.

Returns:

  • (String)

    The ARN of the predictor.

#predictor_nameString

The name of the predictor.

Returns:

  • (String)

    The name of the predictor.

#statusString

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 using the predictor to create a forecast.

Returns:

  • (String)

    The status of the predictor.