PaymentCryptographyControlPlane / Client / list_keys

list_keys

PaymentCryptographyControlPlane.Client.list_keys(**kwargs)

Lists the keys in the caller’s Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys.

This is a paginated operation, which means that each response might contain only a subset of all the keys. When the response contains only a subset of keys, it includes a NextToken value. Use this value in a subsequent ListKeys request to get more keys. When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.

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

Related operations:

• CreateKey

• DeleteKey

• GetKey

See also: AWS API Documentation

Request Syntax

response = client.list_keys(
    KeyState='CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_COMPLETE',
    MaxResults=123,
    NextToken='string'
)

Parameters:

• KeyState (string) – The key state of the keys you want to list.

• MaxResults (integer) – Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.

• NextToken (string) – Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the truncated response you just received.

Return type:

dict

Returns:

Response Syntax

{
    'Keys': [
        {
            'Enabled': True|False,
            'Exportable': True|False,
            'KeyArn': 'string',
            'KeyAttributes': {
                'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'RSA_2048'|'RSA_3072'|'RSA_4096',
                'KeyClass': 'SYMMETRIC_KEY'|'ASYMMETRIC_KEY_PAIR'|'PRIVATE_KEY'|'PUBLIC_KEY',
                'KeyModesOfUse': {
                    'Decrypt': True|False,
                    'DeriveKey': True|False,
                    'Encrypt': True|False,
                    'Generate': True|False,
                    'NoRestrictions': True|False,
                    'Sign': True|False,
                    'Unwrap': True|False,
                    'Verify': True|False,
                    'Wrap': True|False
                },
                '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_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'
            },
            'KeyCheckValue': 'string',
            'KeyState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'DELETE_PENDING'|'DELETE_COMPLETE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Keys (list) –

    The list of keys created within the caller’s Amazon Web Services account and Amazon Web Services Region.

    • (dict) –

      Metadata about an Amazon Web Services Payment Cryptography key.

      • 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.

      • 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.

        • 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.

        • 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.

        • KeyModesOfUse (dict) –

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

          • Decrypt (boolean) –

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

          • DeriveKey (boolean) –

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

          • Encrypt (boolean) –

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

          • Generate (boolean) –

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

          • NoRestrictions (boolean) –

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

          • Sign (boolean) –

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

          • Unwrap (boolean) –

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

          • Verify (boolean) –

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

          • Wrap (boolean) –

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

        • 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.

      • 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. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or “00” or “01” and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.

      • KeyState (string) –

        The state of an Amazon Web Services Payment Cryptography that is being created or deleted.

  • NextToken (string) –

    The token for the next set of results, or an empty or null value if there are no more results.

Exceptions

• PaymentCryptographyControlPlane.Client.exceptions.ServiceUnavailableException

• PaymentCryptographyControlPlane.Client.exceptions.ValidationException

• PaymentCryptographyControlPlane.Client.exceptions.AccessDeniedException

• PaymentCryptographyControlPlane.Client.exceptions.ResourceNotFoundException

• PaymentCryptographyControlPlane.Client.exceptions.ThrottlingException

• PaymentCryptographyControlPlane.Client.exceptions.InternalServerException