Adds replication Amazon Web Services Regions to an existing Amazon Web Services Payment Cryptography key, enabling the key to be used for cryptographic operations in additional Amazon Web Services Regions.
Multi-Region key replication allow you to use the same key material across multiple Amazon Web Services Regions, providing lower latency for applications distributed across regions. When you add Replication Regions, Amazon Web Services Payment Cryptography securely replicates the key material to the specified Amazon Web Services Regions.
The key must be in an active state to add Replication Regions. You can add multiple regions in a single operation, and the key will be available for use in those regions once replication is complete.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "CreateAlias":{ "name":"CreateAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateAliasInput"}, "output":{"shape":"CreateAliasOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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:
", "idempotent":true }, "CreateKey":{ "name":"CreateKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateKeyInput"}, "output":{"shape":"CreateKeyOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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 define 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). 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.
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.
You can use the CreateKey operation to generate an ECC (Elliptic Curve Cryptography) key pair used for establishing an ECDH (Elliptic Curve Diffie-Hellman) key agreement between two parties. In the ECDH key agreement process, both parties generate their own ECC key pair with key usage K3 and exchange the public keys. Each party then use their private key, the received public key from the other party, and the key derivation parameters including key derivation function, hash algorithm, derivation data, and key algorithm to derive a shared key.
To maintain the single-use principle of cryptographic keys in payments, ECDH derived keys should not be used for multiple purposes, such as a TR31_P0_PIN_ENCRYPTION_KEY and TR31_K1_KEY_BLOCK_PROTECTION_KEY. When creating ECC key pairs in Amazon Web Services Payment Cryptography you can optionally set the DeriveKeyUsage parameter, which defines the key usage bound to the symmetric key that will be derived using the ECC key pair.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "DeleteAlias":{ "name":"DeleteAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteAliasInput"}, "output":{"shape":"DeleteAliasOutput"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Deletes the alias, but doesn't affect the underlying key.
Each key can have multiple aliases. To get the aliases of all keys, use the UpdateAlias 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:
", "idempotent":true }, "DeleteKey":{ "name":"DeleteKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteKeyInput"}, "output":{"shape":"DeleteKeyOutput"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Deletes the key material and 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 set using DeleteKeyInDays. The default waiting period is 7 days. During the waiting period, the KeyState is DELETE_PENDING. After the key is deleted, the KeyState is DELETE_COMPLETE.
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:
", "idempotent":true }, "DisableDefaultKeyReplicationRegions":{ "name":"DisableDefaultKeyReplicationRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableDefaultKeyReplicationRegionsInput"}, "output":{"shape":"DisableDefaultKeyReplicationRegionsOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Disables Multi-Region key replication settings for the specified Amazon Web Services Regions in your Amazon Web Services account, preventing new keys from being automatically replicated to those regions.
After disabling Multi-Region key replication for specific regions, new keys created in your account will not be automatically replicated to those regions. You can still manually add replication to those regions for individual keys using the AddKeyReplicationRegions operation.
This operation does not affect existing keys or their current replication configuration.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "EnableDefaultKeyReplicationRegions":{ "name":"EnableDefaultKeyReplicationRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableDefaultKeyReplicationRegionsInput"}, "output":{"shape":"EnableDefaultKeyReplicationRegionsOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Enables Multi-Region key replication settings for your Amazon Web Services account, causing new keys to be automatically replicated to the specified Amazon Web Services Regions when created.
When Multi-Region key replication are enabled, any new keys created in your account will automatically be replicated to these regions unless you explicitly override this behavior during key creation. This simplifies key management for applications that operate across multiple regions.
Existing keys are not affected by this operation - only keys created after enabling default replication will be automatically replicated.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "ExportKey":{ "name":"ExportKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ExportKeyInput"}, "output":{"shape":"ExportKeyOutput"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Exports a key from Amazon Web Services Payment Cryptography.
Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ExportKey you can export symmetric keys using either symmetric and asymmetric key exchange mechanisms. 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
For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm, RSA unwrap, and ECDH (Elliptic Curve Diffie-Hellman) key exchange mechanisms. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK). After which you can export working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.
PCI requires specific minimum key strength of wrapping keys used to protect the keys being exchanged electronically. These requirements can change when PCI standards are revised. The rules specify that wrapping keys used for transport must be at least as strong as the key being protected. For more information on recommended key strength of wrapping keys and key exchange mechanism, see Importing and exporting keys in the Amazon Web Services Payment Cryptography User Guide.
You can also use ExportKey functionality to generate and export an IPEK (Initial Pin Encryption Key) from Amazon Web Services Payment Cryptography using either TR-31 or TR-34 export key exchange. IPEK is generated from BDK (Base Derivation Key) and ExportDukptInitialKey attribute KSN (KeySerialNumber). The generated IPEK does not persist within Amazon Web Services Payment Cryptography and has to be re-generated each time during export.
For key exchange using TR-31 or TR-34 key blocks, you can also export optional blocks within the key block header which contain additional attribute information about the key. The KeyVersion within KeyBlockHeaders indicates the version of the key within the key block. Furthermore, KeyExportability within KeyBlockHeaders can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.
The OptionalBlocks contain the additional data related to the key. For information on data type that can be included within optional blocks, refer to ASC X9.143-2022.
Data included in key block headers is signed but transmitted in clear text. Sensitive or confidential information should not be included in optional blocks. Refer to ASC X9.143-2022 standard for information on allowed data type.
To export initial keys (KEK) or IPEK using TR-34
Using this operation, you can export initial key using TR-34 asymmetric key exchange. You can only export KEK generated within Amazon Web Services Payment Cryptography. 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 Device (KRD). During key export process, KDH is Amazon Web Services Payment Cryptography which initiates key export and KRD is the user receiving the key.
To initiate TR-34 key export, the KRD must obtain an export token by calling GetParametersForExport. This operation also generates a key pair for the purpose of key export, signs the key and returns back the signing public key certificate (also known as KDH signing certificate) and root certificate chain. The KDH uses the private key to sign the the export payload and the signing public key certificate is provided to KRD to verify the signature. The KRD can import the root certificate into its Hardware Security Module (HSM), as required. The export token and the associated KDH signing certificate expires after 30 days.
Next the KRD generates a key pair for the the purpose of encrypting the KDH key and provides the public key cerificate (also known as KRD wrapping certificate) back to KDH. The KRD will also import the root cerificate chain into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey. The KDH, Amazon Web Services Payment Cryptography, will use the KRD wrapping cerificate to encrypt (wrap) the key under export and signs it with signing private key to generate a TR-34 WrappedKeyBlock. For more information on TR-34 key export, see section Exporting symmetric keys in the Amazon Web Services Payment Cryptography User Guide.
Set the following parameters:
ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.
ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.
KeyMaterial: Use Tr34KeyBlock parameters.
CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KRD wrapping key certificate.
ExportToken: Obtained from KDH by calling GetParametersForImport.
WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KRD wrapping key Amazon Web Services Payment Cryptography uses for encryption of the TR-34 export payload. This certificate must be signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography.
When this operation is successful, Amazon Web Services Payment Cryptography returns the KEK or IPEK as a TR-34 WrappedKeyBlock.
To export initial keys (KEK) or IPEK using RSA Wrap and Unwrap
Using this operation, you can export initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate export, generate an asymmetric key pair on the receiving HSM and obtain the public key certificate in PEM format (base64 encoded) for the purpose of wrapping and the root certifiate chain. Import the root certificate into Amazon Web Services Payment Cryptography by calling ImportKey for RootCertificatePublicKey.
Next call ExportKey and set the following parameters:
CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed wrapping key certificate.
KeyMaterial: Set to KeyCryptogram.
WrappingKeyCertificate: The public key certificate in PEM format (base64 encoded) obtained by the receiving HSM and signed by the root certificate (CertificateAuthorityPublicKeyIdentifier) imported into Amazon Web Services Payment Cryptography. The receiving HSM uses its private key component to unwrap the WrappedKeyCryptogram.
When this operation is successful, Amazon Web Services Payment Cryptography returns the WrappedKeyCryptogram.
To export working keys or IPEK using TR-31
Using this operation, you can export working keys or IPEK using TR-31 symmetric key exchange. In TR-31, you must use an initial key such as KEK to encrypt or wrap the key under export. To establish a KEK, you can use CreateKey or ImportKey.
Set the following parameters:
ExportAttributes: Specify export attributes in case of IPEK export. This parameter is optional for KEK export.
ExportKeyIdentifier: The KeyARN of the KEK or BDK (in case of IPEK) under export.
KeyMaterial: Use Tr31KeyBlock parameters.
To export working keys using ECDH
You can also use ECDH key agreement to export working keys in a TR-31 keyblock, where the wrapping key is an ECDH derived key.
To initiate a TR-31 key export using ECDH, both sides must create an ECC key pair with key usage K3 and exchange public key certificates. In Amazon Web Services Payment Cryptography, you can do this by calling CreateKey. If you have not already done so, you must import the CA chain that issued the receiving public key certificate by calling ImportKey with input RootCertificatePublicKey for root CA or TrustedPublicKey for intermediate CA. You can then complete a TR-31 key export by deriving a shared wrapping key using the service ECC key pair, public certificate of your ECC key pair outside of Amazon Web Services Payment Cryptography, and the key derivation parameters including key derivation function, hash algorithm, derivation data, key algorithm.
KeyMaterial: Use DiffieHellmanTr31KeyBlock parameters.
PrivateKeyIdentifier: The KeyArn of the ECC key pair created within Amazon Web Services Payment Cryptography to derive a shared KEK.
PublicKeyCertificate: The public key certificate of the receiving ECC key pair in PEM format (base64 encoded) to derive a shared KEK.
CertificateAuthorityPublicKeyIdentifier: The keyARN of the CA that signed the public key certificate of the receiving ECC key pair.
When this operation is successful, Amazon Web Services Payment Cryptography returns the working key as a TR-31 WrappedKeyBlock, where the wrapping key is the ECDH derived key.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "GetAlias":{ "name":"GetAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetAliasInput"}, "output":{"shape":"GetAliasOutput"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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:
", "readonly":true }, "GetCertificateSigningRequest":{ "name":"GetCertificateSigningRequest", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetCertificateSigningRequestInput"}, "output":{"shape":"GetCertificateSigningRequestOutput"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Creates a certificate signing request (CSR) from a key pair.
" }, "GetDefaultKeyReplicationRegions":{ "name":"GetDefaultKeyReplicationRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetDefaultKeyReplicationRegionsInput"}, "output":{"shape":"GetDefaultKeyReplicationRegionsOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Retrieves the list of Amazon Web Services Regions where Multi-Region key replication is currently enabled for your Amazon Web Services account.
This operation returns the current Multi-Region key replication configuration. New keys created in your account will be automatically replicated to these regions unless explicitly overridden during key creation.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "GetKey":{ "name":"GetKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetKeyInput"}, "output":{"shape":"GetKeyOutput"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Gets the key metadata for an Amazon Web Services Payment Cryptography key, including the immutable and mutable attributes specified when the key was created. Returns key metadata including attributes, state, and timestamps, but does not return the actual cryptographic key material.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
", "readonly":true }, "GetParametersForExport":{ "name":"GetParametersForExport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetParametersForExportInput"}, "output":{"shape":"GetParametersForExportOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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 30 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:
" }, "GetParametersForImport":{ "name":"GetParametersForImport", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetParametersForImportInput"}, "output":{"shape":"GetParametersForImportOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Gets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import into Amazon Web Services Payment Cryptography.
The wrapping key certificate wraps the key under import. The import token and wrapping key certificate must be in place and operational before calling ImportKey. The import token expires in 30 days. You can use the same import token 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:
" }, "GetPublicKeyCertificate":{ "name":"GetPublicKeyCertificate", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetPublicKeyCertificateInput"}, "output":{"shape":"GetPublicKeyCertificateOutput"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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.
", "readonly":true }, "ImportKey":{ "name":"ImportKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ImportKeyInput"}, "output":{"shape":"ImportKeyOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.
Amazon Web Services Payment Cryptography simplifies key exchange by replacing the existing paper-based approach with a modern electronic approach. With ImportKey you can import symmetric keys using either symmetric and asymmetric key exchange mechanisms.
For symmetric key exchange, Amazon Web Services Payment Cryptography uses the ANSI X9 TR-31 norm in accordance with PCI PIN guidelines. And for asymmetric key exchange, Amazon Web Services Payment Cryptography supports ANSI X9 TR-34 norm, RSA unwrap, and ECDH (Elliptic Curve Diffie-Hellman) key exchange mechanisms. Asymmetric key exchange methods are typically used to establish bi-directional trust between the two parties exhanging keys and are used for initial key exchange such as Key Encryption Key (KEK) or Zone Master Key (ZMK). After which you can import working keys using symmetric method to perform various cryptographic operations within Amazon Web Services Payment Cryptography.
PCI requires specific minimum key strength of wrapping keys used to protect the keys being exchanged electronically. These requirements can change when PCI standards are revised. The rules specify that wrapping keys used for transport must be at least as strong as the key being protected. For more information on recommended key strength of wrapping keys and key exchange mechanism, see Importing and exporting keys in the Amazon Web Services Payment Cryptography User Guide.
You can also import a root public key 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 public key certificate in PEM format (base64 encoded) of the private root key under import.
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 trusted public key certificate in PEM format (base64 encoded) under import.
To import initial keys (KEK or ZMK or similar) using TR-34
Using this operation, you can import initial key using TR-34 asymmetric key exchange. 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 Device (KRD). During the key import process, KDH is the user who initiates the key import and KRD is Amazon Web Services Payment Cryptography who receives the key.
To initiate TR-34 key import, the KDH must obtain an import token by calling GetParametersForImport. This operation generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate (also known as KRD wrapping certificate) and the root certificate chain. The KDH must trust and install the KRD wrapping certificate on its HSM and use it to encrypt (wrap) the KDH key during TR-34 WrappedKeyBlock generation. The import token and associated KRD wrapping certificate expires after 30 days.
Next the KDH generates a key pair for the purpose of signing the encrypted KDH key and provides the public certificate of the signing key to Amazon Web Services Payment Cryptography. The KDH will also need to import the root certificate chain of the KDH signing certificate by calling ImportKey for RootCertificatePublicKey. For more information on TR-34 key import, see section Importing symmetric keys in the Amazon Web Services Payment Cryptography User Guide.
Set the following parameters:
KeyMaterial: Use Tr34KeyBlock parameters.
CertificateAuthorityPublicKeyIdentifier: The KeyARN of the certificate chain that signed the KDH signing key certificate.
ImportToken: Obtained from KRD by calling GetParametersForImport.
WrappedKeyBlock: The TR-34 wrapped key material from KDH. It contains the KDH key under import, wrapped with KRD wrapping certificate and signed by KDH signing private key. This TR-34 key block is typically generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.
SigningKeyCertificate: The public key certificate in PEM format (base64 encoded) of the KDH signing key generated under the root certificate (CertificateAuthorityPublicKeyIdentifier) imported in Amazon Web Services Payment Cryptography.
To import initial keys (KEK or ZMK or similar) using RSA Wrap and Unwrap
Using this operation, you can import initial key using asymmetric RSA wrap and unwrap key exchange method. To initiate import, call GetParametersForImport with KeyMaterial set to KEY_CRYPTOGRAM to generate an import token. This operation also generates an encryption keypair for the purpose of key import, signs the key and returns back the wrapping key certificate in PEM format (base64 encoded) and its root certificate chain. The import token and associated KRD wrapping certificate expires after 30 days.
You must trust and install the wrapping certificate and its certificate chain on the sending HSM and use it to wrap the key under export for WrappedKeyCryptogram generation. Next call ImportKey with KeyMaterial set to KEY_CRYPTOGRAM and provide the ImportToken and KeyAttributes for the key under import.
To import working keys using TR-31
Amazon Web Services Payment Cryptography uses TR-31 symmetric key exchange norm to import working keys. A KEK must be established within Amazon Web Services Payment Cryptography by using TR-34 key import or by using CreateKey. To initiate a TR-31 key import, set the following parameters:
KeyMaterial: Use Tr31KeyBlock parameters.
WrappedKeyBlock: The TR-31 wrapped key material. It contains the key under import, encrypted using KEK. The TR-31 key block is typically generated by a 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.
To import working keys using ECDH
You can also use ECDH key agreement to import working keys as a TR-31 keyblock, where the wrapping key is an ECDH derived key.
To initiate a TR-31 key import using ECDH, both sides must create an ECC key pair with key usage K3 and exchange public key certificates. In Amazon Web Services Payment Cryptography, you can do this by calling CreateKey and then GetPublicKeyCertificate to retrieve its public key certificate. Next, you can then generate a TR-31 WrappedKeyBlock using your own ECC key pair, the public certificate of the service's ECC key pair, and the key derivation parameters including key derivation function, hash algorithm, derivation data, and key algorithm. If you have not already done so, you must import the CA chain that issued the receiving public key certificate by calling ImportKey with input RootCertificatePublicKey for root CA or TrustedPublicKey for intermediate CA. To complete the TR-31 key import, you can use the following parameters. It is important that the ECDH key derivation parameters you use should match those used during import to derive the same shared wrapping key within Amazon Web Services Payment Cryptography.
KeyMaterial: Use DiffieHellmanTr31KeyBlock parameters.
PrivateKeyIdentifier: The KeyArn of the ECC key pair created within Amazon Web Services Payment Cryptography to derive a shared KEK.
PublicKeyCertificate: The public key certificate of the receiving ECC key pair in PEM format (base64 encoded) to derive a shared KEK.
CertificateAuthorityPublicKeyIdentifier: The keyARN of the CA that signed the public key certificate of the receiving ECC key pair.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "ListAliases":{ "name":"ListAliases", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListAliasesInput"}, "output":{"shape":"ListAliasesOutput"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the aliases by keyARN. 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:
", "readonly":true }, "ListKeys":{ "name":"ListKeys", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListKeysInput"}, "output":{"shape":"ListKeysOutput"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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:
", "readonly":true }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTagsForResourceInput"}, "output":{"shape":"ListTagsForResourceOutput"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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:
", "readonly":true }, "RemoveKeyReplicationRegions":{ "name":"RemoveKeyReplicationRegions", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveKeyReplicationRegionsInput"}, "output":{"shape":"RemoveKeyReplicationRegionsOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Removes Replication Regions from an existing Amazon Web Services Payment Cryptography key, disabling the key's availability for cryptographic operations in the specified Amazon Web Services Regions.
When you remove Replication Regions, the key material is securely deleted from those regions and can no longer be used for cryptographic operations there. This operation is irreversible for the specified Amazon Web Services Regions. For more information, see Multi-Region key replication.
Ensure that no active cryptographic operations or applications depend on the key in the regions you're removing before performing this operation.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "RestoreKey":{ "name":"RestoreKey", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RestoreKeyInput"}, "output":{"shape":"RestoreKeyOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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:
" }, "StartKeyUsage":{ "name":"StartKeyUsage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StartKeyUsageInput"}, "output":{"shape":"StartKeyUsageOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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":{ "name":"StopKeyUsage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"StopKeyUsageInput"}, "output":{"shape":"StopKeyUsageOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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:
" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceInput"}, "output":{"shape":"TagResourceOutput"}, "errors":[ {"shape":"ServiceQuotaExceededException"}, {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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:
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceInput"}, "output":{"shape":"UntagResourceOutput"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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:
" }, "UpdateAlias":{ "name":"UpdateAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateAliasInput"}, "output":{"shape":"UpdateAliasOutput"}, "errors":[ {"shape":"ServiceUnavailableException"}, {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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:
" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"You do not have sufficient access to perform this action.
This exception is thrown when the caller lacks the necessary IAM permissions to perform the requested operation. Verify that your IAM policy includes the required permissions for the specific Amazon Web Services Payment Cryptography action you're attempting.
", "exception":true }, "AddKeyReplicationRegionsInput":{ "type":"structure", "required":[ "KeyIdentifier", "ReplicationRegions" ], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The key identifier (ARN or alias) of the key for which to add replication regions.
This key must exist and be in a valid state for replication operations.
" }, "ReplicationRegions":{ "shape":"Regions", "documentation":"The list of Amazon Web Services Regions to add to the key's replication configuration.
Each region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available. The key will be replicated to these regions, allowing cryptographic operations to be performed closer to your applications.
" } }, "documentation":"Input parameters for adding replication regions to a specific key.
" }, "AddKeyReplicationRegionsOutput":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"Key", "documentation":"The updated key metadata after adding the replication regions.
This includes the current state of the key and its replication configuration.
" } }, "documentation":"Output from adding replication regions to a key.
" }, "Alias":{ "type":"structure", "required":["AliasName"], "members":{ "AliasName":{ "shape":"AliasName", "documentation":"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.
The KeyARN of the key associated with the alias.
Contains information about an alias.
" }, "AliasName":{ "type":"string", "max":256, "min":7, "pattern":"alias/[a-zA-Z0-9/_-]+" }, "Aliases":{ "type":"list", "member":{"shape":"Alias"} }, "As2805KeyVariant":{ "type":"string", "enum":[ "TERMINAL_MAJOR_KEY_VARIANT_00", "PIN_ENCRYPTION_KEY_VARIANT_28", "MESSAGE_AUTHENTICATION_KEY_VARIANT_24", "DATA_ENCRYPTION_KEY_VARIANT_22" ] }, "Boolean":{ "type":"boolean", "box":true }, "CertificateSigningRequestType":{ "type":"string", "max":32768, "min":1, "pattern":"[^\\[;\\]<>]+", "sensitive":true }, "CertificateSubjectType":{ "type":"structure", "required":["CommonName"], "members":{ "CommonName":{ "shape":"CertificateSubjectTypeCommonNameString", "documentation":"The name you provide to create the certificate signing request.
" }, "OrganizationUnit":{ "shape":"CertificateSubjectTypeOrganizationUnitString", "documentation":"The organization unit you provide to create the certificate signing request.
" }, "Organization":{ "shape":"CertificateSubjectTypeOrganizationString", "documentation":"The organization you provide to create the certificate signing request.
" }, "City":{ "shape":"CertificateSubjectTypeCityString", "documentation":"The city you provide to create the certificate signing request.
" }, "Country":{ "shape":"CertificateSubjectTypeCountryString", "documentation":"The country you provide to create the certificate signing request.
" }, "StateOrProvince":{ "shape":"CertificateSubjectTypeStateOrProvinceString", "documentation":"The state or province you provide to create the certificate signing request.
" }, "EmailAddress":{ "shape":"CertificateSubjectTypeEmailAddressString", "documentation":"The email address you provide to create the certificate signing request.
" } }, "documentation":"The metadata used to create the certificate signing request.
" }, "CertificateSubjectTypeCityString":{ "type":"string", "max":128, "min":1, "pattern":"[^\\[;\\]<>]+" }, "CertificateSubjectTypeCommonNameString":{ "type":"string", "max":64, "min":1, "pattern":"[^\\[;\\]<>]+" }, "CertificateSubjectTypeCountryString":{ "type":"string", "max":2, "min":2, "pattern":"[A-Za-z]+" }, "CertificateSubjectTypeEmailAddressString":{ "type":"string", "max":128, "min":1, "pattern":"[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\\.[a-zA-Z0-9-]+)*" }, "CertificateSubjectTypeOrganizationString":{ "type":"string", "max":64, "min":1, "pattern":"[^\\[;\\]<>]+" }, "CertificateSubjectTypeOrganizationUnitString":{ "type":"string", "max":64, "min":1, "pattern":"[^\\[;\\]<>]+" }, "CertificateSubjectTypeStateOrProvinceString":{ "type":"string", "max":128, "min":1, "pattern":"[^\\[;\\]<>]+" }, "CertificateType":{ "type":"string", "max":32768, "min":1, "pattern":"[^\\[;\\]<>]+" }, "ConflictException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"This request can cause an inconsistent state for the resource.
The requested operation conflicts with the current state of the resource. For example, attempting to delete a key that is currently being used, or trying to create a resource that already exists.
", "exception":true }, "CreateAliasInput":{ "type":"structure", "required":["AliasName"], "members":{ "AliasName":{ "shape":"AliasName", "documentation":"A friendly name that you can use to refer to 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 personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
The KeyARN of the key to associate with the alias.
The alias for the key.
" } } }, "CreateKeyInput":{ "type":"structure", "required":[ "KeyAttributes", "Exportable" ], "members":{ "KeyAttributes":{ "shape":"KeyAttributes", "documentation":"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":{ "shape":"KeyCheckValueAlgorithm", "documentation":"The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
" }, "Exportable":{ "shape":"Boolean", "documentation":"Specifies whether the key is exportable from the service.
" }, "Enabled":{ "shape":"Boolean", "documentation":"Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled.
" }, "Tags":{ "shape":"Tags", "documentation":"Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.
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.
Don't include personal, 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.
The intended cryptographic usage of keys derived from the ECC key pair to be created.
After creating an ECC key pair, you cannot change the intended cryptographic usage of keys derived from it using ECDH.
" }, "ReplicationRegions":{"shape":"Regions"} } }, "CreateKeyOutput":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"Key", "documentation":"The key material that contains all the key attributes.
" } } }, "DeleteAliasInput":{ "type":"structure", "required":["AliasName"], "members":{ "AliasName":{ "shape":"AliasName", "documentation":"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.
The KeyARN of the key that is scheduled for deletion.
The waiting period for key deletion. The default value is seven days.
" } } }, "DeleteKeyInputDeleteKeyInDaysInteger":{ "type":"integer", "box":true, "max":180, "min":3 }, "DeleteKeyOutput":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"Key", "documentation":"The KeyARN of the key that is scheduled for deletion.
A string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.
It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes. It is not recommended to reuse shared information for multiple ECDH key derivations, as it could result in derived key material being the same across different derivations.
" } }, "documentation":"The shared information used when deriving a key using ECDH.
", "union":true }, "DisableDefaultKeyReplicationRegionsInput":{ "type":"structure", "required":["ReplicationRegions"], "members":{ "ReplicationRegions":{ "shape":"Regions", "documentation":"The list of Amazon Web Services Regions to remove from the account's default replication regions.
New keys created after this operation will not automatically be replicated to these regions, though existing keys with replication to these regions will be unaffected.
" } }, "documentation":"Input parameters for disabling default key replication regions for the account.
" }, "DisableDefaultKeyReplicationRegionsOutput":{ "type":"structure", "required":["EnabledReplicationRegions"], "members":{ "EnabledReplicationRegions":{ "shape":"Regions", "documentation":"The remaining list of regions where default key replication is still enabled for the account.
This reflects the account's default replication configuration after removing the specified regions.
" } }, "documentation":"Output from disabling default key replication regions for the account.
" }, "EnableDefaultKeyReplicationRegionsInput":{ "type":"structure", "required":["ReplicationRegions"], "members":{ "ReplicationRegions":{ "shape":"Regions", "documentation":"The list of Amazon Web Services Regions to enable as default replication regions for the Amazon Web Services account for Multi-Region key replication.
New keys created in this account will automatically be replicated to these regions unless explicitly overridden during key creation.
" } }, "documentation":"Input parameters for enabling default key replication regions for the account.
" }, "EnableDefaultKeyReplicationRegionsOutput":{ "type":"structure", "required":["EnabledReplicationRegions"], "members":{ "EnabledReplicationRegions":{ "shape":"Regions", "documentation":"The complete list of regions where default key replication is now enabled for the account.
This includes both previously enabled regions and the newly added regions from this operation.
" } }, "documentation":"Output from enabling default key replication regions for the account.
" }, "EvenHexLengthBetween16And32":{ "type":"string", "max":32, "min":16, "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+" }, "ExportAs2805KeyCryptogram":{ "type":"structure", "required":[ "WrappingKeyIdentifier", "As2805KeyVariant" ], "members":{ "WrappingKeyIdentifier":{"shape":"KeyArnOrKeyAliasType"}, "As2805KeyVariant":{ "shape":"As2805KeyVariant", "documentation":"The cryptographic usage of the key under export.
" } }, "documentation":"Parameter information for key material export using AS2805 key cryptogram format.
" }, "ExportAttributes":{ "type":"structure", "members":{ "ExportDukptInitialKey":{ "shape":"ExportDukptInitialKey", "documentation":"Parameter information for IPEK export.
" }, "KeyCheckValueAlgorithm":{ "shape":"KeyCheckValueAlgorithm", "documentation":"The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity. Specify KCV for IPEK export only.
For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
" } }, "documentation":"The attributes for IPEK generation during export.
" }, "ExportDiffieHellmanTr31KeyBlock":{ "type":"structure", "required":[ "PrivateKeyIdentifier", "CertificateAuthorityPublicKeyIdentifier", "PublicKeyCertificate", "DeriveKeyAlgorithm", "KeyDerivationFunction", "KeyDerivationHashAlgorithm", "DerivationData" ], "members":{ "PrivateKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the asymmetric ECC key created within Amazon Web Services Payment Cryptography.
The keyARN of the CA that signed the PublicKeyCertificate for the client's receiving ECC key pair.
The public key certificate of the client's receiving ECC key pair, in PEM format (base64 encoded), to use for ECDH key derivation.
" }, "DeriveKeyAlgorithm":{ "shape":"SymmetricKeyAlgorithm", "documentation":"The key algorithm of the shared derived ECDH key.
" }, "KeyDerivationFunction":{ "shape":"KeyDerivationFunction", "documentation":"The key derivation function to use when deriving a key using ECDH.
" }, "KeyDerivationHashAlgorithm":{ "shape":"KeyDerivationHashAlgorithm", "documentation":"The hash type to use when deriving a key using ECDH.
" }, "DerivationData":{ "shape":"DiffieHellmanDerivationData", "documentation":"The shared information used when deriving a key using ECDH.
" }, "KeyBlockHeaders":{"shape":"KeyBlockHeaders"} }, "documentation":"Key derivation parameter information for key material export using asymmetric ECDH key exchange method.
" }, "ExportDukptInitialKey":{ "type":"structure", "required":["KeySerialNumber"], "members":{ "KeySerialNumber":{ "shape":"HexLength20Or24", "documentation":"The KSN for IPEK generation using DUKPT.
KSN must be padded before sending to Amazon Web Services Payment Cryptography. KSN hex length should be 20 for a TDES_2KEY key or 24 for an AES key.
" } }, "documentation":"Parameter information for IPEK generation during export.
" }, "ExportKeyCryptogram":{ "type":"structure", "required":[ "CertificateAuthorityPublicKeyIdentifier", "WrappingKeyCertificate" ], "members":{ "CertificateAuthorityPublicKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The KeyARN of the certificate chain that signs the wrapping key certificate during RSA wrap and unwrap key export.
The wrapping key certificate in PEM format (base64 encoded). Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.
" }, "WrappingSpec":{ "shape":"WrappingKeySpec", "documentation":"The wrapping spec for the key under export.
" } }, "documentation":"Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method.
" }, "ExportKeyInput":{ "type":"structure", "required":[ "KeyMaterial", "ExportKeyIdentifier" ], "members":{ "KeyMaterial":{ "shape":"ExportKeyMaterial", "documentation":"The key block format type, for example, TR-34 or TR-31, to use during key material export.
" }, "ExportKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The KeyARN of the key under export from Amazon Web Services Payment Cryptography.
The attributes for IPEK generation during export.
" } } }, "ExportKeyMaterial":{ "type":"structure", "members":{ "Tr31KeyBlock":{ "shape":"ExportTr31KeyBlock", "documentation":"Parameter information for key material export using symmetric TR-31 key exchange method.
" }, "Tr34KeyBlock":{ "shape":"ExportTr34KeyBlock", "documentation":"Parameter information for key material export using the asymmetric TR-34 key exchange method.
" }, "KeyCryptogram":{ "shape":"ExportKeyCryptogram", "documentation":"Parameter information for key material export using asymmetric RSA wrap and unwrap key exchange method
" }, "DiffieHellmanTr31KeyBlock":{ "shape":"ExportDiffieHellmanTr31KeyBlock", "documentation":"Key derivation parameter information for key material export using asymmetric ECDH key exchange method.
" }, "As2805KeyCryptogram":{ "shape":"ExportAs2805KeyCryptogram", "documentation":"Parameter information for key material export using AS2805 key cryptogram format.
" } }, "documentation":"Parameter information for key material export from Amazon Web Services Payment Cryptography using TR-31 or TR-34 or RSA wrap and unwrap key exchange method.
", "union":true }, "ExportKeyOutput":{ "type":"structure", "members":{ "WrappedKey":{ "shape":"WrappedKey", "documentation":"The key material under export as a TR-34 WrappedKeyBlock or a TR-31 WrappedKeyBlock. or a RSA WrappedKeyCryptogram.
" } } }, "ExportTokenId":{ "type":"string", "pattern":"(export-token-[0-9a-zA-Z]{16,64})?" }, "ExportTr31KeyBlock":{ "type":"structure", "required":["WrappingKeyIdentifier"], "members":{ "WrappingKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The KeyARN of the the wrapping key. This key encrypts or wraps the key under export for TR-31 key block generation.
Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
" } }, "documentation":"Parameter information for key material export using symmetric TR-31 key exchange method.
" }, "ExportTr34KeyBlock":{ "type":"structure", "required":[ "CertificateAuthorityPublicKeyIdentifier", "WrappingKeyCertificate", "KeyBlockFormat" ], "members":{ "CertificateAuthorityPublicKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The KeyARN of the certificate chain that signs the wrapping key certificate during TR-34 key export.
The KeyARN of the wrapping key certificate. Amazon Web Services Payment Cryptography uses this certificate to wrap the key under export.
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 30 days. You can use the same export token to export multiple keys from the same service account.
" }, "SigningKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"Key Identifier used for signing the export key
" }, "SigningKeyCertificate":{ "shape":"CertificateType", "documentation":"The certificate used to sign the TR-34 key block.
" }, "KeyBlockFormat":{ "shape":"Tr34KeyBlockFormat", "documentation":"The format of key block that Amazon Web Services Payment Cryptography will use during key export.
" }, "RandomNonce":{ "shape":"EvenHexLengthBetween16And32", "documentation":"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.
" }, "KeyBlockHeaders":{ "shape":"KeyBlockHeaders", "documentation":"Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
" } }, "documentation":"Parameter information for key material export using the asymmetric TR-34 key exchange method.
" }, "GetAliasInput":{ "type":"structure", "required":["AliasName"], "members":{ "AliasName":{ "shape":"AliasName", "documentation":"The alias of the Amazon Web Services Payment Cryptography key.
" } } }, "GetAliasOutput":{ "type":"structure", "required":["Alias"], "members":{ "Alias":{ "shape":"Alias", "documentation":"The alias of the Amazon Web Services Payment Cryptography key.
" } } }, "GetCertificateSigningRequestInput":{ "type":"structure", "required":[ "KeyIdentifier", "SigningAlgorithm", "CertificateSubject" ], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"Asymmetric key used for generating the certificate signing request
" }, "SigningAlgorithm":{ "shape":"SigningAlgorithmType", "documentation":"The cryptographic algorithm used to sign your CSR.
" }, "CertificateSubject":{ "shape":"CertificateSubjectType", "documentation":"The metadata used to create the CSR.
" } } }, "GetCertificateSigningRequestOutput":{ "type":"structure", "required":["CertificateSigningRequest"], "members":{ "CertificateSigningRequest":{ "shape":"CertificateSigningRequestType", "documentation":"The certificate signing request generated using the key pair associated with the key identifier.
" } } }, "GetDefaultKeyReplicationRegionsInput":{ "type":"structure", "members":{}, "documentation":"Input parameters for retrieving the account's default key replication regions. This operation requires no input parameters.
" }, "GetDefaultKeyReplicationRegionsOutput":{ "type":"structure", "required":["EnabledReplicationRegions"], "members":{ "EnabledReplicationRegions":{ "shape":"Regions", "documentation":"The list of regions where default key replication is currently enabled for the account.
New keys created in this account will automatically be replicated to these regions unless explicitly configured otherwise during key creation.
" } }, "documentation":"Output containing the account's current default key replication configuration.
" }, "GetKeyInput":{ "type":"structure", "required":["KeyIdentifier"], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The KeyARN of the Amazon Web Services Payment Cryptography key.
Contains the key metadata, including both immutable and mutable attributes for the key, but does not include actual cryptographic key material.
" } } }, "GetParametersForExportInput":{ "type":"structure", "required":[ "KeyMaterialType", "SigningKeyAlgorithm" ], "members":{ "KeyMaterialType":{ "shape":"KeyMaterialType", "documentation":"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.
The signing key algorithm to generate a signing key certificate. This certificate signs the wrapped key under export within the TR-34 key block. RSA_2048 is the only signing key algorithm allowed.
The signing key certificate in PEM format (base64 encoded) of the public key for signature within the TR-34 key block. The certificate expires after 30 days.
" }, "SigningKeyCertificateChain":{ "shape":"CertificateType", "documentation":"The root certificate authority (CA) that signed the signing key certificate in PEM format (base64 encoded).
" }, "SigningKeyAlgorithm":{ "shape":"KeyAlgorithm", "documentation":"The algorithm of the signing key certificate for use in TR-34 key block generation. RSA_2048 is the only signing key algorithm allowed.
The export token to initiate key export from Amazon Web Services Payment Cryptography. The export token expires after 30 days. You can use the same export token to export multiple keys from the same service account.
" }, "ParametersValidUntilTimestamp":{ "shape":"Timestamp", "documentation":"The validity period of the export token.
" } } }, "GetParametersForImportInput":{ "type":"structure", "required":[ "KeyMaterialType", "WrappingKeyAlgorithm" ], "members":{ "KeyMaterialType":{ "shape":"KeyMaterialType", "documentation":"The method to use for key material import. Import token is only required for TR-34 WrappedKeyBlock (TR34_KEY_BLOCK) and RSA WrappedKeyCryptogram (KEY_CRYPTOGRAM).
Import token is not required for TR-31, root public key cerificate or trusted public key certificate.
" }, "WrappingKeyAlgorithm":{ "shape":"KeyAlgorithm", "documentation":"The wrapping key algorithm to generate a wrapping key certificate. This certificate wraps the key under import.
At this time, RSA_2048 is the allowed algorithm for TR-34 WrappedKeyBlock import. Additionally, RSA_2048, RSA_3072, RSA_4096 are the allowed algorithms for RSA WrappedKeyCryptogram import.
The wrapping key certificate in PEM format (base64 encoded) of the wrapping key for use within the TR-34 key block. The certificate expires in 30 days.
" }, "WrappingKeyCertificateChain":{ "shape":"CertificateType", "documentation":"The Amazon Web Services Payment Cryptography root certificate authority (CA) that signed the wrapping key certificate in PEM format (base64 encoded).
" }, "WrappingKeyAlgorithm":{ "shape":"KeyAlgorithm", "documentation":"The algorithm of the wrapping key for use within TR-34 WrappedKeyBlock or RSA WrappedKeyCryptogram.
" }, "ImportToken":{ "shape":"ImportTokenId", "documentation":"The import token to initiate key import into Amazon Web Services Payment Cryptography. The import token expires after 30 days. You can use the same import token to import multiple keys to the same service account.
" }, "ParametersValidUntilTimestamp":{ "shape":"Timestamp", "documentation":"The validity period of the import token.
" } } }, "GetPublicKeyCertificateInput":{ "type":"structure", "required":["KeyIdentifier"], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The KeyARN of the asymmetric key pair.
The public key component of the asymmetric key pair in a certificate PEM format (base64 encoded). It is signed by the root certificate authority (CA). The certificate expires in 90 days.
" }, "KeyCertificateChain":{ "shape":"CertificateType", "documentation":"The root certificate authority (CA) that signed the public key certificate in PEM format (base64 encoded) of the asymmetric key pair.
" } } }, "HexLength20Or24":{ "type":"string", "max":24, "min":20, "pattern":"[0-9A-F]{20}$|^[0-9A-F]{24}" }, "ImportAs2805KeyCryptogram":{ "type":"structure", "required":[ "As2805KeyVariant", "KeyModesOfUse", "KeyAlgorithm", "Exportable", "WrappingKeyIdentifier", "WrappedKeyCryptogram" ], "members":{ "As2805KeyVariant":{ "shape":"As2805KeyVariant", "documentation":"The cryptographic usage of the key under import.
" }, "KeyModesOfUse":{"shape":"KeyModesOfUse"}, "KeyAlgorithm":{ "shape":"KeyAlgorithm", "documentation":"The key algorithm of the key under import.
" }, "Exportable":{ "shape":"Boolean", "documentation":"Specified whether the key is exportable. This data is immutable after the key is imported.
" }, "WrappingKeyIdentifier":{"shape":"KeyArnOrKeyAliasType"}, "WrappedKeyCryptogram":{ "shape":"WrappedKeyCryptogram", "documentation":"The wrapped key cryptogram under import.
" } }, "documentation":"Parameter information for key material import using AS2805 key cryptogram format.
" }, "ImportDiffieHellmanTr31KeyBlock":{ "type":"structure", "required":[ "PrivateKeyIdentifier", "CertificateAuthorityPublicKeyIdentifier", "PublicKeyCertificate", "DeriveKeyAlgorithm", "KeyDerivationFunction", "KeyDerivationHashAlgorithm", "DerivationData", "WrappedKeyBlock" ], "members":{ "PrivateKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the asymmetric ECC key created within Amazon Web Services Payment Cryptography.
The keyARN of the CA that signed the PublicKeyCertificate for the client's receiving ECC key pair.
The public key certificate of the client's receiving ECC key pair, in PEM format (base64 encoded), to use for ECDH key derivation.
" }, "DeriveKeyAlgorithm":{ "shape":"SymmetricKeyAlgorithm", "documentation":"The key algorithm of the shared derived ECDH key.
" }, "KeyDerivationFunction":{ "shape":"KeyDerivationFunction", "documentation":"The key derivation function to use when deriving a key using ECDH.
" }, "KeyDerivationHashAlgorithm":{ "shape":"KeyDerivationHashAlgorithm", "documentation":"The hash type to use when deriving a key using ECDH.
" }, "DerivationData":{ "shape":"DiffieHellmanDerivationData", "documentation":"The shared information used when deriving a key using ECDH.
" }, "WrappedKeyBlock":{ "shape":"Tr31WrappedKeyBlock", "documentation":"The ECDH wrapped key block to import.
" } }, "documentation":"Key derivation parameter information for key material import using asymmetric ECDH key exchange method.
" }, "ImportKeyCryptogram":{ "type":"structure", "required":[ "KeyAttributes", "Exportable", "WrappedKeyCryptogram", "ImportToken" ], "members":{ "KeyAttributes":{"shape":"KeyAttributes"}, "Exportable":{ "shape":"Boolean", "documentation":"Specifies whether the key is exportable from the service.
" }, "WrappedKeyCryptogram":{ "shape":"WrappedKeyCryptogram", "documentation":"The RSA wrapped key cryptogram under import.
" }, "ImportToken":{ "shape":"ImportTokenId", "documentation":"The import token that initiates key import using the asymmetric RSA wrap and unwrap key exchange method into AWS Payment Cryptography. It expires after 30 days. You can use the same import token to import multiple keys to the same service account.
" }, "WrappingSpec":{ "shape":"WrappingKeySpec", "documentation":"The wrapping spec for the wrapped key cryptogram.
" } }, "documentation":"Parameter information for key material import using asymmetric RSA wrap and unwrap key exchange method.
" }, "ImportKeyInput":{ "type":"structure", "required":["KeyMaterial"], "members":{ "KeyMaterial":{ "shape":"ImportKeyMaterial", "documentation":"The key or public key certificate type to use during key material import, for example TR-34 or RootCertificatePublicKey.
" }, "KeyCheckValueAlgorithm":{ "shape":"KeyCheckValueAlgorithm", "documentation":"The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
" }, "Enabled":{ "shape":"Boolean", "documentation":"Specifies whether import key is enabled.
" }, "Tags":{ "shape":"Tags", "documentation":"Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is imported. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.
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. 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.
Don't include personal, 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.
Parameter information for root public key certificate import.
" }, "TrustedCertificatePublicKey":{ "shape":"TrustedCertificatePublicKey", "documentation":"Parameter information for trusted public key certificate import.
" }, "Tr31KeyBlock":{ "shape":"ImportTr31KeyBlock", "documentation":"Parameter information for key material import using symmetric TR-31 key exchange method.
" }, "Tr34KeyBlock":{ "shape":"ImportTr34KeyBlock", "documentation":"Parameter information for key material import using the asymmetric TR-34 key exchange method.
" }, "KeyCryptogram":{ "shape":"ImportKeyCryptogram", "documentation":"Parameter information for key material import using asymmetric RSA wrap and unwrap key exchange method.
" }, "DiffieHellmanTr31KeyBlock":{ "shape":"ImportDiffieHellmanTr31KeyBlock", "documentation":"Key derivation parameter information for key material import using asymmetric ECDH key exchange method.
" }, "As2805KeyCryptogram":{ "shape":"ImportAs2805KeyCryptogram", "documentation":"Parameter information for key material import using AS2805 key cryptogram format.
" } }, "documentation":"Parameter information for key material import into Amazon Web Services Payment Cryptography using TR-31 or TR-34 or RSA wrap and unwrap key exchange method.
", "union":true }, "ImportKeyOutput":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"Key", "documentation":"The KeyARN of the key material imported within Amazon Web Services Payment Cryptography.
The KeyARN of the key that will decrypt or unwrap a TR-31 key block during import.
The TR-31 wrapped key block to import.
" } }, "documentation":"Parameter information for key material import using symmetric TR-31 key exchange method.
" }, "ImportTr34KeyBlock":{ "type":"structure", "required":[ "CertificateAuthorityPublicKeyIdentifier", "SigningKeyCertificate", "WrappedKeyBlock", "KeyBlockFormat" ], "members":{ "CertificateAuthorityPublicKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The KeyARN of the certificate chain that signs the signing key certificate during TR-34 key import.
The public key component in PEM certificate format of the private key that signs the KDH TR-34 WrappedKeyBlock.
" }, "ImportToken":{ "shape":"ImportTokenId", "documentation":"The import token that initiates key import using the asymmetric TR-34 key exchange method into Amazon Web Services Payment Cryptography. It expires after 30 days. You can use the same import token to import multiple keys to the same service account.
" }, "WrappingKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"Key Identifier used for unwrapping the import key
" }, "WrappingKeyCertificate":{ "shape":"CertificateType", "documentation":"The certificate used to wrap the TR-34 key block.
" }, "WrappedKeyBlock":{ "shape":"Tr34WrappedKeyBlock", "documentation":"The TR-34 wrapped key block to import.
" }, "KeyBlockFormat":{ "shape":"Tr34KeyBlockFormat", "documentation":"The key block format to use during key import. The only value allowed is X9_TR34_2012.
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.
" } }, "documentation":"Parameter information for key material import using the asymmetric TR-34 key exchange method.
" }, "InternalServerException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"The request processing has failed because of an unknown error, exception, or failure.
This indicates a server-side error within the Amazon Web Services Payment Cryptography service. If this error persists, contact support for assistance.
", "exception":true, "fault":true }, "Key":{ "type":"structure", "required":[ "KeyArn", "KeyAttributes", "KeyCheckValue", "KeyCheckValueAlgorithm", "Enabled", "Exportable", "KeyState", "KeyOrigin", "CreateTimestamp" ], "members":{ "KeyArn":{ "shape":"KeyArn", "documentation":"The Amazon Resource Name (ARN) of the key.
" }, "KeyAttributes":{ "shape":"KeyAttributes", "documentation":"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":{ "shape":"KeyCheckValue", "documentation":"The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.
" }, "KeyCheckValueAlgorithm":{ "shape":"KeyCheckValueAlgorithm", "documentation":"The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
" }, "Enabled":{ "shape":"Boolean", "documentation":"Specifies whether the key is enabled.
" }, "Exportable":{ "shape":"Boolean", "documentation":"Specifies whether the key is exportable. This data is immutable after the key is created.
" }, "KeyState":{ "shape":"KeyState", "documentation":"The state of key that is being created or deleted.
" }, "KeyOrigin":{ "shape":"KeyOrigin", "documentation":"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.
The date and time when the key was created.
" }, "UsageStartTimestamp":{ "shape":"Timestamp", "documentation":"The date and time after which Amazon Web Services Payment Cryptography will start using the key material for cryptographic operations.
" }, "UsageStopTimestamp":{ "shape":"Timestamp", "documentation":"The date and time after which Amazon Web Services Payment Cryptography will stop using the key material for cryptographic operations.
" }, "DeletePendingTimestamp":{ "shape":"Timestamp", "documentation":"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.
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.
The cryptographic usage of an ECDH derived key as defined in section A.5.2 of the TR-31 spec.
" }, "MultiRegionKeyType":{ "shape":"MultiRegionKeyType", "documentation":"Indicates whether this key is a Multi-Region key and its role in the Multi-Region key hierarchy.
Multi-Region replication keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a Primary Region key (PRK) (which can be replicated to other Amazon Web Services Regions) or a Replica Region key (RRK) (which is a copy of a PRK in another Region). For more information, see Multi-Region key replication.
" }, "PrimaryRegion":{"shape":"Region"}, "ReplicationStatus":{ "shape":"ReplicationStatus", "documentation":"Information about the replication status of the key across different Amazon Web Services Regions.
This field provides details about the current state of key replication, including any status messages or operational information. It helps track the progress and health of key replication operations.
" }, "UsingDefaultReplicationRegions":{ "shape":"Boolean", "documentation":"Indicates whether this key is using the account's default replication regions configuration for Multi-Region key replication.
When set to true, the key automatically replicates to the regions specified in the account's default replication settings. When set to false, the key has a custom replication configuration that overrides the account defaults.
Metadata about an Amazon Web Services Payment Cryptography key.
" }, "KeyAlgorithm":{ "type":"string", "enum":[ "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224", "RSA_2048", "RSA_3072", "RSA_4096", "ECC_NIST_P256", "ECC_NIST_P384", "ECC_NIST_P521" ] }, "KeyArn":{ "type":"string", "max":150, "min":70, "pattern":"arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}" }, "KeyArnOrKeyAliasType":{ "type":"string", "documentation":"A key identifier that can be either a key ARN or an alias name. This allows flexible key identification in operations.
When using a key ARN, it must be a fully qualified ARN in the format: arn:aws:payment-cryptography:region:account:key/key-id.
When using an alias, it must begin with alias/ followed by the alias name.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
The cryptographic usage of an Amazon Web Services Payment Cryptography key as defined in section A.5.2 of the TR-31 spec.
" }, "KeyClass":{ "shape":"KeyClass", "documentation":"The type of Amazon Web Services Payment Cryptography key to create, which determines the classification of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
" }, "KeyAlgorithm":{ "shape":"KeyAlgorithm", "documentation":"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.
The list of cryptographic operations that you can perform using the key.
" } }, "documentation":"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.
" }, "KeyBlockHeaders":{ "type":"structure", "members":{ "KeyModesOfUse":{"shape":"KeyModesOfUse"}, "KeyExportability":{ "shape":"KeyExportability", "documentation":"Specifies subsequent exportability of the key within the key block after it is received by the receiving party. It can be used to further restrict exportability of the key after export from Amazon Web Services Payment Cryptography.
When set to EXPORTABLE, the key can be subsequently exported by the receiver under a KEK using TR-31 or TR-34 key block export only. When set to NON_EXPORTABLE, the key cannot be subsequently exported by the receiver. When set to SENSITIVE, the key can be exported by the receiver under a KEK using TR-31, TR-34, RSA wrap and unwrap cryptogram or using a symmetric cryptogram key export method. For further information refer to ANSI X9.143-2022.
Parameter used to indicate the version of the key carried in the key block or indicate the value carried in the key block is a component of a key.
" }, "OptionalBlocks":{ "shape":"OptionalBlocks", "documentation":"Parameter used to indicate the type of optional data in key block headers. Refer to ANSI X9.143-2022 for information on allowed data type for optional blocks.
Optional block character limit is 112 characters. For each optional block, 2 characters are reserved for optional block ID and 2 characters reserved for optional block length. More than one optional blocks can be included as long as the combined length does not increase 112 characters.
" } }, "documentation":"Optional metadata for export associated with the key material. This data is signed but transmitted in clear text.
" }, "KeyCheckValue":{ "type":"string", "max":16, "min":4, "pattern":"[0-9a-fA-F]+" }, "KeyCheckValueAlgorithm":{ "type":"string", "enum":[ "CMAC", "ANSI_X9_24", "HMAC", "SHA_1" ] }, "KeyClass":{ "type":"string", "enum":[ "SYMMETRIC_KEY", "ASYMMETRIC_KEY_PAIR", "PRIVATE_KEY", "PUBLIC_KEY" ] }, "KeyDerivationFunction":{ "type":"string", "enum":[ "NIST_SP800", "ANSI_X963" ] }, "KeyDerivationHashAlgorithm":{ "type":"string", "enum":[ "SHA_256", "SHA_384", "SHA_512" ] }, "KeyExportability":{ "type":"string", "enum":[ "EXPORTABLE", "NON_EXPORTABLE", "SENSITIVE" ] }, "KeyMaterial":{ "type":"string", "max":16384, "min":32, "sensitive":true }, "KeyMaterialType":{ "type":"string", "enum":[ "TR34_KEY_BLOCK", "TR31_KEY_BLOCK", "ROOT_PUBLIC_KEY_CERTIFICATE", "TRUSTED_PUBLIC_KEY_CERTIFICATE", "KEY_CRYPTOGRAM" ] }, "KeyModesOfUse":{ "type":"structure", "members":{ "Encrypt":{ "shape":"PrimitiveBoolean", "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used to encrypt data.
" }, "Decrypt":{ "shape":"PrimitiveBoolean", "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used to decrypt data.
" }, "Wrap":{ "shape":"PrimitiveBoolean", "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used to wrap other keys.
" }, "Unwrap":{ "shape":"PrimitiveBoolean", "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used to unwrap other keys.
" }, "Generate":{ "shape":"PrimitiveBoolean", "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used to generate and verify other card and PIN verification keys.
" }, "Sign":{ "shape":"PrimitiveBoolean", "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used for signing.
" }, "Verify":{ "shape":"PrimitiveBoolean", "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used to verify signatures.
" }, "DeriveKey":{ "shape":"PrimitiveBoolean", "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key can be used to derive new keys.
" }, "NoRestrictions":{ "shape":"PrimitiveBoolean", "documentation":"Specifies whether an Amazon Web Services Payment Cryptography key has no special restrictions other than the restrictions implied by KeyUsage.
The list of cryptographic operations that you can perform using the key. The modes of use are defined in section A.5.3 of the TR-31 spec.
" }, "KeyOrigin":{ "type":"string", "documentation":"Defines the source of a key
", "enum":[ "EXTERNAL", "AWS_PAYMENT_CRYPTOGRAPHY" ] }, "KeyReplicationState":{ "type":"string", "documentation":"Defines the replication state of a key
", "enum":[ "IN_PROGRESS", "DELETE_IN_PROGRESS", "FAILED", "SYNCHRONIZED" ] }, "KeyState":{ "type":"string", "documentation":"Defines the state of a key
", "enum":[ "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "DELETE_PENDING", "DELETE_COMPLETE" ] }, "KeySummary":{ "type":"structure", "required":[ "KeyArn", "KeyState", "KeyAttributes", "KeyCheckValue", "Exportable", "Enabled" ], "members":{ "KeyArn":{ "shape":"KeyArn", "documentation":"The Amazon Resource Name (ARN) of the key.
" }, "KeyState":{ "shape":"KeyState", "documentation":"The state of an Amazon Web Services Payment Cryptography that is being created or deleted.
" }, "KeyAttributes":{ "shape":"KeyAttributes", "documentation":"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":{ "shape":"KeyCheckValue", "documentation":"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.
" }, "Exportable":{ "shape":"Boolean", "documentation":"Specifies whether the key is exportable. This data is immutable after the key is created.
" }, "Enabled":{ "shape":"Boolean", "documentation":"Specifies whether the key is enabled.
" }, "MultiRegionKeyType":{ "shape":"MultiRegionKeyType", "documentation":"Indicates whether this key is a Multi-Region key and its role in the Multi-Region key hierarchy.
Multi-Region replication keys allow the same key material to be used across multiple Amazon Web Services Regions. This field specifies whether the key is a Primary Region key (PRK) (which can be replicated to other Amazon Web Services Regions) or a Replica Region key (RRK) (which is a copy of a PRK in another Region). For more information, see Multi-Region key replication.
" }, "PrimaryRegion":{"shape":"Region"} }, "documentation":"Metadata about an Amazon Web Services Payment Cryptography key.
" }, "KeySummaryList":{ "type":"list", "member":{"shape":"KeySummary"} }, "KeyUsage":{ "type":"string", "enum":[ "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_M0_ISO_16609_MAC_KEY", "TR31_M3_ISO_9797_3_MAC_KEY", "TR31_M1_ISO_9797_1_MAC_KEY", "TR31_M6_ISO_9797_5_CMAC_KEY", "TR31_M7_HMAC_KEY", "TR31_P0_PIN_ENCRYPTION_KEY", "TR31_P1_PIN_GENERATION_KEY", "TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE", "TR31_V1_IBM3624_PIN_VERIFICATION_KEY", "TR31_V2_VISA_PIN_VERIFICATION_KEY", "TR31_K2_TR34_ASYMMETRIC_KEY" ] }, "KeyVersion":{ "type":"string", "max":2, "min":2, "pattern":"[0-9A-Z]{2}+" }, "ListAliasesInput":{ "type":"structure", "members":{ "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN for which you want to list all aliases.
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.
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.
" } } }, "ListAliasesOutput":{ "type":"structure", "required":["Aliases"], "members":{ "Aliases":{ "shape":"Aliases", "documentation":"The list of aliases. Each alias describes the KeyArn contained within.
The token for the next set of results, or an empty or null value if there are no more results.
" } } }, "ListKeysInput":{ "type":"structure", "members":{ "KeyState":{ "shape":"KeyState", "documentation":"The key state of the keys you want to list.
" }, "NextToken":{ "shape":"NextToken", "documentation":"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.
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.
" } } }, "ListKeysOutput":{ "type":"structure", "required":["Keys"], "members":{ "Keys":{ "shape":"KeySummaryList", "documentation":"The list of keys created within the caller's Amazon Web Services account and Amazon Web Services Region.
" }, "NextToken":{ "shape":"NextToken", "documentation":"The token for the next set of results, or an empty or null value if there are no more results.
" } } }, "ListTagsForResourceInput":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"The KeyARN of the key whose tags you are getting.
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.
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.
" } } }, "ListTagsForResourceOutput":{ "type":"structure", "required":["Tags"], "members":{ "Tags":{ "shape":"Tags", "documentation":"The list of tags associated with a ResourceArn. Each tag will list the key-value pair contained within that tag.
The token for the next set of results, or an empty or null value if there are no more results.
" } } }, "MaxResults":{ "type":"integer", "box":true, "max":100, "min":1 }, "MultiRegionKeyType":{ "type":"string", "documentation":"Defines the replication type of a key
", "enum":[ "PRIMARY", "REPLICA" ] }, "NextToken":{ "type":"string", "max":8192, "min":1 }, "OptionalBlockId":{ "type":"string", "max":2, "min":2, "pattern":"[0-9A-Z]{2}+", "sensitive":true }, "OptionalBlockValue":{ "type":"string", "max":108, "min":1, "pattern":"[0-9a-zA-Z]+", "sensitive":true }, "OptionalBlocks":{ "type":"map", "key":{"shape":"OptionalBlockId"}, "value":{"shape":"OptionalBlockValue"} }, "PrimitiveBoolean":{"type":"boolean"}, "Region":{ "type":"string", "documentation":"An Amazon Web Services Region identifier in the standard format (e.g., us-east-1, eu-west-1).
Used to specify regions for key replication operations. The region must be a valid Amazon Web Services Region where Amazon Web Services Payment Cryptography is available.
", "pattern":"[a-z]{2}-[a-z]{1,16}-[0-9]+" }, "Regions":{ "type":"list", "member":{"shape":"Region"}, "documentation":"A list of Amazon Web Services Regions for key replication operations.
Each region in the list must be a valid Amazon Web Services Region identifier where Amazon Web Services Payment Cryptography is available. This list is used to specify which regions should be added to or removed from a key's replication configuration.
" }, "RemoveKeyReplicationRegionsInput":{ "type":"structure", "required":[ "KeyIdentifier", "ReplicationRegions" ], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The key identifier (ARN or alias) of the key from which to remove replication regions.
This key must exist and have replication enabled in the specified regions.
" }, "ReplicationRegions":{ "shape":"Regions", "documentation":"The list of Amazon Web Services Regions to remove from the key's replication configuration.
The key will no longer be available for cryptographic operations in these regions after removal. Ensure no active operations depend on the key in these regions before removal.
" } }, "documentation":"Input parameters for removing replication regions from a specific key.
" }, "RemoveKeyReplicationRegionsOutput":{ "type":"structure", "required":["Key"], "members":{ "Key":{ "shape":"Key", "documentation":"The updated key metadata after removing the replication regions.
This reflects the current state of the key and its updated replication configuration.
" } }, "documentation":"Output from removing replication regions from a key.
" }, "ReplicationStatus":{ "type":"map", "key":{"shape":"Region"}, "value":{"shape":"ReplicationStatusType"} }, "ReplicationStatusType":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"KeyReplicationState", "documentation":"The current status of key replication in this Amazon Web Services Region.
This field indicates whether the key replication is in progress, completed successfully, or has encountered an error. Possible values include states such as SYNCRHONIZED, IN_PROGRESS, DELETE_IN_PROGRESS, or FAILED. This provides visibility into the replication process for monitoring and troubleshooting purposes.
A message that provides additional information about the current replication status of the key.
This field contains details about any issues or progress updates related to key replication operations. It may include information about replication failures, synchronization status, or other operational details.
" } }, "documentation":"Represents the replication status information for a key in a replication region for Multi-Region key replication.
This structure contains details about the current state of key replication, including any status messages and operational information about the replication process.
" }, "ResourceArn":{ "type":"string", "max":150, "min":70, "pattern":"arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}" }, "ResourceNotFoundException":{ "type":"structure", "members":{ "ResourceId":{ "shape":"String", "documentation":"The identifier of the resource that was not found.
This field contains the specific resource identifier (such as a key ARN or alias name) that could not be located.
" } }, "documentation":"The request was denied due to resource not found.
The specified key, alias, or other resource does not exist in your account or region. Verify that the resource identifier is correct and that the resource exists in the expected region.
", "exception":true }, "RestoreKeyInput":{ "type":"structure", "required":["KeyIdentifier"], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The KeyARN of the key to be restored within Amazon Web Services Payment Cryptography.
The key material of the restored key. The KeyState will change to CREATE_COMPLETE and value for DeletePendingTimestamp gets removed.
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":{ "shape":"CertificateType", "documentation":"Parameter information for root public key certificate import.
" } }, "documentation":"Parameter information for root public key certificate import.
" }, "ServiceQuotaExceededException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"This request would cause a service quota to be exceeded.
You have reached the maximum number of keys, aliases, or other resources allowed in your account. Review your current usage and consider deleting unused resources or requesting a quota increase.
", "exception":true }, "ServiceUnavailableException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"The service cannot complete the request.
The Amazon Web Services Payment Cryptography service is temporarily unavailable. This is typically a temporary condition - retry your request after a brief delay.
", "exception":true, "fault":true }, "SharedInformation":{ "type":"string", "max":2048, "min":2, "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+" }, "SigningAlgorithmType":{ "type":"string", "documentation":"Defines the Algorithm used to generate the certificate signing request
", "enum":[ "SHA224", "SHA256", "SHA384", "SHA512" ] }, "StartKeyUsageInput":{ "type":"structure", "required":["KeyIdentifier"], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The KeyArn of the key.
The KeyARN of the Amazon Web Services Payment Cryptography key activated for use.
The KeyArn of the key.
The KeyARN of the key.
The key of the tag.
" }, "Value":{ "shape":"TagValue", "documentation":"The value of the tag.
" } }, "documentation":"A structure that contains information about a tag.
" }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeys":{ "type":"list", "member":{"shape":"TagKey"}, "max":200, "min":0 }, "TagResourceInput":{ "type":"structure", "required":[ "ResourceArn", "Tags" ], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"The KeyARN of the key whose tags are being updated.
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 personal, 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 personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
The request was denied due to request throttling.
You have exceeded the rate limits for Amazon Web Services Payment Cryptography API calls. Implement exponential backoff and retry logic in your application to handle throttling gracefully.
", "exception":true }, "Timestamp":{"type":"timestamp"}, "Tr31WrappedKeyBlock":{ "type":"string", "max":9984, "min":56, "pattern":"[0-9a-zA-Z]+", "sensitive":true }, "Tr34KeyBlockFormat":{ "type":"string", "enum":["X9_TR34_2012"] }, "Tr34WrappedKeyBlock":{ "type":"string", "max":4096, "min":2, "pattern":"[0-9A-F]+", "sensitive":true }, "TrustedCertificatePublicKey":{ "type":"structure", "required":[ "KeyAttributes", "PublicKeyCertificate", "CertificateAuthorityPublicKeyIdentifier" ], "members":{ "KeyAttributes":{ "shape":"KeyAttributes", "documentation":"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":{ "shape":"CertificateType", "documentation":"Parameter information for trusted public key certificate import.
" }, "CertificateAuthorityPublicKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The KeyARN of the root public key certificate or certificate chain that signs the trusted public key certificate import.
Parameter information for trusted public key certificate import.
" }, "UntagResourceInput":{ "type":"structure", "required":[ "ResourceArn", "TagKeys" ], "members":{ "ResourceArn":{ "shape":"ResourceArn", "documentation":"The KeyARN of the key whose tags are being removed.
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.
" } } }, "UntagResourceOutput":{ "type":"structure", "members":{} }, "UpdateAliasInput":{ "type":"structure", "required":["AliasName"], "members":{ "AliasName":{ "shape":"AliasName", "documentation":"The alias whose associated key is changing.
" }, "KeyArn":{ "shape":"KeyArn", "documentation":"The KeyARN for the key that you are updating or removing from the alias.
The alias name.
" } } }, "ValidationException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"The request was denied due to an invalid request error.
One or more parameters in your request are invalid. Check the parameter values, formats, and constraints specified in the API documentation.
", "exception":true }, "WrappedKey":{ "type":"structure", "required":[ "WrappingKeyArn", "WrappedKeyMaterialFormat", "KeyMaterial" ], "members":{ "WrappingKeyArn":{ "shape":"KeyArn", "documentation":"The KeyARN of the wrapped key.
The key block format of a wrapped key.
" }, "KeyMaterial":{ "shape":"KeyMaterial", "documentation":"Parameter information for generating a wrapped key using TR-31 or TR-34 skey exchange method.
" }, "KeyCheckValue":{ "shape":"KeyCheckValue", "documentation":"The key check value (KCV) is used to check if all parties holding a given key have the same key or to detect that a key has changed.
" }, "KeyCheckValueAlgorithm":{ "shape":"KeyCheckValueAlgorithm", "documentation":"The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
" } }, "documentation":"Parameter information for generating a WrappedKeyBlock for key exchange.
" }, "WrappedKeyCryptogram":{ "type":"string", "max":4096, "min":16, "pattern":"[0-9A-F]+", "sensitive":true }, "WrappedKeyMaterialFormat":{ "type":"string", "enum":[ "KEY_CRYPTOGRAM", "TR31_KEY_BLOCK", "TR34_KEY_BLOCK" ] }, "WrappingKeySpec":{ "type":"string", "enum":[ "RSA_OAEP_SHA_256", "RSA_OAEP_SHA_512" ] } }, "documentation":"Amazon Web Services Payment Cryptography Control Plane APIs manage encryption keys for use during payment-related cryptographic operations. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. For more information, see Identity and access management in the Amazon Web Services Payment Cryptography User Guide.
To use encryption keys for payment-related transaction processing and associated cryptographic operations, you use the Amazon Web Services Payment Cryptography Data Plane. You can perform actions like encrypt, decrypt, generate, and verify payment-related data.
All Amazon Web Services Payment Cryptography API calls must be signed and transmitted using Transport Layer Security (TLS). We recommend you always use the latest supported TLS version for logging API requests.
Amazon Web Services Payment Cryptography supports CloudTrail for control plane operations, a service that logs Amazon Web Services API calls and related events for your Amazon Web Services account and delivers them to an Amazon S3 bucket you specify. By using the information collected by CloudTrail, you can determine what requests were made to Amazon Web Services Payment Cryptography, who made the request, when it was made, and so on. If you don't configure a trail, you can still view the most recent events in the CloudTrail console. For more information, see the CloudTrail User Guide.
" }