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 { GlobalSignOutRequest, GlobalSignOutResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GlobalSignOutCommand}. */ export interface GlobalSignOutCommandInput extends GlobalSignOutRequest { } /** * @public * * The output of {@link GlobalSignOutCommand}. */ export interface GlobalSignOutCommandOutput extends GlobalSignOutResponse, __MetadataBearer { } declare const GlobalSignOutCommand_base: { new (input: GlobalSignOutCommandInput): import("@smithy/core/client").CommandImpl; new (input: GlobalSignOutCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call * this operation when your user signs out of your app. This results in the following * behavior.

* *

Other requests might be valid until your user's token expires. This operation * doesn't clear the managed login session cookie. To clear the session for * a user who signed in with managed login or the classic hosted UI, direct their browser * session to the logout endpoint.

*

Authorize this action with a signed-in user's access token. It must include the scope aws.cognito.signin.user.admin.

* *

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For * this operation, you can't use IAM credentials to authorize requests, and you can't * grant IAM permissions in policies. For more information about authorization models in * Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CognitoIdentityProviderClient, GlobalSignOutCommand } from "@aws-sdk/client-cognito-identity-provider"; // ES Modules import * // const { CognitoIdentityProviderClient, GlobalSignOutCommand } = 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 = { // GlobalSignOutRequest * AccessToken: "STRING_VALUE", // required * }; * const command = new GlobalSignOutCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param GlobalSignOutCommandInput - {@link GlobalSignOutCommandInput} * @returns {@link GlobalSignOutCommandOutput} * @see {@link GlobalSignOutCommandInput} for command's `input` shape. * @see {@link GlobalSignOutCommandOutput} for command's `response` shape. * @see {@link CognitoIdentityProviderClientResolvedConfig | config} for CognitoIdentityProviderClient's `config` shape. * * @throws {@link ForbiddenException} (client fault) *

This exception is thrown when WAF doesn't allow your request based on a web * ACL that's associated with your user pool.

* * @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 PasswordResetRequiredException} (client fault) *

This exception is thrown when a password reset is required.

* * @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 UserNotConfirmedException} (client fault) *

This exception is thrown when a user isn't confirmed successfully.

* * @throws {@link CognitoIdentityProviderServiceException} *

Base exception class for all service exceptions from CognitoIdentityProvider service.

* * * @public */ export declare class GlobalSignOutCommand extends GlobalSignOutCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GlobalSignOutRequest; output: {}; }; sdk: { input: GlobalSignOutCommandInput; output: GlobalSignOutCommandOutput; }; }; }