PaymentCryptographyControlPlane / Client / delete_alias
delete_alias#
- PaymentCryptographyControlPlane.Client.delete_alias(**kwargs)#
Deletes the alias, but doesn’t affect the underlying key.
Each key can have multiple aliases. To get the aliases of all keys, use the ListAliases operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias.
Cross-account use: This operation can’t be used across different Amazon Web Services accounts.
Related operations:
CreateAlias
GetAlias
ListAliases
UpdateAlias
See also: AWS API Documentation
Request Syntax
response = client.delete_alias( AliasName='string' )
- Parameters:
AliasName (string) –
[REQUIRED]
A friendly name that you can use to refer Amazon Web Services Payment Cryptography key. This value must begin with
alias/
followed by a name, such asalias/ExampleAlias
.- Return type:
dict
- Returns:
Response Syntax
{}
Response Structure
(dict) –
Exceptions
PaymentCryptographyControlPlane.Client.exceptions.ServiceUnavailableException
PaymentCryptographyControlPlane.Client.exceptions.ValidationException
PaymentCryptographyControlPlane.Client.exceptions.ConflictException
PaymentCryptographyControlPlane.Client.exceptions.AccessDeniedException
PaymentCryptographyControlPlane.Client.exceptions.ResourceNotFoundException
PaymentCryptographyControlPlane.Client.exceptions.ThrottlingException
PaymentCryptographyControlPlane.Client.exceptions.InternalServerException