Package software.amazon.awssdk.services.paymentcryptography

Interface PaymentCryptographyClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface PaymentCryptographyClient
extends AwsClient

Service client for accessing Payment Cryptography Control Plane. This can be created using the static builder() method.

You use the Amazon Web Services Payment Cryptography Control Plane to manage the encryption keys you use for 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 encrypt, decrypt, generate, verify, and translate payment-related cryptographic operations.

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, 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 that 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

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static PaymentCryptographyClientBuilder	builder()	Create a builder that can be used to configure and create a PaymentCryptographyClient.
static PaymentCryptographyClient	create()	Create a PaymentCryptographyClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
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 all metadata associated with Amazon Web Services Payment Cryptography key.
default DeleteKeyResponse	deleteKey(DeleteKeyRequest deleteKeyRequest)	Deletes the key material and all 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 using either ANSI X9 TR-34 or TR-31 key export standard.
default ExportKeyResponse	exportKey(ExportKeyRequest exportKeyRequest)	Exports a key from Amazon Web Services Payment Cryptography using either ANSI X9 TR-34 or TR-31 key export standard.
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 to initiate a TR-34 key import into Amazon Web Services Payment Cryptography.
default GetParametersForImportResponse	getParametersForImport(GetParametersForImportRequest getParametersForImportRequest)	Gets the import token and the wrapping key certificate to initiate a TR-34 key 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 keys and public key certificates into Amazon Web Services Payment Cryptography.
default ImportKeyResponse	importKey(ImportKeyRequest importKeyRequest)	Imports keys and public key certificates 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)	Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region.
default ListAliasesIterable	listAliasesPaginator(ListAliasesRequest listAliasesRequest)	Lists the aliases for all keys in the caller's Amazon Web Services account and Amazon Web Services Region.
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)	Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region.
default ListKeysIterable	listKeysPaginator(ListKeysRequest listKeysRequest)	Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region.
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)	Lists the tags for an Amazon Web Services resource.
default ListTagsForResourceIterable	listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)	Lists the tags for an Amazon Web Services resource.
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.
default PaymentCryptographyServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	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 Cryptography
default StartKeyUsageResponse	startKeyUsage(StartKeyUsageRequest startKeyUsageRequest)	Enables an Amazon Web Services Payment Cryptography key, which makes it active for cryptographic operations within Amazon Web Services Payment Cryptography
default 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

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

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:

• DeleteAlias

• GetAlias

• ListAliases

• UpdateAlias

Parameters:

createAliasRequest -

Returns:

Result of the CreateAlias operation returned by the service.

See Also:

• AWS API Documentation

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:

• DeleteAlias

• GetAlias

• ListAliases

• UpdateAlias

This is a convenience which creates an instance of the CreateAliasRequest.Builder avoiding the need to create one manually via CreateAliasRequest.builder()

Parameters:

createAliasRequest - A Consumer that will call methods on CreateAliasRequest.Builder to create a request.

Returns:

Result of the CreateAlias operation returned by the service.

See Also:

• AWS API Documentation

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

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

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

Related operations:

• DeleteKey

• GetKey

• ListKeys

Parameters:

createKeyRequest -

Returns:

Result of the CreateKey operation returned by the service.

See Also:

• AWS API Documentation

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

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

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

Related operations:

• DeleteKey

• GetKey

• ListKeys

This is a convenience which creates an instance of the CreateKeyRequest.Builder avoiding the need to create one manually via CreateKeyRequest.builder()

Parameters:

createKeyRequest - A Consumer that will call methods on CreateKeyRequest.Builder to create a request.

Returns:

Result of the CreateKey operation returned by the service.

See Also:

• AWS API Documentation

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 ListAliases operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias.

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

Related operations:

• CreateAlias

• GetAlias

• ListAliases

• UpdateAlias

Parameters:

deleteAliasRequest -

Returns:

Result of the DeleteAlias operation returned by the service.

See Also:

• AWS API Documentation

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 ListAliases operation. To change the alias of a key, first use DeleteAlias to delete the current alias and then use CreateAlias to create a new alias. To associate an existing alias with a different key, call UpdateAlias.

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

Related operations:

• CreateAlias

• GetAlias

• ListAliases

• UpdateAlias

This is a convenience which creates an instance of the DeleteAliasRequest.Builder avoiding the need to create one manually via DeleteAliasRequest.builder()

Parameters:

deleteAliasRequest - A Consumer that will call methods on DeleteAliasRequest.Builder to create a request.

Returns:

Result of the DeleteAlias operation returned by the service.

See Also:

• AWS API Documentation

deleteKey

default DeleteKeyResponse deleteKey(DeleteKeyRequest deleteKeyRequest)
                             throws ServiceUnavailableException,
ValidationException,
ConflictException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
PaymentCryptographyException

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

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

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

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

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

Related operations:

• RestoreKey

• StartKeyUsage

• StopKeyUsage

Parameters:

deleteKeyRequest -

Returns:

Result of the DeleteKey operation returned by the service.

See Also:

• AWS API Documentation

deleteKey

default DeleteKeyResponse deleteKey(Consumer<DeleteKeyRequest.Builder> deleteKeyRequest)
                             throws ServiceUnavailableException,
ValidationException,
ConflictException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
PaymentCryptographyException

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

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

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

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

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

Related operations:

• RestoreKey

• StartKeyUsage

• StopKeyUsage

This is a convenience which creates an instance of the DeleteKeyRequest.Builder avoiding the need to create one manually via DeleteKeyRequest.builder()

Parameters:

deleteKeyRequest - A Consumer that will call methods on DeleteKeyRequest.Builder to create a request.

Returns:

Result of the DeleteKey operation returned by the service.

See Also:

• AWS API Documentation

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 using either ANSI X9 TR-34 or TR-31 key export standard.

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

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

TR-34 key export

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

Set the following parameters:

CertificateAuthorityPublicKeyIdentifier

The KeyARN of the certificate chain that will sign the wrapping key certificate. This must exist within Amazon Web Services Payment Cryptography before you initiate TR-34 key export. If it does not exist, you can import it by calling ImportKey for RootCertificatePublicKey.

ExportToken

Obtained from KDH by calling GetParametersForExport.

WrappingKeyCertificate

Amazon Web Services Payment Cryptography uses this to wrap the key under export.

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

TR-31 key export

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

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

Related operations:

• GetParametersForExport

• ImportKey

Parameters:

exportKeyRequest -

Returns:

Result of the ExportKey operation returned by the service.

See Also:

• AWS API Documentation

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 using either ANSI X9 TR-34 or TR-31 key export standard.

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

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

TR-34 key export

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

Set the following parameters:

CertificateAuthorityPublicKeyIdentifier

The KeyARN of the certificate chain that will sign the wrapping key certificate. This must exist within Amazon Web Services Payment Cryptography before you initiate TR-34 key export. If it does not exist, you can import it by calling ImportKey for RootCertificatePublicKey.

ExportToken

Obtained from KDH by calling GetParametersForExport.

WrappingKeyCertificate

Amazon Web Services Payment Cryptography uses this to wrap the key under export.

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

TR-31 key export

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

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

Related operations:

• GetParametersForExport

• ImportKey

This is a convenience which creates an instance of the ExportKeyRequest.Builder avoiding the need to create one manually via ExportKeyRequest.builder()

Parameters:

exportKeyRequest - A Consumer that will call methods on ExportKeyRequest.Builder to create a request.

Returns:

Result of the ExportKey operation returned by the service.

See Also:

• AWS API Documentation

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:

• CreateAlias

• DeleteAlias

• ListAliases

• UpdateAlias

Parameters:

getAliasRequest -

Returns:

Result of the GetAlias operation returned by the service.

See Also:

• AWS API Documentation

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:

• CreateAlias

• DeleteAlias

• ListAliases

• UpdateAlias

This is a convenience which creates an instance of the GetAliasRequest.Builder avoiding the need to create one manually via GetAliasRequest.builder()

Parameters:

getAliasRequest - A Consumer that will call methods on GetAliasRequest.Builder to create a request.

Returns:

Result of the GetAlias operation returned by the service.

See Also:

• AWS API Documentation

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:

• CreateKey

• DeleteKey

• ListKeys

Parameters:

getKeyRequest -

Returns:

Result of the GetKey operation returned by the service.

See Also:

• AWS API Documentation

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:

• CreateKey

• DeleteKey

• ListKeys

This is a convenience which creates an instance of the GetKeyRequest.Builder avoiding the need to create one manually via GetKeyRequest.builder()

Parameters:

getKeyRequest - A Consumer that will call methods on GetKeyRequest.Builder to create a request.

Returns:

Result of the GetKey operation returned by the service.

See Also:

• AWS API Documentation

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:

• ExportKey

• GetParametersForImport

Parameters:

getParametersForExportRequest -

Returns:

Result of the GetParametersForExport operation returned by the service.

See Also:

• AWS API Documentation

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:

• ExportKey

• GetParametersForImport

