AWS DataSync

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 create-smb-location.

See also: AWS API Documentation

Request Syntax

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

type LocationArn:

string

param LocationArn:

[REQUIRED]

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

type Subdirectory:

string

param Subdirectory:

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.

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.

type User:

string

param User:

The user who can mount the share has the permissions to access files and folders in the SMB share.

type Domain:

string

param Domain:

The name of the Windows domain that the SMB server belongs to.

type Password:

string

param Password:

The password of the user who can mount the share has the permissions to access files and folders in the SMB share.

type AgentArns:

list

param AgentArns:

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

• (string) --

type MountOptions:

dict

param MountOptions:

Represents the mount options that are available for DataSync to access an SMB location.

• Version (string) --

  The specific SMB version that you want DataSync to use to mount your SMB share. If you don't specify a version, DataSync defaults to AUTOMATIC. That is, DataSync automatically selects a version based on negotiation with the SMB server.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Updates some of the parameters of a previously created location for self-managed object storage server access. For information about creating a self-managed object storage location, see create-object-location.

See also: AWS API Documentation

Request Syntax

client.update_location_object_storage(
    LocationArn='string',
    ServerPort=123,
    ServerProtocol='HTTPS'|'HTTP',
    Subdirectory='string',
    AccessKey='string',
    SecretKey='string',
    AgentArns=[
        'string',
    ]
)

type LocationArn:

string

param LocationArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the self-managed object storage server location to be updated.

type ServerPort:

integer

param ServerPort:

The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.

type ServerProtocol:

string

param ServerProtocol:

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

type Subdirectory:

string

param Subdirectory:

The subdirectory in the self-managed object storage server that is used to read data from.

type AccessKey:

string

param AccessKey:

Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

type SecretKey:

string

param SecretKey:

Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

type AgentArns:

list

param AgentArns:

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

• (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see create-nfs-location.

See also: AWS API Documentation

Request Syntax

client.update_location_nfs(
    LocationArn='string',
    Subdirectory='string',
    OnPremConfig={
        'AgentArns': [
            'string',
        ]
    },
    MountOptions={
        'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
    }
)

type LocationArn:

string

param LocationArn:

[REQUIRED]

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

type Subdirectory:

string

param Subdirectory:

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

To see all the paths exported by your NFS server, run " showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

To transfer all the data in the folder that you specified, DataSync must have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the files you want DataSync to access have permissions that allow read access for all users. Doing either option enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.

type OnPremConfig:

dict

param OnPremConfig:

A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.

• AgentArns (list) -- [REQUIRED]

  ARNs of the agents to use for an NFS location.

  • (string) --

type MountOptions:

dict

param MountOptions:

Represents the mount options that are available for DataSync to access an NFS location.

• Version (string) --

  The specific NFS version that you want DataSync to use to mount your NFS share. If the server refuses to use the version specified, the sync will fail. If you don't specify a version, DataSync defaults to AUTOMATIC. That is, DataSync automatically selects a version based on negotiation with the NFS server.

  You can specify the following NFS versions:

  • NFSv3 - stateless protocol version that allows for asynchronous writes on the server.

  • NFSv4.0 - stateful, firewall-friendly protocol version that supports delegations and pseudo filesystems.

  • NFSv4.1 - stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --