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.
An alias is not a property of a key. Therefore, an alias can be mapped to and unmapped from an existing key without changing the properties of the key.
An alias name can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). An alias must start with the word "alias" followed by a forward slash (alias/). An alias that begins with "aws" after the forward slash (alias/aws...) is reserved by Amazon Web Services (AWS).
The alias and the key it is mapped to must be in the same AWS account and the same region.
Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.dll
Version: (assembly version)
public abstract UpdateAliasResponse UpdateAlias( String aliasName, String targetKeyId )
String that contains the name of the alias to be modified. The name must start with the word "alias" followed by a forward slash (alias/). Aliases that begin with "alias/aws" are reserved.
Unique identifier of the customer master key to be mapped to the alias. This value can be a globally unique identifier or the fully specified ARN of a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 You can call ListAliases to verify that the alias is mapped to the correct TargetKeyId.
Exception | Condition |
---|---|
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 customer master key (CMK), go to How Key State Affects the 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. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5