Serialized Form (AWS Java SDK for AWS DataSync 1.11.590 API)

Package com.amazonaws.services.datasync.model
- Class com.amazonaws.services.datasync.model.AgentListEntry extends Object implements Serializable
  - Serialized Fields
    - agentArn
```
String agentArn
```
      The Amazon Resource Name (ARN) of the agent.
    - name
```
String name
```
      The name of the agent.
    - status
```
String status
```
      The status of the agent.
- Class com.amazonaws.services.datasync.model.AWSDataSyncException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.datasync.model.CancelTaskExecutionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - taskExecutionArn
```
String taskExecutionArn
```
      The Amazon Resource Name (ARN) of the task execution to cancel.
- Class com.amazonaws.services.datasync.model.CancelTaskExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.datasync.model.CreateAgentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - activationKey
```
String activationKey
```
      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 AWS 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 "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-agents.html#activating-agent" (Activating a Agent) in the AWS DataSync User Guide.
    - agentName
```
String agentName
```
      The name you configured for your agent. This value is a text reference that is used to identify the agent in the console.
    - tags
```
List<E> tags
```
      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: + - = . _ : / @.
- Class com.amazonaws.services.datasync.model.CreateAgentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - agentArn
```
String agentArn
```
      The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation to return a list of agents for your account and AWS Region.
- Class com.amazonaws.services.datasync.model.CreateLocationEfsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - subdirectory
```
String subdirectory
```
      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, AWS DataSync uses the root directory.
    - efsFilesystemArn
```
String efsFilesystemArn
```
      The Amazon Resource Name (ARN) for the Amazon EFS file system.
    - ec2Config
```
Ec2Config ec2Config
```
      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 "https://docs.aws.amazon.com/efs/latest/ug/security-considerations.html#network-access" (Security Groups for Amazon EC2 Instances and Mount Targets) in the Amazon EFS User Guide.
    - tags
```
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.
- Class com.amazonaws.services.datasync.model.CreateLocationEfsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - locationArn
```
String locationArn
```
      The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.
- Class com.amazonaws.services.datasync.model.CreateLocationNfsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - subdirectory
```
String subdirectory
```
      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.
      
      For information about NFS export configuration, see "http://web.mit.edu/rhel-doc/5/RHEL-5-manual/Deployment_Guide-en-US/s1-nfs-server-config-exports.html" (18.7. The /etc/exports Configuration File).
    - serverHostname
```
String serverHostname
```
      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.
      
      This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
    - onPremConfig
```
OnPremConfig onPremConfig
```
      Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
    - mountOptions
```
NfsMountOptions mountOptions
```
      The NFS mount options that DataSync can use to mount your NFS share.
    - tags
```
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.
- Class com.amazonaws.services.datasync.model.CreateLocationNfsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - locationArn
```
String locationArn
```
      The Amazon Resource Name (ARN) of the source NFS file system location that is created.
- Class com.amazonaws.services.datasync.model.CreateLocationS3Request extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - subdirectory
```
String subdirectory
```
      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.
    - s3BucketArn
```
String s3BucketArn
```
      The Amazon Resource Name (ARN) of the Amazon S3 bucket.
    - s3Config
```
S3Config s3Config
```
    - tags
```
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.
- Class com.amazonaws.services.datasync.model.CreateLocationS3Result extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - locationArn
```
String locationArn
```
      The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created.
- Class com.amazonaws.services.datasync.model.CreateTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - sourceLocationArn
```
String sourceLocationArn
```
      The Amazon Resource Name (ARN) of the source location for the task.
    - destinationLocationArn
```
String destinationLocationArn
```
      The Amazon Resource Name (ARN) of an AWS storage resource's location.
    - cloudWatchLogGroupArn
```
String cloudWatchLogGroupArn
```
      The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
      
      For more information on these groups, see "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch User Guide.
      
      For more information about how to useCloudWatchLogs with DataSync, see "https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html" (Monitoring Your Task)
    - name
```
String name
```
      The name of a task. This value is a text reference that is used to identify the task in the console.
    - options
```
Options options
```
      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 a the task execution. For more information, see the operation.
    - excludes
```
List<E> excludes
```
      A filter that determines which files to exclude from a task based on the specified pattern. Transfers all files in the task’s subdirectory, except files that match the filter that is set.
    - tags
```
List<E> tags
```
      The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.
- Class com.amazonaws.services.datasync.model.CreateTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - taskArn
```
String taskArn
```
      The Amazon Resource Name (ARN) of the task.
- Class com.amazonaws.services.datasync.model.DeleteAgentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - agentArn
```
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 AWS Region.
- Class com.amazonaws.services.datasync.model.DeleteAgentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.datasync.model.DeleteLocationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - locationArn
```
String locationArn
```
      The Amazon Resource Name (ARN) of the location to delete.
