import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DeleteAliasRequest } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DeleteAliasCommand}. */ export interface DeleteAliasCommandInput extends DeleteAliasRequest { } /** * @public * * The output of {@link DeleteAliasCommand}. */ export interface DeleteAliasCommandOutput extends __MetadataBearer { } declare const DeleteAliasCommand_base: { new (input: DeleteAliasCommandInput): import("@smithy/core/client").CommandImpl; new (input: DeleteAliasCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Deletes the specified alias.

* *

Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see ABAC for KMS in the Key Management Service Developer Guide.

*
*

Because an alias is not a property of a KMS key, you can delete and change the aliases of * a KMS key without affecting the KMS key. Also, aliases do not appear in the response from the * DescribeKey operation. To get the aliases of all KMS keys, use the ListAliases operation.

*

Each KMS key can have multiple aliases. To change the alias of a KMS key, use DeleteAlias to delete the current alias and CreateAlias to * create a new alias. To associate an existing alias with a different KMS key, call UpdateAlias.

*

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

*

* Required permissions *

* *

For details, see Controlling access to aliases in the * Key Management Service Developer Guide.

*

* 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, DeleteAliasCommand } from "@aws-sdk/client-kms"; // ES Modules import * // const { KMSClient, DeleteAliasCommand } = 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 = { // DeleteAliasRequest * AliasName: "STRING_VALUE", // required * }; * const command = new DeleteAliasCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param DeleteAliasCommandInput - {@link DeleteAliasCommandInput} * @returns {@link DeleteAliasCommandOutput} * @see {@link DeleteAliasCommandInput} for command's `input` shape. * @see {@link DeleteAliasCommandOutput} 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 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 delete an alias * ```javascript * // The following example deletes the specified alias. * const input = { * AliasName: "alias/ExampleAlias" * }; * const command = new DeleteAliasCommand(input); * const response = await client.send(command); * /* response is * { /* metadata only *\/ } * *\/ * ``` * * @public */ export declare class DeleteAliasCommand extends DeleteAliasCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DeleteAliasRequest; output: {}; }; sdk: { input: DeleteAliasCommandInput; output: DeleteAliasCommandOutput; }; }; }