PaymentCryptographyControlPlane / Client / restore_key

restore_key#

PaymentCryptographyControlPlane.Client.restore_key(**kwargs)#

Cancels a scheduled key deletion during the waiting period. Use this operation to restore a Key that is scheduled for deletion.

During the waiting period, the KeyState is DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key will be deleted. After Key is restored, the KeyState is CREATE_COMPLETE, and the value for deletePendingTimestamp is removed.

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

Related operations:

See also: AWS API Documentation

Request Syntax

response = client.restore_key(
    KeyIdentifier='string'
)
Parameters:

KeyIdentifier (string) –

[REQUIRED]

The KeyARN of the key to be restored within Amazon Web Services Payment Cryptography.

Return type:

dict

Returns:

Response Syntax

{
    'Key': {
        'KeyArn': 'string',
        'KeyAttributes': {
            'KeyUsage': 'TR31_B0_BASE_DERIVATION_KEY'|'TR31_C0_CARD_VERIFICATION_KEY'|'TR31_D0_SYMMETRIC_DATA_ENCRYPTION_KEY'|'TR31_D1_ASYMMETRIC_KEY_FOR_DATA_ENCRYPTION'|'TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS'|'TR31_E1_EMV_MKEY_CONFIDENTIALITY'|'TR31_E2_EMV_MKEY_INTEGRITY'|'TR31_E4_EMV_MKEY_DYNAMIC_NUMBERS'|'TR31_E5_EMV_MKEY_CARD_PERSONALIZATION'|'TR31_E6_EMV_MKEY_OTHER'|'TR31_K0_KEY_ENCRYPTION_KEY'|'TR31_K1_KEY_BLOCK_PROTECTION_KEY'|'TR31_K3_ASYMMETRIC_KEY_FOR_KEY_AGREEMENT'|'TR31_M3_ISO_9797_3_MAC_KEY'|'TR31_M1_ISO_9797_1_MAC_KEY'|'TR31_M6_ISO_9797_5_CMAC_KEY'|'TR31_M7_HMAC_KEY'|'TR31_P0_PIN_ENCRYPTION_KEY'|'TR31_P1_PIN_GENERATION_KEY'|'TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE'|'TR31_V1_IBM3624_PIN_VERIFICATION_KEY'|'TR31_V2_VISA_PIN_VERIFICATION_KEY'|'TR31_K2_TR34_ASYMMETRIC_KEY',
            'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
            'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
            'KeyModesOfUse': {
                'Encrypt': True|False,
                'Decrypt': True|False,
                'Wrap': True|False,
                'Unwrap': True|False,
                'Generate': True|False,
                'Sign': True|False,
                'Verify': True|False,
                'DeriveKey': True|False,
                'NoRestrictions': True|False
            }
        },
        'KeyCheckValue': 'string',
        'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24',
        'Enabled': True|False,
        'Exportable': True|False,
        'KeyState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_COMPLETE',
        'KeyOrigin': 'EXTERNAL'|'AWS_PAYMENT_CRYPTOGRAPHY',
        'CreateTimestamp': datetime(2015, 1, 1),
        'UsageStartTimestamp': datetime(2015, 1, 1),
        'UsageStopTimestamp': datetime(2015, 1, 1),
        'DeletePendingTimestamp': datetime(2015, 1, 1),
        'DeleteTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • Key (dict) –

      The key material of the restored key. The KeyState will change to CREATE_COMPLETE and value for DeletePendingTimestamp gets removed.

      • KeyArn (string) –

        The Amazon Resource Name (ARN) of the key.

      • KeyAttributes (dict) –

        The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.

        • KeyUsage (string) –

          The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.

        • KeyClass (string) –

          The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.

        • KeyAlgorithm (string) –

          The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.

          For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.

        • KeyModesOfUse (dict) –

          The list of cryptographic operations that you can perform using the key.

          • Encrypt (boolean) –

            Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.

          • Decrypt (boolean) –

            Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.

          • Wrap (boolean) –

            Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.

          • Unwrap (boolean) –

            Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.

          • Generate (boolean) –

            Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.

          • Sign (boolean) –

            Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.

          • Verify (boolean) –

            Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.

          • DeriveKey (boolean) –

            Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.

          • NoRestrictions (boolean) –

            Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.

      • KeyCheckValue (string) –

        The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      • KeyCheckValueAlgorithm (string) –

        The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

        For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

      • Enabled (boolean) –

        Specifies whether the key is enabled.

      • Exportable (boolean) –

        Specifies whether the key is exportable. This data is immutable after the key is created.

      • KeyState (string) –

        The state of key that is being created or deleted.

      • KeyOrigin (string) –

        The source of the key material. For keys created within Amazon Web Services Payment Cryptography, the value is AWS_PAYMENT_CRYPTOGRAPHY. For keys imported into Amazon Web Services Payment Cryptography, the value is EXTERNAL.

      • CreateTimestamp (datetime) –

        The date and time when the key was created.

      • UsageStartTimestamp (datetime) –

        The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.

      • UsageStopTimestamp (datetime) –

        The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.

      • DeletePendingTimestamp (datetime) –

        The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when KeyState is DELETE_PENDING and the key is scheduled for deletion.

      • DeleteTimestamp (datetime) –

        The date and time after which Amazon Web Services Payment Cryptography will delete the key. This value is present only when when the KeyState is DELETE_COMPLETE and the Amazon Web Services Payment Cryptography key is deleted.

Exceptions

  • PaymentCryptographyControlPlane.Client.exceptions.ServiceQuotaExceededException

  • 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