Module Smaws_Client_KMS

KMS client library built on EIO.

Types

module Types : sig ... end

Builders

val make_xks_proxy_authentication_credential_type : raw_secret_access_key: Types.xks_proxy_authentication_raw_secret_access_key_type -> access_key_id:Types.xks_proxy_authentication_access_key_id_type -> unit -> Types.xks_proxy_authentication_credential_type
val make_xks_key_configuration_type : ?id:Types.xks_key_id_type -> unit -> Types.xks_key_configuration_type
val make_verify_response : ?signing_algorithm:Types.signing_algorithm_spec -> ?signature_valid:Types.boolean_type -> ?key_id:Types.key_id_type -> unit -> Types.verify_response
val make_verify_request : ?dry_run:Types.nullable_boolean_type -> ?grant_tokens:Types.grant_token_list -> ?message_type:Types.message_type -> signing_algorithm:Types.signing_algorithm_spec -> signature:Types.ciphertext_type -> message:Types.plaintext_type -> key_id:Types.key_id_type -> unit -> Types.verify_request
val make_verify_mac_response : ?mac_algorithm:Types.mac_algorithm_spec -> ?mac_valid:Types.boolean_type -> ?key_id:Types.key_id_type -> unit -> Types.verify_mac_response
val make_verify_mac_request : ?dry_run:Types.nullable_boolean_type -> ?grant_tokens:Types.grant_token_list -> mac:Types.ciphertext_type -> mac_algorithm:Types.mac_algorithm_spec -> key_id:Types.key_id_type -> message:Types.plaintext_type -> unit -> Types.verify_mac_request
val make_update_primary_region_request : primary_region:Types.region_type -> key_id:Types.key_id_type -> unit -> Types.update_primary_region_request
val make_update_key_description_request : description:Types.description_type -> key_id:Types.key_id_type -> unit -> Types.update_key_description_request
val make_update_custom_key_store_response : unit -> unit
val make_update_custom_key_store_request : ?xks_proxy_connectivity:Types.xks_proxy_connectivity_type -> ?xks_proxy_authentication_credential: Types.xks_proxy_authentication_credential_type -> ?xks_proxy_vpc_endpoint_service_name: Types.xks_proxy_vpc_endpoint_service_name_type -> ?xks_proxy_uri_path:Types.xks_proxy_uri_path_type -> ?xks_proxy_uri_endpoint:Types.xks_proxy_uri_endpoint_type -> ?cloud_hsm_cluster_id:Types.cloud_hsm_cluster_id_type -> ?key_store_password:Types.key_store_password_type -> ?new_custom_key_store_name:Types.custom_key_store_name_type -> custom_key_store_id:Types.custom_key_store_id_type -> unit -> Types.update_custom_key_store_request
val make_update_alias_request : target_key_id:Types.key_id_type -> alias_name:Types.alias_name_type -> unit -> Types.update_alias_request
val make_untag_resource_request : tag_keys:Types.tag_key_list -> key_id:Types.key_id_type -> unit -> Types.untag_resource_request
val make_tag : tag_value:Types.tag_value_type -> tag_key:Types.tag_key_type -> unit -> Types.tag
val make_tag_resource_request : tags:Types.tag_list -> key_id:Types.key_id_type -> unit -> Types.tag_resource_request
val make_sign_response : ?signing_algorithm:Types.signing_algorithm_spec -> ?signature:Types.ciphertext_type -> ?key_id:Types.key_id_type -> unit -> Types.sign_response
val make_sign_request : ?dry_run:Types.nullable_boolean_type -> ?grant_tokens:Types.grant_token_list -> ?message_type:Types.message_type -> signing_algorithm:Types.signing_algorithm_spec -> message:Types.plaintext_type -> key_id:Types.key_id_type -> unit -> Types.sign_request
val make_schedule_key_deletion_response : ?pending_window_in_days:Types.pending_window_in_days_type -> ?key_state:Types.key_state -> ?deletion_date:Types.date_type -> ?key_id:Types.key_id_type -> unit -> Types.schedule_key_deletion_response
val make_schedule_key_deletion_request : ?pending_window_in_days:Types.pending_window_in_days_type -> key_id:Types.key_id_type -> unit -> Types.schedule_key_deletion_request
val make_rotate_key_on_demand_response : ?key_id:Types.key_id_type -> unit -> Types.rotate_key_on_demand_response
val make_rotate_key_on_demand_request : key_id:Types.key_id_type -> unit -> Types.rotate_key_on_demand_request
val make_revoke_grant_request : ?dry_run:Types.nullable_boolean_type -> grant_id:Types.grant_id_type -> key_id:Types.key_id_type -> unit -> Types.revoke_grant_request
val make_retire_grant_request : ?dry_run:Types.nullable_boolean_type -> ?grant_id:Types.grant_id_type -> ?key_id:Types.key_id_type -> ?grant_token:Types.grant_token_type -> unit -> Types.retire_grant_request
val make_multi_region_key : ?region:Types.region_type -> ?arn:Types.arn_type -> unit -> Types.multi_region_key
val make_multi_region_configuration : ?replica_keys:Types.multi_region_key_list -> ?primary_key:Types.multi_region_key -> ?multi_region_key_type:Types.multi_region_key_type -> unit -> Types.multi_region_configuration
val make_key_metadata : ?current_key_material_id:Types.backing_key_id_type -> ?xks_key_configuration:Types.xks_key_configuration_type -> ?mac_algorithms:Types.mac_algorithm_spec_list -> ?pending_deletion_window_in_days:Types.pending_window_in_days_type -> ?multi_region_configuration:Types.multi_region_configuration -> ?multi_region:Types.nullable_boolean_type -> ?key_agreement_algorithms:Types.key_agreement_algorithm_spec_list -> ?signing_algorithms:Types.signing_algorithm_spec_list -> ?encryption_algorithms:Types.encryption_algorithm_spec_list -> ?key_spec:Types.key_spec -> ?customer_master_key_spec:Types.customer_master_key_spec -> ?key_manager:Types.key_manager_type -> ?expiration_model:Types.expiration_model_type -> ?cloud_hsm_cluster_id:Types.cloud_hsm_cluster_id_type -> ?custom_key_store_id:Types.custom_key_store_id_type -> ?origin:Types.origin_type -> ?valid_to:Types.date_type -> ?deletion_date:Types.date_type -> ?key_state:Types.key_state -> ?key_usage:Types.key_usage_type -> ?description:Types.description_type -> ?enabled:Types.boolean_type -> ?creation_date:Types.date_type -> ?arn:Types.arn_type -> ?aws_account_id:Types.aws_account_id_type -> key_id:Types.key_id_type -> unit -> Types.key_metadata
val make_replicate_key_response : ?replica_tags:Types.tag_list -> ?replica_policy:Types.policy_type -> ?replica_key_metadata:Types.key_metadata -> unit -> Types.replicate_key_response
val make_replicate_key_request : ?tags:Types.tag_list -> ?description:Types.description_type -> ?bypass_policy_lockout_safety_check:Types.boolean_type -> ?policy:Types.policy_type -> replica_region:Types.region_type -> key_id:Types.key_id_type -> unit -> Types.replicate_key_request
val make_re_encrypt_response : ?destination_key_material_id:Types.backing_key_id_type -> ?source_key_material_id:Types.backing_key_id_type -> ?destination_encryption_algorithm:Types.encryption_algorithm_spec -> ?source_encryption_algorithm:Types.encryption_algorithm_spec -> ?key_id:Types.key_id_type -> ?source_key_id:Types.key_id_type -> ?ciphertext_blob:Types.ciphertext_type -> unit -> Types.re_encrypt_response
val make_re_encrypt_request : ?dry_run:Types.nullable_boolean_type -> ?grant_tokens:Types.grant_token_list -> ?destination_encryption_algorithm:Types.encryption_algorithm_spec -> ?source_encryption_algorithm:Types.encryption_algorithm_spec -> ?destination_encryption_context:Types.encryption_context_type -> ?source_key_id:Types.key_id_type -> ?source_encryption_context:Types.encryption_context_type -> destination_key_id:Types.key_id_type -> ciphertext_blob:Types.ciphertext_type -> unit -> Types.re_encrypt_request
val make_put_key_policy_request : ?bypass_policy_lockout_safety_check:Types.boolean_type -> ?policy_name:Types.policy_name_type -> policy:Types.policy_type -> key_id:Types.key_id_type -> unit -> Types.put_key_policy_request
val make_grant_constraints : ?encryption_context_equals:Types.encryption_context_type -> ?encryption_context_subset:Types.encryption_context_type -> unit -> Types.grant_constraints
val make_grant_list_entry : ?constraints:Types.grant_constraints -> ?operations:Types.grant_operation_list -> ?issuing_account:Types.principal_id_type -> ?retiring_principal:Types.principal_id_type -> ?grantee_principal:Types.principal_id_type -> ?creation_date:Types.date_type -> ?name:Types.grant_name_type -> ?grant_id:Types.grant_id_type -> ?key_id:Types.key_id_type -> unit -> Types.grant_list_entry
val make_list_grants_response : ?truncated:Types.boolean_type -> ?next_marker:Types.marker_type -> ?grants:Types.grant_list -> unit -> Types.list_grants_response
val make_list_retirable_grants_request : ?marker:Types.marker_type -> ?limit:Types.limit_type -> retiring_principal:Types.principal_id_type -> unit -> Types.list_retirable_grants_request
val make_list_resource_tags_response : ?truncated:Types.boolean_type -> ?next_marker:Types.marker_type -> ?tags:Types.tag_list -> unit -> Types.list_resource_tags_response
val make_list_resource_tags_request : ?marker:Types.marker_type -> ?limit:Types.limit_type -> key_id:Types.key_id_type -> unit -> Types.list_resource_tags_request
val make_key_list_entry : ?key_arn:Types.arn_type -> ?key_id:Types.key_id_type -> unit -> Types.key_list_entry
val make_list_keys_response : ?truncated:Types.boolean_type -> ?next_marker:Types.marker_type -> ?keys:Types.key_list -> unit -> Types.list_keys_response
val make_list_keys_request : ?marker:Types.marker_type -> ?limit:Types.limit_type -> unit -> Types.list_keys_request
val make_rotations_list_entry : ?rotation_type:Types.rotation_type -> ?rotation_date:Types.date_type -> ?valid_to:Types.date_type -> ?expiration_model:Types.expiration_model_type -> ?key_material_state:Types.key_material_state -> ?import_state:Types.import_state -> ?key_material_description:Types.key_material_description_type -> ?key_material_id:Types.backing_key_id_type -> ?key_id:Types.key_id_type -> unit -> Types.rotations_list_entry
val make_list_key_rotations_response : ?truncated:Types.boolean_type -> ?next_marker:Types.marker_type -> ?rotations:Types.rotations_list -> unit -> Types.list_key_rotations_response
val make_list_key_rotations_request : ?marker:Types.marker_type -> ?limit:Types.limit_type -> ?include_key_material:Types.include_key_material -> key_id:Types.key_id_type -> unit -> Types.list_key_rotations_request
val make_list_key_policies_response : ?truncated:Types.boolean_type -> ?next_marker:Types.marker_type -> ?policy_names:Types.policy_name_list -> unit -> Types.list_key_policies_response
val make_list_key_policies_request : ?marker:Types.marker_type -> ?limit:Types.limit_type -> key_id:Types.key_id_type -> unit -> Types.list_key_policies_request
val make_list_grants_request : ?grantee_principal:Types.principal_id_type -> ?grant_id:Types.grant_id_type -> ?marker:Types.marker_type -> ?limit:Types.limit_type -> key_id:Types.key_id_type -> unit -> Types.list_grants_request
val make_alias_list_entry : ?last_updated_date:Types.date_type -> ?creation_date:Types.date_type -> ?target_key_id:Types.key_id_type -> ?alias_arn:Types.arn_type -> ?alias_name:Types.alias_name_type -> unit -> Types.alias_list_entry
val make_list_aliases_response : ?truncated:Types.boolean_type -> ?next_marker:Types.marker_type -> ?aliases:Types.alias_list -> unit -> Types.list_aliases_response
val make_list_aliases_request : ?marker:Types.marker_type -> ?limit:Types.limit_type -> ?key_id:Types.key_id_type -> unit -> Types.list_aliases_request
val make_import_key_material_response : ?key_material_id:Types.backing_key_id_type -> ?key_id:Types.key_id_type -> unit -> Types.import_key_material_response
val make_import_key_material_request : ?key_material_id:Types.backing_key_id_type -> ?key_material_description:Types.key_material_description_type -> ?import_type:Types.import_type -> ?expiration_model:Types.expiration_model_type -> ?valid_to:Types.date_type -> encrypted_key_material:Types.ciphertext_type -> import_token:Types.ciphertext_type -> key_id:Types.key_id_type -> unit -> Types.import_key_material_request
val make_get_public_key_response : ?key_agreement_algorithms:Types.key_agreement_algorithm_spec_list -> ?signing_algorithms:Types.signing_algorithm_spec_list -> ?encryption_algorithms:Types.encryption_algorithm_spec_list -> ?key_usage:Types.key_usage_type -> ?key_spec:Types.key_spec -> ?customer_master_key_spec:Types.customer_master_key_spec -> ?public_key:Types.public_key_type -> ?key_id:Types.key_id_type -> unit -> Types.get_public_key_response
val make_get_public_key_request : ?grant_tokens:Types.grant_token_list -> key_id:Types.key_id_type -> unit -> Types.get_public_key_request
val make_get_parameters_for_import_response : ?parameters_valid_to:Types.date_type -> ?public_key:Types.plaintext_type -> ?import_token:Types.ciphertext_type -> ?key_id:Types.key_id_type -> unit -> Types.get_parameters_for_import_response
val make_get_parameters_for_import_request : wrapping_key_spec:Types.wrapping_key_spec -> wrapping_algorithm:Types.algorithm_spec -> key_id:Types.key_id_type -> unit -> Types.get_parameters_for_import_request
val make_get_key_rotation_status_response : ?on_demand_rotation_start_date:Types.date_type -> ?next_rotation_date:Types.date_type -> ?rotation_period_in_days:Types.rotation_period_in_days_type -> ?key_id:Types.key_id_type -> ?key_rotation_enabled:Types.boolean_type -> unit -> Types.get_key_rotation_status_response
val make_get_key_rotation_status_request : key_id:Types.key_id_type -> unit -> Types.get_key_rotation_status_request
val make_get_key_policy_response : ?policy_name:Types.policy_name_type -> ?policy:Types.policy_type -> unit -> Types.get_key_policy_response
val make_get_key_policy_request : ?policy_name:Types.policy_name_type -> key_id:Types.key_id_type -> unit -> Types.get_key_policy_request
val make_generate_random_response : ?ciphertext_for_recipient:Types.ciphertext_type -> ?plaintext:Types.plaintext_type -> unit -> Types.generate_random_response
val make_recipient_info : ?attestation_document:Types.attestation_document_type -> ?key_encryption_algorithm:Types.key_encryption_mechanism -> unit -> Types.recipient_info
val make_generate_random_request : ?recipient:Types.recipient_info -> ?custom_key_store_id:Types.custom_key_store_id_type -> ?number_of_bytes:Types.number_of_bytes_type -> unit -> Types.generate_random_request
val make_generate_mac_response : ?key_id:Types.key_id_type -> ?mac_algorithm:Types.mac_algorithm_spec -> ?mac:Types.ciphertext_type -> unit -> Types.generate_mac_response
val make_generate_mac_request : ?dry_run:Types.nullable_boolean_type -> ?grant_tokens:Types.grant_token_list -> mac_algorithm:Types.mac_algorithm_spec -> key_id:Types.key_id_type -> message:Types.plaintext_type -> unit -> Types.generate_mac_request
val make_generate_data_key_without_plaintext_response : ?key_material_id:Types.backing_key_id_type -> ?key_id:Types.key_id_type -> ?ciphertext_blob:Types.ciphertext_type -> unit -> Types.generate_data_key_without_plaintext_response
val make_generate_data_key_without_plaintext_request : ?dry_run:Types.nullable_boolean_type -> ?grant_tokens:Types.grant_token_list -> ?number_of_bytes:Types.number_of_bytes_type -> ?key_spec:Types.data_key_spec -> ?encryption_context:Types.encryption_context_type -> key_id:Types.key_id_type -> unit -> Types.generate_data_key_without_plaintext_request
val make_generate_data_key_pair_without_plaintext_response : ?key_material_id:Types.backing_key_id_type -> ?key_pair_spec:Types.data_key_pair_spec -> ?key_id:Types.key_id_type -> ?public_key:Types.public_key_type -> ?private_key_ciphertext_blob:Types.ciphertext_type -> unit -> Types.generate_data_key_pair_without_plaintext_response
val make_generate_data_key_pair_without_plaintext_request : ?dry_run:Types.nullable_boolean_type -> ?grant_tokens:Types.grant_token_list -> ?encryption_context:Types.encryption_context_type -> key_pair_spec:Types.data_key_pair_spec -> key_id:Types.key_id_type -> unit -> Types.generate_data_key_pair_without_plaintext_request
val make_generate_data_key_pair_response : ?key_material_id:Types.backing_key_id_type -> ?ciphertext_for_recipient:Types.ciphertext_type -> ?key_pair_spec:Types.data_key_pair_spec -> ?key_id:Types.key_id_type -> ?public_key:Types.public_key_type -> ?private_key_plaintext:Types.plaintext_type -> ?private_key_ciphertext_blob:Types.ciphertext_type -> unit -> Types.generate_data_key_pair_response
val make_generate_data_key_pair_request : ?dry_run:Types.nullable_boolean_type -> ?recipient:Types.recipient_info -> ?grant_tokens:Types.grant_token_list -> ?encryption_context:Types.encryption_context_type -> key_pair_spec:Types.data_key_pair_spec -> key_id:Types.key_id_type -> unit -> Types.generate_data_key_pair_request
val make_generate_data_key_response : ?key_material_id:Types.backing_key_id_type -> ?ciphertext_for_recipient:Types.ciphertext_type -> ?key_id:Types.key_id_type -> ?plaintext:Types.plaintext_type -> ?ciphertext_blob:Types.ciphertext_type -> unit -> Types.generate_data_key_response
val make_generate_data_key_request : ?dry_run:Types.nullable_boolean_type -> ?recipient:Types.recipient_info -> ?grant_tokens:Types.grant_token_list -> ?key_spec:Types.data_key_spec -> ?number_of_bytes:Types.number_of_bytes_type -> ?encryption_context:Types.encryption_context_type -> key_id:Types.key_id_type -> unit -> Types.generate_data_key_request
val make_encrypt_response : ?encryption_algorithm:Types.encryption_algorithm_spec -> ?key_id:Types.key_id_type -> ?ciphertext_blob:Types.ciphertext_type -> unit -> Types.encrypt_response
val make_encrypt_request : ?dry_run:Types.nullable_boolean_type -> ?encryption_algorithm:Types.encryption_algorithm_spec -> ?grant_tokens:Types.grant_token_list -> ?encryption_context:Types.encryption_context_type -> plaintext:Types.plaintext_type -> key_id:Types.key_id_type -> unit -> Types.encrypt_request
val make_enable_key_rotation_request : ?rotation_period_in_days:Types.rotation_period_in_days_type -> key_id:Types.key_id_type -> unit -> Types.enable_key_rotation_request
val make_enable_key_request : key_id:Types.key_id_type -> unit -> Types.enable_key_request
val make_disconnect_custom_key_store_response : unit -> unit
val make_disconnect_custom_key_store_request : custom_key_store_id:Types.custom_key_store_id_type -> unit -> Types.disconnect_custom_key_store_request
val make_disable_key_rotation_request : key_id:Types.key_id_type -> unit -> Types.disable_key_rotation_request
val make_disable_key_request : key_id:Types.key_id_type -> unit -> Types.disable_key_request
val make_describe_key_response : ?key_metadata:Types.key_metadata -> unit -> Types.describe_key_response
val make_describe_key_request : ?grant_tokens:Types.grant_token_list -> key_id:Types.key_id_type -> unit -> Types.describe_key_request
val make_custom_key_stores_list_entry : ?xks_proxy_configuration:Types.xks_proxy_configuration_type -> ?custom_key_store_type:Types.custom_key_store_type -> ?creation_date:Types.date_type -> ?connection_error_code:Types.connection_error_code_type -> ?connection_state:Types.connection_state_type -> ?trust_anchor_certificate:Types.trust_anchor_certificate_type -> ?cloud_hsm_cluster_id:Types.cloud_hsm_cluster_id_type -> ?custom_key_store_name:Types.custom_key_store_name_type -> ?custom_key_store_id:Types.custom_key_store_id_type -> unit -> Types.custom_key_stores_list_entry
val make_describe_custom_key_stores_response : ?truncated:Types.boolean_type -> ?next_marker:Types.marker_type -> ?custom_key_stores:Types.custom_key_stores_list -> unit -> Types.describe_custom_key_stores_response
val make_describe_custom_key_stores_request : ?marker:Types.marker_type -> ?limit:Types.limit_type -> ?custom_key_store_name:Types.custom_key_store_name_type -> ?custom_key_store_id:Types.custom_key_store_id_type -> unit -> Types.describe_custom_key_stores_request
val make_derive_shared_secret_response : ?key_origin:Types.origin_type -> ?key_agreement_algorithm:Types.key_agreement_algorithm_spec -> ?ciphertext_for_recipient:Types.ciphertext_type -> ?shared_secret:Types.plaintext_type -> ?key_id:Types.key_id_type -> unit -> Types.derive_shared_secret_response
val make_derive_shared_secret_request : ?recipient:Types.recipient_info -> ?dry_run:Types.nullable_boolean_type -> ?grant_tokens:Types.grant_token_list -> public_key:Types.public_key_type -> key_agreement_algorithm:Types.key_agreement_algorithm_spec -> key_id:Types.key_id_type -> unit -> Types.derive_shared_secret_request
val make_delete_imported_key_material_response : ?key_material_id:Types.backing_key_id_response_type -> ?key_id:Types.key_id_type -> unit -> Types.delete_imported_key_material_response
val make_delete_imported_key_material_request : ?key_material_id:Types.backing_key_id_type -> key_id:Types.key_id_type -> unit -> Types.delete_imported_key_material_request
val make_delete_custom_key_store_response : unit -> unit
val make_delete_custom_key_store_request : custom_key_store_id:Types.custom_key_store_id_type -> unit -> Types.delete_custom_key_store_request
val make_delete_alias_request : alias_name:Types.alias_name_type -> unit -> Types.delete_alias_request
val make_decrypt_response : ?key_material_id:Types.backing_key_id_type -> ?ciphertext_for_recipient:Types.ciphertext_type -> ?encryption_algorithm:Types.encryption_algorithm_spec -> ?plaintext:Types.plaintext_type -> ?key_id:Types.key_id_type -> unit -> Types.decrypt_response
val make_decrypt_request : ?dry_run:Types.nullable_boolean_type -> ?recipient:Types.recipient_info -> ?encryption_algorithm:Types.encryption_algorithm_spec -> ?key_id:Types.key_id_type -> ?grant_tokens:Types.grant_token_list -> ?encryption_context:Types.encryption_context_type -> ciphertext_blob:Types.ciphertext_type -> unit -> Types.decrypt_request
val make_create_key_response : ?key_metadata:Types.key_metadata -> unit -> Types.create_key_response
val make_create_key_request : ?xks_key_id:Types.xks_key_id_type -> ?multi_region:Types.nullable_boolean_type -> ?tags:Types.tag_list -> ?bypass_policy_lockout_safety_check:Types.boolean_type -> ?custom_key_store_id:Types.custom_key_store_id_type -> ?origin:Types.origin_type -> ?key_spec:Types.key_spec -> ?customer_master_key_spec:Types.customer_master_key_spec -> ?key_usage:Types.key_usage_type -> ?description:Types.description_type -> ?policy:Types.policy_type -> unit -> Types.create_key_request
val make_create_grant_response : ?grant_id:Types.grant_id_type -> ?grant_token:Types.grant_token_type -> unit -> Types.create_grant_response
val make_create_grant_request : ?dry_run:Types.nullable_boolean_type -> ?name:Types.grant_name_type -> ?grant_tokens:Types.grant_token_list -> ?constraints:Types.grant_constraints -> ?retiring_principal:Types.principal_id_type -> operations:Types.grant_operation_list -> grantee_principal:Types.principal_id_type -> key_id:Types.key_id_type -> unit -> Types.create_grant_request
val make_create_custom_key_store_response : ?custom_key_store_id:Types.custom_key_store_id_type -> unit -> Types.create_custom_key_store_response
val make_create_custom_key_store_request : ?xks_proxy_connectivity:Types.xks_proxy_connectivity_type -> ?xks_proxy_authentication_credential: Types.xks_proxy_authentication_credential_type -> ?xks_proxy_vpc_endpoint_service_name: Types.xks_proxy_vpc_endpoint_service_name_type -> ?xks_proxy_uri_path:Types.xks_proxy_uri_path_type -> ?xks_proxy_uri_endpoint:Types.xks_proxy_uri_endpoint_type -> ?custom_key_store_type:Types.custom_key_store_type -> ?key_store_password:Types.key_store_password_type -> ?trust_anchor_certificate:Types.trust_anchor_certificate_type -> ?cloud_hsm_cluster_id:Types.cloud_hsm_cluster_id_type -> custom_key_store_name:Types.custom_key_store_name_type -> unit -> Types.create_custom_key_store_request
val make_create_alias_request : target_key_id:Types.key_id_type -> alias_name:Types.alias_name_type -> unit -> Types.create_alias_request
val make_connect_custom_key_store_response : unit -> unit
val make_connect_custom_key_store_request : custom_key_store_id:Types.custom_key_store_id_type -> unit -> Types.connect_custom_key_store_request
val make_cancel_key_deletion_response : ?key_id:Types.key_id_type -> unit -> Types.cancel_key_deletion_response
val make_cancel_key_deletion_request : key_id:Types.key_id_type -> unit -> Types.cancel_key_deletion_request

