IKMSClient

Interface in AWS.KMS

Interface for KMS service client.

Methods

CancelKeyDeletion

function CancelKeyDeletion( const ARequest: IKMSCancelKeyDeletionRequest): IKMSCancelKeyDeletionResponse; overload;

IKMSCancelKeyDeletionRequest → IKMSCancelKeyDeletionResponse

Cancel the deletion of a KMS key.

Parameters

Name	Description
ARequest	A CancelKeyDeletion request object.

Returns

Response containing CancelKeyDeletion results.

---

function CancelKeyDeletion( const AKeyId: string): IKMSCancelKeyDeletionResponse; overload;

IKMSCancelKeyDeletionResponse

Cancel the deletion of a KMS key.

Parameters

Name	Description
ARequest	The Amazon Resource Name (ARN) or ID of the KMS key to cancel deletion of.

Returns

Response containing CancelKeyDeletion results.

ConnectCustomKeyStore

function ConnectCustomKeyStore( const ARequest: IKMSConnectCustomKeyStoreRequest): IKMSConnectCustomKeyStoreResponse; overload;

IKMSConnectCustomKeyStoreRequest → IKMSConnectCustomKeyStoreResponse

Connect or reconnect a custom key store to its associated AWS CloudHSM cluster.

Parameters

Name	Description
ARequest	A ConnectCustomKeyStore request object.

Returns

Response containing ConnectCustomKeyStore results.

---

function ConnectCustomKeyStore( const ACustomKeyStoreId: string): IKMSConnectCustomKeyStoreResponse; overload;

IKMSConnectCustomKeyStoreResponse

Connect or reconnect a custom key store to its associated AWS CloudHSM cluster.

Parameters

Name	Description
ACustomKeyStoreId	Specify the key store ID of the custom key store that you want to connect.

Returns

Response containing ConnectCustomKeyStore results.

CreateAlias

function CreateAlias(const ARequest: IKMSCreateAliasRequest): IKMSCreateAliasResponse; overload;

IKMSCreateAliasRequest → IKMSCreateAliasResponse

Create a friendly name for a KMS key.

Parameters

Name	Description
ARequest	A CreateAlias request object.

Returns

Response containing CreateAlias results.

---

function CreateAlias(const AAliasName, ATargetKeyId: string): IKMSCreateAliasResponse; overload;

IKMSCreateAliasResponse

Create a friendly name for a KMS key.

Parameters

Name	Description
AAliasName	Specify the alias name. Must begin with.
ATartgetKeyId	Specify the Amazon Resource Name (ARN) or ID of the KMS key.

Returns

Response containing CreateAlias results.

CreateCustomKeyStore

function CreateCustomKeyStore( const ARequest: IKMSCreateCustomKeyStoreRequest): IKMSCreateCustomKeyStoreResponse;

IKMSCreateCustomKeyStoreRequest → IKMSCreateCustomKeyStoreResponse

Create a custom key store that is associated with an AWS CloudHSM cluster that you own and manage.

Parameters

Name	Description
ARequest	A CreateCustomKeyStore request object.

Returns

Response containing CreateCustomKeyStore results.

CreateGrant

function CreateGrant(const ARequest: IKMSCreateGrantRequest): IKMSCreateGrantResponse;

IKMSCreateGrantRequest → IKMSCreateGrantResponse

Add a grant to a KMS key.

Parameters

Name	Description
ARequest	A CreateGrant request object.

Returns

Response containing CreateGrant results.

CreateKey

function CreateKey(const ARequest: IKMSCreateKeyRequest): IKMSCreateKeyResponse;

IKMSCreateKeyRequest → IKMSCreateKeyResponse

Create a unique customer managed KMS key in your AWS account and region.

Parameters

Name	Description
ARequest	A CreateKey request object.

Returns

Response containing CreateKey results.

Decrypt

function Decrypt(const ARequest: IKMSDecryptRequest): IKMSDecryptResponse;

IKMSDecryptRequest → IKMSDecryptResponse

Decypt ciphertext that was encrypted by a KMS key.

Parameters

Name	Description
ARequest	A Decrypt request object.

Returns

Response containing Decrypt results.

DeleteAlias

function DeleteAlias(const ARequest: IKMSDeleteAliasRequest): IKMSDeleteAliasResponse; overload;

IKMSDeleteAliasRequest → IKMSDeleteAliasResponse

Delete an alias.

Parameters

Name	Description
ARequest	A DeleteAlias request object.

Returns

Response containing DeleteAlias results.

---

function DeleteAlias(const AAliasName: string): IKMSDeleteAliasResponse; overload;

IKMSDeleteAliasResponse

Delete an alias.

Parameters

Name	Description
AAliasName	Specify the Alias to be deleted. Must begin with.

Returns

Response containing DeleteAlias results.

DeleteCustomKeyStore

function DeleteCustomKeyStore( const ARequest: IKMSDeleteCustomKeyStoreRequest): IKMSDeleteCustomKeyStoreResponse; overload;

IKMSDeleteCustomKeyStoreRequest → IKMSDeleteCustomKeyStoreResponse

Delete a custom key store.

Parameters

Name	Description
ARequest	A DeleteCustomKeyStore request object.

Returns

Response containing DeleteCustomKeyStore results.

---

function DeleteCustomKeyStore( const ACustomKeyStoreId: string): IKMSDeleteCustomKeyStoreResponse; overload;

IKMSDeleteCustomKeyStoreResponse

Delete a custom key store.

Parameters

Name	Description
ACustomKeyStoreId	Specify the ID of a custom key store to delete.

Returns

Response containing DeleteCustomKeyStore results.

DeleteImportedKeyMaterial

function DeleteImportedKeyMaterial( const ARequest: IKMSDeleteImportedKeyMaterialRequest): IKMSDeleteImportedKeyMaterialResponse; overload;

IKMSDeleteImportedKeyMaterialRequest → IKMSDeleteImportedKeyMaterialResponse

Delete the key material previously imported.

Parameters

Name	Description
ARequest	A DeleteImportedKeyMaterial request object.

Returns

Response containing DeleteImportedKeyMaterial results.

---

function DeleteImportedKeyMaterial( const AKeyId: string): IKMSDeleteImportedKeyMaterialResponse; overload;

IKMSDeleteImportedKeyMaterialResponse

Delete the key material previously imported.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of the KMS key for which to delete imported key material for.

Returns

Response containing DeleteImportedKeyMaterial results.

DescribeCustomKeyStores

function DescribeCustomKeyStores( const ARequest: IKMSDescribeCustomKeyStoresRequest): IKMSDescribeCustomKeyStoresResponse;

IKMSDescribeCustomKeyStoresRequest → IKMSDescribeCustomKeyStoresResponse

Retrieve information about the custom key stores in the AWS account and region.

Parameters

Name	Description
ARequest	A DescribeCustomKeyStores request object.

Returns

Response containing DescribeCustomKeyStores results.

DescribeKey

function DescribeKey(const ARequest: IKMSDescribeKeyRequest): IKMSDescribeKeyResponse; overload;

IKMSDescribeKeyRequest → IKMSDescribeKeyResponse

Retrieve detailed information about a KMS key.

Parameters

Name	Description
ARequest	A DescribeKey request object.

Returns

Response containing DescribeKey results.

---

function DescribeKey(const AKeyId: string): IKMSDescribeKeyResponse; overload;

IKMSDescribeKeyResponse

Retrieve detailed information about a KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN), ID, alias name, or alias ARN of the KMS key to describe.

Returns

Response containing DescribeKey results.

---

function DescribeKey(const AKeyId: string; const AGrantTokens: array of string): IKMSDescribeKeyResponse; overload;

IKMSDescribeKeyResponse

Retrieve detailed information about a KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN), ID, alias name, or alias ARN of the KMS key to describe.
AGrantTokens	Specify a list of grant tokens.

Returns

Response containing DescribeKey results.

DisableKey

function DisableKey(const ARequest: IKMSDisableKeyRequest): IKMSDisableKeyResponse; overload;

IKMSDisableKeyRequest → IKMSDisableKeyResponse

Disable a KMS key.

Parameters

Name	Description
ARequest	A DisableKey request object.

Returns

Response containing DisableKey results.

---

function DisableKey(const AKeyId: string): IKMSDisableKeyResponse; overload;

IKMSDisableKeyResponse

Disable a KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of the KMS key to disable.

Returns

Response containing DisableKey results.

DisableKeyRotation

function DisableKeyRotation( const ARequest: IKMSDisableKeyRotationRequest): IKMSDisableKeyRotationResponse; overload;

IKMSDisableKeyRotationRequest → IKMSDisableKeyRotationResponse

Disable the automatic rotation of the key material of a specified symmetric encryption KMS key.

Parameters

Name	Description
ARequest	A DisableKeyRotation request object.

Returns

Response containing DisableKeyRotation results.

---

function DisableKeyRotation(const AKeyId: string): IKMSDisableKeyRotationResponse; overload;

IKMSDisableKeyRotationResponse

Disable the automatic rotation of the key material of a specified symmetric encryption KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of the symmetric encryption KMS key.

Returns

Response containing DisableKeyRotation results.

DisconnectCustomKeyStore

function DisconnectCustomKeyStore( const ARequest: IKMSDisconnectCustomKeyStoreRequest): IKMSDisconnectCustomKeyStoreResponse; overload;

IKMSDisconnectCustomKeyStoreRequest → IKMSDisconnectCustomKeyStoreResponse

Disconnect the custom key store from its associated AWS CloudHSM cluster.

Parameters

Name	Description
ARequest	A DisconnectCustomKeyStore request object.

Returns

Response containing DisconnectCustomKeyStore results.

---

function DisconnectCustomKeyStore( const ACustomKeyStoreId: string): IKMSDisconnectCustomKeyStoreResponse; overload;

IKMSDisconnectCustomKeyStoreResponse

Disconnect the custom key store from its associated AWS CloudHSM cluster.

Parameters

Name	Description
ACustomKeyStoreId	Specify the ID of a custom key store to disconnect.

Returns

Response containing DisconnectCustomKeyStore results.

EnableKey

function EnableKey(const ARequest: IKMSEnableKeyRequest): IKMSEnableKeyResponse; overload;

IKMSEnableKeyRequest → IKMSEnableKeyResponse

Enable a KMS key.

Parameters

Name	Description
ARequest	A EnableKey request object.

Returns

Response containing EnableKey results.

---

function EnableKey(const AKeyId: string): IKMSEnableKeyResponse; overload;

IKMSEnableKeyResponse

Enable a KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of the KMS key to enable.

Returns

Response containing EnableKey results.

EnableKeyRotation

function EnableKeyRotation( const ARequest: IKMSEnableKeyRotationRequest): IKMSEnableKeyRotationResponse; overload;

IKMSEnableKeyRotationRequest → IKMSEnableKeyRotationResponse

Enable the automatic rotation of the key material of a specified symmetric encryption KMS key.

Parameters

Name	Description
ARequest	A EnableKeyRotation request object.

Returns

Response containing EnableKeyRotation results.

---

function EnableKeyRotation(const AKeyId: string): IKMSEnableKeyRotationResponse; overload;

IKMSEnableKeyRotationResponse

Enable the automatic rotation of the key material of a specified symmetric encryption KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of the symmetric encryption KMS key.

Returns

Response containing EnableKeyRotation results.

Encrypt

function Encrypt(const ARequest: IKMSEncryptRequest): IKMSEncryptResponse;

IKMSEncryptRequest → IKMSEncryptResponse

Encrypt plaintext of up to 4,096 bytes using a KMS key.

Parameters

Name	Description
ARequest	A Encrypt request object.

Returns

Response containing Encrypt results.

GenerateDataKey

function GenerateDataKey( const ARequest: IKMSGenerateDataKeyRequest): IKMSGenerateDataKeyResponse;

IKMSGenerateDataKeyRequest → IKMSGenerateDataKeyResponse

Generate a unique symmetric data key for use outside of AWS KMS.

Parameters

Name	Description
ARequest	A GenerateDataKey request object.

Returns

Response containing GenerateDataKey results.

GenerateDataKeyPair

function GenerateDataKeyPair( const ARequest: IKMSGenerateDataKeyPairRequest): IKMSGenerateDataKeyPairResponse;

IKMSGenerateDataKeyPairRequest → IKMSGenerateDataKeyPairResponse

Generate a unique asymmetric data key pair for use outside of AWS KMS.

Parameters

Name	Description
ARequest	A GenerateDataKeyPair request object.

Returns

Response containing GenerateDataKeyPair results.

GenerateDataKeyPairWithoutPlaintext

function GenerateDataKeyPairWithoutPlaintext( const ARequest: IKMSGenerateDataKeyPairWithoutPlaintextRequest): IKMSGenerateDataKeyPairWithoutPlaintextResponse;

IKMSGenerateDataKeyPairWithoutPlaintextRequest → IKMSGenerateDataKeyPairWithoutPlaintextResponse

Generate a unique asymmetric data key pair for use outside of AWS KMS.

Parameters

Name	Description
ARequest	A GenerateDataKeyPairWithoutPlaintext request object.

Returns

Response containing GenerateDataKeyPairWithoutPlaintext results.

GenerateDataKeyWithoutPlaintext

function GenerateDataKeyWithoutPlaintext( const ARequest: IKMSGenerateDataKeyWithoutPlaintextRequest): IKMSGenerateDataKeyWithoutPlaintextResponse;

IKMSGenerateDataKeyWithoutPlaintextRequest → IKMSGenerateDataKeyWithoutPlaintextResponse

Generate a unique symmetric data key for use outside of AWS KMS.

Parameters

Name	Description
ARequest	A GenerateDataKey request object.

Returns

Response containing GenerateDataKey results.

GenerateMac

function GenerateMac(const ARequest: IKMSGenerateMacRequest): IKMSGenerateMacResponse;

IKMSGenerateMacRequest → IKMSGenerateMacResponse

Generate a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and MAC algorithm that the key supports.

Parameters

Name	Description
ARequest	A GenerateMac request object.

Returns

Response containing GenerateMac results.

GenerateRandom

function GenerateRandom(const ARequest: IKMSGenerateRandomRequest): IKMSGenerateRandomResponse; overload;

IKMSGenerateRandomRequest → IKMSGenerateRandomResponse

Generate a random byte string that is cyptographically secure.

Parameters

Name	Description
ARequest	A GenerateRandom request object.

Returns

Response containing GenerateRandom results.

---

function GenerateRandom( const ANumberOfBytes: Integer; const ACustomKeyStoreId: string): IKMSGenerateRandomResponse; overload;

IKMSGenerateRandomResponse

Generate a random byte string that is cyptographically secure.

Parameters

Name	Description
ANumberOfBytes	Specify the length of the random byte string. Minimum length 1, maximum length 1024.
ACustomKeyStoreId	Specify ID of a custom key store to generate the random string.

Returns

Response containing GenerateRandom results.

GetKeyPolicy

function GetKeyPolicy(const ARequest: IKMSGetKeyPolicyRequest): IKMSGetKeyPolicyResponse; overload;

IKMSGetKeyPolicyRequest → IKMSGetKeyPolicyResponse

Retreive a key policy attached to the specified KMS key.

Parameters

Name	Description
ARequest	A GetKeyPolicy request object.

Returns

Response containing GetKeyPolicy results.

---

function GetKeyPolicy( const AKeyId: string; const APolicyName: string = 'default'): IKMSGetKeyPolicyResponse; overload;

IKMSGetKeyPolicyResponse

Retreive a key policy attached to the specified KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of a KMS key.
APolicyName	Specify the name of a key policy. The only valid name is.

Returns

Response containing GetKeyPolicy results.

GetKeyRotationStatus

function GetKeyRotationStatus( const ARequest: IKMSGetKeyRotationStatusRequest): IKMSGetKeyRotationStatusResponse; overload;

IKMSGetKeyRotationStatusRequest → IKMSGetKeyRotationStatusResponse

Retrieve the key rotation status for a KMS key.

Parameters

Name	Description
ARequest	A GetKeyRotationStatus request object.

Returns

Response containing GetKeyRotationStatus results.

---

function GetKeyRotationStatus( const AKeyId: string): IKMSGetKeyRotationStatusResponse; overload;

IKMSGetKeyRotationStatusResponse

Retrieve the key rotation status for a KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of a KMS key.

Returns

Response containing GetKeyRotationStatus results.

GetParametersForImport

function GetParametersForImport( const ARequest: IKMSGetParametersForImportRequest): IKMSGetParametersForImportResponse; overload;

IKMSGetParametersForImportRequest → IKMSGetParametersForImportResponse

Retrieve the items needed to import key material into a symmetric encryption KMS key.

Parameters

Name	Description
ARequest	A GetParametersForImport request object.

Returns

Response containing GetParametersForImport results.

---

function GetParametersForImport( const AKeyId, AWrappingAlgorithm: string; const AWrappingKeySpec: string = 'RSA_2048'): IKMSGetParametersForImportResponse; overload;

IKMSGetParametersForImportResponse

Retrieve the items needed to import key material into a symmetric encryption KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of a symmetric encryption KMS key into which you will import the key material.
AWrappingAlgorithm	Specify the algorithm you will use to encrypt the key material with before importing it with ImportKeyMaterial.
AWrappingKeySpec	Specify the type of wrapping key (public key) to return in the response. Only 2048-bit RSA () public keys are supported.

Returns

Response containing GetParametersForImport results.

GetPublicKey

function GetPublicKey(const ARequest: IKMSGetPublicKeyRequest): IKMSGetPublicKeyResponse; overload;

IKMSGetPublicKeyRequest → IKMSGetPublicKeyResponse

Retrieve the public key of an asymmetric KMS key.

Parameters

Name	Description
ARequest	A GetPublicKey request object.

Returns

Response containing GetPublicKey results.

---

function GetPublicKey(const AKeyId: string): IKMSGetPublicKeyResponse; overload;

IKMSGetPublicKeyResponse

Retrieve the public key of an asymmetric KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN), ID, alias ARN, or alias ID of an asymmetric KMS key.

Returns

Response containing GetPublicKey results.

ImportKeyMaterial

function ImportKeyMaterial( const ARequest: IKMSImportKeyMaterialRequest): IKMSImportKeyMaterialResponse;

IKMSImportKeyMaterialRequest → IKMSImportKeyMaterialResponse

Import key material into an existing symmetric encryption KMS key that was created without key material.

Parameters

Name	Description
ARequest	A ImportKeyMaterial request object.

Returns

Response containing ImportKeyMaterial results.

ListAliases

function ListAliases(const ARequest: IKMSListAliasesRequest): IKMSListAliasesResponse; overload;

IKMSListAliasesRequest → IKMSListAliasesResponse

Fetch a list of aliases in the AWS account and region.

Parameters

Name	Description
ARequest	A ListAliases request object.

Returns

Response containing ListAliases results.

---

function ListAliases(const AKeyId: string): IKMSListAliasesResponse; overload;

IKMSListAliasesResponse

Fetch a list of aliases in the AWS account and region for a specific KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of a KMS key.

Returns

Response containing ListAliases results.

---

function ListAliases( const ALimit: Integer; const AMarker: string = ''): IKMSListAliasesResponse; overload;

IKMSListAliasesResponse

Fetch a list of aliases in the AWS account and region for a specific KMS key.

Parameters

Name	Description
ALimit	Specify the the maximum number of items to return.
AMarker	Specify the NextMarker from a previous call to ListAliases to retrieve further results.

Returns

Response containing ListAliases results.

ListGrants

function ListGrants(const ARequest: IKMSListGrantsRequest): IKMSListGrantsResponse; overload;

IKMSListGrantsRequest → IKMSListGrantsResponse

Fetch a list of grants for a specified KMS key.

Parameters

Name	Description
ARequest	A ListGrants request object.

Returns

Response containing ListGrants results.

---

function ListGrants(const AKeyId: string): IKMSListGrantsResponse; overload;

IKMSListGrantsResponse

Fetch a list of grants for a specified KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of a KMS key.

Returns

Response containing ListGrants results.

---

function ListGrants(const AKeyId: string; const ALimit: TOptional<Integer>; const AMarker: string = ''): IKMSListGrantsResponse; overload;

IKMSListGrantsResponse

Fetch a list of grants for a specified KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of a KMS key.
ALimit	Specify the the maximum number of items to return.
AMarker	Specify the NextMarker from a previous call to ListGrants to retrieve further results.

Returns

Response containing ListGrants results.

---

function ListGrants(const AKeyId, AGrantId: string): IKMSListGrantsResponse; overload;

IKMSListGrantsResponse

Fetch a list of grants for a specified KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of a KMS key.
AGrantId	Specify the ID of a grant. Only the specified grant will be retrieved.

Returns

Response containing ListGrants results.

ListKeyPolicies

function ListKeyPolicies(const ARequest: IKMSListKeyPoliciesRequest): IKMSListKeyPoliciesResponse; overload;

IKMSListKeyPoliciesRequest → IKMSListKeyPoliciesResponse

Fetch a list of key policies attached to a specified KMS key.

Parameters

Name	Description
ARequest	A ListKeyPolicies request object.

Returns

Response containing ListKeyPolicies results.

---

function ListKeyPolicies(const AKeyId: string): IKMSListKeyPoliciesResponse; overload;

IKMSListKeyPoliciesResponse

Fetch a list of key policies attached to a specified KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of a KMS key.

Returns

Response containing ListKeyPolicies results.

---

function ListKeyPolicies(const AKeyId: string; const ALimit: TOptional<Integer>; const AMarker: string = ''): IKMSListKeyPoliciesResponse; overload;

IKMSListKeyPoliciesResponse

Fetch a list of key policies attached to a specified KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of a KMS key.
ALimit	Specify the the maximum number of items to return.
AMarker	Specify the NextMarker from a previous call to ListGrants to retrieve further results.

Returns

Response containing ListKeyPolicies results.

ListKeys

function ListKeys(const ARequest: IKMSListKeysRequest): IKMSListKeysResponse; overload;

IKMSListKeysRequest → IKMSListKeysResponse

Fetch a list of KMS keys in the account and region.

Parameters

Name	Description
ARequest	A ListKeys request object.

Returns

Response containing ListKeys results.

---

function ListKeys(const ALimit: TOptional<Integer>; const AMarker: string = ''): IKMSListKeysResponse; overload;

IKMSListKeysResponse

Fetch a list of KMS keys in the account and region.

Parameters

Name	Description
ALimit	Specify the the maximum number of items to return.
AMarker	Specify the NextMarker from a previous call to ListKeys to retrieve further results.

Returns

Response containing ListKeys results.

ListResourceTags

function ListResourceTags( const ARequest: IKMSListResourceTagsRequest): IKMSListResourceTagsResponse; overload;

IKMSListResourceTagsRequest → IKMSListResourceTagsResponse

Fetch a list of tags for a specified KMS key.

Parameters

Name	Description
ARequest	A ListResourceTags request object.

Returns

Response containing ListResourceTags results.

---

function ListResourceTags(const AKeyId: string): IKMSListResourceTagsResponse; overload;

IKMSListResourceTagsResponse

Fetch a list of tags for a specified KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of a KMS key.

Returns

Response containing ListResourceTags results.

---

function ListResourceTags(const AKeyId: string; const ALimit: TOptional<Integer>; const AMarker: string = ''): IKMSListResourceTagsResponse; overload;

IKMSListResourceTagsResponse

Fetch a list of tags for a specified KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of a KMS key.
ALimit	Specify the the maximum number of items to return.
AMarker	Specify the NextMarker from a previous call to ListResourceTags to retrieve further results.

Returns

Response containing ListResourceTags results.

ListRetirableGrants

function ListRetirableGrants( const ARequest: IKMSListRetirableGrantsRequest): IKMSListRetirableGrantsResponse; overload;

IKMSListRetirableGrantsRequest → IKMSListRetirableGrantsResponse

Fetch a list of grants in an account and region for a specified retiring principal.

Parameters

Name	Description
ARequest	A ListRetirableGrants request object.

Returns

Response containing ListRetirableGrants results.

---

function ListRetirableGrants( const ARetirablePrincipal: string): IKMSListRetirableGrantsResponse; overload;

IKMSListRetirableGrantsResponse

Fetch a list of grants in an account and region for a specified retiring principal.

Parameters

Name	Description
ARetirablePrincipal	Specify the retiring principal for which to list grants.

Returns

Response containing ListRetirableGrants results.

---

function ListRetirableGrants(const ARetirablePrincipal: string; const ALimit: TOptional<Integer>; const AMarker: string = ''): IKMSListRetirableGrantsResponse; overload;

IKMSListRetirableGrantsResponse

Fetch a list of grants in an account and region for a specified retiring principal.

Parameters

Name	Description
ARetirablePrincipal	Specify the retiring principal for which to list grants.
ALimit	Specify the the maximum number of items to return.
AMarker	Specify the NextMarker from a previous call to ListResourceTags to retrieve further results.

Returns

Response containing ListRetirableGrants results.

PutKeyPolicy

function PutKeyPolicy(const ARequest: IKMSPutKeyPolicyRequest): IKMSPutKeyPolicyResponse;

IKMSPutKeyPolicyRequest → IKMSPutKeyPolicyResponse

Attach a key policy to a specified KMS key.

Parameters

Name	Description
ARequest	A PutKeyPolicy request object.

Returns

Response containing PutKeyPolicy results.

ReEncrypt

function ReEncrypt(const ARequest: IKMSReEncryptRequest): IKMSReEncryptResponse;

IKMSReEncryptRequest → IKMSReEncryptResponse

Decrypt ciphertext and reencrypt within AWS KMS.

Parameters

Name	Description
ARequest	A ReEncrypt request object.

Returns

Response containing ReEncrypt results.

ReplicateKey

function ReplicateKey(const ARequest: IKMSReplicateKeyRequest): IKMSReplicateKeyResponse;

IKMSReplicateKeyRequest → IKMSReplicateKeyResponse

Replicate a multi-region key into the specified region.

Parameters

Name	Description
ARequest	A ReplicateKey request object.

Returns

Response containing ReplicateKey results.

RetireGrant

function RetireGrant(const ARequest: IKMSRetireGrantRequest): IKMSRetireGrantResponse; overload;

IKMSRetireGrantRequest → IKMSRetireGrantResponse

Delete a grant.

Parameters

Name	Description
ARequest	A RetireGrant request object.

Returns

Response containing RetireGrant results.

---

function RetireGrant(const AGrantId: string; const AKeyId: TARN): IKMSRetireGrantResponse; overload;

IKMSRetireGrantResponse

Delete a grant.

Parameters

Name	Description
AGrantId	Specify a Grant ID to retire.
AKeyId	Specify the Amazon Resource Name (ARN) of the KMS key to retire.

Returns

Response containing RetireGrant results.

---

function RetireGrant(const AGrantToken: string): IKMSRetireGrantResponse; overload;

IKMSRetireGrantResponse

Delete a grant.

Parameters

Name	Description
AGrantToken	Specify a GrantToken for the grant to be retired. Grant tokens are returned from CreateGrant.

Returns

Response containing RetireGrant results.

RevokeGrant

function RevokeGrant(const ARequest: IKMSRevokeGrantRequest): IKMSRevokeGrantResponse; overload;

IKMSRevokeGrantRequest → IKMSRevokeGrantResponse

Delete a grant terminating the permissions that the grant allowed.

Parameters

Name	Description
ARequest	A RevokeGrant request object.

Returns

Response containing RevokeGrant results.

---

function RevokeGrant(const AGrantId: string; const AKeyId: TARN): IKMSRevokeGrantResponse; overload;

IKMSRevokeGrantResponse

Delete a grant.

Parameters

Name	Description
AGrantId	Specify a Grant ID to revoke.
AKeyId	Specify the Amazon Resource Name (ARN) of the KMS key to revoke.

Returns

Response containing RevokeGrant results.

ScheduleKeyDeletion

function ScheduleKeyDeletion(const ARequest: IKMSScheduleKeyDeletionRequest): IKMSScheduleKeyDeletionResponse; overload;

IKMSScheduleKeyDeletionRequest → IKMSScheduleKeyDeletionResponse

Schedule a KMS key for deletion.

Parameters

Name	Description
ARequest	A ScheduleKeyDeletion request object.

Returns

Response containing ScheduleKeyDeletion results.

---

function ScheduleKeyDeletion(const AKeyId: string): IKMSScheduleKeyDeletionResponse; overload;

IKMSScheduleKeyDeletionResponse

Schedule a KMS key for deletion.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) of the KMS key to delete.

Returns

Response containing ScheduleKeyDeletion results.

---

function ScheduleKeyDeletion(const AKeyId: string; const APendingWindowInDays: Integer): IKMSScheduleKeyDeletionResponse; overload;

IKMSScheduleKeyDeletionResponse

Schedule a KMS key for deletion.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) of the KMS key to delete.
APendingWindowInDays	Specify the waiting period in days. Minimum 7, maximum 30.

Returns

Response containing ScheduleKeyDeletion results.

Sign

function Sign(const ARequest: IKMSSignRequest): IKMSSignResponse;

IKMSSignRequest → IKMSSignResponse

Create a digital signature for a message or message digest by using the private key in an asymmetric KMS key.

Parameters

Name	Description
ARequest	A Sign request object.

Returns

Response containing Sign results.

TagResource

function TagResource(const ARequest: IKMSTagResourceRequest): IKMSTagResourceResponse;

IKMSTagResourceRequest → IKMSTagResourceResponse

Add or edit tags on a KMS key.

Parameters

Name	Description
ARequest	A TagResource request object.

Returns

Response containing TagResource results.

UntagResource

function UntagResource( const ARequest: IKMSUntagResourceRequest): IKMSUntagResourceResponse; overload;

IKMSUntagResourceRequest → IKMSUntagResourceResponse

Delete tags from a KMS key.

Parameters

Name	Description
ARequest	An UntagResource request object.

Returns

Response containing UntagResource results.

---

function UntagResource(const AKeyId: string; const ATagKeys: array of string): IKMSUntagResourceResponse; overload;

IKMSUntagResourceResponse

Delete tags from a KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of a KMS key.
ATagKeys	Specify a list of tag key names to remove from the KMS key.

Returns

Response containing UntagResource results.

UpdateAlias

function UpdateAlias( const ARequest: IKMSUpdateAliasRequest): IKMSUpdateAliasResponse; overload;

IKMSUpdateAliasRequest → IKMSUpdateAliasResponse

Associate an existing AWS KMS alias with a different KMS key.

Parameters

Name	Description
ARequest	A UpdateAlias request object.

Returns

Response containing UpdateAlias results.

---

function UpdateAlias( const AAliasName, ATargetKeyId: string): IKMSUpdateAliasResponse; overload;

IKMSUpdateAliasResponse

Associate an existing AWS KMS alias with a different KMS key.

Parameters

Name	Description
AAliasName	Specify the alias that is changing its KMS key. The value must begin with.
ATargetKeyId	Specify the Amazon Resource Name (ARN) of a KMS key with which to associate the alias.

Returns

Response containing UpdateAlias results.

UpdateCustomKeyStore

function UpdateCustomKeyStore( const ARequest: IKMSUpdateCustomKeyStoreRequest): IKMSUpdateCustomKeyStoreResponse;

IKMSUpdateCustomKeyStoreRequest → IKMSUpdateCustomKeyStoreResponse

Update the properties of a custom key store.

Parameters

Name	Description
ARequest	A UpdateCustomKeyStore request object.

Returns

Response containing UpdateCustomKeyStore results.

UpdateKeyDescription

function UpdateKeyDescription( const ARequest: IKMSUpdateKeyDescriptionRequest): IKMSUpdateKeyDescriptionResponse; overload;

IKMSUpdateKeyDescriptionRequest → IKMSUpdateKeyDescriptionResponse

Update the description of a KMS key.

Parameters

Name	Description
ARequest	A UpdateKeyDescription request object.

Returns

Response containing UpdateKeyDescription results.

---

function UpdateKeyDescription(const AKeyId, ADescription: string): IKMSUpdateKeyDescriptionResponse; overload;

IKMSUpdateKeyDescriptionResponse

Update the description of a KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of a KMS key to update.
ADescription	Specify new description for the KMS key.

Returns

Response containing UpdateKeyDescription results.

UpdatePrimaryRegion

function UpdatePrimaryRegion( const ARequest: IKMSUpdatePrimaryRegionRequest): IKMSUpdatePrimaryRegionResponse; overload;

IKMSUpdatePrimaryRegionRequest → IKMSUpdatePrimaryRegionResponse

Update the primary region of a KMS key.

Parameters

Name	Description
ARequest	A UpdatePrimaryRegion request object.

Returns

Response containing UpdatePrimaryRegion results.

---

function UpdatePrimaryRegion( const AKeyId, APrimaryRegion: string): IKMSUpdatePrimaryRegionResponse; overload;

IKMSUpdatePrimaryRegionResponse

Update the primary region of a KMS key.

Parameters

Name	Description
AKeyId	Specify the Amazon Resource Name (ARN) or ID of a KMS key to update.
APrimaryRegion	Specify the region ID of an AWS region to become the new primary region for the KMS key.

Returns

Response containing UpdatePrimaryRegion results.

Verify

function Verify(const ARequest: IKMSVerifyRequest): IKMSVerifyResponse;

IKMSVerifyRequest → IKMSVerifyResponse

Verify a digital signature that was generated by the Sign operation.

Parameters

Name	Description
ARequest	A Verify request object.

Returns

Response containing Verify results.

VerifyMac

function VerifyMac(const ARequest: IKMSVerifyMacRequest): IKMSVerifyMacResponse;

IKMSVerifyMacRequest → IKMSVerifyMacResponse

Verify the hash-based message authentication code (HMAC) for a specified message, HMAC KMS key, and MAC algorithm.

Parameters

Name	Description
ARequest	A VerifyMac request object.

Returns

Response containing VerifyMac results.