2023/02/14 - AWS DataSync - 7 updated api methods
Changes With this launch, we are giving customers the ability to use older SMB protocol versions, enabling them to use DataSync to copy data to and from their legacy storage arrays.
{'Protocol': {'SMB': {'MountOptions': {'Version': {'SMB2_0', 'SMB1'}}}}}
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for ONTAP.
See also: AWS API Documentation
Request Syntax
client.create_location_fsx_ontap(
Protocol={
'NFS': {
'MountOptions': {
'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
}
},
'SMB': {
'Domain': 'string',
'MountOptions': {
'Version': 'AUTOMATIC'|'SMB2'|'SMB3'|'SMB1'|'SMB2_0'
},
'Password': 'string',
'User': 'string'
}
},
SecurityGroupArns=[
'string',
],
StorageVirtualMachineArn='string',
Subdirectory='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
dict
[REQUIRED]
Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
NFS (dict) --
Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).
MountOptions (dict) --
Specifies how DataSync can access a location using the NFS protocol.
Version (string) --
Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.
You can specify the following options:
AUTOMATIC (default): DataSync chooses NFS version 4.1.
NFS3 : Stateless protocol version that allows for asynchronous writes on the server.
NFSv4_0 : Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.
NFSv4_1 : Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.
Note
DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
SMB (dict) --
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.
Domain (string) --
Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
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.
Password (string) -- [REQUIRED]
Specifies the password of a user who has permission to access your SVM.
User (string) -- [REQUIRED]
Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
If you provide a user in your Active Directory, note the following:
If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.
If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.
Make sure that the user has the permissions it needs to copy the data you want:
SE_TCB_NAME : Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).
SE_SECURITY_NAME : May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.
list
[REQUIRED]
Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet.
The security groups must allow outbound traffic on the following ports (depending on the protocol you use):
Network File System (NFS) : TCP ports 111, 635, and 2049
Server Message Block (SMB) : TCP port 445
Your file system's security groups must also allow inbound traffic on the same ports.
(string) --
string
[REQUIRED]
Specifies the ARN of the storage virtual machine (SVM) in your file system where you want to copy data to or from.
string
Specifies a path to the file share in the SVM where you'll copy your data.
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 .
list
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
(dict) --
A key-value pair representing a single tag that's been applied to an Amazon Web Services resource.
Key (string) -- [REQUIRED]
The key for an Amazon Web Services resource tag.
Value (string) --
The value for an Amazon Web Services resource tag.
dict
Response Syntax
{
'LocationArn': 'string'
}
Response Structure
(dict) --
LocationArn (string) --
Specifies the ARN of the FSx for ONTAP file system location that you create.
{'Protocol': {'SMB': {'MountOptions': {'Version': {'SMB2_0', 'SMB1'}}}}}
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for OpenZFS.
Note
Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.
See also: AWS API Documentation
Request Syntax
client.create_location_fsx_open_zfs(
FsxFilesystemArn='string',
Protocol={
'NFS': {
'MountOptions': {
'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
}
},
'SMB': {
'Domain': 'string',
'MountOptions': {
'Version': 'AUTOMATIC'|'SMB2'|'SMB3'|'SMB1'|'SMB2_0'
},
'Password': 'string',
'User': 'string'
}
},
SecurityGroupArns=[
'string',
],
Subdirectory='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
dict
[REQUIRED]
The type of protocol that DataSync uses to access your file system.
NFS (dict) --
Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).
MountOptions (dict) --
Specifies how DataSync can access a location using the NFS protocol.
Version (string) --
Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.
You can specify the following options:
AUTOMATIC (default): DataSync chooses NFS version 4.1.
NFS3 : Stateless protocol version that allows for asynchronous writes on the server.
NFSv4_0 : Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.
NFSv4_1 : Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.
Note
DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
SMB (dict) --
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.
Domain (string) --
Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
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.
Password (string) -- [REQUIRED]
Specifies the password of a user who has permission to access your SVM.
User (string) -- [REQUIRED]
Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
If you provide a user in your Active Directory, note the following:
If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.
If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.
Make sure that the user has the permissions it needs to copy the data you want:
SE_TCB_NAME : Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).
SE_SECURITY_NAME : May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.
list
[REQUIRED]
The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.
(string) --
string
A subdirectory in the location's path that must begin with /fsx . DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).
list
The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
(dict) --
A key-value pair representing a single tag that's been applied to an Amazon Web Services resource.
Key (string) -- [REQUIRED]
The key for an Amazon Web Services resource tag.
Value (string) --
The value for an Amazon Web Services resource tag.
dict
Response Syntax
{
'LocationArn': 'string'
}
Response Structure
(dict) --
LocationArn (string) --
The ARN of the FSx for OpenZFS file system location that you created.
{'MountOptions': {'Version': {'SMB2_0', 'SMB1'}}}
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer. For more information, see Creating an SMB location.
See also: AWS API Documentation
Request Syntax
client.create_location_smb(
Subdirectory='string',
ServerHostname='string',
User='string',
Domain='string',
Password='string',
AgentArns=[
'string',
],
MountOptions={
'Version': 'AUTOMATIC'|'SMB2'|'SMB3'|'SMB1'|'SMB2_0'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
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.
string
[REQUIRED]
Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.
Note
You can't specify an IP version 6 (IPv6) address.
string
[REQUIRED]
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.
string
Specifies the Windows domain name that your SMB file server belongs to.
For more information, see required permissions for SMB locations.
string
[REQUIRED]
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.
list
[REQUIRED]
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) --
dict
Specifies the version of the SMB protocol that DataSync uses to access your 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.
list
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
(dict) --
A key-value pair representing a single tag that's been applied to an Amazon Web Services resource.
Key (string) -- [REQUIRED]
The key for an Amazon Web Services resource tag.
Value (string) --
The value for an Amazon Web Services resource tag.
dict
Response Syntax
{
'LocationArn': 'string'
}
Response Structure
(dict) --
CreateLocationSmbResponse
LocationArn (string) --
The ARN of the SMB location that you created.
{'Protocol': {'SMB': {'MountOptions': {'Version': {'SMB2_0', 'SMB1'}}}}}
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
Note
If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password .
See also: AWS API Documentation
Request Syntax
client.describe_location_fsx_ontap(
LocationArn='string'
)
string
[REQUIRED]
Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system location that you want information about.
dict
Response Syntax
{
'CreationTime': datetime(2015, 1, 1),
'LocationArn': 'string',
'LocationUri': 'string',
'Protocol': {
'NFS': {
'MountOptions': {
'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
}
},
'SMB': {
'Domain': 'string',
'MountOptions': {
'Version': 'AUTOMATIC'|'SMB2'|'SMB3'|'SMB1'|'SMB2_0'
},
'Password': 'string',
'User': 'string'
}
},
'SecurityGroupArns': [
'string',
],
'StorageVirtualMachineArn': 'string',
'FsxFilesystemArn': 'string'
}
Response Structure
(dict) --
CreationTime (datetime) --
The time that the location was created.
LocationArn (string) --
The ARN of the FSx for ONTAP file system location.
LocationUri (string) --
The uniform resource identifier (URI) of the FSx for ONTAP file system location.
Protocol (dict) --
Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
NFS (dict) --
Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).
MountOptions (dict) --
Specifies how DataSync can access a location using the NFS protocol.
Version (string) --
Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.
You can specify the following options:
AUTOMATIC (default): DataSync chooses NFS version 4.1.
NFS3 : Stateless protocol version that allows for asynchronous writes on the server.
NFSv4_0 : Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.
NFSv4_1 : Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.
Note
DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
SMB (dict) --
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.
Domain (string) --
Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
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.
Password (string) --
Specifies the password of a user who has permission to access your SVM.
User (string) --
Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
If you provide a user in your Active Directory, note the following:
If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.
If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.
Make sure that the user has the permissions it needs to copy the data you want:
SE_TCB_NAME : Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).
SE_SECURITY_NAME : May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.
SecurityGroupArns (list) --
The security groups that DataSync uses to access your FSx for ONTAP file system.
(string) --
StorageVirtualMachineArn (string) --
The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system where you're copying data to or from.
FsxFilesystemArn (string) --
The ARN of the FSx for ONTAP file system.
{'Protocol': {'SMB': {'MountOptions': {'Version': {'SMB2_0', 'SMB1'}}}}}
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
Note
Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.
See also: AWS API Documentation
Request Syntax
client.describe_location_fsx_open_zfs(
LocationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the FSx for OpenZFS location to describe.
dict
Response Syntax
{
'LocationArn': 'string',
'LocationUri': 'string',
'SecurityGroupArns': [
'string',
],
'Protocol': {
'NFS': {
'MountOptions': {
'Version': 'AUTOMATIC'|'NFS3'|'NFS4_0'|'NFS4_1'
}
},
'SMB': {
'Domain': 'string',
'MountOptions': {
'Version': 'AUTOMATIC'|'SMB2'|'SMB3'|'SMB1'|'SMB2_0'
},
'Password': 'string',
'User': 'string'
}
},
'CreationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
LocationArn (string) --
The ARN of the FSx for OpenZFS location that was described.
LocationUri (string) --
The uniform resource identifier (URI) of the FSx for OpenZFS location that was described.
Example: fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder
SecurityGroupArns (list) --
The ARNs of the security groups that are configured for the FSx for OpenZFS file system.
(string) --
Protocol (dict) --
The type of protocol that DataSync uses to access your file system.
NFS (dict) --
Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).
MountOptions (dict) --
Specifies how DataSync can access a location using the NFS protocol.
Version (string) --
Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.
You can specify the following options:
AUTOMATIC (default): DataSync chooses NFS version 4.1.
NFS3 : Stateless protocol version that allows for asynchronous writes on the server.
NFSv4_0 : Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.
NFSv4_1 : Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.
Note
DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
SMB (dict) --
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.
Domain (string) --
Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
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.
Password (string) --
Specifies the password of a user who has permission to access your SVM.
User (string) --
Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
If you provide a user in your Active Directory, note the following:
If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.
If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.
Make sure that the user has the permissions it needs to copy the data you want:
SE_TCB_NAME : Required to set object ownership and file metadata. With this privilege, you also can copy NTFS discretionary access lists (DACLs).
SE_SECURITY_NAME : May be needed to copy NTFS system access control lists (SACLs). This operation specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you configure your task to copy SACLs, make sure that the user has the required privileges. For information about copying SACLs, see Ownership and permissions-related options.
CreationTime (datetime) --
The time that the FSx for OpenZFS location was created.
{'MountOptions': {'Version': {'SMB2_0', 'SMB1'}}}
Returns metadata, such as the path and user information about an SMB location.
See also: AWS API Documentation
Request Syntax
client.describe_location_smb(
LocationArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the SMB location to describe.
dict
Response Syntax
{
'LocationArn': 'string',
'LocationUri': 'string',
'AgentArns': [
'string',
],
'User': 'string',
'Domain': 'string',
'MountOptions': {
'Version': 'AUTOMATIC'|'SMB2'|'SMB3'|'SMB1'|'SMB2_0'
},
'CreationTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
DescribeLocationSmbResponse
LocationArn (string) --
The Amazon Resource Name (ARN) of the SMB location that was described.
LocationUri (string) --
The URL of the source SMB location that was described.
AgentArns (list) --
The Amazon Resource Name (ARN) of the source SMB file system location that is created.
(string) --
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.
MountOptions (dict) --
The mount options that are available for DataSync to use to access an SMB location.
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.
CreationTime (datetime) --
The time that the SMB location was created.
{'MountOptions': {'Version': {'SMB2_0', 'SMB1'}}}
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
client.update_location_smb(
LocationArn='string',
Subdirectory='string',
User='string',
Domain='string',
Password='string',
AgentArns=[
'string',
],
MountOptions={
'Version': 'AUTOMATIC'|'SMB2'|'SMB3'|'SMB1'|'SMB2_0'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the SMB location to update.
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.
string
The user who can mount the share has the permissions to access files and folders in the SMB share.
string
The name of the Windows domain that the SMB server belongs to.
string
The password of the user who can mount the share has the permissions to access files and folders in the SMB share.
list
The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
(string) --
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.
dict
Response Syntax
{}
Response Structure
(dict) --