DescribeLocationFsxOpenZfsCommand

Suggest an Edit

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

Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.

Example Syntax

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

import { DataSyncClient, DescribeLocationFsxOpenZfsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeLocationFsxOpenZfsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeLocationFsxOpenZfsRequest
  LocationArn: "STRING_VALUE", // required
};
const command = new DescribeLocationFsxOpenZfsCommand(input);
const response = await client.send(command);
// { // DescribeLocationFsxOpenZfsResponse
//   LocationArn: "STRING_VALUE",
//   LocationUri: "STRING_VALUE",
//   SecurityGroupArns: [ // Ec2SecurityGroupArnList
//     "STRING_VALUE",
//   ],
//   Protocol: { // FsxProtocol
//     NFS: { // FsxProtocolNfs
//       MountOptions: { // NfsMountOptions
//         Version: "AUTOMATIC" || "NFS3" || "NFS4_0" || "NFS4_1",
//       },
//     },
//     SMB: { // FsxProtocolSmb
//       Domain: "STRING_VALUE",
//       MountOptions: { // SmbMountOptions
//         Version: "AUTOMATIC" || "SMB2" || "SMB3" || "SMB1" || "SMB2_0",
//       },
//       Password: "STRING_VALUE", // required
//       User: "STRING_VALUE", // required
//     },
//   },
//   CreationTime: new Date("TIMESTAMP"),
// };

DescribeLocationFsxOpenZfsCommand Input

See DescribeLocationFsxOpenZfsCommandInput for more details

Parameter
Type
Description
LocationArn
Required
string | undefined

The Amazon Resource Name (ARN) of the FSx for OpenZFS location to describe.

DescribeLocationFsxOpenZfsCommand Output

See DescribeLocationFsxOpenZfsCommandOutput for details

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

The time that the FSx for OpenZFS location was created.

LocationArn
string | undefined

The ARN of the FSx for OpenZFS location that was described.

LocationUri
string | undefined

The uniform resource identifier (URI) of the FSx for OpenZFS location that was described.

Example: fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder

Protocol
FsxProtocol | undefined

The type of protocol that DataSync uses to access your file system.

SecurityGroupArns
string[] | undefined

The ARNs of the security groups that are configured for the FSx for OpenZFS file system.

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.