AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests
for this API operation. For this operation, you must use IAM credentials to authorize
requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn moreGetUser
and ListUsers
API requests.
For .NET Core this operation is only available in asynchronous form. Please refer to AdminDisableUserAsync.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public abstract AdminDisableUserResponse AdminDisableUser( AdminDisableUserRequest request )
Container for the necessary parameters to execute the AdminDisableUser service method.
Exception | Condition |
---|---|
InternalErrorException | This exception is thrown when Amazon Cognito encounters an internal error. |
InvalidParameterException | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. |
NotAuthorizedException | This exception is thrown when a user isn't authorized. |
ResourceNotFoundException | This exception is thrown when the Amazon Cognito service can't find the requested resource. |
TooManyRequestsException | This exception is thrown when the user has made too many requests for a given operation. |
UserNotFoundException | This exception is thrown when a user isn't found. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5