@aws-sdk/client-forecast

DescribeForecastCommandOutput Interface

The output of DescribeForecastCommand.

Members

Name
Type
Details
$metadata RequiredResponseMetadata
Metadata pertaining to this request.
CreationTime Date | undefined

When the forecast creation task was created.

DatasetGroupArn string | undefined

The ARN of the dataset group that provided the data used to train the predictor.

EstimatedTimeRemainingInMinutes number | undefined

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

ForecastArn string | undefined

The forecast ARN as specified in the request.

ForecastName string | undefined

The name of the forecast.

ForecastTypes string[] | undefined

The quantiles at which probabilistic forecasts were generated.

LastModificationTime Date | undefined

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 string | undefined

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

PredictorArn string | undefined

The ARN of the predictor used to generate the forecast.

Status string | undefined

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.

TimeSeriesSelector TimeSeriesSelector | undefined

The time series to include in the forecast.

Full Signature

export interface DescribeForecastCommandOutput extends DescribeForecastResponse, MetadataBearer