Skip to content

/AWS1/CL_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 phases 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

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