Skip to content

/AWS1/IF_DSY=>STARTTASKEXECUTION()

About StartTaskExecution

Starts an DataSync transfer task. For each task, you can only run one task execution at a time.

There are several steps to a task execution. For more information, see Task execution statuses.

If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.

Method Signature

METHODS /AWS1/IF_DSY~STARTTASKEXECUTION
  IMPORTING
    !IV_TASKARN TYPE /AWS1/DSYTASKARN OPTIONAL
    !IO_OVERRIDEOPTIONS TYPE REF TO /AWS1/CL_DSYOPTIONS OPTIONAL
    !IT_INCLUDES TYPE /AWS1/CL_DSYFILTERRULE=>TT_FILTERLIST OPTIONAL
    !IT_EXCLUDES TYPE /AWS1/CL_DSYFILTERRULE=>TT_FILTERLIST OPTIONAL
    !IO_MANIFESTCONFIG TYPE REF TO /AWS1/CL_DSYMANIFESTCONFIG OPTIONAL
    !IO_TASKREPORTCONFIG TYPE REF TO /AWS1/CL_DSYTASKREPORTCONFIG OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_DSYTAGLISTENTRY=>TT_INPUTTAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dsystarttaskexecrsp
  RAISING
    /AWS1/CX_DSYINTERNALEXCEPTION
    /AWS1/CX_DSYINVALIDREQUESTEX
    /AWS1/CX_DSYCLIENTEXC
    /AWS1/CX_DSYSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_taskarn TYPE /AWS1/DSYTASKARN /AWS1/DSYTASKARN

Specifies the Amazon Resource Name (ARN) of the task that you want to start.

Optional arguments:

io_overrideoptions TYPE REF TO /AWS1/CL_DSYOPTIONS /AWS1/CL_DSYOPTIONS

OverrideOptions

it_includes TYPE /AWS1/CL_DSYFILTERRULE=>TT_FILTERLIST TT_FILTERLIST

Specifies a list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

it_excludes TYPE /AWS1/CL_DSYFILTERRULE=>TT_FILTERLIST TT_FILTERLIST

Specifies a list of filter rules that determines which files to exclude from a task. The list contains a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2".

io_manifestconfig TYPE REF TO /AWS1/CL_DSYMANIFESTCONFIG /AWS1/CL_DSYMANIFESTCONFIG

Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

To remove a manifest configuration, specify this parameter with an empty value.

io_taskreportconfig TYPE REF TO /AWS1/CL_DSYTASKREPORTCONFIG /AWS1/CL_DSYTASKREPORTCONFIG

Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

To remove a task report configuration, specify this parameter as empty.

it_tags TYPE /AWS1/CL_DSYTAGLISTENTRY=>TT_INPUTTAGLIST TT_INPUTTAGLIST

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.

Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

RETURNING

oo_output TYPE REF TO /aws1/cl_dsystarttaskexecrsp /AWS1/CL_DSYSTARTTASKEXECRSP

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->starttaskexecution(
  io_manifestconfig = new /aws1/cl_dsymanifestconfig(
    io_source = new /aws1/cl_dsysourcemanifestcfg(
      io_s3 = new /aws1/cl_dsys3manifestconfig(
        iv_bucketaccessrolearn = |string|
        iv_manifestobjectpath = |string|
        iv_manifestobjectversionid = |string|
        iv_s3bucketarn = |string|
      )
    )
    iv_action = |string|
    iv_format = |string|
  )
  io_overrideoptions = new /aws1/cl_dsyoptions(
    iv_atime = |string|
    iv_bytespersecond = 123
    iv_gid = |string|
    iv_loglevel = |string|
    iv_mtime = |string|
    iv_objecttags = |string|
    iv_overwritemode = |string|
    iv_posixpermissions = |string|
    iv_preservedeletedfiles = |string|
    iv_preservedevices = |string|
    iv_secdescriptorcopyflags = |string|
    iv_taskqueueing = |string|
    iv_transfermode = |string|
    iv_uid = |string|
    iv_verifymode = |string|
  )
  io_taskreportconfig = new /aws1/cl_dsytaskreportconfig(
    io_destination = new /aws1/cl_dsyreportdestination(
      io_s3 = new /aws1/cl_dsyreportdsts3(
        iv_bucketaccessrolearn = |string|
        iv_s3bucketarn = |string|
        iv_subdirectory = |string|
      )
    )
    io_overrides = new /aws1/cl_dsyreportoverrides(
      io_deleted = new /aws1/cl_dsyreportoverride( |string| )
      io_skipped = new /aws1/cl_dsyreportoverride( |string| )
      io_transferred = new /aws1/cl_dsyreportoverride( |string| )
      io_verified = new /aws1/cl_dsyreportoverride( |string| )
    )
    iv_objectversionids = |string|
    iv_outputtype = |string|
    iv_reportlevel = |string|
  )
  it_excludes = VALUE /aws1/cl_dsyfilterrule=>tt_filterlist(
    (
      new /aws1/cl_dsyfilterrule(
        iv_filtertype = |string|
        iv_value = |string|
      )
    )
  )
  it_includes = VALUE /aws1/cl_dsyfilterrule=>tt_filterlist(
    (
      new /aws1/cl_dsyfilterrule(
        iv_filtertype = |string|
        iv_value = |string|
      )
    )
  )
  it_tags = VALUE /aws1/cl_dsytaglistentry=>tt_inputtaglist(
    (
      new /aws1/cl_dsytaglistentry(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_taskarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_taskexecutionarn = lo_result->get_taskexecutionarn( ).
ENDIF.