import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { UpdateKeyDescriptionRequest } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link UpdateKeyDescriptionCommand}. */ export interface UpdateKeyDescriptionCommandInput extends UpdateKeyDescriptionRequest { } /** * @public * * The output of {@link UpdateKeyDescriptionCommand}. */ export interface UpdateKeyDescriptionCommandOutput extends __MetadataBearer { } declare const UpdateKeyDescriptionCommand_base: { new (input: UpdateKeyDescriptionCommandInput): import("@smithy/core/client").CommandImpl; new (input: UpdateKeyDescriptionCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.

*

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:UpdateKeyDescription (key policy)

*

* Related operations *

* *

* 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, UpdateKeyDescriptionCommand } from "@aws-sdk/client-kms"; // ES Modules import * // const { KMSClient, UpdateKeyDescriptionCommand } = 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 = { // UpdateKeyDescriptionRequest * KeyId: "STRING_VALUE", // required * Description: "STRING_VALUE", // required * }; * const command = new UpdateKeyDescriptionCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param UpdateKeyDescriptionCommandInput - {@link UpdateKeyDescriptionCommandInput} * @returns {@link UpdateKeyDescriptionCommandOutput} * @see {@link UpdateKeyDescriptionCommandInput} for command's `input` shape. * @see {@link UpdateKeyDescriptionCommandOutput} 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 update the description of a KMS key * ```javascript * // The following example updates the description of the specified KMS key. * const input = { * Description: "Example description that indicates the intended use of this KMS key.", * KeyId: "1234abcd-12ab-34cd-56ef-1234567890ab" * }; * const command = new UpdateKeyDescriptionCommand(input); * const response = await client.send(command); * /* response is * { /* metadata only *\/ } * *\/ * ``` * * @public */ export declare class UpdateKeyDescriptionCommand extends UpdateKeyDescriptionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateKeyDescriptionRequest; output: {}; }; sdk: { input: UpdateKeyDescriptionCommandInput; output: UpdateKeyDescriptionCommandOutput; }; }; }