Skip to content

/AWS1/IF_DSY=>UPDATETASK()

About UpdateTask

Updates the configuration of a task, which defines where and how DataSync transfers your data.

Method Signature

METHODS /AWS1/IF_DSY~UPDATETASK
  IMPORTING
    !IV_TASKARN TYPE /AWS1/DSYTASKARN OPTIONAL
    !IO_OPTIONS TYPE REF TO /AWS1/CL_DSYOPTIONS OPTIONAL
    !IT_EXCLUDES TYPE /AWS1/CL_DSYFILTERRULE=>TT_FILTERLIST OPTIONAL
    !IO_SCHEDULE TYPE REF TO /AWS1/CL_DSYTASKSCHEDULE OPTIONAL
    !IV_NAME TYPE /AWS1/DSYTAGVALUE OPTIONAL
    !IV_CLOUDWATCHLOGGROUPARN TYPE /AWS1/DSYLOGGROUPARN OPTIONAL
    !IT_INCLUDES 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
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dsyupdatetaskresponse
  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 ARN of the task that you want to update.

Optional arguments:

io_options TYPE REF TO /AWS1/CL_DSYOPTIONS /AWS1/CL_DSYOPTIONS

Options

it_excludes TYPE /AWS1/CL_DSYFILTERRULE=>TT_FILTERLIST TT_FILTERLIST

Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

io_schedule TYPE REF TO /AWS1/CL_DSYTASKSCHEDULE /AWS1/CL_DSYTASKSCHEDULE

Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.

iv_name TYPE /AWS1/DSYTAGVALUE /AWS1/DSYTAGVALUE

Specifies the name of your task.

iv_cloudwatchloggrouparn TYPE /AWS1/DSYLOGGROUPARN /AWS1/DSYLOGGROUPARN

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

For Enhanced mode tasks, you must use /aws/datasync as your log group name. For example:

arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*

For more information, see Monitoring data transfers with CloudWatch Logs.

it_includes TYPE /AWS1/CL_DSYFILTERRULE=>TT_FILTERLIST TT_FILTERLIST

Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

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 IAM 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 as empty.

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 IAM 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.

RETURNING

oo_output TYPE REF TO /aws1/cl_dsyupdatetaskresponse /AWS1/CL_DSYUPDATETASKRESPONSE

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->updatetask(
  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_options = 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_schedule = new /aws1/cl_dsytaskschedule(
    iv_scheduleexpression = |string|
    iv_status = |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|
      )
    )
  )
  iv_cloudwatchloggrouparn = |string|
  iv_name = |string|
  iv_taskarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.