| 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.CognitoIdentityProvider.AdminDisableUser
Description
Deactivates a user and revokes all access tokens for the user. A
deactivated user can't sign in, but still appears in the responses to
GetUser and ListUsers API requests.
You must make this API request with Amazon Web Services credentials that
have cognito-idp:AdminDisableUser permissions.
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:
AdminDisableUser, adminDisableUser_userPoolId - The user pool ID for the user pool where you want to disable the user.
AdminDisableUser, adminDisableUser_username - The user name of the user you want 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 want 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.