2022/06/28 - AWS DataSync - 2 new2 updated api methods
Changes AWS DataSync now supports Amazon FSx for NetApp ONTAP locations.
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'
},
'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.
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 how DataSync can access a location using the SMB protocol.
Version (string) --
Specifies the SMB version that you want DataSync to use when mounting your SMB share. If you don't specify a version, DataSync defaults to AUTOMATIC and chooses a version based on negotiation with the SMB server.
Password (string) -- [REQUIRED]
Specifies the password of a user who has permission to access your SVM.
User (string) -- [REQUIRED]
Specifies a user who has permission to access your SVM.
list
[REQUIRED]
Specifies the security groups that DataSync can use to access your FSx for ONTAP file system. You must configure the security groups to allow outbound traffic on the following ports (depending on the protocol that you're using):
Network File System (NFS): TCP port 2049
Server Message Block (SMB): TCP port 445
Your file system's security groups must also allow inbound traffic on the same port.
(string) --
string
[REQUIRED]
Specifies the ARN of the storage virtual machine (SVM) on your file system where you're copying data to or from.
string
Specifies the junction path (also known as a mount point) in the SVM volume where you're copying data to or from (for example, /vol1).
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) --
Represents a single entry in a list of Amazon Web Services resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.
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.
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
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'
},
'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.
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 how DataSync can access a location using the SMB protocol.
Version (string) --
Specifies the SMB version that you want DataSync to use when mounting your SMB share. If you don't specify a version, DataSync defaults to AUTOMATIC and chooses a version based on negotiation with the SMB server.
Password (string) --
Specifies the password of a user who has permission to access your SVM.
User (string) --
Specifies a user who has permission to access your SVM.
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': {'Domain': 'string',
'MountOptions': {'Version': 'AUTOMATIC | SMB2 | SMB3'},
'Password': 'string',
'User': 'string'}}}
Creates an endpoint for an Amazon FSx for OpenZFS file system.
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'
},
'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.
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 how DataSync can access a location using the SMB protocol.
Version (string) --
Specifies the SMB version that you want DataSync to use when mounting your SMB share. If you don't specify a version, DataSync defaults to AUTOMATIC and chooses a version based on negotiation with the SMB server.
Password (string) -- [REQUIRED]
Specifies the password of a user who has permission to access your SVM.
User (string) -- [REQUIRED]
Specifies a user who has permission to access your SVM.
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) --
Represents a single entry in a list of Amazon Web Services resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.
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.
{'Protocol': {'SMB': {'Domain': 'string',
'MountOptions': {'Version': 'AUTOMATIC | SMB2 | SMB3'},
'Password': 'string',
'User': 'string'}}}
Returns metadata about an Amazon FSx for OpenZFS location, such as information about its path.
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'
},
'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.
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 how DataSync can access a location using the SMB protocol.
Version (string) --
Specifies the SMB version that you want DataSync to use when mounting your SMB share. If you don't specify a version, DataSync defaults to AUTOMATIC and chooses a version based on negotiation with the SMB server.
Password (string) --
Specifies the password of a user who has permission to access your SVM.
User (string) --
Specifies a user who has permission to access your SVM.
CreationTime (datetime) --
The time that the FSx for OpenZFS location was created.