Operations

module CancelKeyDeletion : sig ... end

Cancels the deletion of a KMS key. When this operation succeeds, the key state of the KMS key is Disabled. To enable the KMS key, use EnableKey.

module ConnectCustomKeyStore : sig ... end

Connects or reconnects a custom key store to its backing key store. For an CloudHSM key store, ConnectCustomKeyStore connects the key store to its associated CloudHSM cluster. For an external key store, ConnectCustomKeyStore connects the key store to the external key store proxy that communicates with your external key manager.

module CreateAlias : sig ... end

Creates a friendly name for a KMS key.

module CreateCustomKeyStore : sig ... end

Creates a custom key store backed by a key store that you own and manage. When you use a KMS key in a custom key store for a cryptographic operation, the cryptographic operation is actually performed in your key store using your keys. KMS supports CloudHSM key stores backed by an CloudHSM cluster and external key stores backed by an external key store proxy and external key manager outside of Amazon Web Services.

module CreateGrant : sig ... end

Adds a grant to a KMS key.

module CreateKey : sig ... end

Creates a unique customer managed KMS key in your Amazon Web Services account and Region. You can use a KMS key in cryptographic operations, such as encryption and signing. Some Amazon Web Services services let you use KMS keys that you create and manage to protect your service resources.

module Decrypt : sig ... end

Decrypts ciphertext that was encrypted by a KMS key using any of the following operations:

module DeleteAlias : sig ... end

Deletes the specified alias.

module DeleteCustomKeyStore : sig ... end

Deletes a custom key store. This operation does not affect any backing elements of the custom key store. It does not delete the CloudHSM cluster that is associated with an CloudHSM key store, or affect any users or keys in the cluster. For an external key store, it does not affect the external key store proxy, external key manager, or any external keys.

module DeleteImportedKeyMaterial : sig ... end

Deletes key material that was previously imported. This operation makes the specified KMS key temporarily unusable. To restore the usability of the KMS key, reimport the same key material. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide.

module DeriveSharedSecret : sig ... end

Derives a shared secret using a key agreement algorithm.

module DescribeCustomKeyStores : sig ... end

Gets information about custom key stores in the account and Region.

module DescribeKey : sig ... end

Provides detailed information about a KMS key. You can run DescribeKey on a customer managed key or an Amazon Web Services managed key.

module DisableKey : sig ... end

Sets the state of a KMS key to disabled. This change temporarily prevents use of the KMS key for cryptographic operations.

module DisableKeyRotation : sig ... end

Disables automatic rotation of the key material of the specified symmetric encryption KMS key.

module DisconnectCustomKeyStore : sig ... end

Disconnects the custom key store from its backing key store. This operation disconnects an CloudHSM key store from its associated CloudHSM cluster or disconnects an external key store from the external key store proxy that communicates with your external key manager.

module EnableKey : sig ... end

Sets the key state of a KMS key to enabled. This allows you to use the KMS key for cryptographic operations.

module EnableKeyRotation : sig ... end

Enables automatic rotation of the key material of the specified symmetric encryption KMS key.

module Encrypt : sig ... end

Encrypts plaintext of up to 4,096 bytes using a KMS key. You can use a symmetric or asymmetric KMS key with a KeyUsage of ENCRYPT_DECRYPT.

module GenerateDataKey : sig ... end

Returns a unique symmetric data key for use outside of KMS. This operation returns a plaintext copy of the data key and a copy that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the plaintext key are random; they are not related to the caller or the KMS key. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data.

module GenerateDataKeyPair : sig ... end

Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key, a plaintext private key, and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. You can use the data key pair to perform asymmetric cryptography and implement digital signatures outside of KMS. The bytes in the keys are random; they are not related to the caller or to the KMS key that is used to encrypt the private key.

Returns a unique asymmetric data key pair for use outside of KMS. This operation returns a plaintext public key and a copy of the private key that is encrypted under the symmetric encryption KMS key you specify. Unlike GenerateDataKeyPair, this operation does not return a plaintext private key. The bytes in the keys are random; they are not related to the caller or to the KMS key that is used to encrypt the private key.

