DataSync / Client / describe_location_nfs

describe_location_nfs#

DataSync.Client.describe_location_nfs(**kwargs)#

Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.

See also: AWS API Documentation

Request Syntax

response = client.describe_location_nfs(
    LocationArn='string'
)
Parameters:

LocationArn (string) –

[REQUIRED]

Specifies the Amazon Resource Name (ARN) of the NFS location that you want information about.

Return type:

dict

Returns:

Response Syntax

{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'OnPremConfig': {
        'AgentArns': [
            'string',
        ]
    },
    'MountOptions': {
        'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
    },
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    DescribeLocationNfsResponse

    • LocationArn (string) –

      The ARN of the NFS location.

    • LocationUri (string) –

      The URI of the NFS location.

    • OnPremConfig (dict) –

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

      • AgentArns (list) –

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

      The mount options that DataSync uses to mount your NFS file server.

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

    • CreationTime (datetime) –

      The time when the NFS location was created.

Exceptions

  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException