Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Transfer.DeleteUser

Contents

Description

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

No response returns from this operation.

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

Synopsis

data DeleteUser = DeleteUser' {
- serverId :: Text
- userName :: Text
}
newDeleteUser :: Text -> Text -> DeleteUser
deleteUser_serverId :: Lens' DeleteUser Text
deleteUser_userName :: Lens' DeleteUser Text
data DeleteUserResponse = DeleteUserResponse' {
}
newDeleteUserResponse :: DeleteUserResponse

Creating a Request

data DeleteUser Source #

See: newDeleteUser smart constructor.

Constructors

DeleteUser'
Fields serverId :: Text A system-assigned unique identifier for a server instance that has the user assigned to it. userName :: Text A unique string that identifies a user that is being deleted from a server.

Instances

Instances details

ToJSON DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods toJSON :: DeleteUser -> Value # toEncoding :: DeleteUser -> Encoding # toJSONList :: [DeleteUser] -> Value # toEncodingList :: [DeleteUser] -> Encoding #
ToHeaders DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods toHeaders :: DeleteUser -> [Header] #
ToPath DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods toPath :: DeleteUser -> ByteString #
ToQuery DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods toQuery :: DeleteUser -> QueryString #
AWSRequest DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Associated Types type AWSResponse DeleteUser # Methods request :: (Service -> Service) -> DeleteUser -> Request DeleteUser # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteUser))) #
Generic DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Associated Types type Rep DeleteUser :: Type -> Type # Methods from :: DeleteUser -> Rep DeleteUser x # to :: Rep DeleteUser x -> DeleteUser #
Read DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods readsPrec :: Int -> ReadS DeleteUser # readList :: ReadS [DeleteUser] # readPrec :: ReadPrec DeleteUser # readListPrec :: ReadPrec [DeleteUser] #
Show DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods showsPrec :: Int -> DeleteUser -> ShowS # show :: DeleteUser -> String # showList :: [DeleteUser] -> ShowS #
NFData DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods rnf :: DeleteUser -> () #
Eq DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods (==) :: DeleteUser -> DeleteUser -> Bool # (/=) :: DeleteUser -> DeleteUser -> Bool #
Hashable DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods hashWithSalt :: Int -> DeleteUser -> Int # hash :: DeleteUser -> Int #
type AWSResponse DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser type AWSResponse DeleteUser = DeleteUserResponse
type Rep DeleteUser Source #
Instance details Defined in Amazonka.Transfer.DeleteUser type Rep DeleteUser = D1 ('MetaData "DeleteUser" "Amazonka.Transfer.DeleteUser" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteUser Source #

Arguments

:: Text	`DeleteUser`
-> Text	`DeleteUser`
-> DeleteUser

Create a value of DeleteUser with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

DeleteUser, deleteUser_userName - A unique string that identifies a user that is being deleted from a server.

Request Lenses

deleteUser_serverId :: Lens' DeleteUser Text Source #

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

deleteUser_userName :: Lens' DeleteUser Text Source #

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

Destructuring the Response

data DeleteUserResponse Source #

See: newDeleteUserResponse smart constructor.

Constructors

DeleteUserResponse'

Instances

Instances details

Generic DeleteUserResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Associated Types type Rep DeleteUserResponse :: Type -> Type # Methods from :: DeleteUserResponse -> Rep DeleteUserResponse x # to :: Rep DeleteUserResponse x -> DeleteUserResponse #
Read DeleteUserResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods readsPrec :: Int -> ReadS DeleteUserResponse # readList :: ReadS [DeleteUserResponse] # readPrec :: ReadPrec DeleteUserResponse # readListPrec :: ReadPrec [DeleteUserResponse] #
Show DeleteUserResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods showsPrec :: Int -> DeleteUserResponse -> ShowS # show :: DeleteUserResponse -> String # showList :: [DeleteUserResponse] -> ShowS #
NFData DeleteUserResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods rnf :: DeleteUserResponse -> () #
Eq DeleteUserResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteUser Methods (==) :: DeleteUserResponse -> DeleteUserResponse -> Bool # (/=) :: DeleteUserResponse -> DeleteUserResponse -> Bool #
type Rep DeleteUserResponse Source #
Instance details Defined in Amazonka.Transfer.DeleteUser type Rep DeleteUserResponse = D1 ('MetaData "DeleteUserResponse" "Amazonka.Transfer.DeleteUser" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DeleteUserResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteUserResponse :: DeleteUserResponse Source #

Create a value of DeleteUserResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.