Skip to content

List Forecast Export Jobs

forecastservice_list_forecast_export_jobs R Documentation

Returns a list of forecast export jobs created using the CreateForecastExportJob operation

Description

Returns a list of forecast export jobs created using the create_forecast_export_job operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the describe_forecast_export_job operation. You can filter the list using an array of Filter objects.

Usage

forecastservice_list_forecast_export_jobs(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 forecast export jobs 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 forecast export jobs that match the statement, specify IS. To exclude matching forecast export jobs, specify IS_NOT.

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

  • Value - The value to match.

For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:

⁠"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]⁠

Value

A list with the following syntax: 

list(
  ForecastExportJobs = list(
    list(
      ForecastExportJobArn = "string",
      ForecastExportJobName = "string",
      Destination = list(
        S3Config = list(
          Path = "string",
          RoleArn = "string",
          KMSKeyArn = "string"
        )
      ),
      Status = "string",
      Message = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModificationTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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