AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . datasync ]

start-task-execution

Description

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 .

Warning

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.

See also: AWS API Documentation

Synopsis

  start-task-execution
--task-arn <value>
[--override-options <value>]
[--includes <value>]
[--excludes <value>]
[--manifest-config <value>]
[--task-report-config <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--task-arn (string)

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

--override-options (structure)

Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options.

Each option has a default value. Unless you need to, you don't have to configure any option before calling StartTaskExecution .

You also can override your task options for each task execution. For example, you might want to adjust the LogLevel for an individual execution.

VerifyMode -> (string)

Specifies if and how DataSync checks the integrity of your data at the end of your transfer.

  • ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred data (including metadata) at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum calculated on that data at the destination.

Note

This is the default option for Enhanced mode tasks .

We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations .

  • POINT_IN_TIME_CONSISTENT - At the end of the transfer, DataSync checks the entire source and destination to verify that both locations are fully synchronized.

Note

The is the default option for Basic mode tasks and isn't currently supported with Enhanced mode tasks.

If you use a manifest , DataSync only scans and verifies what's listed in the manifest. You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations .

  • NONE - DataSync performs data integrity checks only during your transfer. Unlike other options, there's no additional verification at the end of your transfer.

OverwriteMode -> (string)

Specifies whether DataSync should modify or preserve data at the destination location.

  • ALWAYS (default) - DataSync modifies data in the destination location when source data (including metadata) has changed. If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers .
  • NEVER - DataSync doesn't overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination.

Atime -> (string)

Specifies whether to preserve metadata indicating the last time a file was read or written to.

Note

The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.
  • BEST_EFFORT (default) - DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING steps of the task execution). This option is recommended.
  • NONE - Ignores Atime .

Note

If Atime is set to BEST_EFFORT , Mtime must be set to PRESERVE .

If Atime is set to NONE , Mtime must also be NONE .

Mtime -> (string)

Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING step of your task execution. This option is required when you need to run the a task more than once.

  • PRESERVE (default) - Preserves original Mtime , which is recommended.
  • NONE - Ignores Mtime .

Note

If Mtime is set to PRESERVE , Atime must be set to BEST_EFFORT .

If Mtime is set to NONE , Atime must also be set to NONE .

Uid -> (string)

Specifies the POSIX user ID (UID) of the file's owner.

  • INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is recommended.
  • NONE - Ignores UID and GID.

For more information, see Metadata copied by DataSync .

Gid -> (string)

Specifies the POSIX group ID (GID) of the file's owners.

  • INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is recommended.
  • NONE - Ignores UID and GID.

For more information, see Understanding how DataSync handles file and object metadata .

PreserveDeletedFiles -> (string)

Specifies whether files in the destination location that don't exist in the source should be preserved. This option can affect your Amazon S3 storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync .

  • PRESERVE (default) - Ignores such destination files, which is recommended.
  • REMOVE - Deletes destination files that aren’t present in the source.

Note

If you set this parameter to REMOVE , you can't set TransferMode to ALL . When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.

PreserveDevices -> (string)

Specifies whether DataSync should preserve the metadata of block and character devices in the source location and recreate the files with that device name and metadata on the destination. DataSync copies only the name and metadata of such devices.

Note

DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an end-of-file (EOF) marker.
  • NONE (default) - Ignores special devices (recommended).
  • PRESERVE - Preserves character and block device metadata. This option currently isn't supported for Amazon EFS.

PosixPermissions -> (string)

Specifies which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

For more information, see Understanding how DataSync handles file and object metadata .

  • PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.
  • NONE - Ignores POSIX-style permissions.

Note

DataSync can preserve extant permissions of a source location.

BytesPerSecond -> (long)

Limits the bandwidth used by a DataSync task. For example, if you want DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024 ).

Note

Not applicable to Enhanced mode tasks .

TaskQueueing -> (string)

Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks . This is ENABLED by default.

LogLevel -> (string)

Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see CloudWatchLogGroupArn .

  • BASIC - Publishes logs with only basic information (such as transfer errors).
  • TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on.
  • OFF - No logs are published.

TransferMode -> (string)

