| 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.CognitoIdentityProvider.AdminDisableUser
Description
Disables the specified user.
Calling this action requires developer credentials.
Synopsis
- data AdminDisableUser = AdminDisableUser' {
- userPoolId :: Text
- username :: Sensitive Text
- newAdminDisableUser :: Text -> Text -> AdminDisableUser
- adminDisableUser_userPoolId :: Lens' AdminDisableUser Text
- adminDisableUser_username :: Lens' AdminDisableUser Text
- data AdminDisableUserResponse = AdminDisableUserResponse' {
- httpStatus :: Int
- newAdminDisableUserResponse :: Int -> AdminDisableUserResponse
- adminDisableUserResponse_httpStatus :: Lens' AdminDisableUserResponse Int
Creating a Request
data AdminDisableUser Source #
Represents the request to disable the user as an administrator.
See: newAdminDisableUser smart constructor.
Constructors
| AdminDisableUser' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> AdminDisableUser |
Create a value of AdminDisableUser 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:userPoolId:AdminDisableUser', adminDisableUser_userPoolId - The user pool ID for the user pool where you want to disable the user.
$sel:username:AdminDisableUser', adminDisableUser_username - The user name of the user you wish to disable.
Request Lenses
adminDisableUser_userPoolId :: Lens' AdminDisableUser Text Source #
The user pool ID for the user pool where you want to disable the user.
adminDisableUser_username :: Lens' AdminDisableUser Text Source #
The user name of the user you wish to disable.
Destructuring the Response
data AdminDisableUserResponse Source #
Represents the response received from the server to disable the user as an administrator.
See: newAdminDisableUserResponse smart constructor.
Constructors
| AdminDisableUserResponse' | |
Fields
| |
Instances
newAdminDisableUserResponse Source #
Create a value of AdminDisableUserResponse 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:AdminDisableUserResponse', adminDisableUserResponse_httpStatus - The response's http status code.
Response Lenses
adminDisableUserResponse_httpStatus :: Lens' AdminDisableUserResponse Int Source #
The response's http status code.