import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DisableKeyRotationRequest } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DisableKeyRotationCommand}. */ export interface DisableKeyRotationCommandInput extends DisableKeyRotationRequest { } /** * @public * * The output of {@link DisableKeyRotationCommand}. */ export interface DisableKeyRotationCommandOutput extends __MetadataBearer { } declare const DisableKeyRotationCommand_base: { new (input: DisableKeyRotationCommandInput): import("@smithy/core/client").CommandImpl; new (input: DisableKeyRotationCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Disables automatic rotation of the key material of the specified symmetric encryption KMS * key.

Automatic key rotation is supported only on symmetric encryption KMS keys. * You cannot enable automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key.

You can enable (EnableKeyRotation) and disable automatic rotation of the * key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not * configurable. KMS always rotates the key material for every year. Rotation of Amazon Web Services owned KMS * keys varies.

* *

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three * years to every year. For details, see EnableKeyRotation.

* *

The KMS key that you use for this operation must be in a compatible key state. For * details, 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:DisableKeyRotation (key policy)

* Related operations: *

*
* EnableKeyRotation *
*
*
* GetKeyRotationStatus *
*
*
* ListKeyRotations *
*
*
* RotateKeyOnDemand *
*

* 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, DisableKeyRotationCommand } from "@aws-sdk/client-kms"; // ES Modules import * // const { KMSClient, DisableKeyRotationCommand } = 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 = { // DisableKeyRotationRequest * KeyId: "STRING_VALUE", // required * }; * const command = new DisableKeyRotationCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param DisableKeyRotationCommandInput - {@link DisableKeyRotationCommandInput} * @returns {@link DisableKeyRotationCommandOutput} * @see {@link DisableKeyRotationCommandInput} for command's `input` shape. * @see {@link DisableKeyRotationCommandOutput} 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 DisabledException} (client fault) *

The request was rejected because the specified KMS key is not enabled.

* * @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:

*
The key state of the KMS key is not compatible with the operation.
*
To find the key state, use the DescribeKey operation. For more * information about which key states are compatible with each KMS operation, see * Key states of KMS keys in the * Key Management Service Developer Guide * .
*
*
For cryptographic operations on KMS keys in custom key stores, this exception * represents a general failure with many possible causes. To identify the cause, see the * error message that accompanies the exception.
*

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

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

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

The request was rejected because a specified parameter is not supported or a specified * resource is not valid for this operation.

* * @throws {@link KMSServiceException} *

Base exception class for all service exceptions from KMS service.

* * * @example To disable automatic rotation of key material * ```javascript * // The following example disables automatic annual rotation of the key material for the specified KMS key. * const input = { * KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab" * }; * const command = new DisableKeyRotationCommand(input); * const response = await client.send(command); * /* response is * { /* metadata only *\/ } * *\/ * ``` * * @public */ export declare class DisableKeyRotationCommand extends DisableKeyRotationCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DisableKeyRotationRequest; output: {}; }; sdk: { input: DisableKeyRotationCommandInput; output: DisableKeyRotationCommandOutput; }; }; }