DataSync / Client / update_location_smb

update_location_smb#

DataSync.Client.update_location_smb(**kwargs)#

Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.

See also: AWS API Documentation

Request Syntax

response = client.update_location_smb(
    LocationArn='string',
    Subdirectory='string',
    User='string',
    Domain='string',
    Password='string',
    AgentArns=[
        'string',
    ],
    MountOptions={
        'Version': 'AUTOMATIC'|'SMB2'|'SMB3'|'SMB1'|'SMB2_0'
    }
)
Parameters:

  • LocationArn (string) –

    [REQUIRED]

    Specifies the ARN of the SMB location that you want to update.

  • Subdirectory (string) –

    Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, /path/to/subdirectory). Make sure that other SMB clients in your network can also mount this path.

    To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see required permissions for SMB locations.

  • User (string) –

    Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer.

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

  • Domain (string) –

    Specifies the Windows domain name that your SMB file server belongs to.

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

    For more information, see required permissions for SMB locations.

  • Password (string) –

    Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.

    For more information, see required permissions for SMB locations.

  • AgentArns (list) –

    Specifies the DataSync agent (or agents) which you want to connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

    • (string) –

  • MountOptions (dict) –

    Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

    • Version (string) –

      By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

      These are the following options for configuring the SMB version:

      • AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1. This is the recommended option. If you instead choose a specific version that your file server doesn’t support, you may get an Operation Not Supported error.

      • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

      • SMB2: Restricts the protocol negotiation to only SMB version 2.1.

      • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

      • SMB1: Restricts the protocol negotiation to only SMB version 1.0.

      Note

      The SMB1 option isn’t available when creating an Amazon FSx for NetApp ONTAP location.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions