AWS DataSync
User Guide

DescribeLocationSmb

Returns metadata, such as the path and user information about a SMB location.

Request Syntax

{ "LocationArn": "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.

LocationArn

The Amazon resource Name (ARN) of the SMB location to describe.

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}$

Required: Yes

Response Syntax

{ "AgentArns": [ "string" ], "CreationTime": number, "Domain": "string", "LocationArn": "string", "LocationUri": "string", "MountOptions": { "Version": "string" }, "User": "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.

AgentArns

The Amazon Resource Name (ARN) of the source SMB file system location that is created.

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}$

CreationTime

The time that the SMB location was created.

Type: Timestamp

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]$

LocationArn

The Amazon resource Name (ARN) of the SMB location that was described.

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}$

LocationUri

The URL of the source SBM location that was described.

Type: String

Length Constraints: Maximum length of 4355.

Pattern: ^(efs|nfs|s3|smb)://[a-zA-Z0-9.\-]+$

MountOptions

The mount options that are available for DataSync to use to access an SMB location.

Type: SmbMountOptions object

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}$

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

{ "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49" }

Example

Sample Response

{ "AgentArns":[ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs,arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3"" ], "CreationTime":"1532660733.39", "Domain":"AMAZON", "LocationArn":"arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49", "LocationUri":"hostname.amazon.com", "MountOptions":{ "Version":"SMB3" }, "Password":"MyPassword", "ServerHostname":"MyServer.amazon.com", "Subdirectory":"share", "Tags":[ { "Key":"department", "Value":"finance" } ], "User":"user-1" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: