/AWS1/CL_DSY=>CREATETASK()

About CreateTask

Configures a task, which defines where and how DataSync transfers your data.

A task includes a source location, destination location, and transfer options (such as bandwidth limits, scheduling, and more).

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_SOURCELOCATIONARN TYPE /AWS1/DSYLOCATIONARN /AWS1/DSYLOCATIONARN

Specifies the ARN of your transfer's source location.

IV_DESTINATIONLOCATIONARN TYPE /AWS1/DSYLOCATIONARN /AWS1/DSYLOCATIONARN

Specifies the ARN of your transfer's destination location.

Optional arguments:

IV_CLOUDWATCHLOGGROUPARN TYPE /AWS1/DSYLOGGROUPARN /AWS1/DSYLOGGROUPARN

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

IV_NAME TYPE /AWS1/DSYTAGVALUE /AWS1/DSYTAGVALUE

Specifies the name of your task.

IO_OPTIONS TYPE REF TO /AWS1/CL_DSYOPTIONS /AWS1/CL_DSYOPTIONS

Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other 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.

IT_TAGS TYPE /AWS1/CL_DSYTAGLISTENTRY=>TT_INPUTTAGLIST TT_INPUTTAGLIST

Specifies the tags that you want to apply to your task.

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

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 role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

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.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_DSYCREATETASKRESPONSE /AWS1/CL_DSYCREATETASKRESPONSE