DataSync / Client / update_location_nfs

update_location_nfs#

DataSync.Client.update_location_nfs(**kwargs)#

Modifies the following configuration parameters of the Network File System (NFS) transfer location that you’re using with DataSync.

For more information, see Configuring transfers with an NFS file server.

See also: AWS API Documentation

Request Syntax

response = client.update_location_nfs(
    LocationArn='string',
    Subdirectory='string',
    OnPremConfig={
        'AgentArns': [
            'string',
        ]
    },
    MountOptions={
        'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
    }
)
Parameters:

  • LocationArn (string) –

    [REQUIRED]

    Specifies the Amazon Resource Name (ARN) of the NFS transfer location that you want to update.

  • Subdirectory (string) –

    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 (dict) –

    The DataSync agents that can connect to your Network File System (NFS) file server.

    • AgentArns (list) – [REQUIRED]

      The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your NFS file server.

      You can specify more than one agent. For more information, see Using multiple DataSync agents.

      • (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.

      Note

      DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException