DescribeLocationFsxOntap - Amazon DataSync
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeLocationFsxOntap

Provides details about how an Amazon DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.

Note

If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password.

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

Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system location that you want information about.

Type: String

Length Constraints: Maximum length of 128.

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

Required: Yes

Response Syntax

{ "CreationTime": number, "FsxFilesystemArn": "string", "LocationArn": "string", "LocationUri": "string", "Protocol": { "NFS": { "MountOptions": { "Version": "string" } }, "SMB": { "Domain": "string", "MountOptions": { "Version": "string" }, "Password": "string", "User": "string" } }, "SecurityGroupArns": [ "string" ], "StorageVirtualMachineArn": "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 location was created.

Type: Timestamp

FsxFilesystemArn

The ARN of the FSx for ONTAP file system.

Type: String

Length Constraints: Maximum length of 128.

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\-0-9]*:[0-9]{12}:file-system/fs-.*$

LocationArn

The ARN of the FSx for ONTAP file system location.

Type: String

Length Constraints: Maximum length of 128.

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

LocationUri

The uniform resource identifier (URI) of the FSx for ONTAP file system location.

Type: String

Length Constraints: Maximum length of 4360.

Pattern: ^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$

Protocol

Specifies the data transfer protocol that Amazon DataSync uses to access your Amazon FSx file system.

Type: FsxProtocol object

SecurityGroupArns

The security groups that DataSync uses to access your FSx for ONTAP file system.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Maximum length of 128.

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$

StorageVirtualMachineArn

The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system where you're copying data to or from.

Type: String

Length Constraints: Maximum length of 162.

Pattern: ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$

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 Amazon DataSync service.

HTTP Status Code: 500

InvalidRequestException

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

HTTP Status Code: 400

See Also

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