Specifies whether DataSync transfers only the data (including metadata) that differs between locations following an initial copy or transfers all data every time you run the task. If you're planning on recurring transfers, you might only want to transfer what's changed since your previous task execution.

  • CHANGED (default) - After your initial full transfer, DataSync copies only the data and metadata that differs between the source and destination location.
  • ALL - DataSync copies everything in the source to the destination without comparing differences between the locations.

SecurityDescriptorCopyFlags -> (string)

Specifies which components of the SMB security descriptor are copied from source to destination objects.

This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations or between two FSx for Windows File Server locations. For more information, see Understanding how DataSync handles file and object metadata .

  • OWNER_DACL (default) - For each copied object, DataSync copies the following metadata:
    • The object owner.
    • NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object. DataSync won't copy NTFS system access control lists (SACLs) with this option.
  • OWNER_DACL_SACL - For each copied object, DataSync copies the following metadata:
    • The object owner.
    • NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
    • SACLs, which are used by administrators to log attempts to access a secured object. Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user with the right permissions, see required permissions for SMB , FSx for Windows File Server , or FSx for ONTAP (depending on the type of location in your transfer).
  • NONE - None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration.

ObjectTags -> (string)

Specifies whether you want DataSync to PRESERVE object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value.

Shorthand Syntax:

VerifyMode=string,OverwriteMode=string,Atime=string,Mtime=string,Uid=string,Gid=string,PreserveDeletedFiles=string,PreserveDevices=string,PosixPermissions=string,BytesPerSecond=long,TaskQueueing=string,LogLevel=string,TransferMode=string,SecurityDescriptorCopyFlags=string,ObjectTags=string

JSON Syntax:

{
  "VerifyMode": "POINT_IN_TIME_CONSISTENT"|"ONLY_FILES_TRANSFERRED"|"NONE",
  "OverwriteMode": "ALWAYS"|"NEVER",
  "Atime": "NONE"|"BEST_EFFORT",
  "Mtime": "NONE"|"PRESERVE",
  "Uid": "NONE"|"INT_VALUE"|"NAME"|"BOTH",
  "Gid": "NONE"|"INT_VALUE"|"NAME"|"BOTH",
  "PreserveDeletedFiles": "PRESERVE"|"REMOVE",
  "PreserveDevices": "NONE"|"PRESERVE",
  "PosixPermissions": "NONE"|"PRESERVE",
  "BytesPerSecond": long,
  "TaskQueueing": "ENABLED"|"DISABLED",
  "LogLevel": "OFF"|"BASIC"|"TRANSFER",
  "TransferMode": "CHANGED"|"ALL",
  "SecurityDescriptorCopyFlags": "NONE"|"OWNER_DACL"|"OWNER_DACL_SACL",
  "ObjectTags": "PRESERVE"|"NONE"
}

--includes (list)

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

(structure)

Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.

FilterType -> (string)

The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.

Value -> (string)

A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2

Shorthand Syntax:

FilterType=string,Value=string ...

JSON Syntax:

[
  {
    "FilterType": "SIMPLE_PATTERN",
    "Value": "string"
  }
  ...
]

--excludes (list)

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

(structure)

Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.

FilterType -> (string)

The type of filter rule to apply. DataSync only supports the SIMPLE_PATTERN rule type.

Value -> (string)

A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2

Shorthand Syntax:

FilterType=string,Value=string ...

JSON Syntax:

[
  {
    "FilterType": "SIMPLE_PATTERN",
    "Value": "string"
  }
  ...
]

--manifest-config (structure)

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.

Action -> (string)

Specifies what DataSync uses the manifest for.

Format -> (string)

Specifies the file format of your manifest. For more information, see Creating a manifest .

Source -> (structure)

Specifies the manifest that you want DataSync to use and where it's hosted.

Note

You must specify this parameter if you're configuring a new manifest on or after February 7, 2024.

If you don't, you'll get a 400 status code and ValidationException error stating that you're missing the IAM role for DataSync to access the S3 bucket where you're hosting your manifest. For more information, see Providing DataSync access to your manifest .

S3 -> (structure)

Specifies the S3 bucket where you're hosting your manifest.

ManifestObjectPath -> (string)

