DescribeLocationSmb - AWS DataSync

On December 7, 2023, we discontinued version 1 DataSync agents. Check the Agents page on the DataSync console to see if you have affected agents. If you do, replace those agents or delete them if they aren't in use. If you need more help, contact AWS Support.

DescribeLocationSmb

Provides details about how an AWS DataSync transfer location for a Server Message Block (SMB) file server is configured.

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

Specifies the Amazon Resource Name (ARN) of the SMB location that you want information about.

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 ARNs of the DataSync agents that can connect with your SMB file server.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 4 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 Microsoft Active Directory domain that the SMB file server belongs to.

Type: String

Length Constraints: Maximum length of 253.

Pattern: ^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$

LocationArn

The ARN of the SMB location.

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 URI of the SMB location.

Type: String

Length Constraints: Maximum length of 4360.

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

MountOptions

The protocol that DataSync use to access your SMB file.

Type: SmbMountOptions object

User

The user that can mount and access the files, folders, and file metadata in your SMB file server.

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

This example illustrates one usage of DescribeLocationSmb.

Sample Request

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

Example

This example illustrates one usage of DescribeLocationSmb.

Sample Response

{ "AgentArns":[ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0bc3b3dc9bbc15145", "arn:aws:datasync:us-east-2:111222333444:agent/agent-04b3fe3d261a18c8f" ], "CreationTime":"1532660733.39", "Domain":"AMAZON", "LocationArn":"arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49", "LocationUri":"smb://hostname.amazon.com/share", "MountOptions":{ "Version":"SMB3" }, "User":"user-1" }

See Also

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