AWS DataSync
User Guide

DescribeLocationEfs

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

Request Syntax

{ "LocationArn": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

LocationArn

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

Type: String

Length Constraints: Maximum length of 128.

Pattern: ^arn:(aws|aws-cn):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

Required: Yes

Response Syntax

{ "CreationTime": number, "Ec2Config": { "SecurityGroupArns": [ "string" ], "SubnetArn": "string" }, "LocationArn": "string", "LocationUri": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CreationTime

The time that the EFS location was created.

Type: Timestamp

Ec2Config

The subnet and the security group that DataSync uses to access target EFS file system. The subnet must have at least one mount target for that file system. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.

Type: Ec2Config object

LocationArn

The Amazon resource Name (ARN) of the EFS location that was described.

Type: String

Length Constraints: Maximum length of 128.

Pattern: ^arn:(aws|aws-cn):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$

LocationUri

The URL of the EFS location that was described.

Type: String

Pattern: (efs|nfs|s3)://[a-zA-Z0-9.\-]+

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

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

HTTP Status Code: 500

InvalidRequestException

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

HTTP Status Code: 400

Examples

Example

The following example returns information about the Amazon EFS location specified in the sample request.

Sample Request

{ "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50fb" }

Example

Sample Response

{ "CreationTime": "", "Ec2Config": { SecurityGroupArns": ["arn:aws:ec2:us-east-2:11122233344:security-group/sg-0117195988293d62f"], "SubnetArn": "arn:aws:ec2:us-east-2:11122233344:subnet/subnet-f45a0e678", }, "LocationArn" :"LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50fb", "LocationUri": "us-east-2.fs-abcd1234. ", }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: