import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CognitoIdentityProviderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CognitoIdentityProviderClient"; import type { AdminDisableUserRequest, AdminDisableUserResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link AdminDisableUserCommand}. */ export interface AdminDisableUserCommandInput extends AdminDisableUserRequest { } /** * @public * * The output of {@link AdminDisableUserCommand}. */ export interface AdminDisableUserCommandOutput extends AdminDisableUserResponse, __MetadataBearer { } declare const AdminDisableUserCommand_base: { new (input: AdminDisableUserCommandInput): import("@smithy/core/client").CommandImpl; new (input: AdminDisableUserCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Deactivates a user profile and revokes all access tokens for the user. A deactivated * user can't sign in, but still appears in the responses to ListUsers * API requests.

* *

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 more *

* *
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CognitoIdentityProviderClient, AdminDisableUserCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import * // const { CognitoIdentityProviderClient, AdminDisableUserCommand } = require("@aws-sdk/client-cognito-identity-provider"); // CommonJS import * // import type { CognitoIdentityProviderClientConfig } from "@aws-sdk/client-cognito-identity-provider"; * const config = {}; // type is CognitoIdentityProviderClientConfig * const client = new CognitoIdentityProviderClient(config); * const input = { // AdminDisableUserRequest * UserPoolId: "STRING_VALUE", // required * Username: "STRING_VALUE", // required * }; * const command = new AdminDisableUserCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param AdminDisableUserCommandInput - {@link AdminDisableUserCommandInput} * @returns {@link AdminDisableUserCommandOutput} * @see {@link AdminDisableUserCommandInput} for command's `input` shape. * @see {@link AdminDisableUserCommandOutput} for command's `response` shape. * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape. * * @throws {@link InternalErrorException} (server fault) *

This exception is thrown when Amazon Cognito encounters an internal error.

* * @throws {@link InvalidParameterException} (client fault) *

This exception is thrown when the Amazon Cognito service encounters an invalid * parameter.

* * @throws {@link NotAuthorizedException} (client fault) *

This exception is thrown when a user isn't authorized.

* * @throws {@link OperationNotEnabledException} (client fault) *

This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.

* * @throws {@link ResourceNotFoundException} (client fault) *

This exception is thrown when the Amazon Cognito service can't find the requested * resource.

* * @throws {@link TooManyRequestsException} (client fault) *

This exception is thrown when the user has made too many requests for a given * operation.

* * @throws {@link UserNotFoundException} (client fault) *

This exception is thrown when a user isn't found.

* * @throws {@link CognitoIdentityProviderServiceException} *

Base exception class for all service exceptions from CognitoIdentityProvider service.

* * * @public */ export declare class AdminDisableUserCommand extends AdminDisableUserCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: AdminDisableUserRequest; output: {}; }; sdk: { input: AdminDisableUserCommandInput; output: AdminDisableUserCommandOutput; }; }; }