Transfer / Client / delete_user

delete_user#

Transfer.Client.delete_user(**kwargs)#

Deletes the user belonging to a file transfer protocol-enabled server you specify.

No response returns from this operation.

Note

When you delete a user from a server, the user’s information is lost.

See also: AWS API Documentation

Request Syntax

response = client.delete_user(
    ServerId='string',
    UserName='string'
)
Parameters:

  • ServerId (string) –

    [REQUIRED]

    A system-assigned unique identifier for a server instance that has the user assigned to it.

  • UserName (string) –

    [REQUIRED]

    A unique string that identifies a user that is being deleted from a server.

Returns:

None

Exceptions

  • Transfer.Client.exceptions.ResourceNotFoundException

  • Transfer.Client.exceptions.InvalidRequestException

  • Transfer.Client.exceptions.InternalServiceError

  • Transfer.Client.exceptions.ServiceUnavailableException