Specifies the Amazon S3 object key of your manifest. This can include a prefix (for example, prefix/my-manifest.csv ).

BucketAccessRoleArn -> (string)

Specifies the Identity and Access Management (IAM) role that allows DataSync to access your manifest. For more information, see Providing DataSync access to your manifest .

S3BucketArn -> (string)

Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.

ManifestObjectVersionId -> (string)

Specifies the object version ID of the manifest that you want DataSync to use. If you don't set this, DataSync uses the latest version of the object.

Shorthand Syntax:

Action=string,Format=string,Source={S3={ManifestObjectPath=string,BucketAccessRoleArn=string,S3BucketArn=string,ManifestObjectVersionId=string}}

JSON Syntax:

{
  "Action": "TRANSFER",
  "Format": "CSV",
  "Source": {
    "S3": {
      "ManifestObjectPath": "string",
      "BucketAccessRoleArn": "string",
      "S3BucketArn": "string",
      "ManifestObjectVersionId": "string"
    }
  }
}

--task-report-config (structure)

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.

Destination -> (structure)

Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports .

S3 -> (structure)

Specifies the Amazon S3 bucket where DataSync uploads your task report.

Subdirectory -> (string)

Specifies a bucket prefix for your report.

S3BucketArn -> (string)

Specifies the ARN of the S3 bucket where DataSync uploads your report.

BucketAccessRoleArn -> (string)

Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see Allowing DataSync to upload a task report to an Amazon S3 bucket .

OutputType -> (string)

Specifies the type of task report that you want:

  • SUMMARY_ONLY : Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.
  • STANDARD : Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

ReportLevel -> (string)

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

  • ERRORS_ONLY : A report shows what DataSync was unable to transfer, skip, verify, and delete.
  • SUCCESSES_AND_ERRORS : A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

ObjectVersionIds -> (string)

Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket . Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

Overrides -> (structure)

Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

Transferred -> (structure)

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer.

ReportLevel -> (string)

Specifies whether your task report includes errors only or successes and errors.

For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY ). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS ).

Verified -> (structure)

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer.

ReportLevel -> (string)

Specifies whether your task report includes errors only or successes and errors.

For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY ). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS ).

Deleted -> (structure)

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.

ReportLevel -> (string)

Specifies whether your task report includes errors only or successes and errors.

For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY ). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS ).

Skipped -> (structure)

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer.

ReportLevel -> (string)

Specifies whether your task report includes errors only or successes and errors.

For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY ). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS ).

Shorthand Syntax:

Destination={S3={Subdirectory=string,S3BucketArn=string,BucketAccessRoleArn=string}},OutputType=string,ReportLevel=string,ObjectVersionIds=string,Overrides={Transferred={ReportLevel=string},Verified={ReportLevel=string},Deleted={ReportLevel=string},Skipped={ReportLevel=string}}

JSON Syntax:

{
  "Destination": {
    "S3": {
      "Subdirectory": "string",
      "S3BucketArn": "string",
      "BucketAccessRoleArn": "string"
    }
  },
  "OutputType": "SUMMARY_ONLY"|"STANDARD",
  "ReportLevel": "ERRORS_ONLY"|"SUCCESSES_AND_ERRORS",
  "ObjectVersionIds": "INCLUDE"|"NONE",
  "Overrides": {
    "Transferred": {
      "ReportLevel": "ERRORS_ONLY"|"SUCCESSES_AND_ERRORS"
    },
    "Verified": {
      "ReportLevel": "ERRORS_ONLY"|"SUCCESSES_AND_ERRORS"
    },
    "Deleted": {
      "ReportLevel": "ERRORS_ONLY"|"SUCCESSES_AND_ERRORS"
    },
    "Skipped": {
      "ReportLevel": "ERRORS_ONLY"|"SUCCESSES_AND_ERRORS"
    }
  }
}

--tags (list)

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.

(structure)

A key-value pair representing a single tag that's been applied to an Amazon Web Services resource.

Key -> (string)

The key for an Amazon Web Services resource tag.

Value -> (string)

The value for an Amazon Web Services resource tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

TaskExecutionArn -> (string)

The ARN of the running task execution.