CREATEWHATIFFORECASTEXPORT()`¶

About CreateWhatIfForecastExport¶

Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

≈__

The component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

For more information, see howitworks-forecast.

To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports operation.

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport operation.

Method Signature¶

METHODS /AWS1/IF_FCS~CREATEWHATIFFORECASTEXPORT
  IMPORTING
    !IV_WHATIFFORECASTEXPORTNAME TYPE /AWS1/FCSNAME OPTIONAL
    !IT_WHATIFFORECASTARNS TYPE /AWS1/CL_FCSWHATIFFCARNLSTFO00=>TT_WHATIFFCARNLISTFOREXPORT OPTIONAL
    !IO_DESTINATION TYPE REF TO /AWS1/CL_FCSDATADESTINATION OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_FCSTAG=>TT_TAGS OPTIONAL
    !IV_FORMAT TYPE /AWS1/FCSFORMAT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_fcscrewhatiffcexprsp
  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_whatifforecastexportname` `TYPE /AWS1/FCSNAME` `/AWS1/FCSNAME`¶

The name of the what-if forecast to export.

`it_whatifforecastarns` `TYPE /AWS1/CL_FCSWHATIFFCARNLSTFO00=>TT_WHATIFFCARNLISTFOREXPORT` `TT_WHATIFFCARNLISTFOREXPORT`¶

The list of what-if forecast Amazon Resource Names (ARNs) to export.

`io_destination` `TYPE REF TO /AWS1/CL_FCSDATADESTINATION` `/AWS1/CL_FCSDATADESTINATION`¶

The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

Optional arguments:¶

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

A list of tags to apply to the what if forecast.

`iv_format` `TYPE /AWS1/FCSFORMAT` `/AWS1/FCSFORMAT`¶

The format of the exported data, CSV or PARQUET.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_fcscrewhatiffcexprsp` `/AWS1/CL_FCSCREWHATIFFCEXPRSP`¶

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->createwhatifforecastexport(
  io_destination = new /aws1/cl_fcsdatadestination(
    io_s3config = new /aws1/cl_fcss3config(
      iv_kmskeyarn = |string|
      iv_path = |string|
      iv_rolearn = |string|
    )
  )
  it_tags = VALUE /aws1/cl_fcstag=>tt_tags(
    (
      new /aws1/cl_fcstag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  it_whatifforecastarns = VALUE /aws1/cl_fcswhatiffcarnlstfo00=>tt_whatiffcarnlistforexport(
    ( new /aws1/cl_fcswhatiffcarnlstfo00( |string| ) )
  )
  iv_format = |string|
  iv_whatifforecastexportname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_longarn = lo_result->get_whatifforecastexportarn( ).
ENDIF.

/AWS1/IF_FCS=>CREATEWHATIFFORECASTEXPORT()¶