- Class com.amazonaws.services.datasync.model.DeleteLocationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.datasync.model.DeleteTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - taskArn
```
String taskArn
```
      The Amazon Resource Name (ARN) of the task to delete.
- Class com.amazonaws.services.datasync.model.DeleteTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.datasync.model.DescribeAgentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - agentArn
```
String agentArn
```
      The Amazon Resource Name (ARN) of the agent to describe.
- Class com.amazonaws.services.datasync.model.DescribeAgentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - agentArn
```
String agentArn
```
      The Amazon Resource Name (ARN) of the agent.
    - name
```
String name
```
      The name of the agent.
    - status
```
String status
```
      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.
    - lastConnectionTime
```
Date lastConnectionTime
```
      The time that the agent last connected to DataSyc.
    - creationTime
```
Date creationTime
```
      The time that the agent was activated (that is, created in your account).
    - endpointOptions
```
EndpointOptions endpointOptions
```
    - privateLinkConfig
```
PrivateLinkConfig privateLinkConfig
```
- Class com.amazonaws.services.datasync.model.DescribeLocationEfsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - locationArn
```
String locationArn
```
      The Amazon Resource Name (ARN) of the EFS location to describe.
- Class com.amazonaws.services.datasync.model.DescribeLocationEfsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - locationArn
```
String locationArn
```
      The Amazon resource Name (ARN) of the EFS location that was described.
    - locationUri
```
String locationUri
```
      The URL of the EFS location that was described.
    - ec2Config
```
Ec2Config ec2Config
```
    - creationTime
```
Date creationTime
```
      The time that the EFS location was created.
- Class com.amazonaws.services.datasync.model.DescribeLocationNfsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - locationArn
```
String locationArn
```
      The Amazon resource Name (ARN) of the NFS location to describe.
- Class com.amazonaws.services.datasync.model.DescribeLocationNfsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - locationArn
```
String locationArn
```
      The Amazon resource Name (ARN) of the NFS location that was described.
    - locationUri
```
String locationUri
```
      The URL of the source NFS location that was described.
    - onPremConfig
```
OnPremConfig onPremConfig
```
    - mountOptions
```
NfsMountOptions mountOptions
```
      The NFS mount options that DataSync used to mount your NFS share.
    - creationTime
```
Date creationTime
```
      The time that the NFS location was created.
- Class com.amazonaws.services.datasync.model.DescribeLocationS3Request extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - locationArn
```
String locationArn
```
      The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.
- Class com.amazonaws.services.datasync.model.DescribeLocationS3Result extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - locationArn
```
String locationArn
```
      The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
    - locationUri
```
String locationUri
```
      The URL of the Amazon S3 location that was described.
    - s3Config
```
S3Config s3Config
```
    - creationTime
```
Date creationTime
```
      The time that the Amazon S3 bucket location was created.
- Class com.amazonaws.services.datasync.model.DescribeTaskExecutionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - taskExecutionArn
```
String taskExecutionArn
```
      The Amazon Resource Name (ARN) of the task that is being executed.
- Class com.amazonaws.services.datasync.model.DescribeTaskExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - taskExecutionArn
```
String taskExecutionArn
```
      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.
    - status
```
String status
```
      The status of the task execution.
      
      For detailed information about task execution statuses, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses" (Understanding Task Statuses).
    - options
```
Options options
```
    - excludes
```
List<E> excludes
```
      Specifies that the task execution excludes files from the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.
    - includes
```
List<E> includes
```
      Specifies that the task execution excludes files in the transfer based on the specified pattern in the filter. When multiple include filters are set, they are interpreted as an OR.
    - startTime
```
Date startTime
```
      The time that the task execution was started.
    - estimatedFilesToTransfer
```
Long estimatedFilesToTransfer
```
      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.
    - estimatedBytesToTransfer
```
Long estimatedBytesToTransfer
```
      The estimated physical number of bytes that is to be transferred over the network.
    - filesTransferred
```
Long filesTransferred
```
      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.
    - bytesWritten
```
Long bytesWritten
```
      The number of logical bytes written to the destination AWS storage resource.
    - bytesTransferred
