DataSync / Client / update_location_fsx_windows

update_location_fsx_windows#

DataSync.Client.update_location_fsx_windows(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.update_location_fsx_windows(
    LocationArn='string',
    Subdirectory='string',
    Domain='string',
    User='string',
    Password='string'
)
Parameters:

  • LocationArn (string) –

    [REQUIRED]

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

  • Subdirectory (string) – 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).

  • Domain (string) –

    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.

  • User (string) –

    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.

  • Password (string) – 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.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException