Describe Forecast

forecastservice_describe_forecast

R Documentation

Describes a forecast created using the CreateForecast operation¶

Description¶

Describes a forecast created using the create_forecast operation.

In addition to listing the properties provided in the create_forecast 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.

Usage¶

forecastservice_describe_forecast(ForecastArn)

Arguments¶

ForecastArn: [required] The Amazon Resource Name (ARN) of the forecast.

Value¶

A list with the following syntax:

list(
  ForecastArn = "string",
  ForecastName = "string",
  ForecastTypes = list(
    "string"
  ),
  PredictorArn = "string",
  DatasetGroupArn = "string",
  EstimatedTimeRemainingInMinutes = 123,
  Status = "string",
  Message = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  LastModificationTime = as.POSIXct(
    "2015-01-01"
  ),
  TimeSeriesSelector = list(
    TimeSeriesIdentifiers = list(
      DataSource = list(
        S3Config = list(
          Path = "string",
          RoleArn = "string",
          KMSKeyArn = "string"
        )
      ),
      Schema = list(
        Attributes = list(
          list(
            AttributeName = "string",
            AttributeType = "string"|"integer"|"float"|"timestamp"|"geolocation"
          )
        )
      ),
      Format = "string"
    )
  )
)

Request syntax¶

svc$describe_forecast(
  ForecastArn = "string"
)