Transfer / Client / delete_access

delete_access#

Transfer.Client.delete_access(**kwargs)#

Allows you to delete the access specified in the ServerID and ExternalID parameters.

Request Syntax

response = client.delete_access(
    ServerId='string',
    ExternalId='string'
)

Parameters:

ServerId (string) –
[REQUIRED]

A system-assigned unique identifier for a server that has this user assigned.
ExternalId (string) –
[REQUIRED]

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.

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

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: =,.@:/-

Returns:

None

Exceptions