```
Long bytesTransferred
```
      The physical number of bytes transferred over the network.
    - result
```
TaskExecutionResultDetail result
```
      The result of the task execution.
- Class com.amazonaws.services.datasync.model.DescribeTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - taskArn
```
String taskArn
```
      The Amazon Resource Name (ARN) of the task to describe.
- Class com.amazonaws.services.datasync.model.DescribeTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - taskArn
```
String taskArn
```
      The Amazon Resource Name (ARN) of the task that was described.
    - status
```
String status
```
      The status of the task that was described.
      
      For detailed information about task execution statuses, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-tasks.html#understand-task-creation-statuses" (Understanding Task Statuses).
    - name
```
String name
```
      The name of the task that was described.
    - currentTaskExecutionArn
```
String currentTaskExecutionArn
```
      The Amazon Resource Name (ARN) of the task execution that is syncing files.
    - sourceLocationArn
```
String sourceLocationArn
```
      The Amazon Resource Name (ARN) of the source file system's location.
    - destinationLocationArn
```
String destinationLocationArn
```
      The Amazon Resource Name (ARN) of the AWS storage resource's location.
    - cloudWatchLogGroupArn
```
String cloudWatchLogGroupArn
```
      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 "https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html" (Working with Log Groups and Log Streams) in the Amazon CloudWatch UserGuide.
    - options
```
Options options
```
      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 operation.
    - excludes
```
List<E> excludes
```
      Specifies that the task excludes files in the transfer based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.
    - errorCode
```
String errorCode
```
      Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
    - errorDetail
```
String errorDetail
```
      Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.
    - creationTime
```
Date creationTime
```
      The time that the task was created.
- Class com.amazonaws.services.datasync.model.Ec2Config extends Object implements Serializable
  - Serialized Fields
    - subnetArn
```
String subnetArn
```
      The ARN of the subnet and the security group that DataSync uses to access the target EFS file system.
    - securityGroupArns
```
List<E> securityGroupArns
```
      The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource.
- Class com.amazonaws.services.datasync.model.EndpointOptions extends Object implements Serializable
  - Serialized Fields
    - fips
```
Boolean fips
```
    - privateLink
```
Boolean privateLink
```
- Class com.amazonaws.services.datasync.model.FilterRule extends Object implements Serializable
  - Serialized Fields
    - filterType
```
String filterType
```
      Specifies the type of filter rule pattern to apply. DataSync only supports the SIMPLE_PATTERN rule type.
    - value
```
String value
```
      A pattern that defines the filter. The filter might include or exclude files is a transfer.
- Class com.amazonaws.services.datasync.model.InternalException extends AWSDataSyncException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - errorCode
```
String errorCode
```
- Class com.amazonaws.services.datasync.model.InvalidRequestException extends AWSDataSyncException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - errorCode
```
String errorCode
```
- Class com.amazonaws.services.datasync.model.ListAgentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The maximum number of agents to list.
    - nextToken
```
String nextToken
```
      An opaque string that indicates the position at which to begin the next list of agents.
- Class com.amazonaws.services.datasync.model.ListAgentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - agents
```
List<E> agents
```
      A list of agents in your account.
    - nextToken
```
String nextToken
```
      An opaque string that indicates the position at which to begin returning the next list of agents.
- Class com.amazonaws.services.datasync.model.ListLocationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The maximum number of locations to return.
    - nextToken
```
String nextToken
```
      An opaque string that indicates the position at which to begin the next list of locations.
- Class com.amazonaws.services.datasync.model.ListLocationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - locations
```
List<E> locations
```
      An array that contains a list of locations.
    - nextToken
```
String nextToken
```
      An opaque string that indicates the position at which to begin returning the next list of locations.
- Class com.amazonaws.services.datasync.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the resource whose tags to list.
    - maxResults
```
Integer maxResults
```
      The maximum number of locations to return.
    - nextToken
```
String nextToken
```
      An opaque string that indicates the position at which to begin the next list of locations.
