DescribeLocationEfsCommand

Suggest an Edit

Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.

Example Syntax

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

import { DataSyncClient, DescribeLocationEfsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeLocationEfsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeLocationEfsRequest
  LocationArn: "STRING_VALUE", // required
};
const command = new DescribeLocationEfsCommand(input);
const response = await client.send(command);
// { // DescribeLocationEfsResponse
//   LocationArn: "STRING_VALUE",
//   LocationUri: "STRING_VALUE",
//   Ec2Config: { // Ec2Config
//     SubnetArn: "STRING_VALUE", // required
//     SecurityGroupArns: [ // Ec2SecurityGroupArnList // required
//       "STRING_VALUE",
//     ],
//   },
//   CreationTime: new Date("TIMESTAMP"),
//   AccessPointArn: "STRING_VALUE",
//   FileSystemAccessRoleArn: "STRING_VALUE",
//   InTransitEncryption: "NONE" || "TLS1_2",
// };

DescribeLocationEfsCommand Input

See DescribeLocationEfsCommandInput for more details

Parameter
Type
Description
LocationArn
Required
string | undefined

The Amazon Resource Name (ARN) of the Amazon EFS file system location that you want information about.

DescribeLocationEfsCommand Output

See DescribeLocationEfsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AccessPointArn
string | undefined

The ARN of the access point that DataSync uses to access the Amazon EFS file system.

For more information, see Accessing restricted file systems .

CreationTime
Date | undefined

The time that the location was created.

Ec2Config
Ec2Config | undefined

The subnet and security groups that DataSync uses to connect to one of your Amazon EFS file system's mount targets .

FileSystemAccessRoleArn
string | undefined

The Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.

For more information, see Creating a DataSync IAM role for file system access .

InTransitEncryption
EfsInTransitEncryption | undefined

Indicates whether DataSync uses Transport Layer Security (TLS) encryption when transferring data to or from the Amazon EFS file system.

LocationArn
string | undefined

The ARN of the Amazon EFS file system location.

LocationUri
string | undefined

The URL of the Amazon EFS file system location.

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.