UpdateLocationFsxOpenZfsCommand

Suggest an Edit

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

For more information, see Configuring DataSync transfers with FSx for OpenZFS .

Request parameters related to SMB aren't supported with the UpdateLocationFsxOpenZfs operation.

Example Syntax

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

import { DataSyncClient, UpdateLocationFsxOpenZfsCommand } from "@aws-sdk/client-datasync"; // ES Modules import
// const { DataSyncClient, UpdateLocationFsxOpenZfsCommand } = require("@aws-sdk/client-datasync"); // CommonJS import
const client = new DataSyncClient(config);
const input = { // UpdateLocationFsxOpenZfsRequest
  LocationArn: "STRING_VALUE", // required
  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
    },
  },
  Subdirectory: "STRING_VALUE",
};
const command = new UpdateLocationFsxOpenZfsCommand(input);
const response = await client.send(command);
// {};

UpdateLocationFsxOpenZfsCommand Input

See UpdateLocationFsxOpenZfsCommandInput for more details

Parameter
Type
Description
LocationArn
Required
string | undefined

Specifies the Amazon Resource Name (ARN) of the FSx for OpenZFS transfer location that you're updating.

Protocol
FsxProtocol | undefined

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

Subdirectory
string | undefined

Specifies a subdirectory in the location's path that must begin with /fsx. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).

UpdateLocationFsxOpenZfsCommand Output

See UpdateLocationFsxOpenZfsCommandOutput 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.