- Class com.amazonaws.services.datasync.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
List<E> tags
```
      Array of resource tags.
    - nextToken
```
String nextToken
```
      An opaque string that indicates the position at which to begin returning the next list of resource tags.
- Class com.amazonaws.services.datasync.model.ListTaskExecutionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - taskArn
```
String taskArn
```
      The Amazon Resource Name (ARN) of the task whose tasks you want to list.
    - maxResults
```
Integer maxResults
```
      The maximum number of executed tasks to list.
    - nextToken
```
String nextToken
```
      An opaque string that indicates the position at which to begin the next list of the executed tasks.
- Class com.amazonaws.services.datasync.model.ListTaskExecutionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - taskExecutions
```
List<E> taskExecutions
```
      A list of executed tasks.
    - nextToken
```
String nextToken
```
      An opaque string that indicates the position at which to begin returning the next list of executed tasks.
- Class com.amazonaws.services.datasync.model.ListTasksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The maximum number of tasks to return.
    - nextToken
```
String nextToken
```
      An opaque string that indicates the position at which to begin the next list of tasks.
- Class com.amazonaws.services.datasync.model.ListTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tasks
```
List<E> tasks
```
      A list of all the tasks that are returned.
    - nextToken
```
String nextToken
```
      An opaque string that indicates the position at which to begin returning the next list of tasks.
- Class com.amazonaws.services.datasync.model.LocationListEntry extends Object implements Serializable
  - Serialized Fields
    - locationArn
```
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.
    - locationUri
```
String locationUri
```
      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.
- Class com.amazonaws.services.datasync.model.NfsMountOptions extends Object implements Serializable
  - Serialized Fields
    - version
```
String version
```
      The specific NFS version that you want DataSync to use to mount your NFS share. 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.
- Class com.amazonaws.services.datasync.model.OnPremConfig extends Object implements Serializable
  - Serialized Fields
    - agentArns
```
List<E> agentArns
```
      ARNs)of the agents to use for an NFS location.
- Class com.amazonaws.services.datasync.model.Options extends Object implements Serializable
  - Serialized Fields
    - verifyMode
```
String verifyMode
```
      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.
      
      Default value: POINT_IN_TIME_CONSISTENT.
      
      POINT_IN_TIME_CONSISTENT: Perform verification (recommended).
      
      NONE: Skip verification.
    - atime
```
String atime
```
      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 AWS 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.
    - mtime
```
String mtime
```
      A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.
      
      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.
    - uid
```
String uid
```
      The user ID (UID) of the file's owner.
      
      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.
    - gid
```
String gid
```
      The group ID (GID) of the file's owners.
      
      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.
    - preserveDeletedFiles
```
String preserveDeletedFiles
```
      A value that specifies whether files in the destination that don't exist in the source file system should be preserved.
      
      Default value: PRESERVE.
      
      PRESERVE: Ignore such destination files (recommended).
      
      REMOVE: Delete destination files that aren’t present in the source.
    - preserveDevices
```
String preserveDevices
```
      A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.
      
      AWS 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.
    - posixPermissions
```
String posixPermissions
```
      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.
      
      Default value: PRESERVE.
      
      PRESERVE: Preserve POSIX-style permissions (recommended).
      
      NONE: Ignore permissions.
      
      AWS DataSync can preserve extant permissions of a source location.
    - bytesPerSecond
```
Long bytesPerSecond
```
      A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).
- Class com.amazonaws.services.datasync.model.PrivateLinkConfig extends Object implements Serializable
  - Serialized Fields
    - privateLinkEndpoint
```
String privateLinkEndpoint
```
    - subnetArns
```
List<E> subnetArns
```
    - securityGroupArns
```
List<E> securityGroupArns
```
- Class com.amazonaws.services.datasync.model.S3Config extends Object implements Serializable
  - Serialized Fields
    - bucketAccessRoleArn
```
String bucketAccessRoleArn
```
      The Amazon S3 bucket to access. This bucket is used as a parameter in the CreateLocationS3 operation.
- Class com.amazonaws.services.datasync.model.StartTaskExecutionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - taskArn
```
String taskArn
```
      The Amazon Resource Name (ARN) of the task to start.
    - overrideOptions
```
Options overrideOptions
```
    - includes
```
List<E> includes
```
      A filter that determines which files to include in the transfer during a task execution based on the specified pattern in the filter. When multiple include filters are set, they are interpreted as an OR.
- Class com.amazonaws.services.datasync.model.StartTaskExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - taskExecutionArn
```
String taskExecutionArn
```
      The Amazon Resource Name (ARN) of the specific task execution that was started.
- Class com.amazonaws.services.datasync.model.TagListEntry extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The key for an AWS resource tag.
    - value
```
String value
```
      The value for an AWS resource tag.
- Class com.amazonaws.services.datasync.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the resource to apply the tag to.
    - tags
```
List<E> tags
```
      The tags to apply.
- Class com.amazonaws.services.datasync.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.datasync.model.TaskExecutionListEntry extends Object implements Serializable
  - Serialized Fields
    - taskExecutionArn
