Specifies a schedule used to periodically transfer files from a source to a destination location. You can configure your task to execute hourly, daily, weekly or on specific days of the week. You control when in the day or hour you want the task to execute. The time you specify is UTC time. For more information, see Scheduling your task.

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"

The name of the task to update.

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

Undocumented member.

The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup.

The Amazon Resource Name (ARN) of the resource name of the task to update.

The response's http status code.

The Amazon Resource Name (ARN) of the agent to describe.

The time that the agent was activated (that is, created in your account).

The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.

The subnet and the security group that DataSync used to access a VPC endpoint.

The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.

The time that the agent last connected to DataSync.

The Amazon Resource Name (ARN) of the agent.

The name of the agent.

The response's http status code.

The Amazon Resource Name (ARN) of the task to delete.

The response's http status code.

The Amazon Resource Name (ARN) of the SMB location to describe.

The time that the SMB location was created.

The Amazon Resource Name (ARN) of the source SMB file system location that is created.

The name of the Windows domain that the SMB server belongs to.

The URL of the source SMB location that was described.

The user who can mount the share, has the permissions to access files and folders in the SMB share.

The mount options that are available for DataSync to use to access an SMB location.

The Amazon Resource Name (ARN) of the SMB location that was described.

The response's http status code.

You can use API filters to narrow down the list of resources returned by ListLocations. For example, to retrieve all tasks on a specific source location, you can use ListLocations with filter name LocationType S3 and Operator Equals.

An opaque string that indicates the position at which to begin the next list of locations.

The maximum number of locations to return.

An opaque string that indicates the position at which to begin returning the next list of locations.

An array that contains a list of locations.

The response's http status code.

The NFS mount options that DataSync can use to mount your NFS share.

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.

To see all the paths exported by your NFS server, run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.

The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this host name to mount the NFS server in a network.

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

The Amazon Resource Name (ARN) of the source NFS file system location that is created.

The response's http status code.

An opaque string that indicates the position at which to begin the next list of locations.

The maximum number of locations to return.

The Amazon Resource Name (ARN) of the resource whose tags to list.

An opaque string that indicates the position at which to begin returning the next list of resource tags.

Array of resource tags.

The response's http status code.

The Amazon Resource Name (ARN) of the FSx for Windows File Server location to describe.

The time that the FSx for Windows File Server location was created.

The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Windows File Server file system.

The name of the Windows domain that the FSx for Windows File Server belongs to.

The URL of the FSx for Windows File Server location that was described.

The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

The Amazon Resource Name (ARN) of the FSx for Windows File Server location that was described.

The response's http status code.

The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

The subdirectory in the self-managed object storage server that is used to read data from.

Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server. An agent uses this host name to mount the object storage server in a network.

The bucket on the self-managed object storage server that is used to read data from.

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

The response's http status code.

The Amazon Resource Name (ARN) of the task to describe.

The time that the task was created.

The status of the task that was described.

For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.

The schedule used to periodically transfer files from a source to a destination location.

The Amazon Resource Name (ARN) of the task that was described.

The Amazon Resource Name (ARN) of the task execution that is syncing files.

The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that was created for your subnet.

The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.

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"

The name of the task that was described.

Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

The Amazon Resource Name (ARN) of the source file system's location.

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

The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was created for your subnet.

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the overriding OverrideOptions value to StartTaskExecution operation.

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.

For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.

Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

The response's http status code.

The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.

The time that the Amazon S3 bucket location was created.

If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

The URL of the Amazon S3 location that was described.

Undocumented member.

The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.

The response's http status code.

An opaque string that indicates the position at which to begin the next list of agents.

The maximum number of agents to list.

A list of agents in your account.

An opaque string that indicates the position at which to begin returning the next list of agents.

The response's http status code.

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

The name of the Windows domain that the SMB server belongs to.

The user who can mount the share has the permissions to access files and folders in the SMB share.

The password of the user who can mount the share has the permissions to access files and folders in the SMB share.

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:

