AWS SDK for PHP 3.x

Client: Aws\PaymentCryptography\PaymentCryptographyClient

Service ID: payment-cryptography

Version: 2021-09-14

This page describes the parameters and results for the operations of the Payment Cryptography Control Plane (2021-09-14), and shows how to use the Aws\PaymentCryptography\PaymentCryptographyClient object to call the described operations. This documentation is specific to the 2021-09-14 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateAlias ( array $params = [] )
Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key.
CreateKey ( array $params = [] )
Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region.
DeleteAlias ( array $params = [] )
Deletes the alias, but doesn't affect the underlying key.
DeleteKey ( array $params = [] )
Deletes the key material and all metadata associated with Amazon Web Services Payment Cryptography key.
ExportKey ( array $params = [] )
Exports a key from Amazon Web Services Payment Cryptography using either ANSI X9 TR-34 or TR-31 key export standard.
GetAlias ( array $params = [] )
Gets the Amazon Web Services Payment Cryptography key associated with the alias.
GetKey ( array $params = [] )
Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
GetParametersForExport ( array $params = [] )
Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
GetParametersForImport ( array $params = [] )
Gets the import token and the wrapping key certificate to initiate a TR-34 key import into Amazon Web Services Payment Cryptography.
GetPublicKeyCertificate ( array $params = [] )
Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography.
ImportKey ( array $params = [] )
Imports keys and public key certificates into Amazon Web Services Payment Cryptography.
ListAliases ( array $params = [] )
Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region.
ListKeys ( array $params = [] )
Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region.
ListTagsForResource ( array $params = [] )
Lists the tags for an Amazon Web Services resource.
RestoreKey ( array $params = [] )
Cancels a scheduled key deletion during the waiting period.
StartKeyUsage ( array $params = [] )
Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography Cross-account use: This operation can't be used across different Amazon Web Services accounts.
StopKeyUsage ( array $params = [] )
Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
TagResource ( array $params = [] )
Adds or edits tags on an Amazon Web Services Payment Cryptography key.
UntagResource ( array $params = [] )
Deletes a tag from an Amazon Web Services Payment Cryptography key.
UpdateAlias ( array $params = [] )
Associates an existing Amazon Web Services Payment Cryptography alias with a different key.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAliases
ListKeys
ListTagsForResource

Operations

CreateAlias

$result = $client->createAlias([/* ... */]);
$promise = $client->createAliasAsync([/* ... */]);

Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key. You can use an alias to identify a key in the console and when you call cryptographic operations such as EncryptData or DecryptData.

You can associate the alias with any key in the same Amazon Web Services Region. Each alias is associated with only one key at a time, but a key can have multiple aliases. You can't create an alias without a key. The alias must be unique in the account and Amazon Web Services Region, but you can create another alias with the same name in a different Amazon Web Services Region.

To change the key that's associated with the alias, call UpdateAlias. To delete the alias, call DeleteAlias. These operations don't affect the underlying key. To get the alias that you created, call ListAliases.

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

Related operations:

DeleteAlias
GetAlias
ListAliases
UpdateAlias

Parameter Syntax

$result = $client->createAlias([
    'AliasName' => '<string>', // REQUIRED
    'KeyArn' => '<string>',
]);

Parameter Details

Members

AliasName

Required: Yes
Type: string

A friendly name that you can use to refer a key. An alias must begin with alias/ followed by a name, for example alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-).

Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

KeyArn

Type: string

The KeyARN of the key to associate with the alias.

Result Syntax

[
    'Alias' => [
        'AliasName' => '<string>',
        'KeyArn' => '<string>',
    ],
]

Result Details

Members

Alias

Required: Yes
Type: Alias structure

The alias for the key.

Errors

ServiceQuotaExceededException:
This request would cause a service quota to be exceeded.
ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
ConflictException:
This request can cause an inconsistent state for the resource.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

CreateKey

$result = $client->createKey([/* ... */]);
$promise = $client->createKeyAsync([/* ... */]);

Creates an Amazon Web Services Payment Cryptography key, a logical representation of a cryptographic key, that is unique in your account and Amazon Web Services Region. You use keys for cryptographic functions such as encryption and decryption.

In addition to the key material used in cryptographic operations, an Amazon Web Services Payment Cryptography key includes metadata such as the key ARN, key usage, key origin, creation date, description, and key state.

When you create a key, you specify both immutable and mutable data about the key. The immutable data contains key attributes that defines the scope and cryptographic operations that you can perform using the key, for example key class (example: SYMMETRIC_KEY), key algorithm (example: TDES_2KEY), key usage (example: TR31_P0_PIN_ENCRYPTION_KEY) and key modes of use (example: Encrypt). For information about valid combinations of key attributes, see Understanding key attributes in the Amazon Web Services Payment Cryptography User Guide. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.

Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear.

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

Related operations:

DeleteKey
GetKey
ListKeys

Parameter Syntax

$result = $client->createKey([
    'Enabled' => true || false,
    'Exportable' => true || false, // REQUIRED
    'KeyAttributes' => [ // REQUIRED
        'KeyAlgorithm' => 'TDES_2KEY|TDES_3KEY|AES_128|AES_192|AES_256|RSA_2048|RSA_3072|RSA_4096', // REQUIRED
        'KeyClass' => 'SYMMETRIC_KEY|ASYMMETRIC_KEY_PAIR|PRIVATE_KEY|PUBLIC_KEY', // REQUIRED
        'KeyModesOfUse' => [ // REQUIRED
            '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', // REQUIRED
    ],
    'KeyCheckValueAlgorithm' => 'CMAC|ANSI_X9_24',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

Enabled

Type: boolean

Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled.

Exportable

Required: Yes
Type: boolean

Specifies whether the key is exportable from the service.

KeyAttributes

Required: Yes
Type: KeyAttributes structure

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.

KeyCheckValueAlgorithm

Type: string

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.

For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.

Tags

Type: Array of Tag structures

The tags to attach to the key. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

To use this parameter, you must have TagResource permission.

Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

Result Syntax

[
    'Key' => [
        'CreateTimestamp' => <DateTime>,
        'DeletePendingTimestamp' => <DateTime>,
        'DeleteTimestamp' => <DateTime>,
        '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>',
        'KeyCheckValueAlgorithm' => 'CMAC|ANSI_X9_24',
        'KeyOrigin' => 'EXTERNAL|AWS_PAYMENT_CRYPTOGRAPHY',
        'KeyState' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|DELETE_PENDING|DELETE_COMPLETE',
        'UsageStartTimestamp' => <DateTime>,
        'UsageStopTimestamp' => <DateTime>,
    ],
]

Result Details

Members

Key

Required: Yes
Type: Key structure

The key material that contains all the key attributes.

Errors

ServiceQuotaExceededException:
This request would cause a service quota to be exceeded.
ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
ConflictException:
This request can cause an inconsistent state for the resource.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

DeleteAlias

$result = $client->deleteAlias([/* ... */]);
$promise = $client->deleteAliasAsync([/* ... */]);

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

Parameter Syntax

$result = $client->deleteAlias([
    'AliasName' => '<string>', // REQUIRED
]);

Parameter Details

Members

AliasName

Required: Yes
Type: string

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
ConflictException:
This request can cause an inconsistent state for the resource.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

DeleteKey

$result = $client->deleteKey([/* ... */]);
$promise = $client->deleteKeyAsync([/* ... */]);

Deletes the key material and all metadata associated with Amazon Web Services Payment Cryptography key.

Key deletion is irreversible. After a key is deleted, you can't perform cryptographic operations using the key. For example, you can't decrypt data that was encrypted by a deleted Amazon Web Services Payment Cryptography key, and the data may become unrecoverable. Because key deletion is destructive, Amazon Web Services Payment Cryptography has a safety mechanism to prevent accidental deletion of a key. When you call this operation, Amazon Web Services Payment Cryptography disables the specified key but doesn't delete it until after a waiting period. The default waiting period is 7 days. To set a different waiting period, set DeleteKeyInDays. During the waiting period, the KeyState is DELETE_PENDING. After the key is deleted, the KeyState is DELETE_COMPLETE.

If you delete key material, you can use ImportKey to reimport the same key material into the Amazon Web Services Payment Cryptography key.

You should delete a key only when you are sure that you don't need to use it anymore and no other parties are utilizing this key. If you aren't sure, consider deactivating it instead by calling StopKeyUsage.

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

Related operations:

RestoreKey
StartKeyUsage
StopKeyUsage

Parameter Syntax

$result = $client->deleteKey([
    'DeleteKeyInDays' => <integer>,
    'KeyIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

DeleteKeyInDays

Type: int

The waiting period for key deletion. The default value is seven days.

KeyIdentifier

Required: Yes
Type: string

The KeyARN of the key that is scheduled for deletion.

Result Syntax

[
    'Key' => [
        'CreateTimestamp' => <DateTime>,
        'DeletePendingTimestamp' => <DateTime>,
        'DeleteTimestamp' => <DateTime>,
        '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>',
        'KeyCheckValueAlgorithm' => 'CMAC|ANSI_X9_24',
        'KeyOrigin' => 'EXTERNAL|AWS_PAYMENT_CRYPTOGRAPHY',
        'KeyState' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|DELETE_PENDING|DELETE_COMPLETE',
        'UsageStartTimestamp' => <DateTime>,
        'UsageStopTimestamp' => <DateTime>,
    ],
]

Result Details

Members

Key

Required: Yes
Type: Key structure

The KeyARN of the key that is scheduled for deletion.

Errors

ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
ConflictException:
This request can cause an inconsistent state for the resource.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

ExportKey

$result = $client->exportKey([/* ... */]);
$promise = $client->exportKeyAsync([/* ... */]);

Exports a key from Amazon Web Services Payment Cryptography using either ANSI X9 TR-34 or TR-31 key export standard.

Amazon Web Services Payment Cryptography simplifies main or root key exchange process by eliminating the need of a paper-based key exchange process. It takes a modern and secure approach based of the ANSI X9 TR-34 key exchange standard.

You can use ExportKey to export main or root keys such as KEK (Key Encryption Key), using asymmetric key exchange technique following ANSI X9 TR-34 standard. The ANSI X9 TR-34 standard uses asymmetric keys to establishes bi-directional trust between the two parties exchanging keys. After which you can export working keys using the ANSI X9 TR-31 symmetric key exchange standard as mandated by PCI PIN. Using this operation, you can share your Amazon Web Services Payment Cryptography generated keys with other service partners to perform cryptographic operations outside of Amazon Web Services Payment Cryptography

TR-34 key export

Amazon Web Services Payment Cryptography uses TR-34 asymmetric key exchange standard to export main keys such as KEK. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Host (KRH). In key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export. KRH is the user receiving the key. Before you initiate TR-34 key export, you must obtain an export token by calling GetParametersForExport. This operation also returns the signing key certificate that KDH uses to sign the wrapped key to generate a TR-34 wrapped key block. The export token expires after 7 days.

Set the following parameters:

CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that will sign the wrapping key certificate. This must exist within Amazon Web Services Payment Cryptography before you initiate TR-34 key export. If it does not exist, you can import it by calling ImportKey for RootCertificatePublicKey.
ExportToken: Obtained from KDH by calling GetParametersForExport.
WrappingKeyCertificate: Amazon Web Services Payment Cryptography uses this to wrap the key under export.

When this operation is successful, Amazon Web Services Payment Cryptography returns the TR-34 wrapped key block.

TR-31 key export

Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange standard to export working keys. In TR-31, you must use a main key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use CreateKey or ImportKey. When this operation is successful, Amazon Web Services Payment Cryptography returns a TR-31 wrapped key block.

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

Related operations:

GetParametersForExport
ImportKey

Parameter Syntax

$result = $client->exportKey([
    'ExportKeyIdentifier' => '<string>', // REQUIRED
    'KeyMaterial' => [ // REQUIRED
        'Tr31KeyBlock' => [
            'WrappingKeyIdentifier' => '<string>', // REQUIRED
        ],
        'Tr34KeyBlock' => [
            'CertificateAuthorityPublicKeyIdentifier' => '<string>', // REQUIRED
            'ExportToken' => '<string>', // REQUIRED
            'KeyBlockFormat' => 'X9_TR34_2012', // REQUIRED
            'RandomNonce' => '<string>',
            'WrappingKeyCertificate' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Members

ExportKeyIdentifier

Required: Yes
Type: string

The KeyARN of the key under export from Amazon Web Services Payment Cryptography.

KeyMaterial

Required: Yes
Type: ExportKeyMaterial structure

The key block format type, for example, TR-34 or TR-31, to use during key material export.

Result Syntax

[
    'WrappedKey' => [
        'KeyMaterial' => '<string>',
        'WrappedKeyMaterialFormat' => 'KEY_CRYPTOGRAM|TR31_KEY_BLOCK|TR34_KEY_BLOCK',
        'WrappingKeyArn' => '<string>',
    ],
]

Result Details

Members

WrappedKey

Type: WrappedKey structure

The key material under export as a TR-34 or TR-31 wrapped key block.

Errors

ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
ConflictException:
This request can cause an inconsistent state for the resource.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

GetAlias

$result = $client->getAlias([/* ... */]);
$promise = $client->getAliasAsync([/* ... */]);

Gets the Amazon Web Services Payment Cryptography key associated with the alias.

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

Related operations:

CreateAlias
DeleteAlias
ListAliases
UpdateAlias

Parameter Syntax

$result = $client->getAlias([
    'AliasName' => '<string>', // REQUIRED
]);

Parameter Details

Members

AliasName

Required: Yes
Type: string

The alias of the Amazon Web Services Payment Cryptography key.

Result Syntax

[
    'Alias' => [
        'AliasName' => '<string>',
        'KeyArn' => '<string>',
    ],
]

Result Details

Members

Alias

Required: Yes
Type: Alias structure

The alias of the Amazon Web Services Payment Cryptography key.

Errors

ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

GetKey

$result = $client->getKey([/* ... */]);
$promise = $client->getKeyAsync([/* ... */]);

Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.

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

Related operations:

CreateKey
DeleteKey
ListKeys

Parameter Syntax

$result = $client->getKey([
    'KeyIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

KeyIdentifier

Required: Yes
Type: string

The KeyARN of the Amazon Web Services Payment Cryptography key.

Result Syntax

[
    'Key' => [
        'CreateTimestamp' => <DateTime>,
        'DeletePendingTimestamp' => <DateTime>,
        'DeleteTimestamp' => <DateTime>,
        '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>',
        'KeyCheckValueAlgorithm' => 'CMAC|ANSI_X9_24',
        'KeyOrigin' => 'EXTERNAL|AWS_PAYMENT_CRYPTOGRAPHY',
        'KeyState' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|DELETE_PENDING|DELETE_COMPLETE',
        'UsageStartTimestamp' => <DateTime>,
        'UsageStopTimestamp' => <DateTime>,
    ],
]

Result Details

Members

Key

Required: Yes
Type: Key structure

The key material, including the immutable and mutable data for the key.

Errors

ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

GetParametersForExport

$result = $client->getParametersForExport([/* ... */]);
$promise = $client->getParametersForExportAsync([/* ... */]);

Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.

The signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling ExportKey. The export token expires in 7 days. You can use the same export token to export multiple keys from your service account.

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

Related operations:

ExportKey
GetParametersForImport

Parameter Syntax

$result = $client->getParametersForExport([
    'KeyMaterialType' => 'TR34_KEY_BLOCK|TR31_KEY_BLOCK|ROOT_PUBLIC_KEY_CERTIFICATE|TRUSTED_PUBLIC_KEY_CERTIFICATE', // REQUIRED
    'SigningKeyAlgorithm' => 'TDES_2KEY|TDES_3KEY|AES_128|AES_192|AES_256|RSA_2048|RSA_3072|RSA_4096', // REQUIRED
]);

Parameter Details

Members

KeyMaterialType

Required: Yes
Type: string

The key block format type (for example, TR-34 or TR-31) to use during key material export. Export token is only required for a TR-34 key export, TR34_KEY_BLOCK. Export token is not required for TR-31 key export.

SigningKeyAlgorithm

Required: Yes
Type: string

The signing key algorithm to generate a signing key certificate. This certificate signs the wrapped key under export within the TR-34 key block cryptogram. RSA_2048 is the only signing key algorithm allowed.

Result Syntax

[
    'ExportToken' => '<string>',
    'ParametersValidUntilTimestamp' => <DateTime>,
    'SigningKeyAlgorithm' => 'TDES_2KEY|TDES_3KEY|AES_128|AES_192|AES_256|RSA_2048|RSA_3072|RSA_4096',
    'SigningKeyCertificate' => '<string>',
    'SigningKeyCertificateChain' => '<string>',
]

Result Details

Members

ExportToken

Required: Yes
Type: string

The export token to initiate key export from Amazon Web Services Payment Cryptography. The export token expires after 7 days. You can use the same export token to export multiple keys from the same service account.

ParametersValidUntilTimestamp

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The validity period of the export token.

SigningKeyAlgorithm

Required: Yes
Type: string

The algorithm of the signing key certificate for use in TR-34 key block generation. RSA_2048 is the only signing key algorithm allowed.

SigningKeyCertificate

Required: Yes
Type: string

The signing key certificate of the public key for signature within the TR-34 key block cryptogram. The certificate expires after 7 days.

SigningKeyCertificateChain

Required: Yes
Type: string

The certificate chain that signed the signing key certificate. This is the root certificate authority (CA) within your service account.

Errors

ServiceQuotaExceededException:
This request would cause a service quota to be exceeded.
ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
ConflictException:
This request can cause an inconsistent state for the resource.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

GetParametersForImport

$result = $client->getParametersForImport([/* ... */]);
$promise = $client->getParametersForImportAsync([/* ... */]);

Gets the import token and the wrapping key certificate to initiate a TR-34 key import into Amazon Web Services Payment Cryptography.

The wrapping key certificate wraps the key under import within the TR-34 key payload. The import token and wrapping key certificate must be in place and operational before calling ImportKey. The import token expires in 7 days. The same import token can be used to import multiple keys into your service account.

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

Related operations:

GetParametersForExport
ImportKey

Parameter Syntax

$result = $client->getParametersForImport([
    'KeyMaterialType' => 'TR34_KEY_BLOCK|TR31_KEY_BLOCK|ROOT_PUBLIC_KEY_CERTIFICATE|TRUSTED_PUBLIC_KEY_CERTIFICATE', // REQUIRED
    'WrappingKeyAlgorithm' => 'TDES_2KEY|TDES_3KEY|AES_128|AES_192|AES_256|RSA_2048|RSA_3072|RSA_4096', // REQUIRED
]);

Parameter Details

Members

KeyMaterialType

Required: Yes
Type: string

The key block format type such as TR-34 or TR-31 to use during key material import. Import token is only required for TR-34 key import TR34_KEY_BLOCK. Import token is not required for TR-31 key import.

WrappingKeyAlgorithm

Required: Yes
Type: string

The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import within the TR-34 key block cryptogram. RSA_2048 is the only wrapping key algorithm allowed.

Result Syntax

[
    'ImportToken' => '<string>',
    'ParametersValidUntilTimestamp' => <DateTime>,
    'WrappingKeyAlgorithm' => 'TDES_2KEY|TDES_3KEY|AES_128|AES_192|AES_256|RSA_2048|RSA_3072|RSA_4096',
    'WrappingKeyCertificate' => '<string>',
    'WrappingKeyCertificateChain' => '<string>',
]

Result Details

Members

ImportToken

Required: Yes
Type: string

The import token to initiate key import into Amazon Web Services Payment Cryptography. The import token expires after 7 days. You can use the same import token to import multiple keys to the same service account.

ParametersValidUntilTimestamp

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The validity period of the import token.

WrappingKeyAlgorithm

Required: Yes
Type: string

The algorithm of the wrapping key for use within TR-34 key block. RSA_2048 is the only wrapping key algorithm allowed.

WrappingKeyCertificate

Required: Yes
Type: string

The wrapping key certificate of the wrapping key for use within the TR-34 key block. The certificate expires in 7 days.

WrappingKeyCertificateChain

Required: Yes
Type: string

The Amazon Web Services Payment Cryptography certificate chain that signed the wrapping key certificate. This is the root certificate authority (CA) within your service account.

Errors

ServiceQuotaExceededException:
This request would cause a service quota to be exceeded.
ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
ConflictException:
This request can cause an inconsistent state for the resource.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

GetPublicKeyCertificate

$result = $client->getPublicKeyCertificate([/* ... */]);
$promise = $client->getPublicKeyCertificateAsync([/* ... */]);

Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography.

Unlike the private key of an asymmetric key, which never leaves Amazon Web Services Payment Cryptography unencrypted, callers with GetPublicKeyCertificate permission can download the public key certificate of the asymmetric key. You can share the public key certificate to allow others to encrypt messages and verify signatures outside of Amazon Web Services Payment Cryptography

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

Parameter Syntax

$result = $client->getPublicKeyCertificate([
    'KeyIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

KeyIdentifier

Required: Yes
Type: string

The KeyARN of the asymmetric key pair.

Result Syntax

[
    'KeyCertificate' => '<string>',
    'KeyCertificateChain' => '<string>',
]

Result Details

Members

KeyCertificate

Required: Yes
Type: string

The public key component of the asymmetric key pair in a certificate (PEM) format. It is signed by the root certificate authority (CA) within your service account. The certificate expires in 90 days.

KeyCertificateChain

Required: Yes
Type: string

The certificate chain that signed the public key certificate of the asymmetric key pair. This is the root certificate authority (CA) within your service account.

Errors

ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

ImportKey

$result = $client->importKey([/* ... */]);
$promise = $client->importKeyAsync([/* ... */]);

Imports keys and public key certificates into Amazon Web Services Payment Cryptography.

You can use ImportKey to import main or root keys such as KEK (Key Encryption Key) using asymmetric key exchange technique following the ANSI X9 TR-34 standard. The ANSI X9 TR-34 standard uses asymmetric keys to establishes bi-directional trust between the two parties exchanging keys.

After you have imported a main or root key, you can import working keys to perform various cryptographic operations within Amazon Web Services Payment Cryptography using the ANSI X9 TR-31 symmetric key exchange standard as mandated by PCI PIN.

You can also import a root public key certificate, a self-signed certificate used to sign other public key certificates, or a trusted public key certificate under an already established root public key certificate.

To import a public root key certificate

Using this operation, you can import the public component (in PEM cerificate format) of your private root key. You can use the imported public root key certificate for digital signatures, for example signing wrapping key or signing key in TR-34, within your Amazon Web Services Payment Cryptography account.

Set the following parameters:

KeyMaterial: RootCertificatePublicKey
KeyClass: PUBLIC_KEY
KeyModesOfUse: Verify
KeyUsage: TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE
PublicKeyCertificate: The certificate authority used to sign the root public key certificate.

To import a trusted public key certificate

The root public key certificate must be in place and operational before you import a trusted public key certificate. Set the following parameters:

KeyMaterial: TrustedCertificatePublicKey
CertificateAuthorityPublicKeyIdentifier: KeyArn of the RootCertificatePublicKey.
KeyModesOfUse and KeyUsage: Corresponding to the cryptographic operations such as wrap, sign, or encrypt that you will allow the trusted public key certificate to perform.
PublicKeyCertificate: The certificate authority used to sign the trusted public key certificate.

Import main keys

Amazon Web Services Payment Cryptography uses TR-34 asymmetric key exchange standard to import main keys such as KEK. In TR-34 terminology, the sending party of the key is called Key Distribution Host (KDH) and the receiving party of the key is called Key Receiving Host (KRH). During the key import process, KDH is the user who initiates the key import and KRH is Amazon Web Services Payment Cryptography who receives the key. Before initiating TR-34 key import, you must obtain an import token by calling GetParametersForImport. This operation also returns the wrapping key certificate that KDH uses wrap key under import to generate a TR-34 wrapped key block. The import token expires after 7 days.

Set the following parameters:

CertificateAuthorityPublicKeyIdentifier: The KeyArn of the certificate chain that will sign the signing key certificate and should exist within Amazon Web Services Payment Cryptography before initiating TR-34 key import. If it does not exist, you can import it by calling by calling ImportKey for RootCertificatePublicKey.
ImportToken: Obtained from KRH by calling GetParametersForImport.
WrappedKeyBlock: The TR-34 wrapped key block from KDH. It contains the KDH key under import, wrapped with KRH provided wrapping key certificate and signed by the KDH private signing key. This TR-34 key block is generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.
SigningKeyCertificate: The public component of the private key that signed the KDH TR-34 wrapped key block. In PEM certificate format.

TR-34 is intended primarily to exchange 3DES keys. Your ability to export AES-128 and larger AES keys may be dependent on your source system.

Import working keys

Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange standard to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import. To initiate a TR-31 key import, set the following parameters:

WrappedKeyBlock: The key under import and encrypted using KEK. The TR-31 key block generated by your HSM outside of Amazon Web Services Payment Cryptography.
WrappingKeyIdentifier: The KeyArn of the KEK that Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.

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

Related operations:

ExportKey
GetParametersForImport

Parameter Syntax

$result = $client->importKey([
    'Enabled' => true || false,
    'KeyCheckValueAlgorithm' => 'CMAC|ANSI_X9_24',
    'KeyMaterial' => [ // REQUIRED
        'RootCertificatePublicKey' => [
            'KeyAttributes' => [ // REQUIRED
                'KeyAlgorithm' => 'TDES_2KEY|TDES_3KEY|AES_128|AES_192|AES_256|RSA_2048|RSA_3072|RSA_4096', // REQUIRED
                'KeyClass' => 'SYMMETRIC_KEY|ASYMMETRIC_KEY_PAIR|PRIVATE_KEY|PUBLIC_KEY', // REQUIRED
                'KeyModesOfUse' => [ // REQUIRED
                    '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', // REQUIRED
            ],
            'PublicKeyCertificate' => '<string>', // REQUIRED
        ],
        'Tr31KeyBlock' => [
            'WrappedKeyBlock' => '<string>', // REQUIRED
            'WrappingKeyIdentifier' => '<string>', // REQUIRED
        ],
        'Tr34KeyBlock' => [
            'CertificateAuthorityPublicKeyIdentifier' => '<string>', // REQUIRED
            'ImportToken' => '<string>', // REQUIRED
            'KeyBlockFormat' => 'X9_TR34_2012', // REQUIRED
            'RandomNonce' => '<string>',
            'SigningKeyCertificate' => '<string>', // REQUIRED
            'WrappedKeyBlock' => '<string>', // REQUIRED
        ],
        'TrustedCertificatePublicKey' => [
            'CertificateAuthorityPublicKeyIdentifier' => '<string>', // REQUIRED
            'KeyAttributes' => [ // REQUIRED
                'KeyAlgorithm' => 'TDES_2KEY|TDES_3KEY|AES_128|AES_192|AES_256|RSA_2048|RSA_3072|RSA_4096', // REQUIRED
                'KeyClass' => 'SYMMETRIC_KEY|ASYMMETRIC_KEY_PAIR|PRIVATE_KEY|PUBLIC_KEY', // REQUIRED
                'KeyModesOfUse' => [ // REQUIRED
                    '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', // REQUIRED
            ],
            'PublicKeyCertificate' => '<string>', // REQUIRED
        ],
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

Enabled

Type: boolean

Specifies whether import key is enabled.

KeyCheckValueAlgorithm

Type: string

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.

KeyMaterial

Required: Yes
Type: ImportKeyMaterial structure

The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.

Tags

Type: Array of Tag structures

You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the specified one.

To use this parameter, you must have TagResource permission.

Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

Result Syntax

[
    'Key' => [
        'CreateTimestamp' => <DateTime>,
        'DeletePendingTimestamp' => <DateTime>,
        'DeleteTimestamp' => <DateTime>,
        '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>',
        'KeyCheckValueAlgorithm' => 'CMAC|ANSI_X9_24',
        'KeyOrigin' => 'EXTERNAL|AWS_PAYMENT_CRYPTOGRAPHY',
        'KeyState' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|DELETE_PENDING|DELETE_COMPLETE',
        'UsageStartTimestamp' => <DateTime>,
        'UsageStopTimestamp' => <DateTime>,
    ],
]

Result Details

Members

Key

Required: Yes
Type: Key structure

The KeyARN of the key material imported within Amazon Web Services Payment Cryptography.

Errors

ServiceQuotaExceededException:
This request would cause a service quota to be exceeded.
ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
ConflictException:
This request can cause an inconsistent state for the resource.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

ListAliases

$result = $client->listAliases([/* ... */]);
$promise = $client->listAliasesAsync([/* ... */]);

Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of aliases. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.

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

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

Related operations:

CreateAlias
DeleteAlias
GetAlias
UpdateAlias

Parameter Syntax

$result = $client->listAliases([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

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.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

NextToken

Type: 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.

Result Syntax

[
    'Aliases' => [
        [
            'AliasName' => '<string>',
            'KeyArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Aliases

Required: Yes
Type: Array of Alias structures

The list of aliases. Each alias describes the KeyArn contained within.

NextToken

Type: string

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

Errors

ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

ListKeys

$result = $client->listKeys([/* ... */]);
$promise = $client->listKeysAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listKeys([
    'KeyState' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|DELETE_PENDING|DELETE_COMPLETE',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

KeyState

Type: string

The key state of the keys you want to list.

MaxResults

Type: int

NextToken

Type: 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.

Result 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>',
]

Result Details

Members

Keys

Required: Yes
Type: Array of KeySummary structures

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

NextToken

Type: string

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

Errors

ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags for an Amazon Web Services resource.

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

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

Related operations:

TagResource
UntagResource

Parameter Syntax

$result = $client->listTagsForResource([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

NextToken

Type: 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.

ResourceArn

Required: Yes
Type: string

The KeyARN of the key whose tags you are getting.

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

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

Tags

Required: Yes
Type: Array of Tag structures

The list of tags associated with a ResourceArn. Each tag will list the key-value pair contained within that tag.

Errors

ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

RestoreKey

$result = $client->restoreKey([/* ... */]);
$promise = $client->restoreKeyAsync([/* ... */]);

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:

DeleteKey
StartKeyUsage
StopKeyUsage

Parameter Syntax

$result = $client->restoreKey([
    'KeyIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

KeyIdentifier

Required: Yes
Type: string

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

Result Syntax

[
    'Key' => [
        'CreateTimestamp' => <DateTime>,
        'DeletePendingTimestamp' => <DateTime>,
        'DeleteTimestamp' => <DateTime>,
        '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>',
        'KeyCheckValueAlgorithm' => 'CMAC|ANSI_X9_24',
        'KeyOrigin' => 'EXTERNAL|AWS_PAYMENT_CRYPTOGRAPHY',
        'KeyState' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|DELETE_PENDING|DELETE_COMPLETE',
        'UsageStartTimestamp' => <DateTime>,
        'UsageStopTimestamp' => <DateTime>,
    ],
]

Result Details

Members

Key

Required: Yes
Type: Key structure

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

Errors

ServiceQuotaExceededException:
This request would cause a service quota to be exceeded.
ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
ConflictException:
This request can cause an inconsistent state for the resource.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

StartKeyUsage

$result = $client->startKeyUsage([/* ... */]);
$promise = $client->startKeyUsageAsync([/* ... */]);

Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography

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

Related operations:

StopKeyUsage

Parameter Syntax

$result = $client->startKeyUsage([
    'KeyIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

KeyIdentifier

Required: Yes
Type: string

The KeyArn of the key.

Result Syntax

[
    'Key' => [
        'CreateTimestamp' => <DateTime>,
        'DeletePendingTimestamp' => <DateTime>,
        'DeleteTimestamp' => <DateTime>,
        '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>',
        'KeyCheckValueAlgorithm' => 'CMAC|ANSI_X9_24',
        'KeyOrigin' => 'EXTERNAL|AWS_PAYMENT_CRYPTOGRAPHY',
        'KeyState' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|DELETE_PENDING|DELETE_COMPLETE',
        'UsageStartTimestamp' => <DateTime>,
        'UsageStopTimestamp' => <DateTime>,
    ],
]

Result Details

Members

Key

Required: Yes
Type: Key structure

The KeyARN of the Amazon Web Services Payment Cryptography key activated for use.

Errors

ServiceQuotaExceededException:
This request would cause a service quota to be exceeded.
ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
ConflictException:
This request can cause an inconsistent state for the resource.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

StopKeyUsage

$result = $client->stopKeyUsage([/* ... */]);
$promise = $client->stopKeyUsageAsync([/* ... */]);

Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.

You can use this operation instead of DeleteKey to deactivate a key. You can enable the key in the future by calling StartKeyUsage.

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

Related operations:

DeleteKey
StartKeyUsage

Parameter Syntax

$result = $client->stopKeyUsage([
    'KeyIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Members

KeyIdentifier

Required: Yes
Type: string

The KeyArn of the key.

Result Syntax

[
    'Key' => [
        'CreateTimestamp' => <DateTime>,
        'DeletePendingTimestamp' => <DateTime>,
        'DeleteTimestamp' => <DateTime>,
        '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>',
        'KeyCheckValueAlgorithm' => 'CMAC|ANSI_X9_24',
        'KeyOrigin' => 'EXTERNAL|AWS_PAYMENT_CRYPTOGRAPHY',
        'KeyState' => 'CREATE_IN_PROGRESS|CREATE_COMPLETE|DELETE_PENDING|DELETE_COMPLETE',
        'UsageStartTimestamp' => <DateTime>,
        'UsageStopTimestamp' => <DateTime>,
    ],
]

Result Details

Members

Key

Required: Yes
Type: Key structure

The KeyARN of the key.

Errors

ServiceQuotaExceededException:
This request would cause a service quota to be exceeded.
ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
ConflictException:
This request can cause an inconsistent state for the resource.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or edits tags on an Amazon Web Services Payment Cryptography key.

Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can also add tags to an Amazon Web Services Payment Cryptography key when you create it with CreateKey.

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

Related operations:

ListTagsForResource
UntagResource

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The KeyARN of the key whose tags are being updated.

Tags

Required: Yes
Type: Array of Tag structures

One or more tags. Each tag consists of a tag key and a tag value. The tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key. If you specify an existing tag key with a different tag value, Amazon Web Services Payment Cryptography replaces the current tag value with the new one.

Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

To use this parameter, you must have TagResource permission in an IAM policy.

Don't include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceQuotaExceededException:
This request would cause a service quota to be exceeded.
ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
ConflictException:
This request can cause an inconsistent state for the resource.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Deletes a tag from an Amazon Web Services Payment Cryptography key.

Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

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

Related operations:

ListTagsForResource
TagResource

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The KeyARN of the key whose tags are being removed.

TagKeys

Required: Yes
Type: Array of strings

One or more tag keys. Don't include the tag values.

If the Amazon Web Services Payment Cryptography key doesn't have the specified tag key, Amazon Web Services Payment Cryptography doesn't throw an exception or return a response. To confirm that the operation succeeded, use the ListTagsForResource operation.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
ConflictException:
This request can cause an inconsistent state for the resource.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

UpdateAlias

$result = $client->updateAlias([/* ... */]);
$promise = $client->updateAliasAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateAlias([
    'AliasName' => '<string>', // REQUIRED
    'KeyArn' => '<string>',
]);

Parameter Details

Members

AliasName

Required: Yes
Type: string

The alias whose associated key is changing.

KeyArn

Type: string

The KeyARN for the key that you are updating or removing from the alias.

Result Syntax

[
    'Alias' => [
        'AliasName' => '<string>',
        'KeyArn' => '<string>',
    ],
]

Result Details

Members

Alias

Required: Yes
Type: Alias structure

The alias name.

Errors

ServiceUnavailableException:
The service cannot complete the request.
ValidationException:
The request was denied due to an invalid request error.
ConflictException:
This request can cause an inconsistent state for the resource.
AccessDeniedException:
You do not have sufficient access to perform this action.
ResourceNotFoundException:
The request was denied due to an invalid resource error.
ThrottlingException:
The request was denied due to request throttling.
InternalServerException:
The request processing has failed because of an unknown error, exception, or failure.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members

Message

Type: string

Alias

Description

Contains information about an alias.

Members

AliasName

Required: Yes
Type: string

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

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

KeyArn

Type: string

The KeyARN of the key associated with the alias.

ConflictException

Description

This request can cause an inconsistent state for the resource.

Members

Message

Type: string

ExportKeyMaterial

Description

Parameter information for key material export from Amazon Web Services Payment Cryptography.

Members

Tr31KeyBlock

Type: ExportTr31KeyBlock structure

Parameter information for key material export using TR-31 standard.

Tr34KeyBlock

Type: ExportTr34KeyBlock structure

Parameter information for key material export using TR-34 standard.

ExportTr31KeyBlock

Description

Parameter information for key material export using TR-31 standard.

Members

WrappingKeyIdentifier

Required: Yes
Type: string

The KeyARN of the the wrapping key. This key encrypts or wraps the key under export for TR-31 key block generation.

ExportTr34KeyBlock

Description

Parameter information for key material export using TR-34 standard.

Members

CertificateAuthorityPublicKeyIdentifier

Required: Yes
Type: string

The KeyARN of the certificate chain that signs the wrapping key certificate during TR-34 key export.

ExportToken

Required: Yes
Type: string

The export token to initiate key export from Amazon Web Services Payment Cryptography. It also contains the signing key certificate that will sign the wrapped key during TR-34 key block generation. Call GetParametersForExport to receive an export token. It expires after 7 days. You can use the same export token to export multiple keys from the same service account.

KeyBlockFormat

Required: Yes
Type: string

The format of key block that Amazon Web Services Payment Cryptography will use during key export.

RandomNonce

Type: string

A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.

WrappingKeyCertificate

Required: Yes
Type: string

The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.

ImportKeyMaterial

Description

Parameter information for key material import.

Members

RootCertificatePublicKey

Type: RootCertificatePublicKey structure

Parameter information for root public key certificate import.

Tr31KeyBlock

Type: ImportTr31KeyBlock structure

Parameter information for key material import using TR-31 standard.

Tr34KeyBlock

Type: ImportTr34KeyBlock structure

Parameter information for key material import using TR-34 standard.

TrustedCertificatePublicKey

Type: TrustedCertificatePublicKey structure

Parameter information for trusted public key certificate import.

ImportTr31KeyBlock

Description

Parameter information for key material import using TR-31 standard.

Members

WrappedKeyBlock

Required: Yes
Type: string

The TR-34 wrapped key block to import.

WrappingKeyIdentifier

Required: Yes
Type: string

The KeyARN of the key that will decrypt or unwrap a TR-31 key block during import.

ImportTr34KeyBlock

Description

Parameter information for key material import using TR-34 standard.

Members

CertificateAuthorityPublicKeyIdentifier

Required: Yes
Type: string

The KeyARN of the certificate chain that signs the signing key certificate during TR-34 key import.

ImportToken

Required: Yes
Type: string

The import token that initiates key import into Amazon Web Services Payment Cryptography. It expires after 7 days. You can use the same import token to import multiple keys to the same service account.

KeyBlockFormat

Required: Yes
Type: string

The key block format to use during key import. The only value allowed is X9_TR34_2012.

RandomNonce

Type: string

A random number value that is unique to the TR-34 key block generated using 2 pass. The operation will fail, if a random nonce value is not provided for a TR-34 key block generated using 2 pass.

SigningKeyCertificate

Required: Yes
Type: string

The public key component in PEM certificate format of the private key that signs the KDH TR-34 wrapped key block.

WrappedKeyBlock

Required: Yes
Type: string

The TR-34 wrapped key block to import.

InternalServerException

Description

The request processing has failed because of an unknown error, exception, or failure.

Members

Message

Type: string

Key

Description

Metadata about an Amazon Web Services Payment Cryptography key.

Members

CreateTimestamp

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the key was created.

DeletePendingTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

Enabled

Required: Yes
Type: boolean

Specifies whether the key is enabled.

Exportable

Required: Yes
Type: boolean

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

KeyArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the key.

KeyAttributes

Required: Yes
Type: KeyAttributes structure

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.

KeyCheckValue

Required: Yes
Type: 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.

KeyCheckValueAlgorithm

Required: Yes
Type: string

The algorithm used for calculating key check value (KCV) for DES and AES keys. For a DES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For an AES key, Amazon Web Services Payment Cryptography computes the KCV by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.

KeyOrigin

Required: Yes
Type: 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.

KeyState

Required: Yes
Type: string

The state of key that is being created or deleted.

UsageStartTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

UsageStopTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

KeyAttributes

Description

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.

Members

KeyAlgorithm

Required: Yes
Type: 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

Required: Yes
Type: string

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

KeyModesOfUse

Required: Yes
Type: KeyModesOfUse structure

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

KeyUsage

Required: Yes
Type: string

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

KeyModesOfUse

Description

The list of cryptographic operations that you can perform using the key. The modes of use are deﬁned in section A.5.3 of the TR-31 spec.

Members

Decrypt

Type: boolean

Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.

DeriveKey

Type: boolean

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

Encrypt

Type: boolean

Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.

Generate

Type: boolean

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

NoRestrictions

Type: boolean

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

Sign

Type: boolean

Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used for signing.

Unwrap

Type: boolean

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

Verify

Type: boolean

Speciﬁes whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.

Wrap

Type: boolean

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

KeySummary

Description

Metadata about an Amazon Web Services Payment Cryptography key.

Members

Enabled

Required: Yes
Type: boolean

Specifies whether the key is enabled.

Exportable

Required: Yes
Type: boolean

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

KeyArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the key.

KeyAttributes

Required: Yes
Type: KeyAttributes structure

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.

KeyCheckValue

Required: Yes
Type: string

KeyState

Required: Yes
Type: string

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

ResourceNotFoundException

Description

The request was denied due to an invalid resource error.

Members

ResourceId

Type: string

The string for the exception.

RootCertificatePublicKey

Description

Parameter information for root public key certificate import.

Members

KeyAttributes

Required: Yes
Type: KeyAttributes structure

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

PublicKeyCertificate

Required: Yes
Type: string

Parameter information for root public key certificate import.

ServiceQuotaExceededException

Description

This request would cause a service quota to be exceeded.

Members

Message

Type: string

ServiceUnavailableException

Description

The service cannot complete the request.

Members

Message

Type: string

ThrottlingException

Description

The request was denied due to request throttling.

Members

Message

Type: string

TrustedCertificatePublicKey

Description

Parameter information for trusted public key certificate import.

Members

CertificateAuthorityPublicKeyIdentifier

Required: Yes
Type: string

The KeyARN of the root public key certificate or certificate chain that signs the trusted public key certificate import.

KeyAttributes

Required: Yes
Type: KeyAttributes structure

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

PublicKeyCertificate

Required: Yes
Type: string

Parameter information for trusted public key certificate import.

ValidationException

Description

The request was denied due to an invalid request error.

Members

Message

Type: string

WrappedKey

Description

Parameter information for generating a wrapped key using TR-31 or TR-34 standard.

Members

KeyMaterial

Required: Yes
Type: string

Parameter information for generating a wrapped key using TR-31 or TR-34 standard.

WrappedKeyMaterialFormat

Required: Yes
Type: string

The key block format of a wrapped key.

WrappingKeyArn

Required: Yes
Type: string

The KeyARN of the wrapped key.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Payment Cryptography Control Plane 2021-09-14

Operation Summary

Paginators

Operations

CreateAlias

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateKey

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteAlias

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteKey

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

ExportKey

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetAlias

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetKey

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetParametersForExport

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetParametersForImport

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members