CREATEFORECAST()`¶

About CreateForecast¶

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast.

To get a list of all your forecasts, use the ListForecasts operation.

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.

For more information, see howitworks-forecast.

The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status.

By default, a forecast includes predictions for every item (item_id) in the dataset group that was used to train the predictor. However, you can use the TimeSeriesSelector object to generate a forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are not in the input dataset. The forecast export file will not contain these time series or their forecasted values.

Method Signature¶

METHODS /AWS1/IF_FCS~CREATEFORECAST
  IMPORTING
    !IV_FORECASTNAME TYPE /AWS1/FCSNAME OPTIONAL
    !IV_PREDICTORARN TYPE /AWS1/FCSARN OPTIONAL
    !IT_FORECASTTYPES TYPE /AWS1/CL_FCSFORECASTTYPES_W=>TT_FORECASTTYPES OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_FCSTAG=>TT_TAGS OPTIONAL
    !IO_TIMESERIESSELECTOR TYPE REF TO /AWS1/CL_FCSTIMESERIESSELECTOR OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fcscreatefcresponse
  RAISING
    /AWS1/CX_FCSINVALIDINPUTEX
    /AWS1/CX_FCSLIMITEXCEEDEDEX
    /AWS1/CX_FCSRESRCALRDYEXISTSEX
    /AWS1/CX_FCSRESOURCEINUSEEX
    /AWS1/CX_FCSRESOURCENOTFOUNDEX
    /AWS1/CX_FCSCLIENTEXC
    /AWS1/CX_FCSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_forecastname` `TYPE /AWS1/FCSNAME` `/AWS1/FCSNAME`¶

A name for the forecast.

`iv_predictorarn` `TYPE /AWS1/FCSARN` `/AWS1/FCSARN`¶

The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.

Optional arguments:¶

`it_forecasttypes` `TYPE /AWS1/CL_FCSFORECASTTYPES_W=>TT_FORECASTTYPES` `TT_FORECASTTYPES`¶

The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial).

The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].

`it_tags` `TYPE /AWS1/CL_FCSTAG=>TT_TAGS` `TT_TAGS`¶

The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

Maximum number of tags per resource - 50.

For each resource, each tag key must be unique, and each tag key can have only one value.

Maximum key length - 128 Unicode characters in UTF-8.

Maximum value length - 256 Unicode characters in UTF-8.

If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

Tag keys and values are case sensitive.

Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

`io_timeseriesselector` `TYPE REF TO /AWS1/CL_FCSTIMESERIESSELECTOR` `/AWS1/CL_FCSTIMESERIESSELECTOR`¶

Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers object.

The TimeSeriesIdentifiers object needs the following information:

DataSource

Format

Schema

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_fcscreatefcresponse` `/AWS1/CL_FCSCREATEFCRESPONSE`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createforecast(
  io_timeseriesselector = new /aws1/cl_fcstimeseriesselector(
    io_timeseriesidentifiers = new /aws1/cl_fcstimeseriesids(
      io_datasource = new /aws1/cl_fcsdatasource(
        io_s3config = new /aws1/cl_fcss3config(
          iv_kmskeyarn = |string|
          iv_path = |string|
          iv_rolearn = |string|
        )
      )
      io_schema = new /aws1/cl_fcsschema(
        it_attributes = VALUE /aws1/cl_fcsschemaattribute=>tt_schemaattributes(
          (
            new /aws1/cl_fcsschemaattribute(
              iv_attributename = |string|
              iv_attributetype = |string|
            )
          )
        )
      )
      iv_format = |string|
    )
  )
  it_forecasttypes = VALUE /aws1/cl_fcsforecasttypes_w=>tt_forecasttypes(
    ( new /aws1/cl_fcsforecasttypes_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_fcstag=>tt_tags(
    (
      new /aws1/cl_fcstag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_forecastname = |string|
  iv_predictorarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_forecastarn( ).
ENDIF.

/AWS1/IF_FCS=>CREATEFORECAST()¶