UpdateLocationFsxOntap - AWS DataSync

UpdateLocationFsxOntap

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

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

Request Syntax

{ "LocationArn": "string", "Protocol": { "NFS": { "MountOptions": { "Version": "string" } }, "SMB": { "Domain": "string", "MountOptions": { "Version": "string" }, "Password": "string", "User": "string" } }, "Subdirectory": "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 transfer location that you're updating.

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

Protocol

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

Type: FsxUpdateProtocol object

Required: No

Subdirectory

Specifies a path to the file share in the storage virtual machine (SVM) where you want to transfer data to or from.

You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be /vol1, /vol1/tree1, or /share1.

Note

Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.

Type: String

Length Constraints: Maximum length of 255.

Pattern: ^[^\u0000\u0085\u2028\u2029\r\n]{1,255}$

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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 AWS 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 AWS SDKs, see the following: