AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Deletes the specified alias. To map an alias to a different key, call UpdateAlias.

Note:

For PCL this operation is only available in asynchronous form. Please refer to DeleteAliasAsync.

Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z

Syntax

C#
public abstract DeleteAliasResponse DeleteAlias(
         DeleteAliasRequest request
)
Parameters
request
Type: Amazon.KeyManagementService.Model.DeleteAliasRequest

Container for the necessary parameters to execute the DeleteAlias service method.

Return Value
The response from the DeleteAlias service method, as returned by KeyManagementService.

Exceptions

ExceptionCondition
DependencyTimeoutException The system timed out while trying to fulfill the request. The request can be retried.
KMSInternalException The request was rejected because an internal exception occurred. The request can be retried.
KMSInvalidStateException The request was rejected because the state of the specified resource is not valid for this request. For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
NotFoundException The request was rejected because the specified entity or resource could not be found.

Examples

The following example deletes the specified alias.

To delete an alias


var response = client.DeleteAlias(new DeleteAliasRequest 
{
    AliasName = "alias/ExampleAlias" // The alias to delete.
});


            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also