List Forecasts

forecastservice_list_forecasts

R Documentation

Returns a list of forecasts created using the CreateForecast operation

Description

Returns a list of forecasts created using the create_forecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the describe_forecast operation. You can filter the list using an array of Filter objects.

Usage

forecastservice_list_forecasts(NextToken, MaxResults, Filters)

Arguments

NextToken

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

MaxResults

The number of items to return in the response.

Filters

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the forecasts that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

• Condition - The condition to apply. Valid values are IS and IS_NOT. To include the forecasts that match the statement, specify IS. To exclude matching forecasts, specify IS_NOT.

• Key - The name of the parameter to filter on. Valid values are DatasetGroupArn, PredictorArn, and Status.

• Value - The value to match.

For example, to list all forecasts whose status is not ACTIVE, you would specify:

⁠"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]⁠

Value

A list with the following syntax:

list(
  Forecasts = list(
    list(
      ForecastArn = "string",
      ForecastName = "string",
      PredictorArn = "string",
      CreatedUsingAutoPredictor = TRUE|FALSE,
      DatasetGroupArn = "string",
      Status = "string",
      Message = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModificationTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_forecasts(
  NextToken = "string",
  MaxResults = 123,
  Filters = list(
    list(
      Key = "string",
      Value = "string",
      Condition = "IS"|"IS_NOT"
    )
  )
)