This is a convenience which creates an instance of the GetParametersForExportRequest.Builder avoiding the need to create one manually via GetParametersForExportRequest.builder()

Parameters:

getParametersForExportRequest - A Consumer that will call methods on GetParametersForExportRequest.Builder to create a request.

Returns:

Result of the GetParametersForExport operation returned by the service.

See Also:

• AWS API Documentation

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 to initiate a TR-34 key import into Amazon Web Services Payment Cryptography.

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

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

Related operations:

• GetParametersForExport

• ImportKey

Parameters:

getParametersForImportRequest -

Returns:

Result of the GetParametersForImport operation returned by the service.

See Also:

• AWS API Documentation

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 to initiate a TR-34 key import into Amazon Web Services Payment Cryptography.

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

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

Related operations:

• GetParametersForExport

• ImportKey

This is a convenience which creates an instance of the GetParametersForImportRequest.Builder avoiding the need to create one manually via GetParametersForImportRequest.builder()

Parameters:

getParametersForImportRequest - A Consumer that will call methods on GetParametersForImportRequest.Builder to create a request.

Returns:

Result of the GetParametersForImport operation returned by the service.

See Also:

• AWS API Documentation

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 Cryptography

Cross-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:

• AWS API Documentation

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 Cryptography

Cross-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 via GetPublicKeyCertificateRequest.builder()

Parameters:

getPublicKeyCertificateRequest - A Consumer that will call methods on GetPublicKeyCertificateRequest.Builder to create a request.

Returns:

Result of the GetPublicKeyCertificate operation returned by the service.

See Also:

• AWS API Documentation

importKey

default ImportKeyResponse importKey(ImportKeyRequest importKeyRequest)
                             throws ServiceQuotaExceededException,
ServiceUnavailableException,
ValidationException,
ConflictException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
PaymentCryptographyException

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

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

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

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

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

To import a public root key certificate

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

Set the following parameters:

• KeyMaterial: RootCertificatePublicKey

• KeyClass: PUBLIC_KEY

• KeyModesOfUse: Verify

• KeyUsage: TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE

• PublicKeyCertificate: The certificate authority used to sign the root public key certificate.

To import a trusted public key certificate

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

• KeyMaterial: TrustedCertificatePublicKey

• CertificateAuthorityPublicKeyIdentifier: KeyArn of the RootCertificatePublicKey.

• KeyModesOfUse and KeyUsage: Corresponding to the cryptographic operations such as wrap, sign, or encrypt that you will allow the trusted public key certificate to perform.

• PublicKeyCertificate: The certificate authority used to sign the trusted public key certificate.

Import main keys

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

Set the following parameters:

• CertificateAuthorityPublicKeyIdentifier: The KeyArn of the certificate chain that will sign the signing key certificate and should exist within Amazon Web Services Payment Cryptography before initiating TR-34 key import. If it does not exist, you can import it by calling by calling ImportKey for RootCertificatePublicKey.

• ImportToken: Obtained from KRH by calling GetParametersForImport.

• WrappedKeyBlock: The TR-34 wrapped key block from KDH. It contains the KDH key under import, wrapped with KRH provided wrapping key certificate and signed by the KDH private signing key. This TR-34 key block is generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.

• SigningKeyCertificate: The public component of the private key that signed the KDH TR-34 wrapped key block. In PEM certificate format.

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

Import working keys

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

• WrappedKeyBlock: The key under import and encrypted using KEK. The TR-31 key block generated by your HSM outside of Amazon Web Services Payment Cryptography.

• WrappingKeyIdentifier: The KeyArn of the KEK that Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.

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

Related operations:

• ExportKey

• GetParametersForImport

Parameters:

importKeyRequest -

Returns:

Result of the ImportKey operation returned by the service.

See Also:

• AWS API Documentation

importKey

default ImportKeyResponse importKey(Consumer<ImportKeyRequest.Builder> importKeyRequest)
                             throws ServiceQuotaExceededException,
ServiceUnavailableException,
ValidationException,
ConflictException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
PaymentCryptographyException

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

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

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

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

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

To import a public root key certificate

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

Set the following parameters:

• KeyMaterial: RootCertificatePublicKey

• KeyClass: PUBLIC_KEY

• KeyModesOfUse: Verify

• KeyUsage: TR31_S0_ASYMMETRIC_KEY_FOR_DIGITAL_SIGNATURE

• PublicKeyCertificate: The certificate authority used to sign the root public key certificate.

To import a trusted public key certificate

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

• KeyMaterial: TrustedCertificatePublicKey

• CertificateAuthorityPublicKeyIdentifier: KeyArn of the RootCertificatePublicKey.

• KeyModesOfUse and KeyUsage: Corresponding to the cryptographic operations such as wrap, sign, or encrypt that you will allow the trusted public key certificate to perform.

• PublicKeyCertificate: The certificate authority used to sign the trusted public key certificate.

Import main keys

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

Set the following parameters:

• CertificateAuthorityPublicKeyIdentifier: The KeyArn of the certificate chain that will sign the signing key certificate and should exist within Amazon Web Services Payment Cryptography before initiating TR-34 key import. If it does not exist, you can import it by calling by calling ImportKey for RootCertificatePublicKey.

• ImportToken: Obtained from KRH by calling GetParametersForImport.

• WrappedKeyBlock: The TR-34 wrapped key block from KDH. It contains the KDH key under import, wrapped with KRH provided wrapping key certificate and signed by the KDH private signing key. This TR-34 key block is generated by the KDH Hardware Security Module (HSM) outside of Amazon Web Services Payment Cryptography.

• SigningKeyCertificate: The public component of the private key that signed the KDH TR-34 wrapped key block. In PEM certificate format.

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

Import working keys

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

• WrappedKeyBlock: The key under import and encrypted using KEK. The TR-31 key block generated by your HSM outside of Amazon Web Services Payment Cryptography.

• WrappingKeyIdentifier: The KeyArn of the KEK that Amazon Web Services Payment Cryptography uses to decrypt or unwrap the key under import.

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

Related operations:

• ExportKey

• GetParametersForImport

This is a convenience which creates an instance of the ImportKeyRequest.Builder avoiding the need to create one manually via ImportKeyRequest.builder()

Parameters:

importKeyRequest - A Consumer that will call methods on ImportKeyRequest.Builder to create a request.

Returns:

Result of the ImportKey operation returned by the service.

See Also:

• AWS API Documentation

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 subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.

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

Related operations:

• CreateAlias

• DeleteAlias

• GetAlias

• UpdateAlias

Parameters:

listAliasesRequest -

Returns:

Result of the ListAliases operation returned by the service.

See Also:

• AWS API Documentation

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 subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.

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

Related operations:

• CreateAlias

• DeleteAlias

• GetAlias

• UpdateAlias

This is a convenience which creates an instance of the ListAliasesRequest.Builder avoiding the need to create one manually via ListAliasesRequest.builder()

Parameters:

listAliasesRequest - A Consumer that will call methods on ListAliasesRequest.Builder to create a request.

Returns:

Result of the ListAliases operation returned by the service.

See Also:

• AWS API Documentation

listAliasesPaginator

default ListAliasesIterable listAliasesPaginator(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 subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.

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

Related operations:

• CreateAlias

• DeleteAlias

• GetAlias

• UpdateAlias

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 Stream

 
 software.amazon.awssdk.services.paymentcryptography.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

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

• AWS API Documentation

listAliasesPaginator

default ListAliasesIterable listAliasesPaginator(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 subsequent ListAliases request to get more aliases. When you receive a response with no NextToken (or an empty or null value), that means there are no more aliases to get.

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

Related operations:

• CreateAlias

• DeleteAlias

• GetAlias

• UpdateAlias

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 Stream

 
 software.amazon.awssdk.services.paymentcryptography.paginators.ListAliasesIterable responses = client.listAliasesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListAliasesRequest.builder()

Parameters:

listAliasesRequest - A Consumer that will call methods on ListAliasesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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 subsequent ListKeys request to get more keys. When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.

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

Related operations:

• CreateKey

• DeleteKey

• GetKey

Parameters:

listKeysRequest -

Returns:

Result of the ListKeys operation returned by the service.

See Also:

• AWS API Documentation

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 subsequent ListKeys request to get more keys. When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.

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

Related operations:

• CreateKey

• DeleteKey

• GetKey

This is a convenience which creates an instance of the ListKeysRequest.Builder avoiding the need to create one manually via ListKeysRequest.builder()

Parameters:

listKeysRequest - A Consumer that will call methods on ListKeysRequest.Builder to create a request.

Returns:

Result of the ListKeys operation returned by the service.

See Also:

• AWS API Documentation

listKeysPaginator

default ListKeysIterable listKeysPaginator(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 subsequent ListKeys request to get more keys. When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.

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

Related operations:

• CreateKey

• DeleteKey

• GetKey

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 Stream

 
 software.amazon.awssdk.services.paymentcryptography.paginators.ListKeysIterable responses = client.listKeysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

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

• AWS API Documentation

listKeysPaginator

default ListKeysIterable listKeysPaginator(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 subsequent ListKeys request to get more keys. When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.

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

Related operations:

• CreateKey

• DeleteKey

• GetKey

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 Stream

 
 software.amazon.awssdk.services.paymentcryptography.paginators.ListKeysIterable responses = client.listKeysPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListKeysRequest.builder()

Parameters:

listKeysRequest - A Consumer that will call methods on ListKeysRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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 subsequent ListTagsForResource request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

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

Related operations:

• TagResource

• UntagResource

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

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 subsequent ListTagsForResource request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

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

Related operations:

• TagResource

• UntagResource

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResourcePaginator

default ListTagsForResourceIterable listTagsForResourcePaginator(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 subsequent ListTagsForResource request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

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

Related operations:

• TagResource

• UntagResource

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 Stream

 
 software.amazon.awssdk.services.paymentcryptography.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

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

• AWS API Documentation

listTagsForResourcePaginator

default ListTagsForResourceIterable listTagsForResourcePaginator(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 subsequent ListTagsForResource request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

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

Related operations:

• TagResource

• UntagResource

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 Stream

 
 software.amazon.awssdk.services.paymentcryptography.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @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 directly

 
 software.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 via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

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 is DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key will be deleted. After Key is restored, the KeyState is CREATE_COMPLETE, and the value for deletePendingTimestamp is removed.

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

Related operations:

• DeleteKey

• StartKeyUsage

• StopKeyUsage

Parameters:

restoreKeyRequest -

Returns:

Result of the RestoreKey operation returned by the service.

See Also:

• AWS API Documentation

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 is DELETE_PENDING and deletePendingTimestamp contains the date and time after which the Key will be deleted. After Key is restored, the KeyState is CREATE_COMPLETE, and the value for deletePendingTimestamp is removed.

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

Related operations:

• DeleteKey

• StartKeyUsage

• StopKeyUsage

This is a convenience which creates an instance of the RestoreKeyRequest.Builder avoiding the need to create one manually via RestoreKeyRequest.builder()

Parameters:

restoreKeyRequest - A Consumer that will call methods on RestoreKeyRequest.Builder to create a request.

Returns:

Result of the RestoreKey operation returned by the service.

See Also:

• AWS API Documentation

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:

• StopKeyUsage

Parameters:

startKeyUsageRequest -

Returns:

Result of the StartKeyUsage operation returned by the service.

See Also:

• AWS API Documentation

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:

• StopKeyUsage

This is a convenience which creates an instance of the StartKeyUsageRequest.Builder avoiding the need to create one manually via StartKeyUsageRequest.builder()

Parameters:

startKeyUsageRequest - A Consumer that will call methods on StartKeyUsageRequest.Builder to create a request.

Returns:

Result of the StartKeyUsage operation returned by the service.

See Also:

• AWS API Documentation

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:

• DeleteKey

• StartKeyUsage

Parameters:

stopKeyUsageRequest -

Returns:

Result of the StopKeyUsage operation returned by the service.

See Also:

• AWS API Documentation

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:

• DeleteKey

• StartKeyUsage

This is a convenience which creates an instance of the StopKeyUsageRequest.Builder avoiding the need to create one manually via StopKeyUsageRequest.builder()

Parameters:

stopKeyUsageRequest - A Consumer that will call methods on StopKeyUsageRequest.Builder to create a request.

Returns:

Result of the StopKeyUsage operation returned by the service.

See Also:

• AWS API Documentation

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:

• ListTagsForResource

• UntagResource

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• ListTagsForResource

• UntagResource

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• ListTagsForResource

• TagResource

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• ListTagsForResource

• TagResource

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

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:

• CreateAlias

• DeleteAlias

• GetAlias

• ListAliases

Parameters:

updateAliasRequest -

Returns:

Result of the UpdateAlias operation returned by the service.

See Also:

• AWS API Documentation

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:

• CreateAlias

• DeleteAlias

• GetAlias

• ListAliases

This is a convenience which creates an instance of the UpdateAliasRequest.Builder avoiding the need to create one manually via UpdateAliasRequest.builder()

Parameters:

updateAliasRequest - A Consumer that will call methods on UpdateAliasRequest.Builder to create a request.

Returns:

Result of the UpdateAlias operation returned by the service.

See Also:

• AWS API Documentation

create

static PaymentCryptographyClient create()

Create a PaymentCryptographyClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static PaymentCryptographyClientBuilder builder()

Create a builder that can be used to configure and create a PaymentCryptographyClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default PaymentCryptographyServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration