/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Forecast::ForecastSummary

NAME

Paws::Forecast::ForecastSummary

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Forecast::ForecastSummary object:

$service_obj->Method(Att1 => { CreationTime => $value, ..., Status => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Forecast::ForecastSummary object:

$result = $service_obj->Method(...);
$result->Att1->CreationTime

DESCRIPTION

Provides a summary of the forecast properties used in the ListForecasts operation. To get the complete set of properties, call the DescribeForecast operation, and provide the ForecastArn that is listed in the summary.

ATTRIBUTES

CreationTime => Str

When the forecast creation task was created.

DatasetGroupArn => Str

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

ForecastArn => Str

The ARN of the forecast.

ForecastName => Str

The name of the forecast.

LastModificationTime => Str

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

  • CREATE_PENDING - The CreationTime.

  • CREATE_IN_PROGRESS - The current timestamp.

  • CREATE_STOPPING - The current timestamp.

  • CREATE_STOPPED - When the job stopped.

  • ACTIVE or CREATE_FAILED - When the job finished or failed.

Message => Str

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

PredictorArn => Str

The ARN of the predictor used to generate the forecast.

Status => Str

The status of the forecast. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Forecast

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues