UpdateLocationFsxWindowsCommand

Suggest an Edit

Modifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync.

For more information, see Configuring DataSync transfers with FSx for Windows File Server .

Example Syntax

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

import { DataSyncClient, UpdateLocationFsxWindowsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, UpdateLocationFsxWindowsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // UpdateLocationFsxWindowsRequest
  LocationArn: "STRING_VALUE", // required
  Subdirectory: "STRING_VALUE",
  Domain: "STRING_VALUE",
  User: "STRING_VALUE",
  Password: "STRING_VALUE",
};
const command = new UpdateLocationFsxWindowsCommand(input);
const response = await client.send(command);
// {};

UpdateLocationFsxWindowsCommand Input

See UpdateLocationFsxWindowsCommandInput for more details

Parameter
Type
Description
LocationArn
Required
string | undefined

Specifies the ARN of the FSx for Windows File Server transfer location that you're updating.

Domain
string | undefined

Specifies the name of the Windows domain that your FSx for Windows File Server file system belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.

Password
string | undefined

Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

Subdirectory
string | undefined

Specifies a mount path for your file system using forward slashes. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).

User
string | undefined

Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

For information about choosing a user with the right level of access for your transfer, see required permissions  for FSx for Windows File Server locations.

UpdateLocationFsxWindowsCommand Output

See UpdateLocationFsxWindowsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

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.