PaymentCryptographyControlPlane / Client / update_alias

update_alias#

PaymentCryptographyControlPlane.Client.update_alias(**kwargs)#

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

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

Related operations:

  • CreateAlias

  • DeleteAlias

  • GetAlias

  • ListAliases

See also: AWS API Documentation

Request Syntax

response = client.update_alias(
    AliasName='string',
    KeyArn='string'
)
Parameters:

  • AliasName (string) –

    [REQUIRED]

    The alias whose associated key is changing.

  • KeyArn (string) – The KeyARN for the key that you are updating or removing from the alias.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Alias (dict) –

      The alias name.

      • AliasName (string) –

        A friendly name that you can use to refer to a key. The value must begin with alias/.

        Warning

        Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

      • KeyArn (string) –

        The KeyARN of the key associated with the alias.

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