DescribeLocationNfsCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataSyncClient, DescribeLocationNfsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeLocationNfsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeLocationNfsRequest
  LocationArn: "STRING_VALUE", // required
};
const command = new DescribeLocationNfsCommand(input);
const response = await client.send(command);
// { // DescribeLocationNfsResponse
//   LocationArn: "STRING_VALUE",
//   LocationUri: "STRING_VALUE",
//   OnPremConfig: { // OnPremConfig
//     AgentArns: [ // AgentArnList // required
//       "STRING_VALUE",
//     ],
//   },
//   MountOptions: { // NfsMountOptions
//     Version: "AUTOMATIC" || "NFS3" || "NFS4_0" || "NFS4_1",
//   },
//   CreationTime: new Date("TIMESTAMP"),
// };

DescribeLocationNfsCommand Input

See DescribeLocationNfsCommandInput for more details

Parameter
Type
Description
LocationArn
Required
string | undefined

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

DescribeLocationNfsCommand Output

See DescribeLocationNfsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CreationTime
Date | undefined

The time when the NFS location was created.

LocationArn
string | undefined

The ARN of the NFS location.

LocationUri
string | undefined

The URI of the NFS location.

MountOptions
NfsMountOptions | undefined

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

OnPremConfig
OnPremConfig | undefined

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

Throws

Name
Fault
Details
InternalException
server

This exception is thrown when an error occurs in the DataSync service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

DataSyncServiceException
Base exception class for all service exceptions from DataSync service.