• Ensure that the user/password specified belongs to the user who can mount the share and who has the appropriate permissions for all of the files and directories that you want DataSync to access.
• Use credentials of a member of the Backup Operators group to mount the share.

Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.

Undocumented member.

The Amazon Resource Name (ARN) of the SMB location to update.

The response's http status code.

The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents operation to return a list of agents for your account and Amazon Web Services Region.

The response's http status code.

The name that you want to use to configure the agent.

The Amazon Resource Name (ARN) of the agent to update.

The response's http status code.

The name of the Windows domain that the FSx for Windows File Server belongs to.

A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination.

The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows File Server file system.

The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system.

The Amazon Resource Name (ARN) of the FSx for Windows File Server file system location that is created.

The response's http status code.

The Amazon Resource Name (ARN) of the task whose tasks you want to list.

An opaque string that indicates the position at which to begin the next list of the executed tasks.

The maximum number of executed tasks to list.

An opaque string that indicates the position at which to begin returning the next list of executed tasks.

A list of executed tasks.

The response's http status code.

The Amazon Resource Name (ARN) of the specific task execution that is being updated.

Undocumented member.

The response's http status code.

If you are using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.

Undocumented member.

The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created.

The response's http status code.

Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see Scheduling your task.

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"

The name of a task. This value is a text reference that is used to identify the task in the console.

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

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the StartTaskExecution operation.

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

The Amazon Resource Name (ARN) of the source location for the task.

The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.

The Amazon Resource Name (ARN) of the task.

The response's http status code.

A subdirectory in the location’s path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. By default, DataSync uses the root directory.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

The Amazon Resource Name (ARN) for the Amazon EFS file system.

The subnet and security group that the Amazon EFS file system uses. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.

The exact relationship between security group M (of the mount target) and security group S (which you provide for DataSync to use at this stage) is as follows:

• Security group M (which you associate with the mount target) must allow inbound access for the Transmission Control Protocol (TCP) on the NFS port (2049) from security group S. You can enable inbound connections either by IP address (CIDR range) or security group.

• Security group S (provided to DataSync to access EFS) should have a rule that enables outbound connections to the NFS port on one of the file system’s mount targets. You can enable outbound connections either by IP address (CIDR range) or security group.

  For information about security groups and mount targets, see Security Groups for Amazon EC2 Instances and Mount Targets in the Amazon EFS User Guide.

The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.

The response's http status code.

The Amazon Resource Name (ARN) of the self-managed object storage server location that was described.

The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS).

The time that the self-managed object storage server agent was created.

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

The URL of the source self-managed object storage server location that was described.

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

The Amazon Resource Name (ARN) of the self-managed object storage server location to describe.

Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

The response's http status code.

The Amazon Resource Name (ARN) of the location to delete.

The response's http status code.

You can use API filters to narrow down the list of resources returned by ListTasks. For example, to retrieve all tasks on a specific source location, you can use ListTasks with filter name LocationId and Operator Equals with the ARN for the location.

An opaque string that indicates the position at which to begin the next list of tasks.

The maximum number of tasks to return.

A list of all the tasks that are returned.

An opaque string that indicates the position at which to begin returning the next list of tasks.

The response's http status code.

Undocumented member.

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"

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

The Amazon Resource Name (ARN) of the task to start.

The Amazon Resource Name (ARN) of the specific task execution that was started.

The response's http status code.

Undocumented member.

The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.

To see all the paths exported by your NFS server, run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

To transfer all the data in the folder that you specified, DataSync must have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the files you want DataSync to access have permissions that allow read access for all users. Doing either option enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

If you are copying data to or from your Snowcone device, see NFS Server on Snowcone for more information.

For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.

Undocumented member.

The Amazon Resource Name (ARN) of the NFS location to update.

The response's http status code.

The Amazon Resource Name (ARN) of the task that is being executed.

The status of the task execution.

For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.

The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.

For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

The time that the task execution was started.

The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated periodically when each file is read from the source and sent over the network.

