DiscoveryServerConfiguration serverConfiguration
Specifies the server name and network port required to connect with the management interface of your on-premises storage system.
String systemType
Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.
DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
List<E> agentArns
Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system's management interface. You can only specify one ARN.
String cloudWatchLogGroupArn
Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.
List<E> tags
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your on-premises storage system.
String name
Specifies a familiar name for your on-premises storage system.
String clientToken
Specifies a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically.
Credentials credentials
Specifies the user name and password for accessing your on-premises storage system's management interface.
String storageSystemArn
The ARN of the on-premises storage system that you can use with DataSync Discovery.
String agentArn
The Amazon Resource Name (ARN) of a DataSync agent.
String name
The name of an agent.
String status
The status of an agent.
If the status is ONLINE, the agent is configured properly and ready to use.
If the status is OFFLINE, the agent has been out of contact with DataSync for five minutes or
longer. This can happen for a few reasons. For more information, see What do I do if my agent is offline?
Platform platform
The platform-related details about the agent, such as the version number.
String token
Specifies a SAS token that provides permissions to access your Azure Blob Storage.
The token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this:
sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D
String taskExecutionArn
The Amazon Resource Name (ARN) of the task execution to stop.
Long used
The amount of space that's being used in a storage system resource.
Long provisioned
The total amount of space available in a storage system resource.
Long logicalUsed
The amount of space that's being used in a storage system resource without accounting for compression or deduplication.
Long clusterCloudStorageUsed
The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).
String activationKey
Specifies your DataSync agent's activation key. If you don't have an activation key, see Activate your agent.
String agentName
Specifies a name for your agent. You can see this name in the DataSync console.
List<E> tags
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least one tag for your agent.
String vpcEndpointId
Specifies the ID of the VPC endpoint that you want your agent to connect to. For example, a VPC endpoint ID looks
like vpce-01234d5aff67890e1.
The VPC endpoint you use must include the DataSync service name (for example,
com.amazonaws.us-east-2.datasync).
List<E> subnetArns
Specifies the ARN of the subnet where you want to run your DataSync task when using a VPC endpoint. This is the subnet where DataSync creates and manages the network interfaces for your transfer. You can only specify one ARN.
List<E> securityGroupArns
Specifies the Amazon Resource Name (ARN) of the security group that protects your task's network interfaces when using a virtual private cloud (VPC) endpoint. You can only specify one ARN.
String agentArn
The ARN of the agent that you just activated. Use the ListAgents operation to return a list of agents in your Amazon Web Services account and Amazon Web Services Region.
String containerUrl
Specifies the URL of the Azure Blob Storage container involved in your transfer.
String authenticationType
Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).
AzureBlobSasConfiguration sasConfiguration
Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.
String blobType
Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation.
String accessTier
Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers.
String subdirectory
Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example,
/my/images).
List<E> agentArns
Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.
You can specify more than one agent. For more information, see Using multiple agents for your transfer.
List<E> tags
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.
String locationArn
The ARN of the Azure Blob Storage transfer location that you created.
String subdirectory
Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.
You must specify a value with forward slashes (for example, /path/to/folder).
String efsFilesystemArn
Specifies the ARN for the Amazon EFS file system.
Ec2Config ec2Config
Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.
List<E> tags
Specifies 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.
String accessPointArn
Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.
String fileSystemAccessRoleArn
Specifies an Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.
String inTransitEncryption
Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system.
If you specify an access point using AccessPointArn or an IAM role using
FileSystemAccessRoleArn, you must set this parameter to TLS1_2.
String locationArn
The Amazon Resource Name (ARN) of the Amazon EFS file system location that you create.
String fsxFilesystemArn
The Amazon Resource Name (ARN) for the FSx for Lustre file system.
List<E> securityGroupArns
The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Lustre file system.
String subdirectory
A subdirectory in the location's path. This subdirectory in the FSx for Lustre file system is used to read data from the FSx for Lustre source location or write data to the FSx for Lustre destination.
List<E> tags
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.
String locationArn
The Amazon Resource Name (ARN) of the FSx for Lustre file system location that's created.
FsxProtocol protocol
List<E> securityGroupArns
Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet.
The security groups must allow outbound traffic on the following ports (depending on the protocol you use):
Network File System (NFS): TCP ports 111, 635, and 2049
Server Message Block (SMB): TCP port 445
Your file system's security groups must also allow inbound traffic on the same ports.
String storageVirtualMachineArn
Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.
String subdirectory
Specifies a path to the file share in the SVM where you'll copy your data.
You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name
(for SMB file shares). For example, your mount path might be /vol1, /vol1/tree1, or
/share1.
Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
List<E> tags
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
String locationArn
Specifies the ARN of the FSx for ONTAP file system location that you create.
String fsxFilesystemArn
The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
FsxProtocol protocol
The type of protocol that DataSync uses to access your file system.
List<E> securityGroupArns
The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.
String subdirectory
A subdirectory in the location's path that must begin with /fsx. DataSync uses this subdirectory to
read or write data (depending on whether the file system is a source or destination location).
List<E> tags
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.
String locationArn
The ARN of the FSx for OpenZFS file system location that you created.
String subdirectory
Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).
String fsxFilesystemArn
Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
List<E> securityGroupArns
Specifies the ARNs of the security groups that provide access to your file system's preferred subnet.
If you choose a security group that doesn't allow connections from within itself, do one of the following:
Configure the security group to allow it to communicate within itself.
Choose a different security group that can communicate with the mount target's security group.
List<E> tags
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
String user
Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
For information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.
String domain
Specifies the name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.
If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
String password
Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.
String locationArn
The ARN of the FSx for Windows File Server file system location you created.
String subdirectory
A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS
cluster. If the subdirectory isn't specified, it will default to /.
List<E> nameNodes
The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.
Integer blockSize
The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB).
Integer replicationFactor
The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.
String kmsKeyProviderUri
The URI of the HDFS cluster's Key Management Server (KMS).
QopConfiguration qopConfiguration
The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer
protection settings configured on the Hadoop Distributed File System (HDFS) cluster. If
QopConfiguration isn't specified, RpcProtection and DataTransferProtection
default to PRIVACY. If you set RpcProtection or DataTransferProtection,
the other parameter assumes the same value.
String authenticationType
The type of authentication used to determine the identity of the user.
String simpleUser
The user name used to identify the client on the host operating system.
If SIMPLE is specified for AuthenticationType, this parameter is required.
String kerberosPrincipal
The Kerberos principal with access to the files and folders on the HDFS cluster.
If KERBEROS is specified for AuthenticationType, this parameter is required.
ByteBuffer kerberosKeytab
The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you're using the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.
If KERBEROS is specified for AuthenticationType, this parameter is required.
ByteBuffer kerberosKrb5Conf
The krb5.conf file that contains the Kerberos configuration information. You can load the
krb5.conf file by providing the file's address. If you're using the CLI, it performs the base64
encoding for you. Otherwise, provide the base64-encoded text.
If KERBEROS is specified for AuthenticationType, this parameter is required.
List<E> agentArns
The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.
List<E> tags
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.
String locationArn
The ARN of the source HDFS cluster location that's created.
String subdirectory
Specifies the export path in your NFS file server that you want DataSync to mount.
This path (or a subdirectory of the path) is where DataSync transfers data to or from. For information on configuring an export for DataSync, see Accessing NFS file servers.
String serverHostname
Specifies the Domain Name System (DNS) name or IP version 4 address of the NFS file server that your DataSync agent connects to.
OnPremConfig onPremConfig
Specifies the Amazon Resource Name (ARN) of the DataSync agent that want to connect to your NFS file server.
You can specify more than one agent. For more information, see Using multiple agents for transfers.
NfsMountOptions mountOptions
Specifies the options that DataSync can use to mount your NFS file server.
List<E> tags
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
String locationArn
The ARN of the transfer location that you created for your NFS file server.
String serverHostname
Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.
Integer serverPort
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
String serverProtocol
Specifies the protocol that your object storage server uses to communicate.
String subdirectory
Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.
String bucketName
Specifies the name of the object storage bucket involved in the transfer.
String accessKey
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
String secretKey
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
List<E> agentArns
Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
List<E> tags
Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.
ByteBuffer serverCertificate
Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a
private or self-signed certificate authority (CA). You must specify a single .pem file with a full
certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).
The certificate chain might include:
The object storage system's certificate
All intermediate certificates (if there are any)
The root certificate of the signing CA
You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64
encoding). The following example cat command creates an object_storage_certificates.pem
file that includes three certificates:
cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem
To use this parameter, configure ServerProtocol to HTTPS.
String locationArn
Specifies the ARN of the object storage system location that you create.
String subdirectory
Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location).
DataSync can't transfer objects with a prefix that begins with a slash (/) or includes
//, /./, or /../ patterns. For example:
/photos
photos//2006/January
photos/./2006/February
photos/../2006/March
String s3BucketArn
Specifies the ARN of the S3 bucket that you want to use as a location. (When creating your DataSync task later, you specify whether this location is a transfer source or destination.)
If your S3 bucket is located on an Outposts resource, you must specify an Amazon S3 access point. For more information, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.
String s3StorageClass
Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.
For buckets in Amazon Web Services Regions, the storage class defaults to STANDARD. For buckets on
Outposts, the storage class defaults to OUTPOSTS.
For more information, see Storage class considerations with Amazon S3 transfers.
S3Config s3Config
List<E> agentArns
(Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the DataSync agent on your Outpost.
For more information, see Deploy your DataSync agent on Outposts.
List<E> tags
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your transfer location.
String locationArn
The ARN of the S3 location that you created.
String subdirectory
Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can
include a subdirectory in the share path (for example, /path/to/subdirectory). Make sure that other
SMB clients in your network can also mount this path.
To copy all data in the subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see required permissions for SMB locations.
String serverHostname
Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.
You can't specify an IP version 6 (IPv6) address.
String user
Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.
For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.
String domain
Specifies the name of the Active Directory domain that your SMB file server belongs to.
If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
String password
Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.
For more information, see required permissions for SMB locations.
List<E> agentArns
Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
SmbMountOptions mountOptions
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
List<E> tags
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
String locationArn
The ARN of the SMB location that you created.
String sourceLocationArn
Specifies the ARN of your transfer's source location.
String destinationLocationArn
Specifies the ARN of your transfer's destination location.
String cloudWatchLogGroupArn
Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
String name
Specifies the name of your task.
Options options
Specifies your task's settings, such as preserving file metadata, verifying data integrity, among other options.
List<E> excludes
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.
TaskSchedule schedule
Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.
List<E> tags
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.
List<E> includes
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.
ManifestConfig manifestConfig
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.
TaskReportConfig taskReportConfig
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.
String taskArn
The Amazon Resource Name (ARN) of the task.
String agentArn
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.
String locationArn
The Amazon Resource Name (ARN) of the location to delete.
String taskArn
Specifies the Amazon Resource Name (ARN) of the task that you want to delete.
String agentArn
Specifies the Amazon Resource Name (ARN) of the DataSync agent that you want information about.
String agentArn
The ARN of the agent.
String name
The name of the agent.
String status
The status of the agent.
If the status is ONLINE, the agent is configured properly and ready to use.
If the status is OFFLINE, the agent has been out of contact with DataSync for five minutes or
longer. This can happen for a few reasons. For more information, see What do I do if my agent is offline?
Date lastConnectionTime
The last time that the agent was communicating with the DataSync service.
Date creationTime
The time that the agent was activated.
String endpointType
The type of service endpoint that your agent is connected to.
PrivateLinkConfig privateLinkConfig
The network configuration that the agent uses when connecting to a VPC service endpoint.
Platform platform
The platform-related details about the agent, such as the version number.
String discoveryJobArn
Specifies the Amazon Resource Name (ARN) of the discovery job that you want information about.
String storageSystemArn
The ARN of the on-premises storage system you're running the discovery job on.
String discoveryJobArn
The ARN of the discovery job.
Integer collectionDurationMinutes
The number of minutes that the discovery job runs.
String status
Indicates the status of a discovery job. For more information, see Discovery job statuses.
Date jobStartTime
The time when the discovery job started.
Date jobEndTime
The time when the discovery job ended.
String locationArn
Specifies the Amazon Resource Name (ARN) of your Azure Blob Storage transfer location.
String locationArn
The ARN of your Azure Blob Storage transfer location.
String locationUri
The URL of the Azure Blob Storage container involved in your transfer.
String authenticationType
The authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).
String blobType
The type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation.
String accessTier
The access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers.
List<E> agentArns
The ARNs of the DataSync agents that can connect with your Azure Blob Storage container.
Date creationTime
The time that your Azure Blob Storage transfer location was created.
String locationArn
The Amazon Resource Name (ARN) of the Amazon EFS file system location that you want information about.
String locationArn
The ARN of the Amazon EFS file system location.
String locationUri
The URL of the Amazon EFS file system location.
Ec2Config ec2Config
Date creationTime
The time that the location was created.
String accessPointArn
The ARN of the access point that DataSync uses to access the Amazon EFS file system.
String fileSystemAccessRoleArn
The Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.
String inTransitEncryption
Describes whether DataSync uses Transport Layer Security (TLS) encryption when copying data to or from the Amazon EFS file system.
String locationArn
The Amazon Resource Name (ARN) of the FSx for Lustre location to describe.
String locationArn
The Amazon Resource Name (ARN) of the FSx for Lustre location that was described.
String locationUri
The URI of the FSx for Lustre location that was described.
List<E> securityGroupArns
The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Lustre file system.
Date creationTime
The time that the FSx for Lustre location was created.
String locationArn
Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system location that you want information about.
Date creationTime
The time that the location was created.
String locationArn
The ARN of the FSx for ONTAP file system location.
String locationUri
The uniform resource identifier (URI) of the FSx for ONTAP file system location.
FsxProtocol protocol
List<E> securityGroupArns
The security groups that DataSync uses to access your FSx for ONTAP file system.
String storageVirtualMachineArn
The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system where you're copying data to or from.
String fsxFilesystemArn
The ARN of the FSx for ONTAP file system.
String locationArn
The Amazon Resource Name (ARN) of the FSx for OpenZFS location to describe.
String locationArn
The ARN of the FSx for OpenZFS location that was described.
String locationUri
The uniform resource identifier (URI) of the FSx for OpenZFS location that was described.
Example: fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder
List<E> securityGroupArns
The ARNs of the security groups that are configured for the FSx for OpenZFS file system.
FsxProtocol protocol
The type of protocol that DataSync uses to access your file system.
Date creationTime
The time that the FSx for OpenZFS location was created.
String locationArn
Specifies the Amazon Resource Name (ARN) of the FSx for Windows File Server location.
String locationArn
The ARN of the FSx for Windows File Server location.
String locationUri
The uniform resource identifier (URI) of the FSx for Windows File Server location.
List<E> securityGroupArns
The ARNs of the security groups that are configured for the FSx for Windows File Server file system.
Date creationTime
The time that the FSx for Windows File Server location was created.
String user
The user with the permissions to mount and access the FSx for Windows File Server file system.
String domain
The name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.
String locationArn
Specifies the Amazon Resource Name (ARN) of the HDFS location.
String locationArn
The ARN of the HDFS location.
String locationUri
The URI of the HDFS location.
List<E> nameNodes
The NameNode that manages the HDFS namespace.
Integer blockSize
The size of the data blocks to write into the HDFS cluster.
Integer replicationFactor
The number of DataNodes to replicate the data to when writing to the HDFS cluster.
String kmsKeyProviderUri
The URI of the HDFS cluster's Key Management Server (KMS).
QopConfiguration qopConfiguration
The Quality of Protection (QOP) configuration, which specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the HDFS cluster.
String authenticationType
The type of authentication used to determine the identity of the user.
String simpleUser
The user name to identify the client on the host operating system. This parameter is used if the
AuthenticationType is defined as SIMPLE.
String kerberosPrincipal
The Kerberos principal with access to the files and folders on the HDFS cluster. This parameter is used if the
AuthenticationType is defined as KERBEROS.
List<E> agentArns
The ARNs of the DataSync agents that can connect with your HDFS cluster.
Date creationTime
The time that the HDFS location was created.
String locationArn
Specifies the Amazon Resource Name (ARN) of the NFS location that you want information about.
String locationArn
The ARN of the NFS location.
String locationUri
The URI of the NFS location.
OnPremConfig onPremConfig
NfsMountOptions mountOptions
The mount options that DataSync uses to mount your NFS file server.
Date creationTime
The time when the NFS location was created.
String locationArn
Specifies the Amazon Resource Name (ARN) of the object storage system location.
String locationArn
The ARN of the object storage system location.
String locationUri
The URI of the object storage system location.
String accessKey
The access key (for example, a user name) required to authenticate with the object storage system.
Integer serverPort
The port that your object storage server accepts inbound network traffic on (for example, port 443).
String serverProtocol
The protocol that your object storage system uses to communicate.
List<E> agentArns
The ARNs of the DataSync agents that can connect with your object storage system.
Date creationTime
The time that the location was created.
ByteBuffer serverCertificate
The certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).
String locationArn
Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.
String locationArn
The ARN of the Amazon S3 location.
String locationUri
The URL of the Amazon S3 location that was described.
String s3StorageClass
When Amazon S3 is a destination location, this is the storage class that you chose for your objects.
Some storage classes have behaviors that can affect your Amazon S3 storage costs. For more information, see Storage class considerations with Amazon S3 transfers.
S3Config s3Config
List<E> agentArns
The ARNs of the DataSync agents deployed on your Outpost when using working with Amazon S3 on Outposts.
For more information, see Deploy your DataSync agent on Outposts.
Date creationTime
The time that the Amazon S3 location was created.
String locationArn
Specifies the Amazon Resource Name (ARN) of the SMB location that you want information about.
String locationArn
The ARN of the SMB location.
String locationUri
The URI of the SMB location.
List<E> agentArns
The ARNs of the DataSync agents that can connect with your SMB file server.
String user
The user that can mount and access the files, folders, and file metadata in your SMB file server.
String domain
The name of the Microsoft Active Directory domain that the SMB file server belongs to.
SmbMountOptions mountOptions
The protocol that DataSync use to access your SMB file.
Date creationTime
The time that the SMB location was created.
String storageSystemArn
Specifies the Amazon Resource Name (ARN) of an on-premises storage system that you're using with DataSync Discovery.
String discoveryJobArn
Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.
String resourceType
Specifies the kind of storage system resource that you want information about.
String resourceId
Specifies the universally unique identifier (UUID) of the storage system resource that you want information about.
Date startTime
Specifies a time within the total duration that the discovery job ran. To see information gathered during a
certain time frame, use this parameter with EndTime.
Date endTime
Specifies a time within the total duration that the discovery job ran. To see information gathered during a
certain time frame, use this parameter with StartTime.
Integer maxResults
Specifies how many results that you want in the response.
String nextToken
Specifies an opaque string that indicates the position to begin the next list of results in the response.
String discoveryJobArn
Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from your on-premises storage system.
String resourceType
Specifies what kind of storage system resources that you want information about.
List<E> resourceIds
Specifies the universally unique identifiers (UUIDs) of the storage system resources that you want information
about. You can't use this parameter in combination with the Filter parameter.
Map<K,V> filter
Filters the storage system resources that you want returned. For example, this might be volumes associated with a specific storage virtual machine (SVM).
Integer maxResults
Specifies the maximum number of storage system resources that you want to list in a response.
String nextToken
Specifies an opaque string that indicates the position to begin the next list of results in the response.
ResourceDetails resourceDetails
The information collected about your storage system's resources. A response can also include Amazon Web Services storage service recommendations.
For more information, see storage resource information collected by and recommendations provided by DataSync Discovery.
String nextToken
The opaque string that indicates the position to begin the next list of results in the response.
String storageSystemArn
The ARN of the on-premises storage system that the discovery job looked at.
DiscoveryServerConfiguration serverConfiguration
The server name and network port required to connect with your on-premises storage system's management interface.
String systemType
The type of on-premises storage system.
DataSync Discovery currently only supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
List<E> agentArns
The ARN of the DataSync agent that connects to and reads from your on-premises storage system.
String name
The name that you gave your on-premises storage system when adding it to DataSync Discovery.
String errorMessage
Describes the connectivity error that the DataSync agent is encountering with your on-premises storage system.
String connectivityStatus
Indicates whether your DataSync agent can connect to your on-premises storage system.
String cloudWatchLogGroupArn
The ARN of the Amazon CloudWatch log group that's used to monitor and log discovery job events.
Date creationTime
The time when you added the on-premises storage system to DataSync Discovery.
String secretsManagerArn
The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery stores these credentials in Secrets Manager.
String taskExecutionArn
Specifies the Amazon Resource Name (ARN) of the task execution that you want information about.
String taskExecutionArn
The ARN of the task execution that you wanted information about. 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.
String status
The status of the task execution.
Options options
List<E> excludes
A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
List<E> includes
A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.
ManifestConfig manifestConfig
The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.
Date startTime
The time when the task execution started.
Long estimatedFilesToTransfer
The expected number of files, objects, and directories that DataSync will transfer over the network. This value
is calculated during the task execution's PREPARING phase before the TRANSFERRING
phase. The calculation is based on comparing the content of the source and destination locations and finding the
difference that needs to be transferred.
Long estimatedBytesToTransfer
The estimated physical number of bytes that will transfer over the network.
Long filesTransferred
The actual number of files, objects, and directories that DataSync transferred over the network. This value is
updated periodically during the task execution's TRANSFERRING phase when something is read from the
source and sent over the network.
If DataSync fails to transfer something, this value can be less than EstimatedFilesToTransfer. In
some cases, this value can also be greater than EstimatedFilesToTransfer. This element is
implementation-specific for some location types, so don't use it as an exact indication of what transferred or to
monitor your task execution.
Long bytesWritten
The number of logical bytes written to the destination location.
Long bytesTransferred
The total number of bytes that are involved in the transfer. For the number of bytes sent over the network, see
BytesCompressed.
Long bytesCompressed
The physical number of bytes transferred over the network after compression was applied. In most cases, this
number is less than BytesTransferred unless the data isn't compressible.
TaskExecutionResultDetail result
The result of the task execution.
TaskReportConfig taskReportConfig
The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.
Long filesDeleted
The number of files, objects, and directories that DataSync deleted in your destination location. If you don't configure your task to
delete data in the destination that isn't in the source, the value is always 0.
Long filesSkipped
The number of files, objects, and directories that DataSync skipped during your transfer.
Long filesVerified
The number of files, objects, and directories that DataSync verified during your transfer.
When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.
ReportResult reportResult
Indicates whether DataSync generated a complete task report for your transfer.
Long estimatedFilesToDelete
The expected number of files, objects, and directories that DataSync will delete in your destination location. If
you don't configure your
task to delete data in the destination that isn't in the source, the value is always 0.
String taskArn
Specifies the Amazon Resource Name (ARN) of the transfer task that you want information about.
String taskArn
The ARN of your task.
String status
The status of your task. For information about what each status means, see Task statuses.
String name
The name of your task.
String currentTaskExecutionArn
The ARN of the most recent task execution.
String sourceLocationArn
The ARN of your transfer's source location.
String destinationLocationArn
The ARN of your transfer's destination location.
String cloudWatchLogGroupArn
The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
For more information, see Monitoring DataSync with Amazon CloudWatch.
List<E> sourceNetworkInterfaceArns
The ARNs of the network interfaces that DataSync created for your source location.
List<E> destinationNetworkInterfaceArns
The ARNs of the network interfaces that DataSync created for your destination location.
Options options
The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.
List<E> excludes
The 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.
TaskSchedule schedule
The schedule for when you want your task to run. For more information, see Scheduling your task.
String errorCode
If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.
String errorDetail
If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.
Date creationTime
The time that the task was created.
List<E> includes
The include filters that 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.
ManifestConfig manifestConfig
The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see Specifying what DataSync transfers by using a manifest.
TaskReportConfig taskReportConfig
The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.
TaskScheduleDetails scheduleDetails
The details about your task schedule.
String discoveryJobArn
The Amazon Resource Name (ARN) of a discovery job.
String status
The status of a discovery job. For more information, see Discovery job statuses.
String subnetArn
Specifies the ARN of a subnet where DataSync creates the network interfaces for managing traffic during your transfer.
The subnet must be located:
In the same virtual private cloud (VPC) as the Amazon EFS file system.
In the same Availability Zone as at least one mount target for the Amazon EFS file system.
You don't need to specify a subnet that includes a file system mount target.
List<E> securityGroupArns
Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target.
FsxProtocolNfs nFS
Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).
FsxProtocolSmb sMB
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.
NfsMountOptions mountOptions
String domain
Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.
SmbMountOptions mountOptions
String password
Specifies the password of a user who has permission to access your SVM.
String user
Specifies a user that can mount and access the files, folders, and metadata in your SVM.
For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.
String discoveryJobArn
Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.
List<E> resourceIds
Specifies the universally unique identifiers (UUIDs) of the resources in your storage system that you want recommendations on.
String resourceType
Specifies the type of resource in your storage system that you want recommendations on.
String hostname
The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this hostname to communicate with the NameNode in the network.
Integer port
The port that the NameNode uses to listen to client requests.
String errorCode
List<E> agents
A list of DataSync agents in your Amazon Web Services account in the Amazon Web Services Region specified in the request. The list is ordered by the agents' Amazon Resource Names (ARNs).
String nextToken
The opaque string that indicates the position to begin the next list of results in the response.
String storageSystemArn
Specifies the Amazon Resource Name (ARN) of an on-premises storage system. Use this parameter if you only want to list the discovery jobs that are associated with a specific storage system.
Integer maxResults
Specifies how many results you want in the response.
String nextToken
Specifies an opaque string that indicates the position to begin the next list of results in the response.
Integer maxResults
The maximum number of locations to return.
String nextToken
An opaque string that indicates the position at which to begin the next list of locations.
List<E> filters
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.
String resourceArn
Specifies the Amazon Resource Name (ARN) of the resource that you want tag information on.
Integer maxResults
Specifies how many results that you want in the response.
String nextToken
Specifies an opaque string that indicates the position to begin the next list of results in the response.
String taskArn
Specifies the Amazon Resource Name (ARN) of the task that you want execution information about.
Integer maxResults
Specifies how many results you want in the response.
String nextToken
Specifies an opaque string that indicates the position at which to begin the next list of results in the response.
Integer maxResults
The maximum number of tasks to return.
String nextToken
An opaque string that indicates the position at which to begin the next list of tasks.
List<E> filters
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.
String name
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).
List<E> values
The values that you want to filter for. For example, you might want to display only Amazon S3 locations.
String operator
The operator that is used to compare filter values (for example, Equals or Contains).
String locationArn
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.
String locationUri
Represents a list of URIs 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 (for example, nfs or 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 hostname that is 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.
String action
Specifies what DataSync uses the manifest for.
String format
Specifies the file format of your manifest. For more information, see Creating a manifest.
SourceManifestConfig source
Specifies the manifest that you want DataSync to use and where it's hosted.
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.
Double iopsRead
Peak IOPS related to read operations.
Double iopsWrite
Peak IOPS related to write operations.
Double iopsOther
Peak IOPS unrelated to read and write operations.
Double iopsTotal
Peak total IOPS on your on-premises storage system resource.
Double throughputRead
Peak throughput related to read operations.
Double throughputWrite
Peak throughput related to write operations.
Double throughputOther
Peak throughput unrelated to read and write operations.
Double throughputTotal
Peak total throughput on your on-premises storage system resource.
Double latencyRead
Peak latency for read operations.
Double latencyWrite
Peak latency for write operations.
Double latencyOther
Peak latency for operations unrelated to read and write operations.
Long cifsShareCount
The number of CIFS shares in the cluster.
Long nfsExportedVolumes
The number of NFS volumes in the cluster.
String resourceId
The universally unique identifier (UUID) of the cluster.
String clusterName
The name of the cluster.
MaxP95Performance maxP95Performance
The performance data that DataSync Discovery collects about the cluster.
Long clusterBlockStorageSize
The total storage space that's available in the cluster.
Long clusterBlockStorageUsed
The storage space that's being used in a cluster.
Long clusterBlockStorageLogicalUsed
The storage space that's being used in the cluster without accounting for compression or deduplication.
List<E> recommendations
The Amazon Web Services storage services that DataSync Discovery recommends for the cluster. For more information, see Recommendations provided by DataSync Discovery.
String recommendationStatus
Indicates whether DataSync Discovery recommendations for the cluster are ready to view, incomplete, or can't be determined.
For more information, see Recommendation statuses.
Long lunCount
The number of LUNs (logical unit numbers) in the cluster.
Long clusterCloudStorageUsed
The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).
String clusterUuid
The universally unique identifier (UUID) of the cluster associated with the SVM.
String resourceId
The UUID of the SVM.
String svmName
The name of the SVM
Long cifsShareCount
The number of CIFS shares in the SVM.
List<E> enabledProtocols
The data transfer protocols (such as NFS) configured for the SVM.
Long totalCapacityUsed
The storage space that's being used in the SVM.
Long totalCapacityProvisioned
The total storage space that's available in the SVM.
Long totalLogicalCapacityUsed
The storage space that's being used in the SVM without accounting for compression or deduplication.
MaxP95Performance maxP95Performance
The performance data that DataSync Discovery collects about the SVM.
List<E> recommendations
The Amazon Web Services storage services that DataSync Discovery recommends for the SVM. For more information, see Recommendations provided by DataSync Discovery.
Long nfsExportedVolumes
The number of NFS volumes in the SVM.
String recommendationStatus
Indicates whether DataSync Discovery recommendations for the SVM are ready to view, incomplete, or can't be determined.
For more information, see Recommendation statuses.
Long totalSnapshotCapacityUsed
The amount of storage in the SVM that's being used for snapshots.
Long lunCount
The number of LUNs (logical unit numbers) in the SVM.
String volumeName
The name of the volume.
String resourceId
The universally unique identifier (UUID) of the volume.
Long cifsShareCount
The number of CIFS shares in the volume.
String securityStyle
The volume's security style (such as Unix or NTFS).
String svmUuid
The UUID of the storage virtual machine (SVM) associated with the volume.
String svmName
The name of the SVM associated with the volume.
Long capacityUsed
The storage space that's being used in the volume.
Long capacityProvisioned
The total storage space that's available in the volume.
Long logicalCapacityUsed
The storage space that's being used in the volume without accounting for compression or deduplication.
Boolean nfsExported
The number of NFS volumes in the volume.
Long snapshotCapacityUsed
The amount of storage in the volume that's being used for snapshots.
MaxP95Performance maxP95Performance
The performance data that DataSync Discovery collects about the volume.
List<E> recommendations
The Amazon Web Services storage services that DataSync Discovery recommends for the volume. For more information, see Recommendations provided by DataSync Discovery.
String recommendationStatus
Indicates whether DataSync Discovery recommendations for the volume are ready to view, incomplete, or can't be determined.
For more information, see Recommendation statuses.
Long lunCount
The number of LUNs (logical unit numbers) in the volume.
String version
Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.
You can specify the following options:
AUTOMATIC (default): DataSync chooses NFS version 4.1.
NFS3: Stateless protocol version that allows for asynchronous writes on the server.
NFSv4_0: Stateful, firewall-friendly protocol version that supports delegations and pseudo file
systems.
NFSv4_1: Stateful protocol version that supports sessions, directory delegations, and parallel data
processing. NFS version 4.1 also includes all features available in version 4.0.
DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
String verifyMode
Specifies how and when DataSync checks the integrity of your data during a transfer.
ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred files and
metadata at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum
calculated on those files at the destination.
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 (default) - At the end of the transfer, DataSync scans the entire source
and destination to verify that both locations are fully synchronized.
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 doesn't run additional verification at the end of the transfer. All data
transmissions are still integrity-checked with checksum verification during the transfer.
String overwriteMode
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.
String atime
Specifies whether to preserve metadata indicating the last time a file was read or written to.
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 phase of the task execution). This
option is recommended.
NONE - Ignores 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.
String mtime
Specifies whether to preserve metadata indicating the last time that a file was written to before the
PREPARING phase 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.
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.
String uid
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.
String gid
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 Metadata copied by DataSync.
String preserveDeletedFiles
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.
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.
String preserveDevices
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.
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.
String posixPermissions
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 Metadata copied by DataSync.
PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.
NONE - Ignores POSIX-style permissions.
DataSync can preserve extant permissions of a source location.
Long bytesPerSecond
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).
String taskQueueing
Specifies whether your transfer tasks should be put into a queue during certain scenarios when running
multiple tasks. This is ENABLED by default.
String logLevel
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.
String transferMode
Determines whether DataSync transfers only the data and metadata that differ between the source and the destination location or transfers all the content from the source (without comparing what's in the destination).
CHANGED (default) - DataSync copies only data or metadata that is new or different content from the
source location to the destination location.
ALL - DataSync copies everything in the source to the destination without comparing differences
between the locations.
String securityDescriptorCopyFlags
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 how DataSync handles 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.
String objectTags
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.
IOPS iOPS
The IOPS peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
Throughput throughput
The throughput peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
Latency latency
The latency peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
String version
The version of the DataSync agent.
String vpcEndpointId
Specifies the ID of the VPC endpoint that your agent connects to.
String privateLinkEndpoint
Specifies the VPC endpoint provided by Amazon Web Services PrivateLink that your agent connects to.
List<E> subnetArns
Specifies the ARN of the subnet where your VPC endpoint is located. You can only specify one ARN.
List<E> securityGroupArns
Specifies the Amazon Resource Names (ARN) of the security group that provides DataSync access to your VPC endpoint. You can only specify one ARN.
String rpcProtection
The RPC protection setting configured on the HDFS cluster. This setting corresponds to your
hadoop.rpc.protection setting in your core-site.xml file on your Hadoop cluster.
String dataTransferProtection
The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your
dfs.data.transfer.protection setting in the hdfs-site.xml file on your Hadoop cluster.
String storageType
A recommended Amazon Web Services storage service that you can migrate data to based on information that DataSync Discovery collects about your on-premises storage system.
Map<K,V> storageConfiguration
Information about how you can set up a recommended Amazon Web Services storage service.
String estimatedMonthlyStorageCost
The estimated monthly cost of the recommended Amazon Web Services storage service.
String storageSystemArn
Specifies the Amazon Resource Name (ARN) of the storage system that you want to permanently remove from DataSync Discovery.
ReportDestinationS3 s3
Specifies the Amazon S3 bucket where DataSync uploads your task report.
String subdirectory
Specifies a bucket prefix for your report.
String s3BucketArn
Specifies the ARN of the S3 bucket where DataSync uploads your report.
String bucketAccessRoleArn
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.
String reportLevel
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).
ReportOverride transferred
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer.
ReportOverride verified
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer.
ReportOverride deleted
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.
ReportOverride skipped
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer.
String status
Indicates whether DataSync is still working on your report, created a report, or can't create a complete report.
String errorCode
Indicates the code associated with the error if DataSync can't create a complete report.
String errorDetail
Provides details about issues creating a report.
List<E> netAppONTAPSVMs
The information that DataSync Discovery collects about storage virtual machines (SVMs) in your on-premises storage system.
List<E> netAppONTAPVolumes
The information that DataSync Discovery collects about volumes in your on-premises storage system.
List<E> netAppONTAPClusters
The information that DataSync Discovery collects about the cluster in your on-premises storage system.
Date timestamp
The time when DataSync Discovery collected this information from the resource.
P95Metrics p95Metrics
The types of performance data that DataSync Discovery collects about the on-premises storage system resource.
Capacity capacity
The storage capacity of the on-premises storage system resource.
String resourceId
The universally unique identifier (UUID) of the on-premises storage system resource.
String resourceType
The type of on-premises storage system resource.
String bucketAccessRoleArn
Specifies the ARN of the IAM role that DataSync uses to access your S3 bucket.
String manifestObjectPath
Specifies the Amazon S3 object key of your manifest. This can include a prefix (for example,
prefix/my-manifest.csv).
String bucketAccessRoleArn
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.
String s3BucketArn
Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.
String manifestObjectVersionId
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.
String version
By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.
These are the following options for configuring the SMB version:
AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they
mutually support between 2.1 and 3.1.1.
This is the recommended option. If you instead choose a specific version that your file server doesn't support,
you may get an Operation Not Supported error.
SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.
SMB2: Restricts the protocol negotiation to only SMB version 2.1.
SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.
SMB1: Restricts the protocol negotiation to only SMB version 1.0.
The SMB1 option isn't available when creating an Amazon
FSx for NetApp ONTAP location.
S3ManifestConfig s3
Specifies the S3 bucket where you're hosting your manifest.
String storageSystemArn
Specifies the Amazon Resource Name (ARN) of the on-premises storage system that you want to run the discovery job on.
Integer collectionDurationMinutes
Specifies in minutes how long you want the discovery job to run.
For more accurate recommendations, we recommend a duration of at least 14 days. Longer durations allow time to collect a sufficient number of data points and provide a realistic representation of storage performance and utilization.
String clientToken
Specifies a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically.
List<E> tags
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
String discoveryJobArn
The ARN of the discovery job that you started.
String taskArn
Specifies the Amazon Resource Name (ARN) of the task that you want to start.
Options overrideOptions
List<E> includes
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".
List<E> excludes
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".
ManifestConfig manifestConfig
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.
TaskReportConfig taskReportConfig
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.
List<E> tags
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.
String taskExecutionArn
The ARN of the running task execution.
String discoveryJobArn
Specifies the Amazon Resource Name (ARN) of the discovery job that you want to stop.
String taskExecutionArn
The Amazon Resource Name (ARN) of a task execution.
String status
The status of a task execution. For more information, see Task execution statuses.
Long prepareDuration
The total time in milliseconds that DataSync spent in the PREPARING phase.
String prepareStatus
The status of the PREPARING phase.
Long totalDuration
The total time in milliseconds that DataSync took to transfer the file from the source to the destination location.
Long transferDuration
The total time in milliseconds that DataSync spent in the TRANSFERRING phase.
String transferStatus
The status of the TRANSFERRING phase.
Long verifyDuration
The total time in milliseconds that DataSync spent in the VERIFYING phase.
String verifyStatus
The status of the VERIFYING phase.
String errorCode
Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
String errorDetail
Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.
String name
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.
List<E> values
The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.
String operator
The operator that is used to compare filter values (for example, Equals or Contains).
ReportDestination destination
Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.
String outputType
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.
String reportLevel
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.
String objectVersionIds
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.
ReportOverrides overrides
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.
String scheduleExpression
Specifies your task schedule by using a cron expression in UTC time. For information about cron expression syntax, see the Amazon EventBridge User Guide .
String status
Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.
DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails .
Date statusUpdateTime
Indicates the last time the status of your task schedule changed. For example, if DataSync automatically disables your schedule because of a repeated error, you can see when the schedule was disabled.
String disabledReason
Provides a reason if the task schedule is disabled.
If your schedule is disabled by USER, you see a Manually disabled by user. message.
If your schedule is disabled by SERVICE, you see an error message to help you understand why the
task keeps failing. For information on resolving DataSync errors, see Troubleshooting issues with DataSync transfers.
String disabledBy
Indicates how your task schedule was disabled.
USER - Your schedule was manually disabled by using the UpdateTask operation or
DataSync console.
SERVICE - Your schedule was automatically disabled by DataSync because the task failed repeatedly
with the same error.
String discoveryJobArn
Specifies the Amazon Resource Name (ARN) of the discovery job that you want to update.
Integer collectionDurationMinutes
Specifies in minutes how long that you want the discovery job to run. (You can't set this parameter to less than the number of minutes that the job has already run for.)
String locationArn
Specifies the ARN of the Azure Blob Storage transfer location that you're updating.
String subdirectory
Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example,
/my/images).
String authenticationType
Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).
AzureBlobSasConfiguration sasConfiguration
Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.
String blobType
Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation.
String accessTier
Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers.
List<E> agentArns
Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container.
You can specify more than one agent. For more information, see Using multiple agents for your transfer.
String locationArn
The Amazon Resource Name (ARN) of the source HDFS cluster location.
String subdirectory
A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster.
List<E> nameNodes
The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.
Integer blockSize
The size of the data blocks to write into the HDFS cluster.
Integer replicationFactor
The number of DataNodes to replicate the data to when writing to the HDFS cluster.
String kmsKeyProviderUri
The URI of the HDFS cluster's Key Management Server (KMS).
QopConfiguration qopConfiguration
The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS) cluster.
String authenticationType
The type of authentication used to determine the identity of the user.
String simpleUser
The user name used to identify the client on the host operating system.
String kerberosPrincipal
The Kerberos principal with access to the files and folders on the HDFS cluster.
ByteBuffer kerberosKeytab
The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you use the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.
ByteBuffer kerberosKrb5Conf
The krb5.conf file that contains the Kerberos configuration information. You can load the
krb5.conf file by providing the file's address. If you're using the CLI, it performs the base64
encoding for you. Otherwise, provide the base64-encoded text.
List<E> agentArns
The ARNs of the agents that are used to connect to the HDFS cluster.
String locationArn
Specifies the Amazon Resource Name (ARN) of the NFS transfer location that you want to update.
String subdirectory
Specifies the export path in your NFS file server that you want DataSync to mount.
This path (or a subdirectory of the path) is where DataSync transfers data to or from. For information on configuring an export for DataSync, see Accessing NFS file servers.
OnPremConfig onPremConfig
NfsMountOptions mountOptions
String locationArn
Specifies the ARN of the object storage system location that you're updating.
Integer serverPort
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
String serverProtocol
Specifies the protocol that your object storage server uses to communicate.
String subdirectory
Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.
String accessKey
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
String secretKey
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
List<E> agentArns
Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
ByteBuffer serverCertificate
Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a
private or self-signed certificate authority (CA). You must specify a single .pem file with a full
certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).
The certificate chain might include:
The object storage system's certificate
All intermediate certificates (if there are any)
The root certificate of the signing CA
You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64
encoding). The following example cat command creates an object_storage_certificates.pem
file that includes three certificates:
cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem
To use this parameter, configure ServerProtocol to HTTPS.
Updating this parameter doesn't interfere with tasks that you have in progress.
String locationArn
Specifies the ARN of the SMB location that you want to update.
String subdirectory
Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can
include a subdirectory in the share path (for example, /path/to/subdirectory). Make sure that other
SMB clients in your network can also mount this path.
To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see required permissions for SMB locations.
String user
Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer.
For information about choosing a user with the right level of access for your transfer, see required permissions for SMB locations.
String domain
Specifies the Windows domain name that your SMB file server belongs to.
If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.
For more information, see required permissions for SMB locations.
String password
Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.
For more information, see required permissions for SMB locations.
List<E> agentArns
Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).
SmbMountOptions mountOptions
String storageSystemArn
Specifies the ARN of the on-premises storage system that you want reconfigure.
DiscoveryServerConfiguration serverConfiguration
Specifies the server name and network port required to connect with your on-premises storage system's management interface.
List<E> agentArns
Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads your on-premises storage system. You can only specify one ARN.
String name
Specifies a familiar name for your on-premises storage system.
String cloudWatchLogGroupArn
Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.
Credentials credentials
Specifies the user name and password for accessing your on-premises storage system's management interface.
String taskArn
Specifies the ARN of the task that you want to update.
Options options
List<E> excludes
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.
TaskSchedule schedule
Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.
String name
Specifies the name of your task.
String cloudWatchLogGroupArn
Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.
List<E> includes
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.
ManifestConfig manifestConfig
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.
TaskReportConfig taskReportConfig
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.
Copyright © 2024. All rights reserved.