Interface PaymentCryptographyClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aPaymentCryptographyClient
.static PaymentCryptographyClient
create()
Create aPaymentCryptographyClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAliasResponse
createAlias
(Consumer<CreateAliasRequest.Builder> createAliasRequest) Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key.default CreateAliasResponse
createAlias
(CreateAliasRequest createAliasRequest) Creates an alias, or a friendly name, for an Amazon Web Services Payment Cryptography key.default CreateKeyResponse
createKey
(Consumer<CreateKeyRequest.Builder> createKeyRequest) 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.default CreateKeyResponse
createKey
(CreateKeyRequest createKeyRequest) 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.default DeleteAliasResponse
deleteAlias
(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest) Deletes the alias, but doesn't affect the underlying key.default DeleteAliasResponse
deleteAlias
(DeleteAliasRequest deleteAliasRequest) Deletes the alias, but doesn't affect the underlying key.default DeleteKeyResponse
deleteKey
(Consumer<DeleteKeyRequest.Builder> deleteKeyRequest) Deletes the key material and metadata associated with Amazon Web Services Payment Cryptography key.default DeleteKeyResponse
deleteKey
(DeleteKeyRequest deleteKeyRequest) Deletes the key material and metadata associated with Amazon Web Services Payment Cryptography key.default ExportKeyResponse
exportKey
(Consumer<ExportKeyRequest.Builder> exportKeyRequest) Exports a key from Amazon Web Services Payment Cryptography.default ExportKeyResponse
exportKey
(ExportKeyRequest exportKeyRequest) Exports a key from Amazon Web Services Payment Cryptography.default GetAliasResponse
getAlias
(Consumer<GetAliasRequest.Builder> getAliasRequest) Gets the Amazon Web Services Payment Cryptography key associated with the alias.default GetAliasResponse
getAlias
(GetAliasRequest getAliasRequest) Gets the Amazon Web Services Payment Cryptography key associated with the alias.default GetKeyResponse
getKey
(Consumer<GetKeyRequest.Builder> getKeyRequest) Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.default GetKeyResponse
getKey
(GetKeyRequest getKeyRequest) Gets the key material for an Amazon Web Services Payment Cryptography key, including the immutable and mutable data specified when the key was created.default GetParametersForExportResponse
getParametersForExport
(Consumer<GetParametersForExportRequest.Builder> getParametersForExportRequest) Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.default GetParametersForExportResponse
getParametersForExport
(GetParametersForExportRequest getParametersForExportRequest) Gets the export token and the signing key certificate to initiate a TR-34 key export from Amazon Web Services Payment Cryptography.default GetParametersForImportResponse
getParametersForImport
(Consumer<GetParametersForImportRequest.Builder> getParametersForImportRequest) 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.default GetParametersForImportResponse
getParametersForImport
(GetParametersForImportRequest getParametersForImportRequest) 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.default GetPublicKeyCertificateResponse
getPublicKeyCertificate
(Consumer<GetPublicKeyCertificateRequest.Builder> getPublicKeyCertificateRequest) Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography.default GetPublicKeyCertificateResponse
getPublicKeyCertificate
(GetPublicKeyCertificateRequest getPublicKeyCertificateRequest) Gets the public key certificate of the asymmetric key pair that exists within Amazon Web Services Payment Cryptography.default ImportKeyResponse
importKey
(Consumer<ImportKeyRequest.Builder> importKeyRequest) Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.default ImportKeyResponse
importKey
(ImportKeyRequest importKeyRequest) Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.default ListAliasesResponse
listAliases
(Consumer<ListAliasesRequest.Builder> listAliasesRequest) Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region.default ListAliasesResponse
listAliases
(ListAliasesRequest listAliasesRequest) Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region.default ListAliasesIterable
listAliasesPaginator
(Consumer<ListAliasesRequest.Builder> listAliasesRequest) This is a variant oflistAliases(software.amazon.awssdk.services.paymentcryptography.model.ListAliasesRequest)
operation.default ListAliasesIterable
listAliasesPaginator
(ListAliasesRequest listAliasesRequest) This is a variant oflistAliases(software.amazon.awssdk.services.paymentcryptography.model.ListAliasesRequest)
operation.default ListKeysResponse
listKeys
(Consumer<ListKeysRequest.Builder> listKeysRequest) Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region.default ListKeysResponse
listKeys
(ListKeysRequest listKeysRequest) Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region.default ListKeysIterable
listKeysPaginator
(Consumer<ListKeysRequest.Builder> listKeysRequest) This is a variant oflistKeys(software.amazon.awssdk.services.paymentcryptography.model.ListKeysRequest)
operation.default ListKeysIterable
listKeysPaginator
(ListKeysRequest listKeysRequest) This is a variant oflistKeys(software.amazon.awssdk.services.paymentcryptography.model.ListKeysRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for an Amazon Web Services resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for an Amazon Web Services resource.default ListTagsForResourceIterable
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.paymentcryptography.model.ListTagsForResourceRequest)
operation.default ListTagsForResourceIterable
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.paymentcryptography.model.ListTagsForResourceRequest)
operation.default RestoreKeyResponse
restoreKey
(Consumer<RestoreKeyRequest.Builder> restoreKeyRequest) Cancels a scheduled key deletion during the waiting period.default RestoreKeyResponse
restoreKey
(RestoreKeyRequest restoreKeyRequest) Cancels a scheduled key deletion during the waiting period.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartKeyUsageResponse
startKeyUsage
(Consumer<StartKeyUsageRequest.Builder> startKeyUsageRequest) Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptographydefault StartKeyUsageResponse
startKeyUsage
(StartKeyUsageRequest startKeyUsageRequest) Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptographydefault StopKeyUsageResponse
stopKeyUsage
(Consumer<StopKeyUsageRequest.Builder> stopKeyUsageRequest) Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.default StopKeyUsageResponse
stopKeyUsage
(StopKeyUsageRequest stopKeyUsageRequest) Disables an Amazon Web Services Payment Cryptography key, which makes it inactive within Amazon Web Services Payment Cryptography.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or edits tags on an Amazon Web Services Payment Cryptography key.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds or edits tags on an Amazon Web Services Payment Cryptography key.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes a tag from an Amazon Web Services Payment Cryptography key.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Deletes a tag from an Amazon Web Services Payment Cryptography key.default UpdateAliasResponse
updateAlias
(Consumer<UpdateAliasRequest.Builder> updateAliasRequest) Associates an existing Amazon Web Services Payment Cryptography alias with a different key.default UpdateAliasResponse
updateAlias
(UpdateAliasRequest updateAliasRequest) Associates an existing Amazon Web Services Payment Cryptography alias with a different key.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createAlias
default CreateAliasResponse createAlias(CreateAliasRequest createAliasRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
- Parameters:
createAliasRequest
-- Returns:
- Result of the CreateAlias operation returned by the service.
- See Also:
-
createAlias
default CreateAliasResponse createAlias(Consumer<CreateAliasRequest.Builder> createAliasRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
This is a convenience which creates an instance of the
CreateAliasRequest.Builder
avoiding the need to create one manually viaCreateAliasRequest.builder()
- Parameters:
createAliasRequest
- AConsumer
that will call methods onCreateAliasRequest.Builder
to create a request.- Returns:
- Result of the CreateAlias operation returned by the service.
- See Also:
-
createKey
default CreateKeyResponse createKey(CreateKeyRequest createKeyRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
- Parameters:
createKeyRequest
-- Returns:
- Result of the CreateKey operation returned by the service.
- See Also:
-
createKey
default CreateKeyResponse createKey(Consumer<CreateKeyRequest.Builder> createKeyRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
This is a convenience which creates an instance of the
CreateKeyRequest.Builder
avoiding the need to create one manually viaCreateKeyRequest.builder()
- Parameters:
createKeyRequest
- AConsumer
that will call methods onCreateKeyRequest.Builder
to create a request.- Returns:
- Result of the CreateKey operation returned by the service.
- See Also:
-
deleteAlias
default DeleteAliasResponse deleteAlias(DeleteAliasRequest deleteAliasRequest) throws ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
- Parameters:
deleteAliasRequest
-- Returns:
- Result of the DeleteAlias operation returned by the service.
- See Also:
-
deleteAlias
default DeleteAliasResponse deleteAlias(Consumer<DeleteAliasRequest.Builder> deleteAliasRequest) throws ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
This is a convenience which creates an instance of the
DeleteAliasRequest.Builder
avoiding the need to create one manually viaDeleteAliasRequest.builder()
- Parameters:
deleteAliasRequest
- AConsumer
that will call methods onDeleteAliasRequest.Builder
to create a request.- Returns:
- Result of the DeleteAlias operation returned by the service.
- See Also:
-
deleteKey
default DeleteKeyResponse deleteKey(DeleteKeyRequest deleteKeyRequest) throws ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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, theKeyState
isDELETE_PENDING
. After the key is deleted, theKeyState
isDELETE_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:
- Parameters:
deleteKeyRequest
-- Returns:
- Result of the DeleteKey operation returned by the service.
- See Also:
-
deleteKey
default DeleteKeyResponse deleteKey(Consumer<DeleteKeyRequest.Builder> deleteKeyRequest) throws ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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, theKeyState
isDELETE_PENDING
. After the key is deleted, theKeyState
isDELETE_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:
This is a convenience which creates an instance of the
DeleteKeyRequest.Builder
avoiding the need to create one manually viaDeleteKeyRequest.builder()
- Parameters:
deleteKeyRequest
- AConsumer
that will call methods onDeleteKeyRequest.Builder
to create a request.- Returns:
- Result of the DeleteKey operation returned by the service.
- See Also:
-
exportKey
default ExportKeyResponse exportKey(ExportKeyRequest exportKeyRequest) throws ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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 CryptographyFor 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 and RSA wrap and unwrap key exchange mechanism. 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. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
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) andExportDukptInitialKey
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
withinKeyBlockHeaders
indicates the version of the key within the key block. Furthermore,KeyExportability
withinKeyBlockHeaders
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 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
: TheKeyARN
of the KEK or BDK (in case of IPEK) under export. -
KeyMaterial
: UseTr34KeyBlock
parameters. -
CertificateAuthorityPublicKeyIdentifier
: TheKeyARN
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
: TheKeyARN
of the certificate chain that signed wrapping key certificate. -
KeyMaterial
: Set toKeyCryptogram
. -
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
: TheKeyARN
of the KEK or BDK (in case of IPEK) under export. -
KeyMaterial
: UseTr31KeyBlock
parameters.
When this operation is successful, Amazon Web Services Payment Cryptography returns the working key or IPEK as a TR-31 WrappedKeyBlock.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
- Parameters:
exportKeyRequest
-- Returns:
- Result of the ExportKey operation returned by the service.
- See Also:
-
-
exportKey
default ExportKeyResponse exportKey(Consumer<ExportKeyRequest.Builder> exportKeyRequest) throws ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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 CryptographyFor 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 and RSA wrap and unwrap key exchange mechanism. 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. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
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) andExportDukptInitialKey
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
withinKeyBlockHeaders
indicates the version of the key within the key block. Furthermore,KeyExportability
withinKeyBlockHeaders
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 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
: TheKeyARN
of the KEK or BDK (in case of IPEK) under export. -
KeyMaterial
: UseTr34KeyBlock
parameters. -
CertificateAuthorityPublicKeyIdentifier
: TheKeyARN
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
: TheKeyARN
of the certificate chain that signed wrapping key certificate. -
KeyMaterial
: Set toKeyCryptogram
. -
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
: TheKeyARN
of the KEK or BDK (in case of IPEK) under export. -
KeyMaterial
: UseTr31KeyBlock
parameters.
When this operation is successful, Amazon Web Services Payment Cryptography returns the working key or IPEK as a TR-31 WrappedKeyBlock.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
This is a convenience which creates an instance of the
ExportKeyRequest.Builder
avoiding the need to create one manually viaExportKeyRequest.builder()
- Parameters:
exportKeyRequest
- AConsumer
that will call methods onExportKeyRequest.Builder
to create a request.- Returns:
- Result of the ExportKey operation returned by the service.
- See Also:
-
-
getAlias
default GetAliasResponse getAlias(GetAliasRequest getAliasRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
- Parameters:
getAliasRequest
-- Returns:
- Result of the GetAlias operation returned by the service.
- See Also:
-
getAlias
default GetAliasResponse getAlias(Consumer<GetAliasRequest.Builder> getAliasRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
This is a convenience which creates an instance of the
GetAliasRequest.Builder
avoiding the need to create one manually viaGetAliasRequest.builder()
- Parameters:
getAliasRequest
- AConsumer
that will call methods onGetAliasRequest.Builder
to create a request.- Returns:
- Result of the GetAlias operation returned by the service.
- See Also:
-
getKey
default GetKeyResponse getKey(GetKeyRequest getKeyRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
- Parameters:
getKeyRequest
-- Returns:
- Result of the GetKey operation returned by the service.
- See Also:
-
getKey
default GetKeyResponse getKey(Consumer<GetKeyRequest.Builder> getKeyRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
This is a convenience which creates an instance of the
GetKeyRequest.Builder
avoiding the need to create one manually viaGetKeyRequest.builder()
- Parameters:
getKeyRequest
- AConsumer
that will call methods onGetKeyRequest.Builder
to create a request.- Returns:
- Result of the GetKey operation returned by the service.
- See Also:
-
getParametersForExport
default GetParametersForExportResponse getParametersForExport(GetParametersForExportRequest getParametersForExportRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
- Parameters:
getParametersForExportRequest
-- Returns:
- Result of the GetParametersForExport operation returned by the service.
- See Also:
-
getParametersForExport
default GetParametersForExportResponse getParametersForExport(Consumer<GetParametersForExportRequest.Builder> getParametersForExportRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
This is a convenience which creates an instance of the
GetParametersForExportRequest.Builder
avoiding the need to create one manually viaGetParametersForExportRequest.builder()
- Parameters:
getParametersForExportRequest
- AConsumer
that will call methods onGetParametersForExportRequest.Builder
to create a request.- Returns:
- Result of the GetParametersForExport operation returned by the service.
- See Also:
-
getParametersForImport
default GetParametersForImportResponse getParametersForImport(GetParametersForImportRequest getParametersForImportRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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 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:
- Parameters:
getParametersForImportRequest
-- Returns:
- Result of the GetParametersForImport operation returned by the service.
- See Also:
-
getParametersForImport
default GetParametersForImportResponse getParametersForImport(Consumer<GetParametersForImportRequest.Builder> getParametersForImportRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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 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:
This is a convenience which creates an instance of the
GetParametersForImportRequest.Builder
avoiding the need to create one manually viaGetParametersForImportRequest.builder()
- Parameters:
getParametersForImportRequest
- AConsumer
that will call methods onGetParametersForImportRequest.Builder
to create a request.- Returns:
- Result of the GetParametersForImport operation returned by the service.
- See Also:
-
getPublicKeyCertificate
default GetPublicKeyCertificateResponse getPublicKeyCertificate(GetPublicKeyCertificateRequest getPublicKeyCertificateRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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 CryptographyCross-account use: This operation can't be used across different Amazon Web Services accounts.
- Parameters:
getPublicKeyCertificateRequest
-- Returns:
- Result of the GetPublicKeyCertificate operation returned by the service.
- See Also:
-
getPublicKeyCertificate
default GetPublicKeyCertificateResponse getPublicKeyCertificate(Consumer<GetPublicKeyCertificateRequest.Builder> getPublicKeyCertificateRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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 CryptographyCross-account use: This operation can't be used across different Amazon Web Services accounts.
This is a convenience which creates an instance of the
GetPublicKeyCertificateRequest.Builder
avoiding the need to create one manually viaGetPublicKeyCertificateRequest.builder()
- Parameters:
getPublicKeyCertificateRequest
- AConsumer
that will call methods onGetPublicKeyCertificateRequest.Builder
to create a request.- Returns:
- Result of the GetPublicKeyCertificate operation returned by the service.
- See Also:
-
importKey
default ImportKeyResponse importKey(ImportKeyRequest importKeyRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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 and RSA wrap and unwrap 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.
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. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
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 theRootCertificatePublicKey
. -
KeyModesOfUse
andKeyUsage
: 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 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
forRootCertificatePublicKey
. 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
: UseTr34KeyBlock
parameters. -
CertificateAuthorityPublicKeyIdentifier
: TheKeyARN
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 toKEY_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 7 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
withKeyMaterial
set toKEY_CRYPTOGRAM
and provide theImportToken
andKeyAttributes
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
: UseTr31KeyBlock
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
: TheKeyArn
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:
- Parameters:
importKeyRequest
-- Returns:
- Result of the ImportKey operation returned by the service.
- See Also:
-
-
importKey
default ImportKeyResponse importKey(Consumer<ImportKeyRequest.Builder> importKeyRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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 and RSA wrap and unwrap 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.
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. With RSA wrap and unwrap, you can exchange both 3DES and AES-128 keys. The keys are imported in a WrappedKeyCryptogram format and you will need to specify the key attributes during import.
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 theRootCertificatePublicKey
. -
KeyModesOfUse
andKeyUsage
: 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 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
forRootCertificatePublicKey
. 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
: UseTr34KeyBlock
parameters. -
CertificateAuthorityPublicKeyIdentifier
: TheKeyARN
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 toKEY_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 7 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
withKeyMaterial
set toKEY_CRYPTOGRAM
and provide theImportToken
andKeyAttributes
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
: UseTr31KeyBlock
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
: TheKeyArn
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:
This is a convenience which creates an instance of the
ImportKeyRequest.Builder
avoiding the need to create one manually viaImportKeyRequest.builder()
- Parameters:
importKeyRequest
- AConsumer
that will call methods onImportKeyRequest.Builder
to create a request.- Returns:
- Result of the ImportKey operation returned by the service.
- See Also:
-
-
listAliases
default ListAliasesResponse listAliases(ListAliasesRequest listAliasesRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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 subsequentListAliases
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:
- Parameters:
listAliasesRequest
-- Returns:
- Result of the ListAliases operation returned by the service.
- See Also:
-
listAliases
default ListAliasesResponse listAliases(Consumer<ListAliasesRequest.Builder> listAliasesRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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 subsequentListAliases
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:
This is a convenience which creates an instance of the
ListAliasesRequest.Builder
avoiding the need to create one manually viaListAliasesRequest.builder()
- Parameters:
listAliasesRequest
- AConsumer
that will call methods onListAliasesRequest.Builder
to create a request.- Returns:
- Result of the ListAliases operation returned by the service.
- See Also:
-
listAliasesPaginator
default ListAliasesIterable listAliasesPaginator(ListAliasesRequest listAliasesRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException This is a variant of
listAliases(software.amazon.awssdk.services.paymentcryptography.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.paymentcryptography.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.paymentcryptography.paginators.ListAliasesIterable responses = client .listAliasesPaginator(request); for (software.amazon.awssdk.services.paymentcryptography.model.ListAliasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.paymentcryptography.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.paymentcryptography.model.ListAliasesRequest)
operation.- Parameters:
listAliasesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAliasesPaginator
default ListAliasesIterable listAliasesPaginator(Consumer<ListAliasesRequest.Builder> listAliasesRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException This is a variant of
listAliases(software.amazon.awssdk.services.paymentcryptography.model.ListAliasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.paymentcryptography.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.paymentcryptography.paginators.ListAliasesIterable responses = client .listAliasesPaginator(request); for (software.amazon.awssdk.services.paymentcryptography.model.ListAliasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.paymentcryptography.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAliases(software.amazon.awssdk.services.paymentcryptography.model.ListAliasesRequest)
operation.
This is a convenience which creates an instance of the
ListAliasesRequest.Builder
avoiding the need to create one manually viaListAliasesRequest.builder()
- Parameters:
listAliasesRequest
- AConsumer
that will call methods onListAliasesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listKeys
default ListKeysResponse listKeys(ListKeysRequest listKeysRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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 subsequentListKeys
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:
- Parameters:
listKeysRequest
-- Returns:
- Result of the ListKeys operation returned by the service.
- See Also:
-
listKeys
default ListKeysResponse listKeys(Consumer<ListKeysRequest.Builder> listKeysRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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 subsequentListKeys
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:
This is a convenience which creates an instance of the
ListKeysRequest.Builder
avoiding the need to create one manually viaListKeysRequest.builder()
- Parameters:
listKeysRequest
- AConsumer
that will call methods onListKeysRequest.Builder
to create a request.- Returns:
- Result of the ListKeys operation returned by the service.
- See Also:
-
listKeysPaginator
default ListKeysIterable listKeysPaginator(ListKeysRequest listKeysRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException This is a variant of
listKeys(software.amazon.awssdk.services.paymentcryptography.model.ListKeysRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.paymentcryptography.paginators.ListKeysIterable responses = client.listKeysPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.paymentcryptography.paginators.ListKeysIterable responses = client.listKeysPaginator(request); for (software.amazon.awssdk.services.paymentcryptography.model.ListKeysResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.paymentcryptography.paginators.ListKeysIterable responses = client.listKeysPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKeys(software.amazon.awssdk.services.paymentcryptography.model.ListKeysRequest)
operation.- Parameters:
listKeysRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listKeysPaginator
default ListKeysIterable listKeysPaginator(Consumer<ListKeysRequest.Builder> listKeysRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException This is a variant of
listKeys(software.amazon.awssdk.services.paymentcryptography.model.ListKeysRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.paymentcryptography.paginators.ListKeysIterable responses = client.listKeysPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.paymentcryptography.paginators.ListKeysIterable responses = client.listKeysPaginator(request); for (software.amazon.awssdk.services.paymentcryptography.model.ListKeysResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.paymentcryptography.paginators.ListKeysIterable responses = client.listKeysPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKeys(software.amazon.awssdk.services.paymentcryptography.model.ListKeysRequest)
operation.
This is a convenience which creates an instance of the
ListKeysRequest.Builder
avoiding the need to create one manually viaListKeysRequest.builder()
- Parameters:
listKeysRequest
- AConsumer
that will call methods onListKeysRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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 subsequentListTagsForResource
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:
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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 subsequentListTagsForResource
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:
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException This is a variant of
listTagsForResource(software.amazon.awssdk.services.paymentcryptography.model.ListTagsForResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.paymentcryptography.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.paymentcryptography.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.paymentcryptography.model.ListTagsForResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.paymentcryptography.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.paymentcryptography.model.ListTagsForResourceRequest)
operation.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ServiceUnavailableException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException This is a variant of
listTagsForResource(software.amazon.awssdk.services.paymentcryptography.model.ListTagsForResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.paymentcryptography.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.paymentcryptography.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.paymentcryptography.model.ListTagsForResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.paymentcryptography.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.paymentcryptography.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
restoreKey
default RestoreKeyResponse restoreKey(RestoreKeyRequest restoreKeyRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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
isDELETE_PENDING
anddeletePendingTimestamp
contains the date and time after which theKey
will be deleted. AfterKey
is restored, theKeyState
isCREATE_COMPLETE
, and the value fordeletePendingTimestamp
is removed.Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
- Parameters:
restoreKeyRequest
-- Returns:
- Result of the RestoreKey operation returned by the service.
- See Also:
-
restoreKey
default RestoreKeyResponse restoreKey(Consumer<RestoreKeyRequest.Builder> restoreKeyRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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
isDELETE_PENDING
anddeletePendingTimestamp
contains the date and time after which theKey
will be deleted. AfterKey
is restored, theKeyState
isCREATE_COMPLETE
, and the value fordeletePendingTimestamp
is removed.Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
This is a convenience which creates an instance of the
RestoreKeyRequest.Builder
avoiding the need to create one manually viaRestoreKeyRequest.builder()
- Parameters:
restoreKeyRequest
- AConsumer
that will call methods onRestoreKeyRequest.Builder
to create a request.- Returns:
- Result of the RestoreKey operation returned by the service.
- See Also:
-
startKeyUsage
default StartKeyUsageResponse startKeyUsage(StartKeyUsageRequest startKeyUsageRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
- Parameters:
startKeyUsageRequest
-- Returns:
- Result of the StartKeyUsage operation returned by the service.
- See Also:
-
startKeyUsage
default StartKeyUsageResponse startKeyUsage(Consumer<StartKeyUsageRequest.Builder> startKeyUsageRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
This is a convenience which creates an instance of the
StartKeyUsageRequest.Builder
avoiding the need to create one manually viaStartKeyUsageRequest.builder()
- Parameters:
startKeyUsageRequest
- AConsumer
that will call methods onStartKeyUsageRequest.Builder
to create a request.- Returns:
- Result of the StartKeyUsage operation returned by the service.
- See Also:
-
stopKeyUsage
default StopKeyUsageResponse stopKeyUsage(StopKeyUsageRequest stopKeyUsageRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
- Parameters:
stopKeyUsageRequest
-- Returns:
- Result of the StopKeyUsage operation returned by the service.
- See Also:
-
stopKeyUsage
default StopKeyUsageResponse stopKeyUsage(Consumer<StopKeyUsageRequest.Builder> stopKeyUsageRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
This is a convenience which creates an instance of the
StopKeyUsageRequest.Builder
avoiding the need to create one manually viaStopKeyUsageRequest.builder()
- Parameters:
stopKeyUsageRequest
- AConsumer
that will call methods onStopKeyUsageRequest.Builder
to create a request.- Returns:
- Result of the StopKeyUsage operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ServiceQuotaExceededException, ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAlias
default UpdateAliasResponse updateAlias(UpdateAliasRequest updateAliasRequest) throws ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
- Parameters:
updateAliasRequest
-- Returns:
- Result of the UpdateAlias operation returned by the service.
- See Also:
-
updateAlias
default UpdateAliasResponse updateAlias(Consumer<UpdateAliasRequest.Builder> updateAliasRequest) throws ServiceUnavailableException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, InternalServerException, AwsServiceException, SdkClientException, PaymentCryptographyException 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:
This is a convenience which creates an instance of the
UpdateAliasRequest.Builder
avoiding the need to create one manually viaUpdateAliasRequest.builder()
- Parameters:
updateAliasRequest
- AConsumer
that will call methods onUpdateAliasRequest.Builder
to create a request.- Returns:
- Result of the UpdateAlias operation returned by the service.
- See Also:
-
create
Create aPaymentCryptographyClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aPaymentCryptographyClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-