UpdateLocationNfs
Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see Creating a location for NFS.
Request Syntax
{
"LocationArn": "string
",
"MountOptions": {
"Version": "string
"
},
"OnPremConfig": {
"AgentArns": [ "string
" ]
},
"Subdirectory": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- LocationArn
-
The Amazon Resource Name (ARN) of the NFS location to update.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$
Required: Yes
- MountOptions
-
Specifies how DataSync can access a location using the NFS protocol.
Type: NfsMountOptions object
Required: No
- OnPremConfig
-
A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.
Type: OnPremConfig object
Required: No
- 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 that you specified, DataSync must have permissions to read all the data. To ensure this, either configure the NFS export with
no_root_squash
, or ensure that the files you want DataSync to access have permissions that allow read access for all users. Doing either option enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.If you are copying data to or from your Amazon Snowcone device, see NFS Server on Amazon Snowcone for more information.
For information about NFS export configuration, see 18.7. The /etc/exports Configuration File
in the Red Hat Enterprise Linux documentation. Type: String
Length Constraints: Maximum length of 4096.
Pattern:
^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]+$
Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
This exception is thrown when an error occurs in the Amazon DataSync service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: