Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . forecast ]

describe-forecast

Description

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-forecast
--forecast-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--forecast-arn (string)

The Amazon Resource Name (ARN) of the forecast.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ForecastArn -> (string)

The forecast ARN as specified in the request.

ForecastName -> (string)

The name of the forecast.

ForecastTypes -> (list)

The quantiles at which probabilistic forecasts were generated.

(string)

PredictorArn -> (string)

The ARN of the predictor used to generate the forecast.

DatasetGroupArn -> (string)

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

Status -> (string)

The status of the forecast. States include:

  • ACTIVE
  • CREATE_PENDING , CREATE_IN_PROGRESS , CREATE_FAILED
  • DELETE_PENDING , DELETE_IN_PROGRESS , DELETE_FAILED

Note

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

Message -> (string)

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

CreationTime -> (timestamp)

When the forecast creation task was created.

LastModificationTime -> (timestamp)

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