module GenerateDataKeyWithoutPlaintext : sig ... end

Returns a unique symmetric data key for use outside of KMS. This operation returns a data key that is encrypted under a symmetric encryption KMS key that you specify. The bytes in the key are random; they are not related to the caller or to the KMS key.

module GenerateMac : sig ... end

Generates a hash-based message authentication code (HMAC) for a message using an HMAC KMS key and a MAC algorithm that the key supports. HMAC KMS keys and the HMAC algorithms that KMS uses conform to industry standards defined in RFC 2104.

module GenerateRandom : sig ... end

Returns a random byte string that is cryptographically secure.

module GetKeyPolicy : sig ... end

Gets a key policy attached to the specified KMS key.

module GetKeyRotationStatus : sig ... end

Provides detailed information about the rotation status for a KMS key, including whether automatic rotation of the key material is enabled for the specified KMS key, the rotation period, and the next scheduled rotation date.

module GetParametersForImport : sig ... end

Returns the public key and an import token you need to import or reimport key material for a KMS key.

module GetPublicKey : sig ... end

Returns the public key of an asymmetric KMS key. Unlike the private key of a asymmetric KMS key, which never leaves KMS unencrypted, callers with kms:GetPublicKey permission can download the public key of an asymmetric KMS key. You can share the public key to allow others to encrypt messages and verify signatures outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

module ImportKeyMaterial : sig ... end

Imports or reimports key material into an existing KMS key that was created without key material. You can also use this operation to set or update the expiration model and expiration date of the imported key material.

module ListAliases : sig ... end

Gets a list of aliases in the caller's Amazon Web Services account and region. For more information about aliases, see CreateAlias.

module ListGrants : sig ... end

Gets a list of all grants for the specified KMS key.

module ListKeyPolicies : sig ... end

Gets the names of the key policies that are attached to a KMS key. This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is default.

module ListKeyRotations : sig ... end

Returns information about the key materials associated with the specified KMS key. You can use the optional IncludeKeyMaterial parameter to control which key materials are included in the response.

module ListKeys : sig ... end

Gets a list of all KMS keys in the caller's Amazon Web Services account and Region.

module ListResourceTags : sig ... end

Returns all tags on the specified KMS key.

module ListRetirableGrants : sig ... end

Returns information about all grants in the Amazon Web Services account and Region that have the specified retiring principal.

module PutKeyPolicy : sig ... end

Attaches a key policy to the specified KMS key.

module ReEncrypt : sig ... end

Decrypts ciphertext and then reencrypts it entirely within KMS. You can use this operation to change the KMS key under which data is encrypted, such as when you manually rotate a KMS key or change the KMS key that protects a ciphertext. You can also use it to reencrypt ciphertext under the same KMS key, such as to change the encryption context of a ciphertext.

module ReplicateKey : sig ... end

Replicates a multi-Region key into the specified Region. This operation creates a multi-Region replica key based on a multi-Region primary key in a different Region of the same Amazon Web Services partition. You can create multiple replicas of a primary key, but each must be in a different Region. To create a multi-Region primary key, use the CreateKey operation.

module RetireGrant : sig ... end

Deletes a grant. Typically, you retire a grant when you no longer need its permissions. To identify the grant to retire, use a grant token, or both the grant ID and a key identifier (key ID or key ARN) of the KMS key. The CreateGrant operation returns both values.

module RevokeGrant : sig ... end

Deletes the specified grant. You revoke a grant to terminate the permissions that the grant allows. For more information, see Retiring and revoking grants in the Key Management Service Developer Guide.

module RotateKeyOnDemand : sig ... end

Immediately initiates rotation of the key material of the specified symmetric encryption KMS key.

module ScheduleKeyDeletion : sig ... end

Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30 days, but you can specify a waiting period of 7-30 days. When this operation is successful, the key state of the KMS key changes to PendingDeletion and the key can't be used in any cryptographic operations. It remains in this state for the duration of the waiting period. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes the KMS key, its key material, and all KMS data associated with it, including all aliases that refer to it.

module Sign : sig ... end

Creates a digital signature for a message or message digest by using the private key in an asymmetric signing KMS key. To verify the signature, use the Verify operation, or use the public key in the same asymmetric KMS key outside of KMS. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

module TagResource : sig ... end

Adds or edits tags on a customer managed key.

module UntagResource : sig ... end

Deletes tags from a customer managed key. To delete a tag, specify the tag key and the KMS key.

module UpdateAlias : sig ... end

Associates an existing KMS alias with a different KMS key. Each alias is associated with only one KMS key at a time, although a KMS key can have multiple aliases. The alias and the KMS key must be in the same Amazon Web Services account and Region.

module UpdateCustomKeyStore : sig ... end

Changes the properties of a custom key store. You can use this operation to change the properties of an CloudHSM key store or an external key store.

module UpdateKeyDescription : sig ... end

Updates the description of a KMS key. To see the description of a KMS key, use DescribeKey.

module UpdatePrimaryRegion : sig ... end

Changes the primary key of a multi-Region key.

module Verify : sig ... end

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

module VerifyMac : sig ... end

Verifies the hash-based message authentication code (HMAC) for a specified message, HMAC KMS key, and MAC algorithm. To verify the HMAC, VerifyMac computes an HMAC using the message, HMAC KMS key, and MAC algorithm that you specify, and compares the computed HMAC to the HMAC that you specify. If the HMACs are identical, the verification succeeds; otherwise, it fails. Verification indicates that the message hasn't changed since the HMAC was calculated, and the specified key was used to generate and verify the HMAC.

module Json_serializers : sig ... end
module Json_deserializers : sig ... end