CREATEDATASETEXPORTJOB()`¶

About CreateDatasetExportJob¶

Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3. The operation returns a jobId immediately; poll DescribeDatasetExportJob to track progress and ListDatasetExportJobs to enumerate a workspace's jobs.

Method Signature¶

METHODS /AWS1/IF_IOS~CREATEDATASETEXPORTJOB
  IMPORTING
    !IV_WORKSPACENAME TYPE /AWS1/IOSWORKSPACENAME OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/IOSCLIENTTOKEN OPTIONAL
    !IV_DESTINATIONS3URI TYPE /AWS1/IOSS3URI OPTIONAL
    !IO_INPUT TYPE REF TO /AWS1/CL_IOSPROCESSINGINPUT OPTIONAL
    !IO_ERRORREPORTLOCATION TYPE REF TO /AWS1/CL_IOSEXPERRORREPORTLOC OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioscrtdsexportjobrsp
  RAISING
    /AWS1/CX_IOSACCESSDENIEDEX
    /AWS1/CX_IOSCNFLCTOPERATIONEX
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /AWS1/CX_IOSRESOURCENOTFOUNDEX
    /AWS1/CX_IOSTHROTTLINGEX
    /AWS1/CX_IOSCLIENTEXC
    /AWS1/CX_IOSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_workspacename` `TYPE /AWS1/IOSWORKSPACENAME` `/AWS1/IOSWORKSPACENAME`¶

The name of the workspace in which to create the dataset export job.

`iv_destinations3uri` `TYPE /AWS1/IOSS3URI` `/AWS1/IOSS3URI`¶

The S3 URI where output clips will be written.

`io_input` `TYPE REF TO /AWS1/CL_IOSPROCESSINGINPUT` `/AWS1/CL_IOSPROCESSINGINPUT`¶

The processing input source.

`io_errorreportlocation` `TYPE REF TO /AWS1/CL_IOSEXPERRORREPORTLOC` `/AWS1/CL_IOSEXPERRORREPORTLOC`¶

The location where the error report will be written on failure.

Optional arguments:¶

`iv_clienttoken` `TYPE /AWS1/IOSCLIENTTOKEN` `/AWS1/IOSCLIENTTOKEN`¶

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The AWS SDKs and CLI populate this automatically.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ioscrtdsexportjobrsp` `/AWS1/CL_IOSCRTDSEXPORTJOBRSP`¶

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->createdatasetexportjob(
  io_errorreportlocation = new /aws1/cl_iosexperrorreportloc( |string| )
  io_input = new /aws1/cl_iosprocessinginput(
    io_dataset = new /aws1/cl_iosdatasetitem(
      io_trimsettings = new /aws1/cl_iostrimsettings(
        io_endtime = new /aws1/cl_iostimeinnanos(
          iv_offsetinnanos = 123
          iv_timeinseconds = 123
        )
        io_starttime = new /aws1/cl_iostimeinnanos(
          iv_offsetinnanos = 123
          iv_timeinseconds = 123
        )
      )
      it_exportdatatypes = VALUE /aws1/cl_iosexpdatatypelist_w=>tt_exportdatatypelist(
        ( new /aws1/cl_iosexpdatatypelist_w( |string| ) )
      )
      iv_datasetid = |string|
    )
    it_timeseries = VALUE /aws1/cl_iostimeseriesitem=>tt_timeserieslist(
      (
        new /aws1/cl_iostimeseriesitem(
          io_formatsettings = new /aws1/cl_iosformatsettings(
            iv_framespersecond = 123
            iv_heightinpixels = 123
            iv_widthinpixels = 123
          )
          io_trimsettings = new /aws1/cl_iostrimsettings(
            io_endtime = new /aws1/cl_iostimeinnanos(
              iv_offsetinnanos = 123
              iv_timeinseconds = 123
            )
            io_starttime = new /aws1/cl_iostimeinnanos(
              iv_offsetinnanos = 123
              iv_timeinseconds = 123
            )
          )
          iv_propertyalias = |string|
          iv_timeseriesid = |string|
        )
      )
    )
  )
  iv_clienttoken = |string|
  iv_destinations3uri = |string|
  iv_workspacename = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_datasetexportjobid = lo_result->get_jobid( ).
  lv_workspacename = lo_result->get_workspacename( ).
ENDIF.

/AWS1/IF_IOS=>CREATEDATASETEXPORTJOB()¶