DescribeForecastCommand

Suggest an Edit

Describes a forecast created using the CreateForecast operation.

In addition to listing the properties provided in the CreateForecast request, this operation lists the following properties:

  • DatasetGroupArn - The dataset group that provided the training data.

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ForecastClient, DescribeForecastCommand } from "@aws-sdk/client-forecast"; // ES Modules import
// const { ForecastClient, DescribeForecastCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
const client = new ForecastClient(config);
const input = { // DescribeForecastRequest
  ForecastArn: "STRING_VALUE", // required
};
const command = new DescribeForecastCommand(input);
const response = await client.send(command);
// { // DescribeForecastResponse
//   ForecastArn: "STRING_VALUE",
//   ForecastName: "STRING_VALUE",
//   ForecastTypes: [ // ForecastTypes
//     "STRING_VALUE",
//   ],
//   PredictorArn: "STRING_VALUE",
//   DatasetGroupArn: "STRING_VALUE",
//   EstimatedTimeRemainingInMinutes: Number("long"),
//   Status: "STRING_VALUE",
//   Message: "STRING_VALUE",
//   CreationTime: new Date("TIMESTAMP"),
//   LastModificationTime: new Date("TIMESTAMP"),
//   TimeSeriesSelector: { // TimeSeriesSelector
//     TimeSeriesIdentifiers: { // TimeSeriesIdentifiers
//       DataSource: { // DataSource
//         S3Config: { // S3Config
//           Path: "STRING_VALUE", // required
//           RoleArn: "STRING_VALUE", // required
//           KMSKeyArn: "STRING_VALUE",
//         },
//       },
//       Schema: { // Schema
//         Attributes: [ // SchemaAttributes
//           { // SchemaAttribute
//             AttributeName: "STRING_VALUE",
//             AttributeType: "string" || "integer" || "float" || "timestamp" || "geolocation",
//           },
//         ],
//       },
//       Format: "STRING_VALUE",
//     },
//   },
// };

DescribeForecastCommand Input

See DescribeForecastCommandInput for more details

Parameter
Type
Description
ForecastArn
Required
string | undefined

The Amazon Resource Name (ARN) of the forecast.

DescribeForecastCommand Output

See DescribeForecastCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
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.

Throws

Name
Fault
Details
InvalidInputException
client

We can't process the request because it includes an invalid value or a value that exceeds the valid range.

ResourceNotFoundException
client

We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

ForecastServiceException
Base exception class for all service exceptions from Forecast service.