:doc:`PaymentCryptographyControlPlane <../../payment-cryptography>` / Client / delete_alias

************
delete_alias
************



.. py:method:: 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 `UpdateAlias <https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html>`__ operation. To change the alias of a key, first use `DeleteAlias <https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_DeleteAlias.html>`__ to delete the current alias and then use `CreateAlias <https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html>`__ to create a new alias. To associate an existing alias with a different key, call `UpdateAlias <https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html>`__.

   

  **Cross-account use:** This operation can't be used across different Amazon Web Services accounts.

   

  **Related operations:**

   

  
  * `CreateAlias <https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateAlias.html>`__
   
  * `GetAlias <https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetAlias.html>`__
   
  * `ListAliases <https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ListAliases.html>`__
   
  * `UpdateAlias <https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_UpdateAlias.html>`__
  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/payment-cryptography-2021-09-14/DeleteAlias>`_  


  **Request Syntax**
  ::

    response = client.delete_alias(
        AliasName='string'
    )
    
  :type AliasName: string
  :param AliasName: **[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 as ``alias/ExampleAlias``.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`PaymentCryptographyControlPlane.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`PaymentCryptographyControlPlane.Client.exceptions.ValidationException`

  
  *   :py:class:`PaymentCryptographyControlPlane.Client.exceptions.ConflictException`

  
  *   :py:class:`PaymentCryptographyControlPlane.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`PaymentCryptographyControlPlane.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`PaymentCryptographyControlPlane.Client.exceptions.ThrottlingException`

  
  *   :py:class:`PaymentCryptographyControlPlane.Client.exceptions.InternalServerException`

  