import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DisableKeyRequest } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DisableKeyCommand}. */ export interface DisableKeyCommandInput extends DisableKeyRequest { } /** * @public * * The output of {@link DisableKeyCommand}. */ export interface DisableKeyCommandOutput extends __MetadataBearer { } declare const DisableKeyCommand_base: { new (input: DisableKeyCommandInput): import("@smithy/core/client").CommandImpl; new (input: DisableKeyCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS * key for cryptographic operations.

*

The KMS key that you use for this operation must be in a compatible key state. For more * information about how key state affects the use of a KMS key, see Key states of KMS keys in the * * Key Management Service Developer Guide * .

*

* Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

*

* Required permissions: kms:DisableKey (key policy)

*

* Related operations: EnableKey *

*

* Eventual consistency: The KMS API follows an eventual consistency model. * For more information, see KMS eventual consistency.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { KMSClient, DisableKeyCommand } from "@aws-sdk/client-kms"; // ES Modules import * // const { KMSClient, DisableKeyCommand } = require("@aws-sdk/client-kms"); // CommonJS import * // import type { KMSClientConfig } from "@aws-sdk/client-kms"; * const config = {}; // type is KMSClientConfig * const client = new KMSClient(config); * const input = { // DisableKeyRequest * KeyId: "STRING_VALUE", // required * }; * const command = new DisableKeyCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param DisableKeyCommandInput - {@link DisableKeyCommandInput} * @returns {@link DisableKeyCommandOutput} * @see {@link DisableKeyCommandInput} for command's `input` shape. * @see {@link DisableKeyCommandOutput} for command's `response` shape. * @see {@link KMSClientResolvedConfig | config} for KMSClient's `config` shape. * * @throws {@link DependencyTimeoutException} (server fault) *

The system timed out while trying to fulfill the request. You can retry the * request.

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

The request was rejected because a specified ARN, or an ARN in a key policy, is not * valid.

* * @throws {@link KMSInternalException} (server fault) *

The request was rejected because an internal exception occurred. The request can be * retried.

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

The request was rejected because the state of the specified resource is not valid for this * request.

*

This exceptions means one of the following:

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

The request was rejected because the specified entity or resource could not be * found.

* * @throws {@link KMSServiceException} *

Base exception class for all service exceptions from KMS service.

* * * @example To disable a KMS key * ```javascript * // The following example disables the specified KMS key. * const input = { * KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab" * }; * const command = new DisableKeyCommand(input); * const response = await client.send(command); * /* response is * { /* metadata only *\/ } * *\/ * ``` * * @public */ export declare class DisableKeyCommand extends DisableKeyCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DisableKeyRequest; output: {}; }; sdk: { input: DisableKeyCommandInput; output: DisableKeyCommandOutput; }; }; }