If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer. This value can also be greater than EstimatedFilesTransferred in some cases. This element is implementation-specific for some location types, so don't use it as an indicator for a correct file number or to monitor your task execution.

The number of logical bytes written to the destination Amazon Web Services storage resource.

The physical number of bytes transferred over the network.

The result of the task execution.

A list of filter rules that determines which files to include when running a task. The list 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"

The expected number of files that is to be transferred over the network. This value is calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the expected number of files to be transferred. It's calculated based on comparing the content of the source and destination locations and finding the delta that needs to be transferred.

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

Undocumented member.

The estimated physical number of bytes that is to be transferred over the network.

The response's http status code.

The name of the Windows domain that the SMB server belongs to.

The mount options used by DataSync to access the SMB server.

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

The user who can mount the share, has the permissions to access files and folders in the SMB share.

For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

The Amazon Resource Name (ARN) of the source SMB file system location that is created.

The response's http status code.

The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task. The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four network interfaces.

The name you configured for your agent. This value is a text reference that is used to identify the agent in the console.

The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is the client-side VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.

Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the DataSync console.

The redirect URL returned in the response provides you the activation key for your agent in the query string parameter activationKey. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.

For more information, see Activating an Agent in the /DataSync User Guide./

The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation to return a list of agents for your account and Amazon Web Services Region.

The response's http status code.

The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

The subdirectory in the self-managed object storage server that is used to read data from.

Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

The Amazon Resource Name (ARN) of the self-managed object storage server location to be updated.

The response's http status code.

The Amazon Resource Name (ARN) of the EFS location to describe.

The time that the EFS location was created.

The URL of the EFS location that was described.

The Amazon Resource Name (ARN) of the EFS location that was described.

Undocumented member.

The response's http status code.

The Amazon Resource Name (ARN) of the resource to apply the tag to.

The tags to apply.

The response's http status code.

The Amazon Resource Name (ARN) of the resource to remove the tag from.

The keys in the key-value pair in the tag to remove.

The response's http status code.

The Amazon Resource Name (ARN) of the NFS location to describe.

The time that the NFS location was created.

The URL of the source NFS location that was described.

Undocumented member.

The NFS mount options that DataSync used to mount your NFS share.

The Amazon Resource Name (ARN) of the NFS location that was described.

The response's http status code.

The Amazon Resource Name (ARN) of the task execution to cancel.

The response's http status code.

The status of the agent.

The Amazon Resource Name (ARN) of the agent.

The name of the agent.

The ARN of the subnet and the security group that DataSync uses to access the target EFS file system.

The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource.

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

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

The name of the filter being used. Each API call supports a list of filters that are available for it (for example, LocationType for ListLocations).

The values that you want to filter for. For example, you might want to display only Amazon S3 locations.

The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see API filters for ListTasks and ListLocations.

Represents a list of URLs of a location. LocationUri returns an array that contains a list of locations when the ListLocations operation is called.

Format: TYPE://GLOBAL_ID/SUBDIR.

TYPE designates the type of location. Valid values: NFS | EFS | S3.

GLOBAL_ID is the globally unique identifier of the resource that backs the location. An example for EFS is us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket name, such as myBucket. An example for NFS is a valid IPv4 address or a host name compliant with Domain Name Service (DNS).

SUBDIR is a valid file system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, it's the export path to mount the location. For Amazon S3, it's the prefix path that you mount to and treat as the root of the location.

The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon EFS, the location is the export path. For Amazon S3, the location is the prefix path that you want to mount and use as the root of the location.

The specific NFS version that you want DataSync to use to mount your NFS share. If the server refuses to use the version specified, the sync will fail. If you don't specify a version, DataSync defaults to AUTOMATIC. That is, DataSync automatically selects a version based on negotiation with the NFS server.

You can specify the following NFS versions:

• NFSv3 - stateless protocol version that allows for asynchronous writes on the server.
• NFSv4.0 - stateful, firewall-friendly protocol version that supports delegations and pseudo filesystems.
• NFSv4.1 - stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.

