DescribeLocationFsxWindowsCommand

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

Example Syntax

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

import { DataSyncClient, DescribeLocationFsxWindowsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, DescribeLocationFsxWindowsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // DescribeLocationFsxWindowsRequest
  LocationArn: "STRING_VALUE", // required
};
const command = new DescribeLocationFsxWindowsCommand(input);
const response = await client.send(command);
// { // DescribeLocationFsxWindowsResponse
//   LocationArn: "STRING_VALUE",
//   LocationUri: "STRING_VALUE",
//   SecurityGroupArns: [ // Ec2SecurityGroupArnList
//     "STRING_VALUE",
//   ],
//   CreationTime: new Date("TIMESTAMP"),
//   User: "STRING_VALUE",
//   Domain: "STRING_VALUE",
// };

DescribeLocationFsxWindowsCommand Input

Parameter
Type
Description
LocationArn
Required
string | undefined

Specifies the Amazon Resource Name (ARN) of the FSx for Windows File Server location.

DescribeLocationFsxWindowsCommand Output

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

The time that the FSx for Windows File Server location was created.

Domain
string | undefined

The name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.

LocationArn
string | undefined

The ARN of the FSx for Windows File Server location.

LocationUri
string | undefined

The uniform resource identifier (URI) of the FSx for Windows File Server location.

SecurityGroupArns
string[] | undefined

The ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.

For information about configuring security groups for file system access, see the Amazon FSx for Windows File Server User Guide  .

User
string | undefined

The user with the permissions to mount and access the FSx for Windows File Server 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.