Returns metadata, such as the path information, about an NFS location.

See also: AWS API Documentation

Request Syntax

response = client.describe_location_nfs(
LocationArn (string) --


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

Return type
Response Syntax
    'LocationArn': 'string',
    'LocationUri': 'string',
    'OnPremConfig': {
        'AgentArns': [
    'MountOptions': {
        'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
    'CreationTime': datetime(2015, 1, 1)

Response Structure

  • (dict) --


    • LocationArn (string) --

      The Amazon Resource Name (ARN) of the NFS location that was described.

    • LocationUri (string) --

      The URL of the source NFS location that was described.

    • OnPremConfig (dict) --

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

      • AgentArns (list) --

        ARNs of the agents to use for an NFS location.

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

      The NFS mount options that DataSync used to mount your NFS share.

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

    • CreationTime (datetime) --

      The time that the NFS location was created.


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