DataSync / Client / update_location_smb

update_location_smb#

DataSync.Client.update_location_smb(**kwargs)#

Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB.

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]

    The Amazon Resource Name (ARN) of the SMB location to update.

  • Subdirectory (string) –

    The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that’s exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

    Note

    Subdirectory must be specified with forward slashes. For example, /path/to/folder.

    To transfer all the data in the folder that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:

    • Ensure that the user/password specified belongs to the user who can mount the share and who has the appropriate permissions for all of the files and directories that you want DataSync to access.

    • Use credentials of a member of the Backup Operators group to mount the share.

    Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.

  • User (string) – The user who can mount the share has the permissions to access files and folders in the SMB share.

  • Domain (string) – The name of the Windows domain that the SMB server belongs to.

  • Password (string) – The password of the user who can mount the share has the permissions to access files and folders in the SMB share.

  • AgentArns (list) –

    The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

    • (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 a protocol version that they mutually support. (DataSync supports SMB versions 1.0 and later.) 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

  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException