CreateLocationSmb
Defines a file system on an Server Message Block (SMB) server that can be read from or written to.
Request Syntax
{ "AgentArns": [ "string" ], "Domain": "string", "MountOptions": { "Version": "string" }, "Password": "string", "ServerHostname": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "User": "string" }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AgentArns
-
The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 64 items.
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$Required: Yes
- Domain
-
The name of the Windows domain that the SMB server belongs to.
Type: String
Length Constraints: Maximum length of 253.
Pattern:
^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$Required: No
- MountOptions
-
The mount options used by DataSync to access the SMB server.
Type: SmbMountOptions object
Required: No
- Password
-
The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.
Type: String
Length Constraints: Maximum length of 104.
Pattern:
^.{0,104}$Required: Yes
- ServerHostname
-
The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.
Note
This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$Required: Yes
- 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 you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either 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, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.
Type: String
Length Constraints: Maximum length of 4096.
Pattern:
^[a-zA-Z0-9_\-\./]+$Required: Yes
- Tags
-
The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.
Type: Array of TagListEntry objects
Array Members: Minimum number of 0 items. Maximum number of 55 items.
Required: No
- User
-
The user who can mount the share, has the permissions to access files and folders in the SMB share.
Type: String
Length Constraints: Maximum length of 104.
Pattern:
^[^\\x5B\\x5D\\/:;|=,+*?]{1,104}$Required: Yes
Response Syntax
{ "LocationArn": "string" }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- LocationArn
-
The Amazon Resource Name (ARN) of the source SMB file system location that is created.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
This exception is thrown when an error occurs in the AWS DataSync service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
Examples
Example
Sample Request
{ "AgentArns":[ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs,arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3" ], "Domain":"AMAZON", "MountOptions":{ "Version":"SMB3" }, "Password":"string", "ServerHostname":"MyServer.amazon.com", "Subdirectory":"share", "Tags":[ { "Key":"department", "Value":"finance" } ], "User":"user-1" }
Example
Sample Response
{"arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49"}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
