| 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.DescribeUser
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
- data DescribeUser = DescribeUser' {}
- newDescribeUser :: Text -> Text -> DescribeUser
- describeUser_serverId :: Lens' DescribeUser Text
- describeUser_userName :: Lens' DescribeUser Text
- data DescribeUserResponse = DescribeUserResponse' {
- httpStatus :: Int
- serverId :: Text
- user :: DescribedUser
- newDescribeUserResponse :: Int -> Text -> DescribedUser -> DescribeUserResponse
- describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int
- describeUserResponse_serverId :: Lens' DescribeUserResponse Text
- describeUserResponse_user :: Lens' DescribeUserResponse DescribedUser
Creating a Request
data DescribeUser Source #
See: newDescribeUser smart constructor.
Constructors
| DescribeUser' | |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> 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 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 Transfer Family service and perform file transfer tasks.
Destructuring the Response
data DescribeUserResponse Source #
See: newDescribeUserResponse smart constructor.
Constructors
| DescribeUserResponse' | |
Fields
| |
Instances
newDescribeUserResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> DescribedUser | |
| -> 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 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.