Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1444219188.6 KB

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

post/#X-Amz-Target=FmrsService.DescribeLocationSmb

Headers

X-Amz-Target'FmrsService.DescribeLocationSmb' required

Request body

LocationArnstring required

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

Response

Success

LocationArnstring

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

LocationUristring

The URL of the source SMB location that was described.

AgentArnsAgentArn[]

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

Userstring

The user who can mount the share, has the permissions to access files and folders in the SMB share.

Domainstring

The name of the Windows domain that the SMB server belongs to.

CreationTimestring date-time

The time that the SMB location was created.