ARNs of the agents to use for an NFS location.

A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so DataSync can only do this on a best-effort basis.

Default value: BEST_EFFORT.

BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).

NONE: Ignore Atime.

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

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

A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see Configure task settings.

Default value: POINT_IN_TIME_CONSISTENT.

ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.

POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.

NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.

A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.

If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.

A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.

A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.

Default value: PRESERVE.

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

DataSync can preserve extant permissions of a source location.

A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase. This option is required for cases when you need to run the same task more than one time.

Default value: PRESERVE.

PRESERVE: Preserve original Mtime (recommended)

NONE: Ignore Mtime.

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.

The POSIX user ID (UID) of the file's owner. This option should only be set for NFS, EFS, and S3 locations. To learn more about what metadata is copied by DataSync, see Metadata Copied by DataSync.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

NONE: Ignore UID and GID.

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

A value that determines 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 Amazon FSx for Windows File Server locations. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.

Default value: OWNER_DACL.

OWNER_DACL: For each copied object, DataSync copies the following metadata:

• Object owner.
• NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.

When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.

OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:

• Object owner.
• NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
• NTFS system access control lists (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 that ensures sufficient permissions to files, folders, and metadata, see user.

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.

The POSIX group ID (GID) of the file's owners. This option should only be set for NFS, EFS, and S3 locations. For more information about what metadata is copied by DataSync, see Metadata Copied by DataSync.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

NONE: Ignore UID and GID.

A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with Amazon S3 storage classes in DataSync in the DataSync User Guide.

A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.

CHANGED: DataSync copies only data or metadata that is new or different content from the source location to the destination location.

ALL: DataSync copies all source location content to the destination, without comparing to existing content on the destination.

A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your 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 in the DataSync User Guide.

Default value: PRESERVE.

PRESERVE: Ignore such destination files (recommended).

REMOVE: Delete destination files that aren’t present in the source.

A value that determines whether DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata.

DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

Default value: NONE.

NONE: Ignore special devices (recommended).

PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.

The Amazon Resource Names (ARNs) of the security groups that are configured for the EC2 resource that hosts an agent activated in a VPC or an agent that has access to a VPC endpoint.

The Amazon Resource Names (ARNs) of the subnets that are configured for an agent activated in a VPC or an agent that has access to a VPC endpoint.

The private endpoint that is configured for an agent that has access to IP addresses in a PrivateLink. An agent that is configured with this endpoint will not be accessible over the public internet.

The ID of the VPC endpoint that is configured for an agent. An agent that is configured with a VPC endpoint will not be accessible over the public internet.

The Amazon S3 bucket to access. This bucket is used as a parameter in the CreateLocationS3 operation.

The specific SMB version that you want DataSync to use to mount your SMB share. If you don't specify a version, DataSync defaults to AUTOMATIC. That is, DataSync automatically selects a version based on negotiation with the SMB server.

The value for an Amazon Web Services resource tag.

The key for an Amazon Web Services resource tag.

The status of a task execution.

The Amazon Resource Name (ARN) of the task that was executed.

The total time in milliseconds that DataSync spent in the PREPARING phase.

The status of the PREPARING phase.

The status of the VERIFYING phase.

The total time in milliseconds that DataSync spent in the VERIFYING phase.

The total time in milliseconds that DataSync took to transfer the file from the source to the destination location.

The status of the TRANSFERRING phase.

Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

The total time in milliseconds that DataSync spent in the TRANSFERRING phase.

Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

The name of the filter being used. Each API call supports a list of filters that are available for it. For example, LocationId for ListTasks.

The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.

The operator that is used to compare filter values (for example, Equals or Contains). For more about API filtering operators, see API filters for ListTasks and ListLocations.

The status of the task.

The Amazon Resource Name (ARN) of the task.

The name of the task.

A cron expression that specifies when DataSync initiates a scheduled transfer from a source to a destination location.