AbstractAWSPaymentCryptographyAsync (AWS Java SDK for Payment Cryptography Control Plane 1.12.610 API)

java.lang.Object
- com.amazonaws.services.paymentcryptography.AbstractAWSPaymentCryptography
- - com.amazonaws.services.paymentcryptography.AbstractAWSPaymentCryptographyAsync

All Implemented Interfaces:

AWSPaymentCryptography, AWSPaymentCryptographyAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSPaymentCryptographyAsync
extends AbstractAWSPaymentCryptography
implements AWSPaymentCryptographyAsync
```
Abstract implementation of AWSPaymentCryptographyAsync. Convenient method forms pass through to the corresponding overload that takes a request object and an AsyncHandler, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.paymentcryptography.AWSPaymentCryptography
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAWSPaymentCryptographyAsync()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAWSPaymentCryptographyAsync()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Future<CreateAliasResult>`	`createAliasAsync(CreateAliasRequest request)` Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key.
`Future<CreateAliasResult>`	`createAliasAsync(CreateAliasRequest request, AsyncHandler<CreateAliasRequest,CreateAliasResult> asyncHandler)` Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key.
`Future<CreateKeyResult>`	`createKeyAsync(CreateKeyRequest request)` 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.
`Future<CreateKeyResult>`	`createKeyAsync(CreateKeyRequest request, AsyncHandler<CreateKeyRequest,CreateKeyResult> asyncHandler)` 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.
`Future<DeleteAliasResult>`	`deleteAliasAsync(DeleteAliasRequest request)` Deletes the alias, but doesn't affect the underlying key.
`Future<DeleteAliasResult>`	`deleteAliasAsync(DeleteAliasRequest request, AsyncHandler<DeleteAliasRequest,DeleteAliasResult> asyncHandler)` Deletes the alias, but doesn't affect the underlying key.
`Future<DeleteKeyResult>`	`deleteKeyAsync(DeleteKeyRequest request)` Deletes the key material and metadata associated with Amazon Web Services Payment Cryptography key.
`Future<DeleteKeyResult>`	`deleteKeyAsync(DeleteKeyRequest request, AsyncHandler<DeleteKeyRequest,DeleteKeyResult> asyncHandler)` Deletes the key material and metadata associated with Amazon Web Services Payment Cryptography key.
`Future<ExportKeyResult>`	`exportKeyAsync(ExportKeyRequest request)` Exports a key from Amazon Web Services Payment Cryptography.
`Future<ExportKeyResult>`	`exportKeyAsync(ExportKeyRequest request, AsyncHandler<ExportKeyRequest,ExportKeyResult> asyncHandler)` Exports a key from Amazon Web Services Payment Cryptography.
`Future<GetAliasResult>`	`getAliasAsync(GetAliasRequest request)` Gets the Amazon Web Services Payment Cryptography key associated with the alias.
`Future<GetAliasResult>`	`getAliasAsync(GetAliasRequest request, AsyncHandler<GetAliasRequest,GetAliasResult> asyncHandler)` Gets the Amazon Web Services Payment Cryptography key associated with the alias.
`Future<GetKeyResult>`	`getKeyAsync(GetKeyRequest request)` Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
`Future<GetKeyResult>`	`getKeyAsync(GetKeyRequest request, AsyncHandler<GetKeyRequest,GetKeyResult> asyncHandler)` Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
`Future<GetParametersForExportResult>`	`getParametersForExportAsync(GetParametersForExportRequest request)` Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
`Future<GetParametersForExportResult>`	`getParametersForExportAsync(GetParametersForExportRequest request, AsyncHandler<GetParametersForExportRequest,GetParametersForExportResult> asyncHandler)` Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
`Future<GetParametersForImportResult>`	`getParametersForImportAsync(GetParametersForImportRequest request)` Gets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock.
`Future<GetParametersForImportResult>`	`getParametersForImportAsync(GetParametersForImportRequest request, AsyncHandler<GetParametersForImportRequest,GetParametersForImportResult> asyncHandler)` Gets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock.
`Future<GetPublicKeyCertificateResult>`	`getPublicKeyCertificateAsync(GetPublicKeyCertificateRequest request)` Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography.
`Future<GetPublicKeyCertificateResult>`	`getPublicKeyCertificateAsync(GetPublicKeyCertificateRequest request, AsyncHandler<GetPublicKeyCertificateRequest,GetPublicKeyCertificateResult> asyncHandler)` Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography.
`Future<ImportKeyResult>`	`importKeyAsync(ImportKeyRequest request)` Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.
`Future<ImportKeyResult>`	`importKeyAsync(ImportKeyRequest request, AsyncHandler<ImportKeyRequest,ImportKeyResult> asyncHandler)` Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.
`Future<ListAliasesResult>`	`listAliasesAsync(ListAliasesRequest request)` Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region.
`Future<ListAliasesResult>`	`listAliasesAsync(ListAliasesRequest request, AsyncHandler<ListAliasesRequest,ListAliasesResult> asyncHandler)` Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region.
`Future<ListKeysResult>`	`listKeysAsync(ListKeysRequest request)` Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region.
`Future<ListKeysResult>`	`listKeysAsync(ListKeysRequest request, AsyncHandler<ListKeysRequest,ListKeysResult> asyncHandler)` Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region.
`Future<ListTagsForResourceResult>`	`listTagsForResourceAsync(ListTagsForResourceRequest request)` Lists the tags for an Amazon Web Services resource.
`Future<ListTagsForResourceResult>`	`listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)` Lists the tags for an Amazon Web Services resource.
`Future<RestoreKeyResult>`	`restoreKeyAsync(RestoreKeyRequest request)` Cancels a scheduled key deletion during the waiting period.
`Future<RestoreKeyResult>`	`restoreKeyAsync(RestoreKeyRequest request, AsyncHandler<RestoreKeyRequest,RestoreKeyResult> asyncHandler)` Cancels a scheduled key deletion during the waiting period.
`Future<StartKeyUsageResult>`	`startKeyUsageAsync(StartKeyUsageRequest request)` Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography
`Future<StartKeyUsageResult>`	`startKeyUsageAsync(StartKeyUsageRequest request, AsyncHandler<StartKeyUsageRequest,StartKeyUsageResult> asyncHandler)` Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography
`Future<StopKeyUsageResult>`	`stopKeyUsageAsync(StopKeyUsageRequest request)` Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
`Future<StopKeyUsageResult>`	`stopKeyUsageAsync(StopKeyUsageRequest request, AsyncHandler<StopKeyUsageRequest,StopKeyUsageResult> asyncHandler)` Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
`Future<TagResourceResult>`	`tagResourceAsync(TagResourceRequest request)` Adds or edits tags on an Amazon Web Services Payment Cryptography key.
`Future<TagResourceResult>`	`tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)` Adds or edits tags on an Amazon Web Services Payment Cryptography key.
`Future<UntagResourceResult>`	`untagResourceAsync(UntagResourceRequest request)` Deletes a tag from an Amazon Web Services Payment Cryptography key.
`Future<UntagResourceResult>`	`untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)` Deletes a tag from an Amazon Web Services Payment Cryptography key.
`Future<UpdateAliasResult>`	`updateAliasAsync(UpdateAliasRequest request)` Associates an existing Amazon Web Services Payment Cryptography alias with a different key.
`Future<UpdateAliasResult>`	`updateAliasAsync(UpdateAliasRequest request, AsyncHandler<UpdateAliasRequest,UpdateAliasResult> asyncHandler)` Associates an existing Amazon Web Services Payment Cryptography alias with a different key.

