UpdateAlias - AWS Payment Cryptography Control Plane


Associates an existing AWS Payment Cryptography alias with a different key. Each alias is associated with only one AWS Payment Cryptography key at a time, although a key can have multiple aliases. The alias and the AWS Payment Cryptography key must be in the same AWS account and AWS Region

Cross-account use: This operation can't be used across different AWS accounts.

Related operations:

Request Syntax

{ "AliasName": "string", "KeyArn": "string" }

Request Parameters

The request accepts the following data in JSON format.


The alias whose associated key is changing.

Type: String

Length Constraints: Minimum length of 7. Maximum length of 256.

Pattern: alias/[a-zA-Z0-9/_-]+

Required: Yes


The KeyARN for the key that you are updating or removing from the alias.

Type: String

Length Constraints: Minimum length of 70. Maximum length of 150.

Pattern: arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}

Required: No

Response Syntax

{ "Alias": { "AliasName": "string", "KeyArn": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The alias name.

Type: Alias object



You do not have sufficient access to perform this action.

HTTP Status Code: 400


This request can cause an inconsistent state for the resource.

HTTP Status Code: 400


The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500


The request was denied due to an invalid resource error.

HTTP Status Code: 400


The service cannot complete the request.

HTTP Status Code: 500


The request was denied due to request throttling.

HTTP Status Code: 400


The request was denied due to an invalid request error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: