paymentcryptography/aws.sdk.kotlin.services.paymentcryptography

Package-level declarations

Types

interface PaymentCryptographyClient : SdkClient

Amazon Web Services Payment Cryptography Control Plane APIs manage encryption keys for use during payment-related cryptographic operations. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. For more information, see Identity and access management in the Amazon Web Services Payment Cryptography User Guide.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Functions

createAlias

inline suspend fun PaymentCryptographyClient.createAlias(crossinline block: CreateAliasRequest.Builder.() -> Unit): CreateAliasResponse

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.

createKey

inline suspend fun PaymentCryptographyClient.createKey(crossinline block: CreateKeyRequest.Builder.() -> Unit): CreateKeyResponse

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.

deleteAlias

inline suspend fun PaymentCryptographyClient.deleteAlias(crossinline block: DeleteAliasRequest.Builder.() -> Unit): DeleteAliasResponse

Deletes the alias, but doesn't affect the underlying key.

deleteKey

inline suspend fun PaymentCryptographyClient.deleteKey(crossinline block: DeleteKeyRequest.Builder.() -> Unit): DeleteKeyResponse

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

exportKey

inline suspend fun PaymentCryptographyClient.exportKey(crossinline block: ExportKeyRequest.Builder.() -> Unit): ExportKeyResponse

Exports a key from Amazon Web Services Payment Cryptography.

getAlias

inline suspend fun PaymentCryptographyClient.getAlias(crossinline block: GetAliasRequest.Builder.() -> Unit): GetAliasResponse

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

getKey

inline suspend fun PaymentCryptographyClient.getKey(crossinline block: GetKeyRequest.Builder.() -> Unit): GetKeyResponse

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

getParametersForExport

inline suspend fun PaymentCryptographyClient.getParametersForExport(crossinline block: GetParametersForExportRequest.Builder.() -> Unit): GetParametersForExportResponse

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

getParametersForImport

inline suspend fun PaymentCryptographyClient.getParametersForImport(crossinline block: GetParametersForImportRequest.Builder.() -> Unit): GetParametersForImportResponse

Gets the import token and the wrapping key certificate in PEM format (base64 encoded) to initiate a TR-34 WrappedKeyBlock or a RSA WrappedKeyCryptogram import into Amazon Web Services Payment Cryptography.

getPublicKeyCertificate

inline suspend fun PaymentCryptographyClient.getPublicKeyCertificate(crossinline block: GetPublicKeyCertificateRequest.Builder.() -> Unit): GetPublicKeyCertificateResponse

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

importKey

inline suspend fun PaymentCryptographyClient.importKey(crossinline block: ImportKeyRequest.Builder.() -> Unit): ImportKeyResponse

Imports symmetric keys and public key certificates in PEM format (base64 encoded) into Amazon Web Services Payment Cryptography.

listAliases

inline suspend fun PaymentCryptographyClient.listAliases(crossinline block: ListAliasesRequest.Builder.() -> Unit): ListAliasesResponse

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.

listKeys

inline suspend fun PaymentCryptographyClient.listKeys(crossinline block: ListKeysRequest.Builder.() -> Unit): ListKeysResponse

Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys.

listTagsForResource

inline suspend fun PaymentCryptographyClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Lists the tags for an Amazon Web Services resource.

restoreKey

inline suspend fun PaymentCryptographyClient.restoreKey(crossinline block: RestoreKeyRequest.Builder.() -> Unit): RestoreKeyResponse

Cancels a scheduled key deletion during the waiting period. Use this operation to restore a Key that is scheduled for deletion.

startKeyUsage

inline suspend fun PaymentCryptographyClient.startKeyUsage(crossinline block: StartKeyUsageRequest.Builder.() -> Unit): StartKeyUsageResponse

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

stopKeyUsage

inline suspend fun PaymentCryptographyClient.stopKeyUsage(crossinline block: StopKeyUsageRequest.Builder.() -> Unit): StopKeyUsageResponse

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

tagResource

inline suspend fun PaymentCryptographyClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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

untagResource

inline suspend fun PaymentCryptographyClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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

updateAlias

inline suspend fun PaymentCryptographyClient.updateAlias(crossinline block: UpdateAliasRequest.Builder.() -> Unit): UpdateAliasResponse

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

withConfig

fun PaymentCryptographyClient.withConfig(block: PaymentCryptographyClient.Config.Builder.() -> Unit): PaymentCryptographyClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.