Amazonka.Transfer.DescribeUser

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.

Creating a Request

data DescribeUser

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 Transfer Family service and perform file transfer tasks.

Instances

ToJSON DescribeUser

Defined in Amazonka.Transfer.DescribeUser

Methods

toJSON :: DescribeUser -> Value

toEncoding :: DescribeUser -> Encoding

toJSONList :: [DescribeUser] -> Value

toEncodingList :: [DescribeUser] -> Encoding

ToHeaders DescribeUser

Defined in Amazonka.Transfer.DescribeUser

Methods

toHeaders :: DescribeUser -> [Header]

ToPath DescribeUser

Defined in Amazonka.Transfer.DescribeUser

Methods

toPath :: DescribeUser -> ByteString

ToQuery DescribeUser

Defined in Amazonka.Transfer.DescribeUser

Methods

toQuery :: DescribeUser -> QueryString

AWSRequest DescribeUser

Defined in Amazonka.Transfer.DescribeUser

Associated Types

type AWSResponse DescribeUser

Methods

request :: (Service -> Service) -> DescribeUser -> Request DescribeUser

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeUser)))

Generic DescribeUser

Defined in Amazonka.Transfer.DescribeUser

Associated Types

type Rep DescribeUser :: Type -> Type

Methods

from :: DescribeUser -> Rep DescribeUser x

to :: Rep DescribeUser x -> DescribeUser

Read DescribeUser

Defined in Amazonka.Transfer.DescribeUser

Methods

readsPrec :: Int -> ReadS DescribeUser

readList :: ReadS [DescribeUser]

readPrec :: ReadPrec DescribeUser

readListPrec :: ReadPrec [DescribeUser]

Show DescribeUser

Defined in Amazonka.Transfer.DescribeUser

Methods

showsPrec :: Int -> DescribeUser -> ShowS

show :: DescribeUser -> String

showList :: [DescribeUser] -> ShowS

NFData DescribeUser

Defined in Amazonka.Transfer.DescribeUser

Methods

rnf :: DescribeUser -> ()

Eq DescribeUser

Defined in Amazonka.Transfer.DescribeUser

Methods

(==) :: DescribeUser -> DescribeUser -> Bool

(/=) :: DescribeUser -> DescribeUser -> Bool

Hashable DescribeUser

Defined in Amazonka.Transfer.DescribeUser

Methods

hashWithSalt :: Int -> DescribeUser -> Int

hash :: DescribeUser -> Int

type AWSResponse DescribeUser

Defined in Amazonka.Transfer.DescribeUser

type AWSResponse DescribeUser = DescribeUserResponse

type Rep DescribeUser

Defined in Amazonka.Transfer.DescribeUser

type Rep DescribeUser = D1 ('MetaData "DescribeUser" "Amazonka.Transfer.DescribeUser" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "DescribeUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeUser

Arguments

:: Text

DescribeUser

-> Text

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:

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

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 Transfer Family service and perform file transfer tasks.

Request Lenses

describeUser_serverId :: Lens' DescribeUser Text

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

describeUser_userName :: Lens' DescribeUser Text

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

Destructuring the Response

data DescribeUserResponse

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

Generic DescribeUserResponse

Defined in Amazonka.Transfer.DescribeUser

Associated Types

type Rep DescribeUserResponse :: Type -> Type

Methods

from :: DescribeUserResponse -> Rep DescribeUserResponse x

to :: Rep DescribeUserResponse x -> DescribeUserResponse

Read DescribeUserResponse

Defined in Amazonka.Transfer.DescribeUser

Methods

readsPrec :: Int -> ReadS DescribeUserResponse

readList :: ReadS [DescribeUserResponse]

readPrec :: ReadPrec DescribeUserResponse

readListPrec :: ReadPrec [DescribeUserResponse]

Show DescribeUserResponse

Defined in Amazonka.Transfer.DescribeUser

Methods

showsPrec :: Int -> DescribeUserResponse -> ShowS

show :: DescribeUserResponse -> String

showList :: [DescribeUserResponse] -> ShowS

NFData DescribeUserResponse

Defined in Amazonka.Transfer.DescribeUser

Methods

rnf :: DescribeUserResponse -> ()

Eq DescribeUserResponse

Defined in Amazonka.Transfer.DescribeUser

Methods

(==) :: DescribeUserResponse -> DescribeUserResponse -> Bool

(/=) :: DescribeUserResponse -> DescribeUserResponse -> Bool

type Rep DescribeUserResponse

Defined in Amazonka.Transfer.DescribeUser

type Rep DescribeUserResponse = D1 ('MetaData "DescribeUserResponse" "Amazonka.Transfer.DescribeUser" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" '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

Arguments

:: Int

$sel:httpStatus:DescribeUserResponse'

-> Text

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.

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

The response's http status code.

describeUserResponse_serverId :: Lens' DescribeUserResponse Text

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

describeUserResponse_user :: Lens' DescribeUserResponse DescribedUser

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