Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Transfer.DescribeUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the user assigned to the specific file transfer protocol-enabled server, as identified by its ServerId property.

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

Synopsis

Creating a Request

data DescribeUser Source #

See: newDescribeUser smart constructor.

Constructors

DescribeUser'
Fields serverId :: Text A system-assigned unique identifier for a server that has this user assigned. userName :: Text The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the Amazon Web Services Transfer Family service and perform file transfer tasks.

Instances

Instances details

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

newDescribeUser Source #

Arguments

:: Text	`$sel:serverId:DescribeUser'`
-> Text	`$sel:userName:DescribeUser'`
-> DescribeUser

Create a value of DescribeUser 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:

$sel:serverId:DescribeUser', describeUser_serverId - A system-assigned unique identifier for a server that has this user assigned.

$sel:userName:DescribeUser', describeUser_userName - The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the Amazon Web Services Transfer Family service and perform file transfer tasks.

Request Lenses

describeUser_serverId :: Lens' DescribeUser Text Source #

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

describeUser_userName :: Lens' DescribeUser Text Source #

The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the Amazon Web Services Transfer Family service and perform file transfer tasks.

Destructuring the Response

data DescribeUserResponse Source #

See: newDescribeUserResponse smart constructor.

Constructors

DescribeUserResponse'
Fields httpStatus :: Int The response's http status code. serverId :: Text A system-assigned unique identifier for a server that has this user assigned. user :: DescribedUser An array containing the properties of the user account for the `ServerID` value that you specified.

Instances

Instances details

Eq DescribeUserResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods (==) :: DescribeUserResponse -> DescribeUserResponse -> Bool # (/=) :: DescribeUserResponse -> DescribeUserResponse -> Bool #
Read DescribeUserResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods readsPrec :: Int -> ReadS DescribeUserResponse # readList :: ReadS [DescribeUserResponse] # readPrec :: ReadPrec DescribeUserResponse # readListPrec :: ReadPrec [DescribeUserResponse] #
Show DescribeUserResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods showsPrec :: Int -> DescribeUserResponse -> ShowS # show :: DescribeUserResponse -> String # showList :: [DescribeUserResponse] -> ShowS #
Generic DescribeUserResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Associated Types type Rep DescribeUserResponse :: Type -> Type # Methods from :: DescribeUserResponse -> Rep DescribeUserResponse x # to :: Rep DescribeUserResponse x -> DescribeUserResponse #
NFData DescribeUserResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeUser Methods rnf :: DescribeUserResponse -> () #
type Rep DescribeUserResponse Source #
Instance details Defined in Amazonka.Transfer.DescribeUser type Rep DescribeUserResponse = D1 ('MetaData "DescribeUserResponse" "Amazonka.Transfer.DescribeUser" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "DescribeUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DescribedUser))))

newDescribeUserResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeUserResponse'`
-> Text	`$sel:serverId:DescribeUser'`
-> DescribedUser	`$sel:user:DescribeUserResponse'`
-> DescribeUserResponse

Create a value of DescribeUserResponse 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:

$sel:httpStatus:DescribeUserResponse', describeUserResponse_httpStatus - The response's http status code.

$sel:serverId:DescribeUser', describeUserResponse_serverId - A system-assigned unique identifier for a server that has this user assigned.

$sel:user:DescribeUserResponse', describeUserResponse_user - An array containing the properties of the user account for the ServerID value that you specified.

Response Lenses

describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int Source #

The response's http status code.

describeUserResponse_serverId :: Lens' DescribeUserResponse Text Source #

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

describeUserResponse_user :: Lens' DescribeUserResponse DescribedUser Source #

An array containing the properties of the user account for the ServerID value that you specified.