| 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.IdentityStore.DescribeUser
Description
Retrieves the user metadata and attributes from UserId in an identity
store.
Synopsis
- data DescribeUser = DescribeUser' {
- identityStoreId :: Text
- userId :: Text
- newDescribeUser :: Text -> Text -> DescribeUser
- describeUser_identityStoreId :: Lens' DescribeUser Text
- describeUser_userId :: Lens' DescribeUser Text
- data DescribeUserResponse = DescribeUserResponse' {}
- newDescribeUserResponse :: Int -> Text -> Text -> DescribeUserResponse
- describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int
- describeUserResponse_userName :: Lens' DescribeUserResponse Text
- describeUserResponse_userId :: Lens' DescribeUserResponse Text
Creating a Request
data DescribeUser Source #
See: newDescribeUser smart constructor.
Constructors
| DescribeUser' | |
Fields
| |
Instances
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:identityStoreId:DescribeUser', describeUser_identityStoreId - The globally unique identifier for the identity store, such as
d-1234567890. In this example, d- is a fixed prefix, and
1234567890 is a randomly generated string that contains number and
lower case letters. This value is generated at the time that a new
identity store is created.
$sel:userId:DescribeUser', describeUser_userId - The identifier for a user in the identity store.
Request Lenses
describeUser_identityStoreId :: Lens' DescribeUser Text Source #
The globally unique identifier for the identity store, such as
d-1234567890. In this example, d- is a fixed prefix, and
1234567890 is a randomly generated string that contains number and
lower case letters. This value is generated at the time that a new
identity store is created.
describeUser_userId :: Lens' DescribeUser Text Source #
The identifier for a user in the identity store.
Destructuring the Response
data DescribeUserResponse Source #
See: newDescribeUserResponse smart constructor.
Constructors
| DescribeUserResponse' | |
Fields
| |
Instances
newDescribeUserResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> 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:userName:DescribeUserResponse', describeUserResponse_userName - Contains the user’s user name value. The length limit is 128 characters.
This value can consist of letters, accented characters, symbols,
numbers, and punctuation. The characters <>;:% are excluded. This
value is specified at the time the user is created and stored as an
attribute of the user object in the identity store.
$sel:userId:DescribeUser', describeUserResponse_userId - The identifier for a user in the identity store.
Response Lenses
describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int Source #
The response's http status code.
describeUserResponse_userName :: Lens' DescribeUserResponse Text Source #
Contains the user’s user name value. The length limit is 128 characters.
This value can consist of letters, accented characters, symbols,
numbers, and punctuation. The characters <>;:% are excluded. This
value is specified at the time the user is created and stored as an
attribute of the user object in the identity store.
describeUserResponse_userId :: Lens' DescribeUserResponse Text Source #
The identifier for a user in the identity store.