```
String taskExecutionArn
```
      The Amazon Resource Name (ARN) of the task that was executed.
    - status
```
String status
```
      The status of a task execution.
- Class com.amazonaws.services.datasync.model.TaskExecutionResultDetail extends Object implements Serializable
  - Serialized Fields
    - prepareDuration
```
Long prepareDuration
```
      The total time in milliseconds that AWS DataSync spent in the PREPARING phase.
    - prepareStatus
```
String prepareStatus
```
      The status of the PREPARING phase.
    - transferDuration
```
Long transferDuration
```
      The total time in milliseconds that AWS DataSync spent in the TRANSFERRING phase.
    - transferStatus
```
String transferStatus
```
      The status of the TRANSFERRING Phase.
    - verifyDuration
```
Long verifyDuration
```
      The total time in milliseconds that AWS DataSync spent in the VERIFYING phase.
    - verifyStatus
```
String verifyStatus
```
      The status of the VERIFYING Phase.
    - errorCode
```
String errorCode
```
      Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
    - errorDetail
```
String errorDetail
```
      Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.
- Class com.amazonaws.services.datasync.model.TaskListEntry extends Object implements Serializable
  - Serialized Fields
    - taskArn
```
String taskArn
```
      The Amazon Resource Name (ARN) of the task.
    - status
```
String status
```
      The status of the task.
    - name
```
String name
```
      The name of the task.
- Class com.amazonaws.services.datasync.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the resource to remove the tag from.
    - keys
```
List<E> keys
```
      The keys in the key-value pair in the tag to remove.
- Class com.amazonaws.services.datasync.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.datasync.model.UpdateAgentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - agentArn
```
String agentArn
```
      The Amazon Resource Name (ARN) of the agent to update.
    - name
```
String name
```
      The name that you want to use to configure the agent.
- Class com.amazonaws.services.datasync.model.UpdateAgentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.datasync.model.UpdateTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - taskArn
```
String taskArn
```
      The Amazon Resource Name (ARN) of the resource name of the task to update.
    - options
```
Options options
```
    - excludes
```
List<E> excludes
```
      A filter that determines which files to exclude from a task based on the specified pattern in the filter. Transfers all files in the task’s subdirectory, except files that match the filter that is set.
    - name
```
String name
```
      The name of the task to update.
    - cloudWatchLogGroupArn
```
String cloudWatchLogGroupArn
```
      The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup.
- Class com.amazonaws.services.datasync.model.UpdateTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Form

Package com.amazonaws.services.datasync.model

Class com.amazonaws.services.datasync.model.AgentListEntry extends Object implements Serializable

Serialized Fields

agentArn

name

status

Class com.amazonaws.services.datasync.model.AWSDataSyncException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.datasync.model.CancelTaskExecutionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskExecutionArn

Class com.amazonaws.services.datasync.model.CancelTaskExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.datasync.model.CreateAgentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

activationKey

agentName

tags

Class com.amazonaws.services.datasync.model.CreateAgentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

agentArn

Class com.amazonaws.services.datasync.model.CreateLocationEfsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subdirectory

efsFilesystemArn

ec2Config

tags

Class com.amazonaws.services.datasync.model.CreateLocationEfsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

locationArn

Class com.amazonaws.services.datasync.model.CreateLocationNfsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subdirectory

serverHostname

onPremConfig

mountOptions

tags

Class com.amazonaws.services.datasync.model.CreateLocationNfsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

locationArn

Class com.amazonaws.services.datasync.model.CreateLocationS3Request extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subdirectory

s3BucketArn

s3Config

tags

Class com.amazonaws.services.datasync.model.CreateLocationS3Result extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

locationArn

Class com.amazonaws.services.datasync.model.CreateTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sourceLocationArn

destinationLocationArn

cloudWatchLogGroupArn

name

options

excludes

tags

Class com.amazonaws.services.datasync.model.CreateTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

taskArn

Class com.amazonaws.services.datasync.model.DeleteAgentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

agentArn

Class com.amazonaws.services.datasync.model.DeleteAgentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.datasync.model.DeleteLocationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

locationArn

Class com.amazonaws.services.datasync.model.DeleteLocationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.datasync.model.DeleteTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskArn

Class com.amazonaws.services.datasync.model.DeleteTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.datasync.model.DescribeAgentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

agentArn

Class com.amazonaws.services.datasync.model.DescribeAgentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

agentArn

name

status