Methods inherited from class com.amazonaws.services.paymentcryptography.AbstractAWSPaymentCryptography
createAlias, createKey, deleteAlias, deleteKey, exportKey, getAlias, getCachedResponseMetadata, getKey, getParametersForExport, getParametersForImport, getPublicKeyCertificate, importKey, listAliases, listKeys, listTagsForResource, restoreKey, shutdown, startKeyUsage, stopKeyUsage, tagResource, untagResource, updateAlias

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.paymentcryptography.AWSPaymentCryptography
createAlias, createKey, deleteAlias, deleteKey, exportKey, getAlias, getCachedResponseMetadata, getKey, getParametersForExport, getParametersForImport, getPublicKeyCertificate, importKey, listAliases, listKeys, listTagsForResource, restoreKey, shutdown, startKeyUsage, stopKeyUsage, tagResource, untagResource, updateAlias

- Constructor Detail
  - AbstractAWSPaymentCryptographyAsync
```
protected AbstractAWSPaymentCryptographyAsync()
```
- Method Detail
  - createAliasAsync
```
public Future<CreateAliasResult> createAliasAsync(CreateAliasRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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:
    Specified by:
    
    createAliasAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the CreateAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAliasAsync
```
public Future<CreateAliasResult> createAliasAsync(CreateAliasRequest request,
                                                  AsyncHandler<CreateAliasRequest,CreateAliasResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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:
    Specified by:
    
    createAliasAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the CreateAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createKeyAsync
```
public Future<CreateKeyResult> createKeyAsync(CreateKeyRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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). For information about valid combinations of key attributes, see Understanding key attributes in the Amazon Web Services Payment Cryptography User Guide. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.
    
    Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    Specified by:
    
    createKeyAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the CreateKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createKeyAsync
```
public Future<CreateKeyResult> createKeyAsync(CreateKeyRequest request,
                                              AsyncHandler<CreateKeyRequest,CreateKeyResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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). For information about valid combinations of key attributes, see Understanding key attributes in the Amazon Web Services Payment Cryptography User Guide. The mutable data contained within a key includes usage timestamp and key deletion timestamp and can be modified after creation.
    
    Amazon Web Services Payment Cryptography binds key attributes to keys using key blocks when you store or export them. Amazon Web Services Payment Cryptography stores the key contents wrapped and never stores or transmits them in the clear.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    Specified by:
    
    createKeyAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the CreateKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAliasAsync
```
public Future<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Deletes the alias, but doesn't affect the underlying key.
    
    Each key can have multiple aliases. To get the aliases of all keys, use the ListAliases operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    Specified by:
    
    deleteAliasAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the DeleteAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAliasAsync
```
public Future<DeleteAliasResult> deleteAliasAsync(DeleteAliasRequest request,
                                                  AsyncHandler<DeleteAliasRequest,DeleteAliasResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Deletes the alias, but doesn't affect the underlying key.
    
    Each key can have multiple aliases. To get the aliases of all keys, use the ListAliases operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    Specified by:
    
    deleteAliasAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DeleteAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteKeyAsync
```
public Future<DeleteKeyResult> deleteKeyAsync(DeleteKeyRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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:
    Specified by:
    
    deleteKeyAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the DeleteKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteKeyAsync
```
public Future<DeleteKeyResult> deleteKeyAsync(DeleteKeyRequest request,
                                              AsyncHandler<DeleteKeyRequest,DeleteKeyResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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:
    Specified by:
    
    deleteKeyAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the DeleteKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - exportKeyAsync
```
public Future<ExportKeyResult> exportKeyAsync(ExportKeyRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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 . 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.
    
    The TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block.
    
    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.
    
    To export 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 7 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 WK (Working Key) 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.
    When this operation is successful, Amazon Web Services Payment Cryptography returns the WK or IPEK as a TR-31 WrappedKeyBlock.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    - GetParametersForExport
    - ImportKey
    Specified by:
    
    exportKeyAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the ExportKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - exportKeyAsync
```
public Future<ExportKeyResult> exportKeyAsync(ExportKeyRequest request,
                                              AsyncHandler<ExportKeyRequest,ExportKeyResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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 . 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.
    
    The TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block.
    
    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.
    
    To export 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 7 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 WK (Working Key) 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.
    When this operation is successful, Amazon Web Services Payment Cryptography returns the WK or IPEK as a TR-31 WrappedKeyBlock.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    - GetParametersForExport
    - ImportKey
    Specified by:
    
    exportKeyAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ExportKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAliasAsync
```
public Future<GetAliasResult> getAliasAsync(GetAliasRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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:
    Specified by:
    
    getAliasAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the GetAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAliasAsync
```
public Future<GetAliasResult> getAliasAsync(GetAliasRequest request,
                                            AsyncHandler<GetAliasRequest,GetAliasResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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:
    Specified by:
    
    getAliasAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the GetAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getKeyAsync
```
public Future<GetKeyResult> getKeyAsync(GetKeyRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    Specified by:
    
    getKeyAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the GetKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getKeyAsync
```
public Future<GetKeyResult> getKeyAsync(GetKeyRequest request,
                                        AsyncHandler<GetKeyRequest,GetKeyResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    Specified by:
    
    getKeyAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the GetKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getParametersForExportAsync
```
public Future<GetParametersForExportResult> getParametersForExportAsync(GetParametersForExportRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
    
    The signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling ExportKey. The export token expires in 7 days. You can use the same export token to export multiple keys from your service account.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    - ExportKey
    - GetParametersForImport
    Specified by:
    
    getParametersForExportAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the GetParametersForExport operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getParametersForExportAsync
```
public Future<GetParametersForExportResult> getParametersForExportAsync(GetParametersForExportRequest request,
                                                                        AsyncHandler<GetParametersForExportRequest,GetParametersForExportResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.
    
    The signing key certificate signs the wrapped key under export within the TR-34 key payload. The export token and signing key certificate must be in place and operational before calling ExportKey. The export token expires in 7 days. You can use the same export token to export multiple keys from your service account.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    - ExportKey
    - GetParametersForImport
    Specified by:
    
    getParametersForExportAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the GetParametersForExport operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getParametersForImportAsync
```
public Future<GetParametersForImportResult> getParametersForImportAsync(GetParametersForImportRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Gets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock.
    
    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 7 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:
    - GetParametersForExport
    - ImportKey
    Specified by:
    
    getParametersForImportAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the GetParametersForImport operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getParametersForImportAsync
```
public Future<GetParametersForImportResult> getParametersForImportAsync(GetParametersForImportRequest request,
                                                                        AsyncHandler<GetParametersForImportRequest,GetParametersForImportResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Gets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock.
    
    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 7 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:
    - GetParametersForExport
    - ImportKey
    Specified by:
    
    getParametersForImportAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the GetParametersForImport operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getPublicKeyCertificateAsync
```
public Future<GetPublicKeyCertificateResult> getPublicKeyCertificateAsync(GetPublicKeyCertificateRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    
    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.
    
    Specified by:
    
    getPublicKeyCertificateAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the GetPublicKeyCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getPublicKeyCertificateAsync
```
public Future<GetPublicKeyCertificateResult> getPublicKeyCertificateAsync(GetPublicKeyCertificateRequest request,
                                                                          AsyncHandler<GetPublicKeyCertificateRequest,GetPublicKeyCertificateResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    
    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.
    
    Specified by:
    
    getPublicKeyCertificateAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the GetPublicKeyCertificate operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importKeyAsync
```
public Future<ImportKeyResult> importKeyAsync(ImportKeyRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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 . 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.
    
    The TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block.
    
    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
    
    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 KEK or ZMK 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 7 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 WK (Working Key) 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.
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    - ExportKey
    - GetParametersForImport
    Specified by:
    
    importKeyAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the ImportKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - importKeyAsync
```
public Future<ImportKeyResult> importKeyAsync(ImportKeyRequest request,
                                              AsyncHandler<ImportKeyRequest,ImportKeyResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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 . 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.
    
    The TR-34 norm is intended for exchanging 3DES keys only and keys are imported in a WrappedKeyBlock format. Key attributes (such as KeyUsage, KeyAlgorithm, KeyModesOfUse, Exportability) are contained within the key block.
    
    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
    
    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 KEK or ZMK 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 7 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 WK (Working Key) 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.
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    - ExportKey
    - GetParametersForImport
    Specified by:
    
    importKeyAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ImportKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAliasesAsync
```
public Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of aliases. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.
    
    This is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value. Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    Specified by:
    
    listAliasesAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the ListAliases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAliasesAsync
```
public Future<ListAliasesResult> listAliasesAsync(ListAliasesRequest request,
                                                  AsyncHandler<ListAliasesRequest,ListAliasesResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of aliases. For more information, see Using aliases in the Amazon Web Services Payment Cryptography User Guide.
    
    This is a paginated operation, which means that each response might contain only a subset of all the aliases. When the response contains only a subset of aliases, it includes a NextToken value. Use this value in a subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    Specified by:
    
    listAliasesAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ListAliases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKeysAsync
```
public Future<ListKeysResult> listKeysAsync(ListKeysRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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:
    Specified by:
    
    listKeysAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the ListKeys operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKeysAsync
```
public Future<ListKeysResult> listKeysAsync(ListKeysRequest request,
                                            AsyncHandler<ListKeysRequest,ListKeysResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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:
    Specified by:
    
    listKeysAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ListKeys operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResourceAsync
```
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Lists the tags for an Amazon Web Services resource.
    
    This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTagsForResource request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    - TagResource
    - UntagResource
    Specified by:
    
    listTagsForResourceAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResourceAsync
```
public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request,
                                                                  AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Lists the tags for an Amazon Web Services resource.
    
    This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTagsForResource request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    - TagResource
    - UntagResource
    Specified by:
    
    listTagsForResourceAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - restoreKeyAsync
```
public Future<RestoreKeyResult> restoreKeyAsync(RestoreKeyRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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:
    Specified by:
    
    restoreKeyAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the RestoreKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - restoreKeyAsync
```
public Future<RestoreKeyResult> restoreKeyAsync(RestoreKeyRequest request,
                                                AsyncHandler<RestoreKeyRequest,RestoreKeyResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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:
    Specified by:
    
    restoreKeyAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the RestoreKey operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startKeyUsageAsync
```
public Future<StartKeyUsageResult> startKeyUsageAsync(StartKeyUsageRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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
    Specified by:
    
    startKeyUsageAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the StartKeyUsage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startKeyUsageAsync
```
public Future<StartKeyUsageResult> startKeyUsageAsync(StartKeyUsageRequest request,
                                                      AsyncHandler<StartKeyUsageRequest,StartKeyUsageResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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
    Specified by:
    
    startKeyUsageAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the StartKeyUsage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopKeyUsageAsync
```
public Future<StopKeyUsageResult> stopKeyUsageAsync(StopKeyUsageRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
    
    You can use this operation instead of DeleteKey to deactivate a key. You can enable the key in the future by calling StartKeyUsage.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    - DeleteKey
    - StartKeyUsage
    Specified by:
    
    stopKeyUsageAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the StopKeyUsage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopKeyUsageAsync
```
public Future<StopKeyUsageResult> stopKeyUsageAsync(StopKeyUsageRequest request,
                                                    AsyncHandler<StopKeyUsageRequest,StopKeyUsageResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.
    
    You can use this operation instead of DeleteKey to deactivate a key. You can enable the key in the future by calling StartKeyUsage.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    - DeleteKey
    - StartKeyUsage
    Specified by:
    
    stopKeyUsageAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the StopKeyUsage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResourceAsync
```
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Adds or edits tags on an Amazon Web Services Payment Cryptography key.
    
    Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
    
    Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can also add tags to an Amazon Web Services Payment Cryptography key when you create it with CreateKey.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    - ListTagsForResource
    - UntagResource
    Specified by:
    
    tagResourceAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResourceAsync
```
public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request,
                                                  AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Adds or edits tags on an Amazon Web Services Payment Cryptography key.
    
    Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
    
    Each tag consists of a tag key and a tag value, both of which are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value. You can also add tags to an Amazon Web Services Payment Cryptography key when you create it with CreateKey.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    - ListTagsForResource
    - UntagResource
    Specified by:
    
    tagResourceAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResourceAsync
```
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Deletes a tag from an Amazon Web Services Payment Cryptography key.
    
    Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    - ListTagsForResource
    - TagResource
    Specified by:
    
    untagResourceAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResourceAsync
```
public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request,
                                                      AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    Deletes a tag from an Amazon Web Services Payment Cryptography key.
    
    Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.
    
    Cross-account use: This operation can't be used across different Amazon Web Services accounts.
    
    Related operations:
    - ListTagsForResource
    - TagResource
    Specified by:
    
    untagResourceAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAliasAsync
```
public Future<UpdateAliasResult> updateAliasAsync(UpdateAliasRequest request)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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:
    Specified by:
    
    updateAliasAsync in interface AWSPaymentCryptographyAsync
    
    Returns:
    
    A Java Future containing the result of the UpdateAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAliasAsync
```
public Future<UpdateAliasResult> updateAliasAsync(UpdateAliasRequest request,
                                                  AsyncHandler<UpdateAliasRequest,UpdateAliasResult> asyncHandler)
```
    Description copied from interface: AWSPaymentCryptographyAsync
    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:
    Specified by:
    
    updateAliasAsync in interface AWSPaymentCryptographyAsync
    
    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
    
    Returns:
    
    A Java Future containing the result of the UpdateAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation

Class AbstractAWSPaymentCryptographyAsync

Field Summary

Fields inherited from interface com.amazonaws.services.paymentcryptography.AWSPaymentCryptography

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.services.paymentcryptography.AbstractAWSPaymentCryptography

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.paymentcryptography.AWSPaymentCryptography

Constructor Detail

AbstractAWSPaymentCryptographyAsync

Method Detail

createAliasAsync

createAliasAsync

createKeyAsync

createKeyAsync

deleteAliasAsync

deleteAliasAsync

deleteKeyAsync

deleteKeyAsync

exportKeyAsync

exportKeyAsync

getAliasAsync

getAliasAsync

getKeyAsync

getKeyAsync

getParametersForExportAsync

getParametersForExportAsync

getParametersForImportAsync

getParametersForImportAsync

getPublicKeyCertificateAsync

getPublicKeyCertificateAsync

importKeyAsync

importKeyAsync

listAliasesAsync

listAliasesAsync

listKeysAsync

listKeysAsync

listTagsForResourceAsync

listTagsForResourceAsync

restoreKeyAsync

restoreKeyAsync

startKeyUsageAsync

startKeyUsageAsync

stopKeyUsageAsync

stopKeyUsageAsync

tagResourceAsync

tagResourceAsync

untagResourceAsync

untagResourceAsync

updateAliasAsync

updateAliasAsync