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.

See also: AWS API Documentation

Request Syntax

response = client.update_location_nfs(
        'AgentArns': [
        'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
  • LocationArn (string) --


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

  • Subdirectory (string) --

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

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

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

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

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

  • OnPremConfig (dict) --

    A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.

    • AgentArns (list) -- [REQUIRED]

      ARNs of the agents to use for an NFS location.

      • (string) --
  • MountOptions (dict) --

    Specifies how DataSync can access a location using the NFS protocol.

    • Version (string) --

      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.

Return type



Response Syntax


Response Structure

  • (dict) --


  • DataSync.Client.exceptions.InvalidRequestException
  • DataSync.Client.exceptions.InternalException