v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1458293303.1 KB

Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property and its ExternalId.

The response from this call returns the properties of the access that is associated with the ServerId value that was specified.

post/#X-Amz-Target=TransferService.DescribeAccess

Headers

X-Amz-Target'TransferService.DescribeAccess' required

Request body

ServerIdstring required

A system-assigned unique identifier for a server that has this access assigned.

ExternalIdstring required
<p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p> <p> <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code> </p> <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p> <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>

Response

Success

ServerIdstring required

A system-assigned unique identifier for a server that has this access assigned.